All Downloads are FREE. Search and download functionalities are using the official Maven repository.

eedm.advancement-prospects.v10.0.advancement-prospects.json Maven / Gradle / Ivy

{
  "title" : "Advancement Prospects",
  "description" : "A prospect is a constituent (or multiple constituents) which has been identified as potential major supporter.",
  "type" : "object",
  "properties" : {
    "metadata" : {
      "$ref" : "resource:/eedm/metadata.json"
    },
    "id" : {
      "title" : "ID",
      "description" : "The global identifier of the advancement prospect.",
      "type" : "string",
      "format" : "guid",
      "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
    },
    "title" : {
      "title" : "Title",
      "description" : "The full name of the advancement prospect.",
      "type" : "string",
      "minLength" : 1
    },
    "description" : {
      "title" : "Description",
      "description" : "The description of the prospect.",
      "type" : "string"
    },
    "type" : {
      "title" : "Type",
      "description" : "The type of prospect.",
      "enum" : [ "individual", "familyFoundation", "foundation", "corporation", "couple", "group" ],
      "type" : "string"
    },
    "source" : {
      "title" : "Source",
      "description" : "The source of information for the prospect.",
      "oneOf" : [ {
        "type" : "object",
        "properties" : {
          "id" : {
            "title" : "ID",
            "description" : "The global identifier for the Source.",
            "type" : "string",
            "format" : "guid",
            "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
          }
        },
        "links" : [ {
          "rel" : "self",
          "href" : "/advancement-sources/{id}",
          "targetSchema" : {
            "$ref" : "advancement-sources.json#"
          }
        } ],
        "additionalProperties" : false,
        "required" : [ "id" ]
      }, {
        "type" : "object",
        "maxProperties" : 0
      } ]
    },
    "status" : {
      "title" : "Status",
      "description" : "The status of the prospect.",
      "type" : "object",
      "properties" : {
        "id" : {
          "title" : "ID",
          "description" : "The global identifier for the Status.",
          "type" : "string",
          "format" : "guid",
          "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
        }
      },
      "links" : [ {
        "rel" : "self",
        "href" : "/advancement-statuses/{id}",
        "targetSchema" : {
          "$ref" : "advancement-statuses.json#"
        }
      } ],
      "additionalProperties" : false,
      "required" : [ "id" ]
    },
    "startOn" : {
      "title" : "Start On",
      "description" : "The first date of the time period defined for the prospect.",
      "oneOf" : [ {
        "type" : "string",
        "format" : "date-time",
        "pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?(Z|[+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])?$"
      }, {
        "type" : "string",
        "maxLength" : 0
      } ]
    },
    "endOn" : {
      "title" : "End On",
      "description" : "The last date of the time period defined for the prospect.",
      "oneOf" : [ {
        "type" : "string",
        "format" : "date-time",
        "pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?(Z|[+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])?$"
      }, {
        "type" : "string",
        "maxLength" : 0
      } ]
    },
    "givingExpectation" : {
      "title" : "Giving Expectation",
      "description" : "The amount of funds expected from the prospect.",
      "oneOf" : [ {
        "type" : "object",
        "format" : "currency",
        "properties" : {
          "value" : {
            "title" : "Value",
            "description" : "The monetary value",
            "type" : "number"
          },
          "currency" : {
            "title" : "Currency",
            "description" : "The ISO 4217 currency code",
            "enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ],
            "type" : "string"
          }
        },
        "additionalProperties" : false,
        "required" : [ "value", "currency" ]
      }, {
        "type" : "object",
        "maxProperties" : 0
      } ]
    },
    "targetGiftLevel" : {
      "title" : "Target Gift Level",
      "description" : "The target gift level associated with the prospect.",
      "oneOf" : [ {
        "type" : "object",
        "properties" : {
          "id" : {
            "title" : "ID",
            "description" : "The global identifier for the Target Gift Level.",
            "type" : "string",
            "format" : "guid",
            "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
          }
        },
        "links" : [ {
          "rel" : "self",
          "href" : "/target-gift-levels/{id}",
          "targetSchema" : {
            "$ref" : "target-gift-levels.json#"
          }
        } ],
        "additionalProperties" : false,
        "required" : [ "id" ]
      }, {
        "type" : "object",
        "maxProperties" : 0
      } ]
    },
    "campaign" : {
      "title" : "Campaign",
      "description" : "The campaign to which the prospect is associated.",
      "oneOf" : [ {
        "type" : "object",
        "properties" : {
          "id" : {
            "title" : "ID",
            "description" : "The global identifier for the Campaign.",
            "type" : "string",
            "format" : "guid",
            "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
          }
        },
        "links" : [ {
          "rel" : "self",
          "href" : "/campaigns/{id}",
          "targetSchema" : {
            "$ref" : "campaigns.json#"
          }
        } ],
        "additionalProperties" : false,
        "required" : [ "id" ]
      }, {
        "type" : "object",
        "maxProperties" : 0
      } ]
    },
    "primaryContact" : {
      "title" : "Primary Contact",
      "description" : "The primary contact for the prospect.",
      "type" : "object",
      "properties" : {
        "constituent" : {
          "title" : "Constituent",
          "description" : "The primary constituent (person or organization) associated with the prospect.",
          "oneOf" : [ {
            "title" : "persons",
            "description" : "The primary person associated with the prospect.",
            "type" : "object",
            "properties" : {
              "person" : {
                "title" : "Person",
                "description" : "The primary person associated with the prospect.",
                "type" : "object",
                "properties" : {
                  "id" : {
                    "title" : "ID",
                    "description" : "The global identifier for the Person.",
                    "type" : "string",
                    "format" : "guid",
                    "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
                  }
                },
                "links" : [ {
                  "rel" : "self",
                  "href" : "/constituent-persons/{id}",
                  "targetSchema" : {
                    "$ref" : "constituent-persons.json#"
                  }
                } ],
                "additionalProperties" : false,
                "required" : [ "id" ]
              }
            },
            "additionalProperties" : false,
            "required" : [ "person" ]
          }, {
            "title" : "organization",
            "description" : "The primary organization associated with the prospect.",
            "type" : "object",
            "properties" : {
              "organization" : {
                "title" : "Organization",
                "description" : "The primary organization associated with the prospect.",
                "type" : "object",
                "properties" : {
                  "id" : {
                    "title" : "ID",
                    "description" : "The global identifier for the Organization.",
                    "type" : "string",
                    "format" : "guid",
                    "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
                  }
                },
                "links" : [ {
                  "rel" : "self",
                  "href" : "/constituent-organizations/{id}",
                  "targetSchema" : {
                    "$ref" : "constituent-organizations.json#"
                  }
                } ],
                "additionalProperties" : false,
                "required" : [ "id" ]
              }
            },
            "additionalProperties" : false,
            "required" : [ "organization" ]
          } ]
        }
      },
      "additionalProperties" : false
    },
    "persons" : {
      "title" : "Persons",
      "description" : "The people associated with the prospect.",
      "type" : "array",
      "items" : {
        "title" : "Persons",
        "description" : "The people associated with the prospect.",
        "type" : "object",
        "properties" : {
          "id" : {
            "title" : "ID",
            "description" : "The global identifier for the Persons.",
            "type" : "string",
            "format" : "guid",
            "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
          }
        },
        "links" : [ {
          "rel" : "self",
          "href" : "/constituent-persons/{id}",
          "targetSchema" : {
            "$ref" : "constituent-persons.json#"
          }
        } ],
        "additionalProperties" : false,
        "required" : [ "id" ]
      }
    },
    "organizations" : {
      "title" : "Organizations",
      "description" : "The organizations associated with the prospect.",
      "type" : "array",
      "items" : {
        "title" : "Organizations",
        "description" : "The organizations associated with the prospect.",
        "type" : "object",
        "properties" : {
          "id" : {
            "title" : "ID",
            "description" : "The global identifier for the Organizations.",
            "type" : "string",
            "format" : "guid",
            "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
          }
        },
        "links" : [ {
          "rel" : "self",
          "href" : "/constituent-organizations/{id}",
          "targetSchema" : {
            "$ref" : "constituent-organizations.json#"
          }
        } ],
        "additionalProperties" : false,
        "required" : [ "id" ]
      }
    },
    "groups" : {
      "title" : "Groups",
      "description" : "The group associated with the prospect.",
      "type" : "array",
      "items" : {
        "type" : "object",
        "properties" : {
          "groupType" : {
            "title" : "Group Type",
            "description" : "The type of group.",
            "type" : "object",
            "properties" : {
              "id" : {
                "title" : "ID",
                "description" : "The global identifier for the Group Type.",
                "type" : "string",
                "format" : "guid",
                "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
              }
            },
            "links" : [ {
              "rel" : "self",
              "href" : "/advancement-prospect-group-types/{id}",
              "targetSchema" : {
                "$ref" : "advancement-prospect-group-types.json#"
              }
            } ],
            "additionalProperties" : false,
            "required" : [ "id" ]
          },
          "college" : {
            "title" : "College",
            "description" : "The college or institutional unit associated with the prospect.",
            "oneOf" : [ {
              "title" : "Institutional Unit",
              "description" : "The name of the institutional unit.",
              "type" : "object",
              "properties" : {
                "institutionalUnit" : {
                  "title" : "Institutional Unit",
                  "description" : "The name of the institutional unit.",
                  "oneOf" : [ {
                    "type" : "object",
                    "properties" : {
                      "id" : {
                        "title" : "ID",
                        "description" : "The global identifier for the Institutional Unit.",
                        "type" : "string",
                        "format" : "guid",
                        "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
                      }
                    },
                    "links" : [ {
                      "rel" : "self",
                      "href" : "/educational-institution-units/{id}",
                      "targetSchema" : {
                        "$ref" : "educational-institution-units.json#"
                      }
                    } ],
                    "additionalProperties" : false,
                    "required" : [ "id" ]
                  }, {
                    "type" : "object",
                    "maxProperties" : 0
                  } ]
                }
              },
              "additionalProperties" : false
            }, {
              "title" : "name",
              "description" : "The name of the college.",
              "type" : "object",
              "properties" : {
                "name" : {
                  "title" : "Name",
                  "description" : "The name of the college.",
                  "type" : "string"
                }
              },
              "additionalProperties" : false
            } ]
          },
          "targetGiftLevel" : {
            "title" : "Target Gift Level",
            "description" : "The target gift level associated with the group.",
            "oneOf" : [ {
              "type" : "object",
              "properties" : {
                "id" : {
                  "title" : "ID",
                  "description" : "The global identifier for the Target Gift Level.",
                  "type" : "string",
                  "format" : "guid",
                  "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
                }
              },
              "links" : [ {
                "rel" : "self",
                "href" : "/target-gift-levels/{id}",
                "targetSchema" : {
                  "$ref" : "target-gift-levels.json#"
                }
              } ],
              "additionalProperties" : false,
              "required" : [ "id" ]
            }, {
              "type" : "object",
              "maxProperties" : 0
            } ]
          },
          "startOn" : {
            "title" : "Start On",
            "description" : "The date the group was assigned to the prospect.",
            "oneOf" : [ {
              "type" : "string",
              "format" : "date-time",
              "pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?(Z|[+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])?$"
            }, {
              "type" : "string",
              "maxLength" : 0
            } ]
          },
          "endOn" : {
            "title" : "End On",
            "description" : "The last date the group was assigned to the prospect.",
            "oneOf" : [ {
              "type" : "string",
              "format" : "date-time",
              "pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?(Z|[+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])?$"
            }, {
              "type" : "string",
              "maxLength" : 0
            } ]
          }
        },
        "additionalProperties" : false,
        "required" : [ "groupType" ]
      }
    },
    "assignments" : {
      "title" : "Assignments",
      "description" : "The persons or teams assigned to the prospect.",
      "type" : "array",
      "items" : {
        "type" : "object",
        "properties" : {
          "assignee" : {
            "title" : "Assignee",
            "description" : "A person or team assigned to the prospect.",
            "oneOf" : [ {
              "title" : "Representative",
              "description" : "An advancement representative assigned to the prospect.",
              "type" : "object",
              "properties" : {
                "representative" : {
                  "title" : "Representative",
                  "description" : "An advancement representative assigned to the prospect.",
                  "type" : "object",
                  "properties" : {
                    "id" : {
                      "title" : "ID",
                      "description" : "The global identifier for the Representative.",
                      "type" : "string",
                      "format" : "guid",
                      "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
                    }
                  },
                  "links" : [ {
                    "rel" : "self",
                    "href" : "/advancement-representatives/{id}",
                    "targetSchema" : {
                      "$ref" : "advancement-representatives.json#"
                    }
                  } ],
                  "additionalProperties" : false,
                  "required" : [ "id" ]
                }
              },
              "additionalProperties" : false,
              "required" : [ "representative" ]
            }, {
              "title" : "Team",
              "description" : "An advancement team assigned to the prospect.",
              "type" : "object",
              "properties" : {
                "team" : {
                  "title" : "Team",
                  "description" : "An advancement team assigned to the prospect.",
                  "type" : "object",
                  "properties" : {
                    "id" : {
                      "title" : "ID",
                      "description" : "The global identifier for the Team.",
                      "type" : "string",
                      "format" : "guid",
                      "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
                    }
                  },
                  "links" : [ {
                    "rel" : "self",
                    "href" : "/advancement-teams/{id}",
                    "targetSchema" : {
                      "$ref" : "advancement-teams.json#"
                    }
                  } ],
                  "additionalProperties" : false,
                  "required" : [ "id" ]
                }
              },
              "additionalProperties" : false,
              "required" : [ "team" ]
            } ]
          },
          "role" : {
            "title" : "Role",
            "description" : "The role of the assignee.",
            "oneOf" : [ {
              "type" : "object",
              "properties" : {
                "id" : {
                  "title" : "ID",
                  "description" : "The global identifier for the Role.",
                  "type" : "string",
                  "format" : "guid",
                  "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
                }
              },
              "links" : [ {
                "rel" : "self",
                "href" : "/advancement-roles/{id}",
                "targetSchema" : {
                  "$ref" : "advancement-roles.json#"
                }
              } ],
              "additionalProperties" : false,
              "required" : [ "id" ]
            }, {
              "type" : "object",
              "maxProperties" : 0
            } ]
          },
          "startOn" : {
            "title" : "Start On",
            "description" : "The start date of the assignment.",
            "type" : "string",
            "format" : "date-time",
            "pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?(Z|[+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])?$"
          },
          "endOn" : {
            "title" : "End On",
            "description" : "The end date of the assignment.",
            "oneOf" : [ {
              "type" : "string",
              "format" : "date-time",
              "pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?(Z|[+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])?$"
            }, {
              "type" : "string",
              "maxLength" : 0
            } ]
          },
          "preference" : {
            "title" : "Preference",
            "description" : "Indicates the primary assignee for the prospect.",
            "oneOf" : [ {
              "type" : "string",
              "enum" : [ "primary" ]
            }, {
              "type" : "string",
              "maxLength" : 0
            } ]
          }
        },
        "additionalProperties" : false,
        "required" : [ "assignee", "startOn" ]
      }
    },
    "stages" : {
      "title" : "Stages",
      "description" : "The stage of the prospect.",
      "type" : "array",
      "items" : {
        "type" : "object",
        "properties" : {
          "name" : {
            "title" : "Name",
            "description" : "The name of the stage.",
            "type" : "string"
          },
          "enteredOn" : {
            "title" : "Entered On",
            "description" : "The date when the prospect entered the stage.",
            "type" : "string",
            "format" : "date-time",
            "pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?(Z|[+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])?$"
          }
        },
        "additionalProperties" : false,
        "required" : [ "name", "enteredOn" ]
      }
    },
    "notes" : {
      "title" : "Notes",
      "description" : "Notes/comments that have been generated regarding the prospect.",
      "type" : "array",
      "items" : {
        "type" : "object",
        "properties" : {
          "subject" : {
            "title" : "Subject",
            "description" : "The subject of the note.",
            "type" : "string"
          },
          "content" : {
            "title" : "Content",
            "description" : "The content of the note.",
            "type" : "string",
            "minLength" : 1
          }
        },
        "additionalProperties" : false,
        "required" : [ "content" ]
      }
    }
  },
  "required" : [ "id", "title", "type", "status", "primaryContact" ],
  "additionalProperties" : false,
  "links" : [ {
    "rel" : "filter",
    "encType" : "application/x-www-form-urlencoded",
    "method" : "GET",
    "href" : "/advancement-prospects/",
    "schema" : {
      "type" : "object",
      "properties" : {
        "type" : {
          "description" : "The type of prospect.",
          "enum" : [ "individual", "familyFoundation", "foundation", "corporation", "couple", "group" ],
          "type" : "string"
        },
        "persons" : {
          "description" : "The people associated with the prospect.",
          "type" : "string",
          "format" : "guid",
          "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
        },
        "organizations" : {
          "description" : "The organization associated with the prospect.",
          "type" : "string",
          "format" : "guid",
          "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
        },
        "campaign" : {
          "description" : "The campaign to which the prospect is associated.",
          "type" : "string",
          "format" : "guid",
          "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
        },
        "stages" : {
          "description" : "The stage of the prospect.",
          "type" : "object",
          "properties" : {
            "name" : {
              "type" : "string"
            }
          }
        },
        "primaryContact" : {
          "description" : "The primary contact for the prospect.",
          "type" : "object",
          "properties" : {
            "constituent" : {
              "type" : "string",
              "format" : "guid",
              "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
            }
          }
        },
        "groups" : {
          "description" : "The group associated with the prospect",
          "type" : "object",
          "properties" : {
            "groupType" : {
              "type" : "string",
              "format" : "guid",
              "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
            }
          }
        }
      }
    }
  } ]
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy