rapidModel CharityNavigator
/** The Charity Navigator Data API provides access to Charity Navigator's
ratings, research content and charitable organization profiles. */
// resourceAPI CharityNavigatorDataAPI baseURI "https://cntest.getsandbox.com/v1"
// resourceAPI CharityNavigatorDataAPI baseURI "https://cnapi.reprezen.com:443"
// resourceAPI CharityNavigatorDataAPI baseURI "https://data-api-2445579900832.staging.gw.apicast.io:443"
resourceAPI CharityNavigatorDataAPI baseURI "https://api.data.charitynavigator.org/v2"
/** The full collection of organizations in Charity Navigator. Allows paged
retrieval, simple and advanced searching. */
collectionResource OrganizationCollection type OrganizationSummary
URI /Organizations
/* Subset of organization and rating data */
referenceEmbed > currentRating
targetProperties
ratingID
score
rating
ratingImage
financialRating
accountabilityRating
publicationDate
form990
referenceEmbed > financialRating
targetProperties
score
rating
referenceEmbed > accountabilityRating
targetProperties
score
rating
referenceEmbed > category
targetProperties
categoryID
categoryName
referenceEmbed > cause
targetProperties
causeID
causeName
referenceEmbed > irsClassification
referenceEmbed > mailingAddress
referenceEmbed > donationAddress
referenceEmbed > advisories
mediaTypes
application/json
/** Retrieve a list of the organizations available in the Charity Navigator Data
Store. Allows paged retrieval, simple and advanced searching. */
method GET searchOrganizations
request
/** 3Scale App ID: unique identifier for an application registered in the
Charity Navigator developer portal. */
required param app_id type string in query
extensions
x-data-threescale-name : app_ids
/** 3Scale App Key: a secret key to authenticate the assigned App ID. */
required param app_key type string in query
extensions
x-data-threescale-name : app_keys
/** Number of organizations to return in a single response message. Used in
combination with `pageNum` for paged responses. Default value is 100. If
specified, must be an integer value between 1 and 1,000. */
param pageSize type int in query
default "100"
/** Page number to return, in case the number of available objects in the result
set is greater than the specified or default `pageSize`. Default value is 1.
If the value of pageNum is greater than the number of pages in the result set,
the method will return a 404 error. If the requested starting position, computed
as `((pageNum-1) * pageSize) + 1`, is greater than the maximum supported result
size of 10,000 objects, the method will return a 400 error. */
param pageNum type integer in query
default "1"
/** A simple search string that narrows the results to organizations matching
the specified search terms. This is a relevance-driven search, not an exact
match. Whitespace-separated terms in the search string are combined using AND
logic, so adding terms has the effect of narrowing the search.
By default, the search looks for matches in all string or text properties. The
searchType parameter can change the field values included in the search. */
param search type string in query
/** .Used in combination with the `search` parameter, specifies the type of
.search to be performed.
.
.| Value | Search Behavior |
.| --------- | ------------------------------------- |
.| DEFAULT | Search in all string properties. |
.| NAME_ONLY | Search only in the Organization name. |
.
.Omitting the searchType parameter has the same effect as specifying "DEFAULT".
.
.Any value other than the ones specified in the table above will cause an HTTP
.400 error response. */
param searchType type string in query
default "DEFAULT"
/** .Specifies whether to include only rated charities or unrated charities. By
.default, all charities will be returned.
.
.Can be specified as `TRUE` or `FALSE`, `0` or `1`, or included without a value,
.which is equivalent to `TRUE` or `1`.
.
.| Usage | Search Behavior |
.| --- | --- |
.| `rated=TRUE`
`rated=1`
`rated` | Return only rated charities. |
.| `rated=FALSE`
`rated=0` | Return only unrated charities. |
.| (default) | Return all charities. |
.
.Any value other than the ones specified in the table above will cause an HTTP
.400 error response. */
param rated type boolean in query
/** ID of a Category. Search results will be filtered to include only
organizations in the specified category. */
param categoryID type string in query
/** ID of a Cause. Search results will be filtered to include only organizations
in the specified cause. */
param causeID type string in query
/** .Specifies whether to include or exclude organizations flagged by Charity
.Navigator as fundraising organizations. By default, all charities will be
.returned.
[Learn
.More](javascript:openBrWindow('http://www.charitynavigator.org/index.cfm?bay=glossary.word&gid=95&print=1','glossary','scrollbars=yes,width=760,height=400')
.
.Can be specified as `TRUE` or `FALSE`, `0` or `1`, or included without a value,
.which is equivalent to `TRUE` or `1`.
.
.Note that a charity that has a "Moderate" or "High" Severity Advisory has its rating superseded by the Advisory
.and will not show up with the rated filter on. A rated charity with "Low" Severity Advisory is still considered rated
.and will still be found with the filter on.
.
.| Usage | Search Behavior |
.| --- | --- |
.| `fundraisingOrgs=TRUE`
`fundraisingOrgs=1`
`fundraisingOrgs` | Return only fundraising organizations. |
.| `fundraisingOrgs=FALSE`
`fundraisingOrgs=0` | Return only charities that are not fundraising organizations. |
.| (default) | Return all charities. |
.
.Any value other than the ones specified in the table above will cause an HTTP
.400 error response. */
param fundraisingOrgs type boolean in query
/** If set to a valid 2-letter state code (not case-sensitive), filters search
results to include only organizations in the specified state. An invalid state
code will respond with a 400 error. */
param state type string in query
/** Filters search results to include only organizations in cities whose names
match the specified string. This uses fuzzy matching, and the city name may be
given as a partial string. */
param city type string in query
/** Filters search results to include only organizations in the specified zip
code. */
param zip type string in query
/** Filters search results to include only organizations with a rating greater
than or equal to the specified value. Must be an integer value betwen 0 and 4,
inclusive. Must be less than or equal to maxRating, if specified. */
param minRating type int in query
/** Filters search results to include only organizations with a rating less than
or equal to the specified value. Must be an integer value betwen 0 and 4,
inclusive. Must be greater than or equal to minRating, if specified. */
param maxRating type int in query
/** .Filters search results to include only organizations within a given size
.bracket, as measured in annual Total Expenses. possible values include:
.
.| Value | Range |
.| ----- | ----------------- |
.| 1 | Up to $3.5MM |
.| 2 | $3.5MM to $13.5MM |
.| 3 | $13.5MM and up |
.*/
param sizeRange type int in query
/** .Specifies whether to include or exclude organizations that have a donor
.privacy policy. By default, all charities are included, regardless of donor
.privacy policy.
.
.Can be specified as `TRUE` or `FALSE`, `0` or `1`, or included without a value,
.which is equivalent to `TRUE` or `1`.
.
.| Usage | Search Behavior |
.| --- | --- |
.| `donorPrivacy=TRUE`
`donorPrivacy=1`
`donorPrivacy` | Return only organizations that have a donor privacy policy. |
.| `donorPrivacy=FALSE`
`donorPrivacy=0` | Return only organizations that do not have a donor privacy policy. |
.| (default) | Return all charities. |
.
.Any value other than the ones specified in the table above will cause an HTTP
.400 error response. */
param donorPrivacy type boolean in query
/** Filters search results to include only organizations with a given scope of
work. Possible values are "ALL" (the default), "REGIONAL", "NATIONAL", or
"INTERNATIONAL" */
param scopeOfWork type int in query
default "ALL"
/** .Specifies whether to include or exclude organizations that are included in
.the Combined Federal Campaign, the largest workplace giving campaign in USA. By
.default, all organizations are included.
[Learn
.More](https://www.charitynavigator.org/index.cfm?bay=glossary.word&word=CFC&print=1.)
.
.Can be specified as `TRUE` or `FALSE`, `0` or `1`, or included without a value,
.which is equivalent to `TRUE` or `1`.
.
.| Usage | Search Behavior |
.| --- | --- |
.| `cfcCharities=TRUE`
`cfcCharities=1`
`cfcCharities` | Return only CFC charities. |
.| `cfcCharities=FALSE`
`cfcCharities=0` | Return only non-CFC charities. |
.| (default) | Return all charities. |
.
.Any value other than the ones specified in the table above will cause an HTTP
.400 error response. */
param cfcCharities type boolean in query
/** .Specifies whether to include or exclude organizations that do not receive
.government support. By default, all organizations are included.
.
.Can be specified as `TRUE` or `FALSE`, `0` or `1`, or included without a value,
.which is equivalent to `TRUE` or `1`.
.
.| Usage | Search Behavior |
.| --- | --- |
.| `noGovSupport=TRUE`
`noGovSupport=1`
`noGovSupport` | Return only charities that do not receive government support. |
.| `noGovSupport=FALSE`
`noGovSupport=0` | Return only charities that receive government support. |
.| (default) | Return all charities. |
.
.Any value other than the ones specified in the table above will cause an HTTP
.400 error response. */
param noGovSupport type boolean in query
/** .Specifies how results should be sorted. By default, results are sorted by
.increasing `ein` value unless a `search` string is specified, in which case
.results are sorted by decreasing relevance to the search string.
.
.This parameter takes the form of a sort property and an optional direction
.indicator, separated by a colon. E.g. `NAME` or `NAME:ASC`.
.
.Sort property can be any of the following (examples indicate default direction):
.
.| Property | Example | Sort Behavior |
.| ----- | ------- | ------------- |
.| `NAME` | `sort=NAME:ASC` | Sort alphabetically by charity name |
.| `RATING` | `sort=RATING:DESC` | Sort numerically by overall ratings score. Implies `rated=true`. |
.| `RELEVANCE` | `sort=RELEVANCE:DESC` | Sort numerically by search relevance score |
.
.Currently only one sort property is allowed.
.
.Any of the following usages will result in an HTTP 400 error response:
.
.* Sort field is not one of the values listed above.
.* Sort direction is provided and is neither `ASC` nor `DESC`.
.* Sort field is `RATING` and `rated=false` is also specified.
.* Sort field is `RELEVANCE` and the `search` parameter is not specified. */
param sort type string in query
/** Successful response, with a list of Organizations. */
response with /* this */OrganizationCollection statusCode 200
/** Indicates the total number of objects available in the result set. May be
used by the client in combination with `pageSize` to compute the number of pages
of available data. */
param CN_Result_Count type integer in header
externalExample "examples/Organizations.json"
/** Invalid request. The ErrorInfo object should contain additional details. */
response with type ErrorInfo statusCode 400
/** Not found. This means there is no data that satisfies the request criteria,
Or the specified `pageNum` is greater than the number of pages of data returned
from the request query. */
response with type ErrorInfo statusCode 404
extensions
openAPI.tags : "Organization Collection"
/** Represents a single Organization in Charity Navigator. */
default objectResource OrganizationObject type Organization
URI /Organizations/{ein}
required templateParam ein property ein
referenceEmbed > category
targetProperties
categoryID
categoryName
image
charityNavigatorURL
referenceEmbed > cause
targetProperties
causeID
causeName
image
charityNavigatorURL
default linkDescriptor OrganizationLink
ein
charityName
mediaTypes
application/json
/** Retrieve full detail of a single Organization. This is a composite set of
information describing an organization that may engage in charitable work.
Normally the Organization data structure includes a single legal entity, though
legal entity information may be excluded in exceptional cases. */
method GET getOrganization
request
/** 3Scale App ID: unique identifier for an application registered in the
Charity Navigator developer portal. */
required param app_id type string in query
extensions
x-data-threescale-name : app_ids
/** 3Scale App Key: a secret key to authenticate the assigned App ID. */
required param app_key type string in query
extensions
x-data-threescale-name : app_keys
response with /* this */OrganizationObject statusCode 200
externalExample "examples/Organization.json"
/** Invalid request. The ErrorInfo object should contain additional details. */
response with type ErrorInfo statusCode 400
/** Not found. Indicates an invalid or non-existent path parameter value. */
response with type ErrorInfo statusCode 404
extensions
openAPI.tags : "Organization Object"
/** Represents the set of Organization Ratings in Charity Navigator.
![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
collectionResource RatingCollection type Rating
URI /Organizations/{ein}/Ratings
required templateParam ein type string
mediaTypes
application/json
/** Retrieve all Charity Navigator ratings for a single organization.
![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
method GET getRatings
request
/** 3Scale App ID: unique identifier for an application registered in the
Charity Navigator developer portal. */
required param app_id type string in query
extensions
x-data-threescale-name : app_ids
/** 3Scale App Key: a secret key to authenticate the assigned App ID. */
required param app_key type string in query
extensions
x-data-threescale-name : app_keys
/** Number of objects to return in a single response message. Used in
combination with `pageNum` for paged responses. Default value is 100. If
specified, must be an integer value between 1 and 1,000. */
param pageSize type int in query
default "100"
/** Page number to return, in case the number of available objects in the result
set is greater than the specified or default `pageSize`. Default value is 1.
If the value of pageNum is greater than the number of pages in the result set,
the method will return a 404 error. If the requested starting position, computed
as `((pageNum-1) * pageSize) + 1`, is greater than the maximum supported result
size of 10,000 objects, the method will return a 400 error. */
param pageNum type integer in query
default "1"
/** Successful response, with a list of Ratings. */
response with /* this */RatingCollection statusCode 200
/** Indicates the total number of objects available in the result set. May be
used by the client in combination with `pageSize` to compute the number of pages
of available data. */
param CN_Result_Count type integer in header
externalExample "examples/Ratings.json"
/** Invalid request. The ErrorInfo object should contain additional details. */
response with type ErrorInfo statusCode 400
/** Not found. This means there is no data that satisfies the request criteria,
Or the specified `pageNum` is greater than the number of pages of data returned
from the request query. */
response with type ErrorInfo statusCode 404
extensions
openAPI.tags : "Rating Collection (Content Plan)"
/** Represents a single Rating in Charity Navigator. Each rating is listed once,
under its primary `referenceOrganization`. Note that the rating may apply to
other organizations, and this is represented by `includedOrganizations`, which
is a collection of hyperlinks to all of the organizations to which the rating
applies.
![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
objectResource RatingObject type Rating
URI /Organizations/{ein}/Ratings/{RatingID}
required templateParam ein type string
required templateParam RatingID property ratingID
referenceLink > referenceOrganization
targetResource OrganizationObject
referenceLink > includedOrganizations
targetResource OrganizationObject
default linkDescriptor ratingLink
ratingID
score
rating
ratingImage
publicationDate
form990
mediaTypes
application/json
/** Retrieve a single Rating object for an Organization. Each rating is listed
once, under its primary `referenceOrganization`. Note that the rating may apply
to other organizations, and this is represented by `includedOrganizations`,
which is a collection of hyperlinks to all of the organizations to which the
rating applies.
The rating is a point-in-time assessment provided by Charity Navigator, along
with related metrics and ratios taken from financial statements for a fiscal
year, on which the rating is based.
![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
method GET getRating
request
/** 3Scale App ID: unique identifier for an application registered in the
Charity Navigator developer portal. */
required param app_id type string in query
extensions
x-data-threescale-name : app_ids
/** 3Scale App Key: a secret key to authenticate the assigned App ID. */
required param app_key type string in query
extensions
x-data-threescale-name : app_keys
response with /* this */RatingObject statusCode 200
externalExample "examples/Rating.json"
/** Invalid request. The ErrorInfo object should contain additional details. */
response with type ErrorInfo statusCode 400
/** Not found. Indicates an invalid or non-existent path parameter value. */
response with type ErrorInfo statusCode 404
extensions
openAPI.tags : "Rating Object (Content Plan)"
/** Represents the complete set of available Advisories. */
collectionResource AdvisoryCollection type Advisory
URI /Organizations/{ein}/Advisories
required templateParam ein of type string
// embed the full object representation
with all properties
mediaTypes
application/json
/** Retrieve the full set of Charity Navigator advisories for a specified
organization. An advisory is a cautionary communication from Charity Navigator,
advising of unusual events or behavior related to a known organization. */
method GET getAdvisories
request
/** 3Scale App ID: unique identifier for an application registered in the
Charity Navigator developer portal. */
required param app_id type string in query
extensions
x-data-threescale-name : app_ids
/** 3Scale App Key: a secret key to authenticate the assigned App ID. */
required param app_key type string in query
extensions
x-data-threescale-name : app_keys
/** Number of objects to return in a single response message. Used in
combination with `pageNum` for paged responses. Default value is 100. If
specified, must be an integer value between 1 and 1,000. */
param pageSize type int in query
default "100"
/** Page number to return, in case the number of available objects in the result
set is greater than the specified or default `pageSize`. Default value is 1.
If the value of pageNum is greater than the number of pages in the result set,
the method will return a 404 error. If the requested starting position, computed
as `((pageNum-1) * pageSize) + 1`, is greater than the maximum supported result
size of 10,000 objects, the method will return a 400 error. */
param pageNum type integer in query
default "1"
/** .An optional filter parameter to limit the Advisories returned, based on
.status:
.
.| Status Value | Advisories Included |
.| ------------ | --------------------------------------------------- |
.| ALL | All advisories included, regardless of status. |
.| ACTIVE | Includes only advisories that are currently active. |
.| REMOVED | Includes only advisories that have been removed. |
.
.Omitting the status property is the equivalent of specifying ALL. Any value
.other than the ones listed above will result in an HTTP error 400. */
param status type string in query
default "ALL"
/** Successful response, with a list of Advisorites. */
response with /* this */AdvisoryCollection statusCode 200
/** Indicates the total number of objects available in the result set. May be
used by the client in combination with `pageSize` to compute the number of pages
of available data. */
param CN_Result_Count type integer in header
externalExample "examples/Advisories.json"
/** Invalid request. The ErrorInfo object should contain additional details. */
response with type ErrorInfo statusCode 400
/** Not found. This means there is no data that satisfies the request criteria,
Or the specified `pageNum` is greater than the number of pages of data returned
from the request query. */
response with type ErrorInfo statusCode 404
extensions
openAPI.tags : "Advisory Collection"
/** Represents a single Advisory. */
objectResource AdvisoryObject type Advisory
URI /Organizations/{ein}/Advisories/{AdvisoryID}
required templateParam ein type string
required templateParam AdvisoryID property advisoryID
default linkDescriptor AdvisoryLink
advisoryID
dateModified
dateRemoved
severity
mediaTypes
application/json
/** Retrieve full details of a single Advisory, under a given organization. An
advisory is a cautionary communication from Charity Navigator, advising of
unusual events or behavior related to a known organization. */
method GET getAdvisory
/** Empty Request body, standard for a GET method. */
request
/** 3Scale App ID: unique identifier for an application registered in the
Charity Navigator developer portal. */
required param app_id type string in query
extensions
x-data-threescale-name : app_ids
/** 3Scale App Key: a secret key to authenticate the assigned App ID. */
required param app_key type string in query
extensions
x-data-threescale-name : app_keys
/** Successful response, with the requested object instance. */
response with /* this */AdvisoryObject statusCode 200
externalExample "examples/Advisory.json"
/** Invalid request. The ErrorInfo object should contain additional details. */
response with type ErrorInfo statusCode 400
/** Not found. Indicates an invalid or non-existent path parameter value. */
response with type ErrorInfo statusCode 404
extensions
openAPI.tags : "Advisory Object"
/** Represents the full set of Lists defined in Charity Navigator.
![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
collectionResource ListCollection type List
URI /Lists
mediaTypes
application/json
/** Retrieve a set of Lists defined in Charity Navigator. Each entry in this
collection is a curated or generated list of organizations, published by Charity
Navigator.
![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
method GET getLists
request
/** 3Scale App ID: unique identifier for an application registered in the
Charity Navigator developer portal. */
required param app_id type string in query
extensions
x-data-threescale-name : app_ids
/** 3Scale App Key: a secret key to authenticate the assigned App ID. */
required param app_key type string in query
extensions
x-data-threescale-name : app_keys
/** Number of objects to return in a single response message. Used in
combination with `pageNum` for paged responses. Default value is 100. If
specified, must be an integer value between 1 and 1,000. */
param pageSize type int in query
default "100"
/** Page number to return, in case the number of available objects in the result
set is greater than the specified or default `pageSize`. Default value is 1.
If the value of pageNum is greater than the number of pages in the result set,
the method will return a 404 error. If the requested starting position, computed
as `((pageNum-1) * pageSize) + 1`, is greater than the maximum supported result
size of 10,000 objects, the method will return a 400 error. */
param pageNum type integer in query
default "1"
/** Successful response, with a list of Advisorites. */
response with /* this */ListCollection statusCode 200
/** Indicates the total number of objects available in the result set. May be
used by the client in combination with `pageSize` to compute the number of pages
of available data. */
param CN_Result_Count type integer in header
externalExample "examples/Lists.json"
/** Invalid request. The ErrorInfo object should contain additional details. */
response with type ErrorInfo statusCode 400
/** Not found. This means there is no data that satisfies the request criteria,
Or the specified `pageNum` is greater than the number of pages of data returned
from the request query. */
response with type ErrorInfo statusCode 404
extensions
openAPI.tags : "List Collection (Content Plan)"
/** Represents a single List defined in Charity Navigator.
![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
objectResource ListObject type List
URI /Lists/{ListID}
required templateParam ListID property listID
default linkDescriptor ListObjectLink
listID
listType
listName
listAbstract
listImageURL
isCurrentlyFeatured
sortOrder
mediaTypes
application/json
/** Retrieve a curated or generated list of organizations, published by Charity
Navigator.
![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
method GET getList
/** Empty Request body, standard for a GET method. */
request
/** 3Scale App ID: unique identifier for an application registered in the
Charity Navigator developer portal. */
required param app_id type string in query
extensions
x-data-threescale-name : app_ids
/** 3Scale App Key: a secret key to authenticate the assigned App ID. */
required param app_key type string in query
extensions
x-data-threescale-name : app_keys
/** Successful response, with the requested object instance. */
response with /* this */ListObject statusCode 200
externalExample "examples/List.json"
/** Invalid request. The ErrorInfo object should contain additional details. */
response with type ErrorInfo statusCode 400
/** Not found. Indicates an invalid or non-existent path parameter value. */
response with type ErrorInfo statusCode 404
extensions
openAPI.tags : "List Object (Content Plan)"
/** Charity Navigator's classification hierarchy for charitable Organizations,
including Categories and Causes.
![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
/* TODO: For review. This is my proposed, minimal design for category + cause metadata.
There are no object resources, and there's no Causes collection resource. Everything
is contained here, and if this is sufficient, we can leave it as-is.
Matt proposed
adding a hyperlink to OrganizationCollection from each Category and Cause. I'm not sure
this is helpful, in part because there's no way to communicate the full range of
query options without duplicating all query parameters. And getting the full list
of orgs is probably overkill of just about any conceivable use case.
I could also imagine adding search capability to this, returning a filtered hierarchy
that matches a search term. Since we have at our disposal a content store with
powerful search capabilities, maybe this would be a convenience for some applications
(like Zac's) that want to let users find a classifier by "keyword", and then show
the top N charities, sorted by some criteria TBD.
*/
collectionResource CategoryCollection type Category
URI /Categories
referenceEmbed > causes
targetProperties
causeID, causeName, image, charityNavigatorURL
mediaTypes
application/json
/** Returns metadata for Charity Navigator's classification hierarchy for
charitable Organizations. Category is the top-level classifier, and each
category may contain a number of Causes.
![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
method GET getCategories
request
/** 3Scale App ID: unique identifier for an application registered in the
Charity Navigator developer portal. */
required param app_id type string in query
extensions
x-data-threescale-name : app_ids
/** 3Scale App Key: a secret key to authenticate the assigned App ID. */
required param app_key type string in query
extensions
x-data-threescale-name : app_keys
response CategoryCollection statusCode 200
extensions
openAPI.tags : "Category Collection (Content Plan)"
/** Represents the complete list of Organizations with active advisories. */
collectionResource ActiveAdvisoryCollection type AdvisorySummary
URI /Advisory
with all properties
excluding
ein
charityName
charityNavigatorURL
referenceEmbed > mailingAddress
targetProperties
city
stateOrProvince
referenceEmbed > organization
targetProperties
ein
charityName
charityNavigatorURL
mediaTypes
application/json
/** Retrieve the full set of Charity Navigator advisories for a specified
organization. An advisory is a cautionary communication from Charity Navigator,
advising of unusual events or behavior related to a known organization. */
method GET getAllActiveAdvisories
request
/** 3Scale App ID: unique identifier for an application registered in the
Charity Navigator developer portal. */
required param app_id type string in query
extensions
x-data-threescale-name : app_ids
/** 3Scale App Key: a secret key to authenticate the assigned App ID. */
required param app_key type string in query
extensions
x-data-threescale-name : app_keys
/** Number of organizations to return in a single response message. Used in
combination with `pageNum` for paged responses. Default value is 100. If
specified, must be an integer value between 1 and 1,000. */
param pageSize type int in query
default "100"
/** Page number to return, in case the number of available objects in the result
set is greater than the specified or default `pageSize`. Default value is 1.
If the value of pageNum is greater than the number of pages in the result set,
the method will return a 404 error. If the requested starting position, computed
as `((pageNum-1) * pageSize) + 1`, is greater than the maximum supported result
size of 10,000 objects, the method will return a 400 error. */
param pageNum type integer in query
default "1"
/** Successful response, with a list of Advisorites. */
response with /* this */ActiveAdvisoryCollection statusCode 200
/** Indicates the total number of objects available in the result set. May be
used by the client in combination with `pageSize` to compute the number of pages
of available data. */
param CN_Result_Count type integer in header
externalExample "examples/ActiveAdvisories.json"
/** Invalid request. The ErrorInfo object should contain additional details. */
response with type ErrorInfo statusCode 400
/** Not found. This means there is no data that satisfies the request criteria,
Or the specified `pageNum` is greater than the number of pages of data returned
from the request query. */
response with type ErrorInfo statusCode 404
extensions
openAPI.tags : "Active Advisory Collection"
/** The core data model for Charity Navigator APIs. This defines the essential
concepts, any of which may be used in any number of APIs. Each API usage context
can specify a _realization_ of the data structure, which can specify a subset of
relevant properties, contextual constraints, and reference treatments as
hyperlinks and/or embedded data. */
dataModel CharityNavigatorDataModel
/** A composite set of information describing an organization that may engage in
charitable work. Normally the Organization data structure includes a single
legal entity, though legal entity information may be excluded in exceptional
cases. */
structure Organization
// Free plan, all orgs
/** The federal Employer Identification Number for the charitable organization.
May be set to a system-assigned value in cases where the organization is
fictitious, or the real EIN is not available. */
ein : string!
/** Internal identifier assigned by Charity Navigator. Only rated charities have
an orgID.
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
orgID : integer
// Free plan, all orgs
/** Name of the charitable organization. */
charityName : string
// Free plan, all orgs
/** Tagline describing the charity. */
tagLine : string
// Free plan, all orgs
/** The classification and tax treatment of the Organization by the Internal
Revenue Service. */
irsClassification : reference to IRSClassification
/** URL of the organization's website.
![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
websiteURL : anyURI
// Free plan, all orgs
/* URL for this organization on the Charity Navigator website. */
charityNavigatorURL : anyURI
// Free plan, all orgs
/** The primary category of the charity. */
/* TODO: I don't think we need this, because cause refers to a category.
So category can be retrieved as cause.category.
CN will discuss */
category : reference to Category
// Free plan, all orgs
/** The primary cause of this organization's charitable work as assigned by
Charity Navigator. */
cause : reference to Cause
// Free plan, all orgs
/** The organization's mission statement. */
mission : string
// Free plan, all orgs
/** Mailing address of the organization. */
mailingAddress : containing reference to Address
// Free plan, all orgs
/** Address to send donations to the organization. */
donationAddress : containing reference to Address
/** Main phone number of the organization.
![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
phoneNumber : string
/** General email address for the organization.
![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
generalEmail : string
// Free plan, all orgs
/** Advisories related to the organization that are currently in effect. */
activeAdvisories : reference to Advisory*
// Free plan, all orgs
/** Advisories that were previously in effect for the organization, and have
been recently removed.
NOTE: This may not be the complete history of past advisories. Charity Navigator
includes only advisories within a specified aging policy. */
removedAdvisories : reference to Advisory*
// ======================================================================
// The following properties normally appear for rated organizations only.
// ======================================================================
/** Information about the current chairperson for the Board.
![Rated
Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
currentBoardChair : reference to Representative
/** Information about the current CEO of the organization.
![Rated
Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
currentCEO : reference to Representative
/** Current rating for the organization.
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") */
currentRating : reference to Rating
/** Ratings previously published on this organization.
NOTE: This may not be the complete history of past ratings. Charity Navigator
includes only ratings within a specified aging policy.
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
ratingHistory : reference to Rating*
/** Essential information about an Organization advisory, used in resources or methods
that do not need the full detail of the organization's advisory'. Includes references to
the Organization and AdvisoryRollup, which may be realized as a hyperlink. */
structure AdvisorySummary
// Free plan, all orgs
/** Link to the organization resource, with all available details. */
organization : reference to Organization!
// Free plan, all orgs
/** The federal Employer Identification Number for the charitable organization.
May be set to a system-assigned value in cases where the organization is
fictitious, or the real EIN is not available. */
ein : string!
// Free plan, all orgs
/** Name of the charitable organization. */
charityName : string
// Free plan, all orgs
/** Mailing address of the organization. */
mailingAddress : containing reference to Address
// Free plan, all orgs
/* URL for this organization on the Charity Navigator website. */
charityNavigatorURL : anyURI
// Free plan, all orgs
/** Advisories related to the organization that are currently in effect. */
advisories : reference to AdvisoryRollup
/** Essential information about an Organization, used in resources or methods
that do not need the full detail of the organization. Includes a reference to
the Organization, which may be realized as a hyperlink. */
structure OrganizationSummary
// Free plan, all orgs
/** Link to the organization resource, with all available details. */
organization : reference to Organization!
// Free plan, all orgs
/** The federal Employer Identification Number for the charitable organization.
May be set to a system-assigned value in cases where the organization is
fictitious, or the real EIN is not available. */
ein : string!
/** Internal identifier assigned by Charity Navigator. Only rated charities have
an orgID.
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
orgID : integer
// Free plan, all orgs
/** Name of the charitable organization. */
charityName : string
// Free plan, all orgs
/** Tagline describing the charity. */
tagLine : string
// Free plan, all orgs
/** Mailing address of the organization. */
mailingAddress : containing reference to Address
// Free plan, all orgs
/** Address to send donations to the organization. */
donationAddress : containing reference to Address
// Free plan, all orgs
/** The primary category of this organization's charitable work as assigned by
Charity Navigator. */
category : reference to Category
// Free plan, all orgs
/** The primary cause of this organization's charitable work as assigned by
Charity Navigator. */
cause : reference to Cause
/** Current rating for the organization.
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") */
currentRating : reference to Rating
// Free plan, all orgs
/** The classification and tax treatment of the Organization by the Internal
Revenue Service. */
irsClassification : reference to IRSClassification
/** URL of the organization's website.
![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
websiteURL : anyURI
// Free plan, all orgs
/* URL for this organization on the Charity Navigator website. */
charityNavigatorURL : anyURI
// Free plan, all orgs
/** The organization's mission statement. */
mission : string
// Free plan, all orgs
/** Advisories related to the organization that are currently in effect. */
advisories : reference to AdvisoryRollup
/** A physical or postal address. */
structure Address
// Free plan, all orgs
/** First line of the street address. */
streetAddress1 : string
// Free plan, all orgs
/** Second line of the street address. */
streetAddress2 : string
// Free plan, all orgs
/** City. */
city : string
// Free plan, all orgs
/** State or province. */
stateOrProvince : string
// Free plan, all orgs
/** Postal code. */
postalCode : string
// Free plan, all orgs
/** Country. Note that Charity Navigator currently covers only organizations
based in the United States. If the Country is null, empty, or missing, it is
safe to assume a US-based address. */
country : string
/** An officer or other individual in a specified role within an Organization.
*/
structure Representative
/** The name of the indivdual holding this position within the organization
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
name : string
/** The title of this individual at this organization
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
title : string
/** Describes the classification and tax treatment of the Organization by the
Internal Revenue Service. */
structure IRSClassification
/** A subsection in the tax code which defines the category under which an
organization may be exempt from taxes. */
subsection : string
/** IRS classification of type of foundation. This is only applicable to
501(c)(3) Foundations. */
foundationStatus : string
/** Specifies whether donations to this organization are tax-deductible. */
deductibility : DeductibilityType
/** Provides more information when deductibility is NOT_DEDUCTIBLE_GENERALLY,
indicating that donations to an organization are not generally deductible. */
deductibilityDetail : string
/** IRS Code to specify whether donations to this organization are tax-deductible. */
deductibilityCode: string
/** The IRS's full classification code for the type of work this Organization
performs */
nteeCode : string
/** The IRS's text description of the work that this Organization performs
which corresponds to the full NTEECode */
nteeClassification : string
/** Within the IRS's classification system, the first letter of the code
represents broad subsectors, such as health, education, and youth development,
of the charitable organization universe. */
nteeLetter : string
/** The IRS's text description of the NTEE Letter portion of this this
organizations classification */
nteeType : string
/** The last and optional character in the IRS classification system */
nteeSuffix : string
/** affiliation */
affiliation : string
/** groupName */
groupName : string
/** exemptOrgStatus */
exemptOrgStatus : string
/** exemptOrgStatusCode */
exemptOrgStatusCode : string
/** rulingDate */
rulingDate : string
/** assetAmount */
assetAmount : string
/** incomeAmount */
incomeAmount : string
/** latest990 */
latest990 : string
/** filingRequirement */
filingRequirement : string
/** accountingPeriod */
accountingPeriod : string
/** classification */
classification : string
/** A value that summarizes deductibilty of donations to an Organization under a
given IRS Classification. */
enum string DeductibilityType
/* Donations are tax-deductible. */
DEDUCTIBLE : "Deductible"
/* Donations are not tax-deductible. */
NOT_DEDUCTIBLE : "Not Deductible"
/* Donations are generally not tax-deductible. This value may be accompanied by
another property containing or referencing a more detailed explanation. */
NOT_DEDUCTIBLE_GENERALLY : "Not Deductible, Generally"
/** A point-in-time rating provided by Charity Navigator, along with related
metrics and ratios taken from financial statements for a fiscal year, on which
the rating is based. */
structure Rating
/** Unique identifier for this Rating.
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
ratingID : string
/** All organizations to which the rating applies. In most cases, a rating will
apply to a single organization, and in that case primaryOrganization will be the
only member of the includedOrganizationsList. A rating for a composite
organization will include multiple individual organizations, each with a
distinct EIN.
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
includedOrganizations : as reference to Organization+
/** An organization to which the rating applies, and which may be used as
reference to obtain descriptive organizational details.
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
referenceOrganization : as reference to Organization
/** Overall score, out of a possible 100, based on a two-dimensional analysis of
financial health and accountability.
[Learn
More](https://www.charitynavigator.org/index.cfm?bay=content.view&cpid=1287)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
score : decimal
/** Overall rating, on a four-star scale, based on a two-dimensional analysis of
financial health and accountability.
[Learn
More](https://www.charitynavigator.org/index.cfm?bay=content.view&cpid=1287)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") */
rating : int
/* TODO: Access to images was a user feedback point. We should discuss
this to decide how we want to handle options like image size and
format, and other image URLs such as CN-branded badges.
CN: maybe a structure for this with things like small: medium: large? */
/** URLs to retrieve a star rating images for this Rating
![Rated
Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") */
ratingImage : as reference to IconSet
/** Financial disclosures reported on the organization's IRS Form 990.
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
form990 : as reference to Form990
/** Financial Score, Rating, and performance metrics.
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
financialRating : as reference to FinancialRating
/** Accountability and Transparency Score, Rating, and test indicators.
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
accountabilityRating : as reference to AccountabilityRating
/** Date the Rating was published ![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.")
*/
publicationDate : as date
/** A set of URLs different sized icons with the same underlying meaning. */
structure IconSet
small : anyURI
large : anyURI
/** A collection of financial performance metrics, each of which has an assigned
weight in Charity Navigator's Financial Score and Financial Rating */
structure PerformanceMetrics
/** The amount spent to raise $1 in charitable contributions.
[Learn
More](https://www.charitynavigator.org/index.cfm?bay=glossary.word&word=Fundraising%20Efficiency&mid=1&cid=12&print=1*)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
fundraisingEfficiency : decimal
/** This measure reflects what a charity spends to raise money.
[Learn
More](https://www.charitynavigator.org/index.cfm?bay=glossary.word&word=Fundraising%20Expenses&mid=2&cid=12)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
fundraisingExpensesRatio : decimal
/** Average annual growth of organization's program expenses.
[Learn
More](https://www.charitynavigator.org/index.cfm?bay=glossary.word&word=Program%20Expenses%20Growth&mid=6&cid=12&print=1)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
programExpensesGrowth : decimal
/** The percent of its total expenses a charity spends on the programs and
services it exists to deliver. [Learn
More](https://www.charitynavigator.org/index.cfm?bay=glossary.word&word=Program%20Expenses&mid=7&cid=21&print=1)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
programExpensesRatio : decimal
/** This measure reflects what percent of its total budget a charity spends on
overhead, administrative staff and associated costs, and organizational
meetings.
[Learn
More](https://www.charitynavigator.org/index.cfm?bay=glossary.word&word=Administrative%20Expenses&mid=3&cid=12&print=1)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
administrationExpensesRatio : decimal
/** Liabilities to Assets is an indicator of an organization’s solvency and or
long term sustainability. This ratio is computed by dividing a charity's total
liabilities by its total assets.
[Learn
More](https://www.charitynavigator.org/index.cfm?bay=glossary.word&word=Liabilities%20to%20Assets&mid=10&cid=16&print=1)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
liabilitiesToAssetsRatio : decimal
/** Determines how long a charity could sustain its level of spending using its
net available assets, or working capital, as reported on its most recently filed
Form 990.
[Learn
More](https://www.charitynavigator.org/index.cfm?bay=glossary.word&word=Working%20Capital%20Ratio&mid=4&cid=12&print=1)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
workingCapitalRatio : decimal
/** Prior to CN2.1 Ratings looked at Primary Revenue Growth for an Organization
in addition to Program Expense Growth. For CN2.1 Ratings this is no longer
considered and will be null
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
primaryRevenueGrowth : decimal
/** A composite of an organization's Financial Score and Financial Rating, along
with the performance metrics that Charity Navigator compiles to determine the
score. */
structure FinancialRating
/** Overall financial score, out of a possible 100, based on a set of individual
measures of financial health.
[Learn
More](https://www.charitynavigator.org/index.cfm?bay=content.view&cpid=35)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
score : decimal
/** Overall financial rating, on a four-star scale.
[Learn
More](https://www.charitynavigator.org/index.cfm?bay=content.view&cpid=1287)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
rating : int
/** Financial performance metrics for the organization.
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
performanceMetrics : as reference to PerformanceMetrics
/** A composite of an organization's Accountability and Transparency Score and
Rating, along with the accountability and transparency tests that Charity
Navigator compiles to determine the score. */
structure AccountabilityRating
/** Overall accountability score, out of a possible 100, based on a set of
individual measures of accountability and transparency.
[Learn
More](https://www.charitynavigator.org/index.cfm?bay=content.view&cpid=1093)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
score : decimal
/** Overall accountability and transparency rating, on a four-star scale.
[Learn
More](https://www.charitynavigator.org/index.cfm?bay=content.view&cpid=1283)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
rating : int
/** Pass/fail criteria used to determine the accountability score and rating.
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
accountabilityTests : as reference to AccountabilityTests
/** A subset of financial disclosures reported on the organization's IRS Form
990. */
structure Form990
/** Fundraising expenses as reported on the income statement for the rating
period. This measure reflects what a charity spends to raise money. Fundraising
expenses can include campaign printing, publicity, mailing, and staffing and
costs incurred in soliciting donations, memberships, and grants.
[Learn
More](https://www.charitynavigator.org/index.cfm?bay=glossary.word&word=Fundraising%20Expenses&mid=2&cid=21&print=1)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
fundraisingExpenses : decimal
/** Administrative expenses as reported on the income statement for the rating
period. This measure reflects what percent of its total budget a charity spends
on overhead, administrative staff and associated costs, and organizational
meetings.
[Learn
More](https://www.charitynavigator.org/index.cfm?bay=glossary.word&word=Administrative%20Expenses&mid=3&cid=21&print=1)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
administrativeExpenses : decimal
/** Program expenses as reported on the income statement for the rating period.
This measure reflects what a charity spends to raise money. Fundraising expenses
can include campaign printing, publicity, mailing, and staffing and costs
incurred in soliciting donations, memberships, and grants.
[Learn
More](https://www.charitynavigator.org/index.cfm?bay=glossary.word&word=Program%20Expenses&mid=7&cid=21&print=1)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
programExpenses : decimal
/** Total functional expenses, computed as the sum of program expenses,
administrative expenses and fundraising expenses, as reported on the income
statement for the rating period.
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
totalExpenses : decimal
/** Total revenue, as reported on the income statement for the rating period.
Charities can derive revenue or funding from a variety of sources, including
contributions, program services, membership dues, interest on savings,
investment income, special events, and sales of inventory.
![Rated
Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
totalRevenue : decimal
/** Total net assets, computed as he difference between assets and liabilities,
as reported on the organization's financial statement for the rating period.
Although charities do not exist to make money, they do work to build and
maintain reasonable reserves of net assets. Growing its net assets helps a
charity outpace inflation and sustain future program activities. [Learn
More](https://www.charitynavigator.org/index.cfm?bay=glossary.word&word=Net%20Assets&print=1)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
totalNetAssets : decimal
/** Total contributions is the sum of all contributions - including
gifts, and grants, federated campaigns, membership dues, fundraising events,
related organizations, and government grants. ![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
totalContributions : decimal
/** The revenue a charity generates as a result of the work it does.
A charity's primary revenue includes grants and contributions, revenue produced from
programs and services, and membership fees and dues. [Learn
More](https://www.charitynavigator.org/index.cfm?bay=glossary.word&gid=10&print=1)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
primaryRevenue : decimal
/** In addition to primary revenue sources, charities derive revenue from investments,
rents, special events, sales of inventory, and other unrelated business income. [Learn
More](https://www.charitynavigator.org/index.cfm?bay=glossary.word&word=Other%20Revenue&print=1)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
otherRevenue : decimal
/** Based on the data found in each charity's most recently filed Form 990, we include salary,
cash bonuses, and expense accounts when we measure a CEO's compensation. We do not include
contributions to benefit plans or deferred compensation that is allocated to be paid in later
years. Deferred compensation is often accrued over many years and then is paid as a lump sum in
one year. As such, we do include deferred compensation as part of the compensation figure in the
year in which it is actually paid out to the employee and/or when it is expensed per the 990.
Many charities use fiscal years that differ from the calendar year. In these cases, it is
important to recognize that the CEO’s compensation reported on the Form 990 reflects the CEO’s
pay for the calendar year, not the fiscal year. Why? Because the IRS requires that charities
report compensation on the Form 990 exactly the same as they did on the W-2 Form
(which is based on the calendar year).
Many donors are understandably interested in how much the leaders of charities earn. This information
is public record so Charity Navigator reports it for our users. This information does not factor
into an organization's Charity Navigator rating. We provide this percentage so donors can quickly put
the salary into perspective. For comparative purposes, a charity with total expenses of $20 million,
which compensates its highest paid executive at $200,000 per year (or 1%) would appear to have tighter
control on expenses than the $1 million organization which pays its chief executive the same amount
(or 20% of expenses for one person). [Learn
More](https://www.charitynavigator.org/index.cfm/bay/glossary.word/word/Leadership%20Compensation%20and%20Other%20Salaries%20of%20Note%20as%20a%20Percentage%20of%20Total%20Expenses/print/1.htm)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
ceoCompensationPercent : decimal
/** A set of conditional tests, each of which has an assigned weight in Charity
Navigator's Accountability and Transparency Score and Rating. These tests
generally have a value of "Pass" or "Fail." Some tests may be "Not Reported", or
have a specific "Partial" state, somewhere in between an unequivocal pass or
fail state. */
structure AccountabilityTests
/** "Pass" indicates that the board members are listed on the Organization's
website. Other possible values are "Fail" or "Not Reported".
[Learn
More](https://www.charitynavigator.org/index.cfm?bay=glossary.word&gid=63&print=1)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
boardListStatus : PassFailOrNotReported
/** "Pass" indicates that the organization's key staff members are named on its
website. Other possible values are "Fail" or "Not Reported".
[Learn
More](https://www.charitynavigator.org/index.cfm?bay=glossary.word&gid=62&print=1)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
staffListStatus : PassFailOrNotReported
/** "Pass" indicates that audited financial statements are available on the
organization's website. Other possible values are "Fail" or "Not Reported".
[Learn
More](https://www.charitynavigator.org/index.cfm?bay=glossary.word&gid=64&print=1)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
auditedFinancialStatus : PassFailOrNotReported
/** "Pass" indicates that a current IRS Form 990 is available on the
organization's website. Other possible values are "Fail" or "Not Reported".
[Learn
More](https://www.charitynavigator.org/index.cfm?bay=search.summary&orgid=4338)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
form990Status : PassFailOrNotReported
/** "Pass" indicates that the organization has a written donor privacy policy
published on its website, with strong and unequivocal privacy protections for
donors. Other possible values are "Fail" or "Opt Out".
[Learn
More](https://www.charitynavigator.org/index.cfm?bay=glossary.word&gid=66&print=1)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
privacyStatus : PassFailOrOptOut
/** "Pass" indicates that the organization has not reported any loans to or from
officers or other interested parties. Other possible values are "Fail" or "Not
Reported".
[Learn
More](https://www.charitynavigator.org/index.cfm?bay=glossary.word&gid=55&print=1)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
loansToOrFromOfficers : PassFailOrNotReported
/** "Pass" indicates that the charity did not report reciving any loans from
their Officers on their Form 990. Other possible values are "Fail" or "Not
Reported".
[Learn
More](https://www.charitynavigator.org/index.cfm?bay=glossary.word&gid=55&print=1)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
loansToOfficers : PassFailOrNotReported
/** "Pass" indicates that the charity did not report making any loans to their
Officers on their Form 990. Other possible values are "Fail" or "Not Reported".
[Learn
More](https://www.charitynavigator.org/index.cfm?bay=glossary.word&gid=55&print=1)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
loansFromOfficers : PassFailOrNotReported
/** "Pass" indicates that there has been no diversion of assets within the last
two years. Other possible values are "Fail" or "Remediated".
[Learn
More](https://www.charitynavigator.org/index.cfm?bay=glossary.word&gid=56&print=1)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
materialDiversionOfAssets : PassFailOrRemediated
/** "Pass" indicates that the organization keeps meeting minutes, and reports
availability of these on IRS Form 990. Other possible values are "Fail" or "Not
Reported".
[Learn
More](https://www.charitynavigator.org/index.cfm?bay=glossary.word&gid=51&print=1)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
boardMeetingMinutes : PassFailOrNotReported
/** "Pass" indicates that the organization has provided copies of its Form 990
the governing body in advance of filing. Other possible values are "Fail" or
"Not Reported".
[Learn
More](https://www.charitynavigator.org/index.cfm?bay=glossary.word&gid=52&print=1)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
distributes990ToBoard : PassFailOrNotReported
/** "Pass" indicates that the organization has a conflict of interest policy in
place. Other possible values are "Fail" or "Not Reported".
[Learn
More](https://www.charitynavigator.org/index.cfm?bay=glossary.word&gid=53&print=1)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
conflictOfInterestPolicy : PassFailOrNotReported
/** "Pass" indicates that the organization has a whistleblower policy, as
reported on IRS Form 990. Other possible values are "Fail" or "Not Reported".
[Learn
More](https://www.charitynavigator.org/index.cfm?bay=glossary.word&gid=54&print=1)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
whistleBlowerPolicy : PassFailOrNotReported
/** "Pass" indicates that the organization has a records retention and
destruction policy, as reported on IRS Form 990. Other possible values are
"Fail" or "Not Reported".
[Learn
More](https://www.charitynavigator.org/index.cfm?bay=search.summary&orgid=4338)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
recordsRetentionPolicy : PassFailOrNotReported
/** "Pass" indicates that the organization included the CEO's name and
compensation on Form 990. Other possible values are "Fail" or "Not Reported".
[Learn
More](https://www.charitynavigator.org/index.cfm?bay=glossary.word&gid=59&print=1)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
reportsCEOAndSalary : PassFailOrNotReported
/** "Pass" indicates that the organization has a consistent policy for
determining CEO compensation, meeting certain best practices and standards
established by Charity Navigator. Other possible values are "Fail" or "Not
Reported".
[Learn
More](https://www.charitynavigator.org/index.cfm?bay=glossary.word&gid=61&print=1)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
ceoCompensationProcedure : PassFailOrNotReported
/** "Pass" indicates that the organization lists its board members, and does not
compensate them for serving on its Board of Directors. Other possible values are
"Fail" or "Not Reported".
[Learn
More](https://www.charitynavigator.org/index.cfm?bay=search.summary&orgid=4338)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.")
*/
compensatesBoard : PassFailOrNotReported
/** "Pass" indicates that the organization's financial statements are prepared
by an independent accountant with oversight from an audit committee. Other
possible values are "Fail," "Partial," or "Not Reported".
[Learn
More](https://www.charitynavigator.org/index.cfm?bay=glossary.word&gid=57&print=1)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
independentAudit : PassFailOrPartial
/** "Pass" indicates that independent Board members are a voting majority and
also at least five in number. Other possible values are "Fail" or "Not
Reported".
[Learn
More](https://www.charitynavigator.org/index.cfm?bay=glossary.word&gid=50&print=1)
![Rated Charities
Only](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/Blue_Star-16.png
"Only available for rated charities.") ![Content
Subscription](https://cdn2.hubspot.net/hubfs/597611/CharityNavigator/FA-Data-Table-16.png
"Included with the paid Content Subscription.") */
independentBoard : PassFailOrNotReported
/** In Charity Navigator's taxonomy, Category is the most general level of
classification of Organziations. */
/* TODO: There should be endpoints to get all the charities in a Cause
or Category.
(Implementation probably just internally calls the search endpoint.)
*/
structure Category
/** Charity Navigator's unique identifier for the category. */
categoryID : string
/** Name of the category. */
categoryName : string
/** A list of specific causes, contained within this general category. */
causes : containing reference to Cause* inverse category
/** URL for an image representing the Category. */
image : anyURI
/** URL to the Category page on Charity Navigator's website. */
charityNavigatorURL : anyURI
/** In Charity Navigator's taxonomy, Cause is a second level of classification
of an Organization, below Category. */
structure Cause
/** Charity Navigator's unique identifier for the cause. */
causeID : string
/** Name of the cause. */
causeName : string
/** The general category that contains this cause. */
category : container reference to Category inverse causes
/** URL for an image representing the Cause. */
image : anyURI
/** URL to the Cause page on Charity Navigator's website. */
charityNavigatorURL : anyURI
/* TODO: For discussion, there was a comment in the User Feedback
document: "Make sure we're relating lists to other details
so a developer can get all the expected information in one
call. This is something they said would be necessary for
the 'big players' like YouTube or Facebook."
We need to understand this a bit better, and try to
ensure that the data model & API design support these use
cases.
Matt: I think this means that when there's a List for Event X the details
of the charities are exposed in that single List "detail" API request
I would imagine things like:
charityName
overallRating
overallScore
URL
City
State
Tag Line
Link to the rating page
rating related graphic stuff
Matt will double check with Lindsey to make sure that covers the request
*/
/** A curated or generated list of organizations, published by Charity
Navigator. */
structure List
/** Unique ID for the list, assigned by Charity Navigator. */
listID : string
/** Name of the list. */
listName : string
/** A general classification of the list. */
listType : string
/** Boolean field, true is list is currently featured on site. */
isCurrentlyFeatured : boolean
/** If list is currently featured, the sort order it is currently displayed in. */
sortOrder : integer
/** Short list description. */
listAbstract : string
/** Long list description. */
listExplanation : string
/** URL for an image representing the List. */
listImageURL : anyURI
/** URL to the List page on Charity Navigator's website. */
charityNavigatorURL : anyURI
/** Groups of organizations within the list. May be a single, unnamed group in
the case of a flat list. */
groups : as containing reference to OrganizationGroup*
/** A group of organization entries contained within a List. A composite "List
of Lists" will have multiple named groups. A flat List of organizations will
have a single, unnamed group. */
structure OrganizationGroup
/** Optional name of the group. */
groupName : string
/** Description of the group. */
groupDescription : string
/** Organization entries in the list. */
organizations : as containing reference to OrgListEntry*
/** The participation of a individual organization as a member of an
OrganizationList. */
structure OrgListEntry
/** Organization participating in the list. */
organization : as reference to Organization
/** Rank of the organization within its containing group. */
rank : int
/** Description of the group. */
groupDescription : string
/** Optional name of the group. */
groupName : string
/** A cautionary communication from Charity Navigator, advising of unusual
events or behavior related to a known organization. */
structure Advisory
/** Unique identifier for this advisory. */
advisoryID : string
/** The Organization that is the subject of the advisory. */
organization : reference to Organization
/** Severity of the Advisory. */
severity : Severity
/** Date when the Advisory was first published. */
datePublished : date
/** Date when the Advisory was removed. Advisory can be assumed to be active if
dateRemoved is omitted. */
dateRemoved : date
/** Date when the Advisory most recently modified. */
dateModified : date
/** Ordered list of Advisory Sources */
sources : as reference to AdvisorySource+
/** A rolled up summary of the active advisory records of an organization.
If the organization does not have any active advisory records, severity will have
a NULL value */
structure AdvisoryRollup
/** Rolled up severity level of all active advisory records for the organization.
A NULL value means there are no active advisory records */
severity : Severity
/** Reference to all active advisory records for an organization.*/
active : as reference to Advisory*
/** A synopsis of an event or reference that triggers or provides additional
details for an Advisory. */
structure AdvisorySource
/** Date when the Advisory Source was published. */
datePublished : date
/** Date when the Advisory Source was removed. The Advisory Source can be
assumed to ba active if dateRemoved is omitted. */
dateRemoved : date
/** Date when the Advisory Source was most recently modified. */
dateModified : date
/** Name of the Advisory Source publisher. */
publisher : string
/** URL referring to the Advisory Source. */
url : anyURI
/** A summary description of the Advisory Source. */
summary : string
/** A generic structure to carry information about an error response from from
the service. */
structure ErrorInfo
errorMessage : string
/** Enumeration describing three levels of severity. */
enum string Severity
/** High severity. */
HIGH : "High"
/** Moderate severity. */
MODERATE : "Moderate"
/** Low severity. */
LOW : "Low"
/** Enum for reporting of most accountability and transparency tests. The
documentation for each metric should describe the criteria for a passing value.
*/
enum string PassFailOrNotReported
/** Indicates that the organization meets the criteria to pass this
accountability/transparency test. A favorable result. */
PASS : "Pass"
/** Indicates that the organization did not meets the criteria to pass this
accountability/transparency test. An unfavorable result. */
FAIL : "Fail"
/** Indicates that the information required for this test is unavailiable, or
that Charity Navigator has not scored the organization on this test. */
NOT_REPORTED : "Not Reported"
/** Enum for reporting of privacy tests within the accountability and
transparency scoring system. */
enum string PassFailOrOptOut
/** Indicates that the organization meets the criteria to pass this
accountability/transparency test. A favorable result. */
PASS : "Pass"
/** Indicates that the organization did not meets the criteria to pass this
accountability/transparency test. An unfavorable result. */
FAIL : "Fail"
/** Indicates that the organization allows privacy, but not by default; only by
the subject taking an explicit action to opt-out of information sharing. */
OPT_OUT : "Opt-Out"
/** Enum for reporting of the material diversion of assets test, and potentially
for similar tests, within the accountability and transparency scoring system. */
enum string PassFailOrRemediated
/** Indicates that the organization meets the criteria to pass this
accountability/transparency test. A favorable result. */
PASS : "Pass"
/** Indicates that the organization did not meets the criteria to pass this
accountability/transparency test. An unfavorable result. */
FAIL : "Fail"
/** Indicates that a material diversion of assets was reported, and subsequently
corrected. */
REMEDIATED : "Remediated"
/** Indicates that the information required for this test is unavailiable, or
that Charity Navigator has not scored the organization on this test. */
NOT_REPORTED : "Not Reported"
/** Enum for reporting of accountability and transparency tests that have a
partial or equivocal value. Each test property should describe the criteria for
passing and partial values. */
enum string PassFailOrPartial
/** Indicates that the organization meets the criteria to pass this
accountability/transparency test. A favorable result. */
PASS : "Pass"
/** Indicates that the organization did not meets the criteria to pass this
accountability/transparency test. An unfavorable result. */
FAIL : "Fail"
/** Indicates that certain criteria were met, but not all of the criteria
required to pass the test unequivocally. Used on tests where Charity Navigator
gives partial credit, or a smaller reduction of the Accountability Score than a
failed test. */
PARTIAL : "Partial"
/** Indicates that the information required for this test is unavailiable, or
that Charity Navigator has not scored the organization on this test. */
NOT_REPORTED : "Not Reported"
/* TODO: Current build is set in the POM.XML to use the daily Maven repo
instead of release. This is a temporary fix, to allow use of the
RAPID-XChange GenTemplates. We should revert to Release when we
have a release build with RAPID-XChange GenTemplates. */
/* TODO: Check all reference links to make sure:
(1) cardinality is handled correctly, e.g. a multi-valued
reference targeting a single-valued objectResource becomes
a list of links; and
(2) implied parameter binding is supported. The target resource
must have parameters that allow the reference to link to
the right object instance, or subset of objects in a
collection.
*/
/* TODO: Reinstate use of the 'this' keyword in messages, once we have
a resolution to https://modelsolv.atlassian.net/browse/ZEN-3562
*/