eedm.constituent-ratings.v15.0.constituent-ratings.json Maven / Gradle / Ivy
{
"title" : "Constituent Ratings",
"description" : "Information on ratings associated with constituents.",
"type" : "object",
"properties" : {
"metadata" : {
"$ref" : "resource:/eedm/metadata.json"
},
"id" : {
"title" : "Id",
"description" : "The global identifier of the constituent rating",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
},
"description" : {
"title" : "Description",
"description" : "The description of the constituent rating.",
"type" : "string"
},
"constituent" : {
"title" : "Constituent",
"description" : "The constituent associated with the rating.",
"oneOf" : [ {
"title" : "person",
"description" : "The person associated with the rating.",
"type" : "object",
"properties" : {
"person" : {
"title" : "Person",
"description" : "The person associated with the rating.",
"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 organization associated with the rating.",
"type" : "object",
"properties" : {
"organization" : {
"title" : "Organization",
"description" : "The organization associated with the rating.",
"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" ]
}, {
"title" : "prospect",
"description" : "The prospect associated with the rating.",
"type" : "object",
"properties" : {
"prospect" : {
"title" : "Prospect",
"description" : "The prospect associated with the rating.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Prospect.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/advancement-prospects/{id}",
"targetSchema" : {
"$ref" : "advancement-prospects.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
},
"additionalProperties" : false,
"required" : [ "prospect" ]
} ]
},
"type" : {
"title" : "Type",
"description" : "The type of the constituent rating, e.g.: influence, income capacity, etc.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Type.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/constituent-rating-types/{id}",
"targetSchema" : {
"$ref" : "constituent-rating-types.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
},
"preference" : {
"title" : "Preference",
"description" : "Indicates the primary rating for the constituent for the given rating type. Only one rating should be set to primary for a constituent for a rating type.",
"oneOf" : [ {
"type" : "string",
"enum" : [ "primary" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"area" : {
"title" : "Area",
"description" : "The area for which the constituent was rated, e.g.: planned giving, capital campaign, etc.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Area.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/constituent-rating-areas/{id}",
"targetSchema" : {
"$ref" : "constituent-rating-areas.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"status" : {
"title" : "Status",
"description" : "The status of the rating.",
"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" ]
},
"ratedOn" : {
"title" : "Rated On",
"description" : "The date on which the constituent was rated.",
"type" : "string",
"format" : "date",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])$"
},
"screening" : {
"title" : "Screening",
"description" : "The target type and the method of screening used for the rating.",
"type" : "object",
"properties" : {
"targetType" : {
"title" : "Target Type",
"description" : "The target type of the screening, e.g.: individual, household.",
"oneOf" : [ {
"type" : "string",
"enum" : [ "individual", "household" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"method" : {
"title" : "Method",
"description" : "The method used in screening the target, e.g.: staff visit, peer evaluation, etc.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Method.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/constituent-rating-screening-methods/{id}",
"targetSchema" : {
"$ref" : "constituent-rating-screening-methods.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
}
},
"additionalProperties" : false
},
"college" : {
"title" : "College",
"description" : "The institution associated with the rating.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the College.",
"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
} ]
},
"campaign" : {
"title" : "Campaign",
"description" : "The campaign associated with the rating.",
"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
} ]
},
"evaluator" : {
"title" : "Evaluator",
"description" : "The person who evaluated the rating.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Evaluator.",
"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" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"source" : {
"title" : "Source",
"description" : "The source from which the rating information originated.",
"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
} ]
},
"businessUnit" : {
"title" : "Business Unit",
"description" : "The business unit associated with the rating.",
"type" : "string"
},
"value" : {
"title" : "Value",
"description" : "The rating of the constituent for the rating type, e.g.: high, platinum, gold, etc.",
"type" : "string"
},
"amount" : {
"title" : "Amount",
"description" : "The amount at which a constituent was rated.",
"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
} ]
},
"participation" : {
"title" : "Participation",
"description" : "The estimation of the likelihood of the constituent contributing to the campaign, e.g.: high, medium, low, etc.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Participation.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/giving-participation-ratings/{id}",
"targetSchema" : {
"$ref" : "giving-participation-ratings.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"currencyRange" : {
"title" : "Currency Range",
"description" : "The range at which a constituent was rated.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Currency Range.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/advancement-currency-ranges/{id}",
"targetSchema" : {
"$ref" : "advancement-currency-ranges.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"capacity" : {
"title" : "Capacity",
"description" : "The highest contribution level expected for the constituent, e.g.: major gift, annual gift, etc.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Capacity.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/giving-capacities/{id}",
"targetSchema" : {
"$ref" : "giving-capacities.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"readiness" : {
"title" : "Readiness",
"description" : "The timeframe expected for the constituent's contribution, e.g.: 1 - 2 years, 2 - 3 years, etc.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Readiness.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/giving-readiness-ratings/{id}",
"targetSchema" : {
"$ref" : "giving-readiness-ratings.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"inclination" : {
"title" : "Inclination",
"description" : "The level of constituent's inclination to donate, e.g.: definitely give, not likely to give, etc.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Inclination.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/giving-inclination-ratings/{id}",
"targetSchema" : {
"$ref" : "giving-inclination-ratings.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"notes" : {
"title" : "Notes",
"description" : "Notes/comments that have been generated regarding the rating.",
"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", "constituent", "type", "status", "ratedOn" ],
"additionalProperties" : false,
"links" : [ {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/constituent-ratings?criteria={\"constituent\":{\"person\": $id}}",
"title" : "Person",
"description" : "The person associated with the rating.",
"schema" : {
"type" : "object",
"properties" : {
"constituent" : {
"type" : "object",
"properties" : {
"person" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}
}
}
},
"targetSchema" : {
"$ref" : "constituent-ratings.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/constituent-ratings?criteria={\"constituent\":{\"organization\": $id}}",
"title" : "Organization",
"description" : "The organization associated with the rating.",
"schema" : {
"type" : "object",
"properties" : {
"constituent" : {
"type" : "object",
"properties" : {
"organization" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}
}
}
},
"targetSchema" : {
"$ref" : "constituent-ratings.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/constituent-ratings?criteria={\"constituent\":{\"prospect\": $id}}",
"title" : "Prospect",
"description" : "The prospect associated with the rating.",
"schema" : {
"type" : "object",
"properties" : {
"constituent" : {
"type" : "object",
"properties" : {
"prospect" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}
}
}
},
"targetSchema" : {
"$ref" : "constituent-ratings.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/constituent-ratings?criteria={\"type\": {\"id\": $id}}",
"title" : "Type",
"description" : "The type of the constituent rating.",
"schema" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}
},
"targetSchema" : {
"$ref" : "constituent-ratings.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/constituent-ratings?criteria={\"college\": {\"id\": $id}}",
"title" : "College",
"description" : "The institution associated with the rating.",
"schema" : {
"type" : "object",
"properties" : {
"institution" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}
},
"targetSchema" : {
"$ref" : "constituent-ratings.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/constituent-ratings?criteria={\"campaign\": {\"id\": $id}}",
"title" : "Campaign",
"description" : "The campaign associated with the rating.",
"schema" : {
"type" : "object",
"properties" : {
"campaign" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}
},
"targetSchema" : {
"$ref" : "constituent-ratings.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/constituent-ratings?criteria={\"area\": {\"id\": $id}}",
"title" : "Area",
"description" : "The area for which the constituent was rated.",
"schema" : {
"type" : "object",
"properties" : {
"area" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}
},
"targetSchema" : {
"$ref" : "constituent-ratings.json#"
}
} ]
}© 2015 - 2025 Weber Informatics LLC | Privacy Policy