SMU DataArts API

Resource Group ¶

Grant Programs ¶

Program resource representation.

Show all grant programs
GET`/grant_programs{?organization_id,include}`

Get a JSON representation of all the grant programs.

Example URI

GET /grant_programs?organization_id=&include=

URI Parameters

HideShow

organization_id: integer (optional)
Organization ID of grant program to retrieve
include: string (optional)
Load available relationships: pools

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "type": "grant_programs",
      "id": "1",
      "attributes": {
        "organization_id": 2,
        "runnable_report_id": 3,
        "report_not_ready": false,
        "name": "The Example Program Name",
        "sort_name": "Example Program Name",
        "effective_start_date": "2012-01-01",
        "effective_end_date": "2012-12-31",
        "number_of_pools": 4,
        "current_pool": 5,
        "revision_message": " ",
        "notes": " ",
        "preferred_report": 0,
        "opt_in_url": false,
        "requirements": "For more information on this grant program, visit the grantmaker's website.",
        "add_instructions": " ",
        "required_years": 3,
        "suggested_years": 3,
        "default_pool_length": "year",
        "delivery_method": 2,
        "created_at": "2012-01-10 00:00:00",
        "updated_at": "2012-01-10 00:00:00",
        "deleted_at": "",
        "created_by": 2,
        "updated_by": 11937,
        "deleted_by": 0
      }
    }
  ]
}

Show grant program
GET`/grant_programs/{id}{?include}`

Show either a single program or a list of grant programs

Example URI

GET /grant_programs/1?include=

URI Parameters

HideShow

id: integer (required) Example: 1
ID of grant program(s) to retrieve - can be comma separated for multiple, i.e. 1,2,3
include: string (optional)
Load available relationships: pools

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "type": "grant_programs",
      "id": "1",
      "attributes": {
        "organization_id": 2,
        "runnable_report_id": 3,
        "report_not_ready": false,
        "name": "The Example Program Name",
        "sort_name": "Example Program Name",
        "effective_start_date": "2012-01-01",
        "effective_end_date": "2012-12-31",
        "number_of_pools": 4,
        "current_pool": 5,
        "revision_message": " ",
        "notes": " ",
        "preferred_report": 0,
        "opt_in_url": false,
        "requirements": "For more information on this grant program, visit the grantmaker's website.",
        "add_instructions": " ",
        "required_years": 3,
        "suggested_years": 3,
        "default_pool_length": "year",
        "delivery_method": 2,
        "created_at": "2012-01-10 00:00:00",
        "updated_at": "2012-01-10 00:00:00",
        "deleted_at": "",
        "created_by": 2,
        "updated_by": 11937,
        "deleted_by": 0
      }
    }
  ]
}

Pools ¶

Pool resource representation.

Show all pools
GET`/pools{?grant_program_id,include}`

Get a JSON representation of all the pools.

Example URI

GET /pools?grant_program_id=&include=

URI Parameters

HideShow

grant_program_id: integer (optional)
Grant Program ID of pools to retrieve
include: string (optional)
Load available relationships: applications, grant_programs

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "type": "pools",
      "id": "1",
      "attributes": {
        "start_date": "2015-12-10 16:49:02",
        "end_date": "2015-12-10 16:49:02",
        "deadline": "2015-12-10 16:49:09"
      }
    }
  ]
}

Show Pool
GET`/pools/{id}{?include}`

Show the specific pools(s)

Example URI

GET /pools/1?include=

URI Parameters

HideShow

id: integer (required) Example: 1
ID of pool(s) to retrieve - can be comma separated for multiple, i.e. 1,2,3
include: string (optional)
Load available relationships: applications, grant_programs

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "type": "pools",
      "id": "1",
      "attributes": {
        "start_date": "2015-12-10 16:49:02",
        "end_date": "2015-12-10 16:49:02",
        "deadline": "2015-12-10 16:49:09"
      }
    }
  ]
}

Reports ¶

Survey resource representation.

Show all reports
GET`/reports{?organization_id,include}`

Get a JSON representation of all the reports.

Example URI

GET /reports?organization_id=&include=

URI Parameters

HideShow

organization_id: integer (optional)
Organization ID of reports to retrieve
include: string (optional)
Load available relationships: applications

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "type": "reports",
      "id": "1",
      "attributes": {
        "name": "Annual Report",
        "description": "some info about this report",
        "type": "annual",
        "short_name": "annual_report",
        "user_id": 1,
        "organization_id": 1,
        "runnable_report_id": 1,
        "fiscal_year_param": "",
        "criteria": null,
        "pdf_filename": null,
        "excel_filename": null,
        "generated_at": "",
        "updated_at": "-0001-11-30 00:00:00",
        "deleted_at": "",
        "updated_by": null,
        "deleted_by": null
      }
    }
  ]
}

Show report
GET`/reports/{id}{?include}`

Show the specific report(s)

Example URI

GET /reports/1?include=

URI Parameters

HideShow

id: integer (required) Example: 1
ID of report(s) to retrieve - can be comma separated for multiple, i.e. 1,2,3
include: string (optional)
Load available relationships: applications

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "type": "reports",
      "id": "1",
      "attributes": {
        "name": "Annual Report",
        "description": "some info about this report",
        "type": "annual",
        "short_name": "annual_report",
        "user_id": 1,
        "organization_id": 1,
        "report_type_id": 1,
        "fiscal_year_param": "",
        "criteria": null,
        "pdf_filename": null,
        "excel_filename": null,
        "meta": {
          "title": "Example Organization",
          "description": null,
          "subject_organizations": "Example Organization",
          "comparison_organizations": null
        },
        "generated_at": "",
        "updated_at": "-0001-11-30 00:00:00",
        "deleted_at": "",
        "updated_by": null,
        "deleted_by": null
      }
    }
  ]
}

Download report
GET`/reports/{id}/download`

Download the specific report

Example URI

GET /reports/1/download

URI Parameters

HideShow

id: integer (required) Example: 1
ID of report to download
format: string (optional) Default: pdf
Format of report to download, pdf or xls

Request

HideShow

Headers

Content-Type: application/json

Body

{
  "id": "1",
  "format": "pdf"
}

Response 200

HideShow

Headers

Content-Type: application/pdf

Users ¶

User resource representation.

Show all users
GET`/users{?organization_id,include}`

Get a JSON representation of all the users.

Example URI

GET /users?organization_id=&include=

URI Parameters

HideShow

organization_id: integer (optional)
Organization ID of users to retrieve
include: string (optional)
Load available relationships: organizations

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "type": "users",
      "id": "1",
      "attributes": {
        "first_name": "John",
        "last_name": "Smith",
        "email": "jsmith@domain.com",
        "phone": "555-555-5555",
        "addr_street": "",
        "addr_line2": "",
        "addr_city": "",
        "addr_zip": "",
        "addr_country": ""
      }
    }
  ]
}

Show user
GET`/users/{id}{?include}`

Show a single user

Example URI

GET /users/1?include=

URI Parameters

HideShow

id: integer (required) Example: 1
ID of user(s) to retrieve - can be comma separated for multiple, i.e. 1,2,3
include: string (optional)
Load available relationships: organizations

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "type": "users",
      "id": "1",
      "attributes": {
        "first_name": "John",
        "last_name": "Smith",
        "email": "jsmith@domain.com",
        "phone": "555-555-5555",
        "addr_street": "",
        "addr_line2": "",
        "addr_city": "",
        "addr_zip": "",
        "addr_country": ""
      }
    }
  ]
}

Organizations ¶

Organization resource representation.

Show all organizations
GET`/organizations{?tax_id,updated_after,updated_before,include}`

Get a JSON representation of all the organizations.

Example URI

GET /organizations?tax_id=&updated_after=2016-01-15&updated_before=2016-01-31&include=

URI Parameters

HideShow

tax_id: integer (optional)
Tax ID of organization to retrieve
county: string (optional)
Select organizations that are within this county
addr_state: string (optional)
Select organizations that are within this state
updated_after: string (optional) Example: 2016-01-15
Select organizations that were updated after this date
updated_before: string (optional) Example: 2016-01-31
Select organizations that were updated before this date
include: string (optional)
Load available relationships: organization_profiles, survey_responses, users

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "type": "organizations",
      "id": "1",
      "attributes": {
        "name": "CDP",
        "tax_id": "123456789",
        "phone": "555-555-5555",
        "url": "http://cdp.com",
        "legal_name": "",
        "fiscal_year_end": "",
        "addr_street": "1111 CDP Street",
        "addr_line2": "",
        "addr_city": "CDP City",
        "addr_state": "PA",
        "addr_zip": "62534",
        "addr_country": "USA",
        "poc_first_name": "CDP",
        "poc_last_name": "PoC",
        "poc_title": "",
        "poc_email": "",
        "poc_phone": "5555555555",
        "logo_uri": "",
        "mission": "",
        "year_founded": "2000",
        "year_incorporated": "",
        "city_council_district": "1",
        "state_house_district": "2",
        "state_senate_district": "3",
        "federal_congressional_district": "4",
        "county": "",
        "county_supervisorial_district": "",
        "parent_name": "",
        "fiscal_sponsor_name": "",
        "ntee": "",
        "nisp_institution": "",
        "nisp_specialty": "",
        "nisp_classification": "",
        "irs_exemption_date": "",
        "nmbr_board_members": "",
        "org_type": "",
        "address2": "",
        "audited": "",
        "month_count": "",
        "type_501c": "",
        "service_agreement_start": "",
        "service_agreement_end": "",
        "service_agreement_url": "",
        "is_cdp": false,
        "is_grantmaker": false,
        "is_applicant": false,
        "is_service": false,
        "is_demo": false
      }
    }
  ]
}

Show organization
GET`/organizations/{id}{?include}`

Show a single organization

Example URI

GET /organizations/1?include=

URI Parameters

HideShow

id: integer (required) Example: 1
ID of organization(s) to retrieve - can be comma separated for multiple, i.e. 1,2,3
include: string (optional)
Load available relationships: organization_profiles, survey_responses, users

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "type": "organizations",
      "id": "1",
      "attributes": {
        "name": "CDP",
        "tax_id": "123456789",
        "phone": "555-555-5555",
        "url": "http://cdp.com",
        "legal_name": "",
        "fiscal_year_end": "",
        "addr_street": "1111 CDP Street",
        "addr_line2": "",
        "addr_city": "CDP City",
        "addr_state": "PA",
        "addr_zip": "62534",
        "addr_country": "USA",
        "poc_first_name": "CDP",
        "poc_last_name": "PoC",
        "poc_title": "",
        "poc_email": "",
        "poc_phone": "5555555555",
        "logo_uri": "",
        "mission": "",
        "year_founded": "2000",
        "year_incorporated": "",
        "city_council_district": "1",
        "state_house_district": "2",
        "state_senate_district": "3",
        "federal_congressional_district": "4",
        "county": "",
        "county_supervisorial_district": "",
        "parent_name": "",
        "fiscal_sponsor_name": "",
        "ntee": "",
        "nisp_institution": "",
        "nisp_specialty": "",
        "nisp_classification": "",
        "irs_exemption_date": "",
        "nmbr_board_members": "",
        "org_type": "",
        "address2": "",
        "audited": "",
        "month_count": "",
        "type_501c": "",
        "service_agreement_start": "",
        "service_agreement_end": "",
        "service_agreement_url": "",
        "is_cdp": false,
        "is_grantmaker": false,
        "is_applicant": false,
        "is_service": false,
        "is_demo": false
      }
    }
  ]
}

Organization Logo ¶

Organization Logo resource representation.

POST`/orgLogo`

Example URI

POST /orgLogo

Organization Profiles ¶

Organization resource representation.

Show all organization profiles
GET`/organization_profiles{?organization_id}`

Get a JSON representation of all the organization profiles.

Example URI

GET /organization_profiles?organization_id=

URI Parameters

HideShow

organization_id: integer (optional)
Organization ID of organization profiles to retrieve

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "type": "organization_profiles",
      "id": "1",
      "attributes": {
        "organization_id": 2,
        "fiscal_year_end": "2016-07-31",
        "background_info": "Some background info",
        "org_type": "",
        "type_501c": 0,
        "legal_name": "legal name of org",
        "federal_id": 123123123,
        "under_parent_name": "Under this Parent name",
        "parent_name": "Parent Name",
        "parent_EIN": 0,
        "parent_type": "",
        "parent_type_other": "",
        "fiscal_sponsor_name": "",
        "fiscal_sponsor_EIN": 0,
        "address1": "123 Gohere Road",
        "address2": "",
        "city": "Anytown",
        "zip_plus_4": 0,
        "state": "Ohio",
        "county": "",
        "phone": 1231231234,
        "city_council_district": 0,
        "state_house_district": 0,
        "state_senate_district": 0,
        "federal_congressional_district": 0,
        "url": "",
        "org_year_founded": 0,
        "under_parent_year_founded": 0,
        "org_year_incorporated": 0,
        "irs_exemption_date": 8,
        "duns_nmbr": 0,
        "mission": "",
        "full_data_profile": true,
        "wants_full_data_profile": false,
        "audited": false,
        "affiliations": "",
        "endowment_reserve_check": false,
        "restricted_revenue_check": true,
        "restricted_revenue_check_both": false,
        "restricted_earned_revenue_check": true,
        "revenue_from_special_events_check": false,
        "non_operating_revenue_check": true,
        "non_operating_expense_check": true,
        "investment_revenue_check": false,
        "paid_staff_check": false,
        "one_or_more_marketing_FTE_check": false,
        "wants_marketing_financial_detail_check": false,
        "wants_disaggregated_balance_sheet_check": false,
        "membership_program_check": true,
        "ntee": "A01",
        "nisp_classification": "01",
        "nisp_specialty": "H",
        "nisp_institution": "01",
        "program_activity_suggested_list": "",
        "program_activity_total_less_suggested_list": "",
        "museum_breakout": "",
        "pays_artists_performers_directly_check": false,
        "subscriptions_events_check": false,
        "subscriptions_media_check": false,
        "generated_tags": "",
        "generated_survey_tags": "",
        "created_at": "2015-12-04 18:54:45",
        "updated_at": "2015-12-04 18:54:45",
        "deleted_at": "",
        "created_by": 2,
        "updated_by": 2,
        "deleted_by": 0
      }
    }
  ]
}

Show organization
GET`/organization_profiles/{id}{?organization_id}`

Show a single organization

Example URI

GET /organization_profiles/1?organization_id=

URI Parameters

HideShow

id: integer (required) Example: 1
ID of organization profile(s) to retrieve - can be comma separated for multiple, i.e. 1,2,3
organization_id: integer (optional)
Organization ID of organization profiles to retrieve

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "type": "organization_profiles",
      "id": "1",
      "attributes": {
        "organization_id": 2,
        "fiscal_year_end": "2016-07-31",
        "background_info": "Some background info",
        "org_type": "",
        "type_501c": 0,
        "legal_name": "legal name of org",
        "federal_id": 123123123,
        "under_parent_name": "Under this Parent name",
        "parent_name": "Parent Name",
        "parent_EIN": 0,
        "parent_type": "",
        "parent_type_other": "",
        "fiscal_sponsor_name": "",
        "fiscal_sponsor_EIN": 0,
        "address1": "123 Gohere Road",
        "address2": "",
        "city": "Anytown",
        "zip_plus_4": 0,
        "state": "Ohio",
        "county": "",
        "phone": 1231231234,
        "city_council_district": 0,
        "state_house_district": 0,
        "state_senate_district": 0,
        "federal_congressional_district": 0,
        "url": "",
        "org_year_founded": 0,
        "under_parent_year_founded": 0,
        "org_year_incorporated": 0,
        "irs_exemption_date": 8,
        "duns_nmbr": 0,
        "mission": "",
        "full_data_profile": true,
        "wants_full_data_profile": false,
        "audited": false,
        "affiliations": "",
        "endowment_reserve_check": false,
        "restricted_revenue_check": true,
        "restricted_revenue_check_both": false,
        "restricted_earned_revenue_check": true,
        "revenue_from_special_events_check": false,
        "non_operating_revenue_check": true,
        "non_operating_expense_check": true,
        "investment_revenue_check": false,
        "paid_staff_check": false,
        "one_or_more_marketing_FTE_check": false,
        "wants_marketing_financial_detail_check": false,
        "wants_disaggregated_balance_sheet_check": false,
        "membership_program_check": true,
        "ntee": "A01",
        "nisp_classification": "01",
        "nisp_specialty": "H",
        "nisp_institution": "01",
        "program_activity_suggested_list": "",
        "program_activity_total_less_suggested_list": "",
        "museum_breakout": "",
        "pays_artists_performers_directly_check": false,
        "subscriptions_events_check": false,
        "subscriptions_media_check": false,
        "generated_tags": "",
        "generated_survey_tags": "",
        "created_at": "2015-12-04 18:54:45",
        "updated_at": "2015-12-04 18:54:45",
        "deleted_at": "",
        "created_by": 2,
        "updated_by": 2,
        "deleted_by": 0
      }
    }
  ]
}

Applications ¶

Application resource representation.

Show all applications
GET`/applications{?grant_program_id,pool_id,organization_id,include}`

Get a JSON representation of all the applications.

Example URI

GET /applications?grant_program_id=&pool_id=&organization_id=&include=

URI Parameters

HideShow

grant_program_id: integer (optional)
Grant Program ID of application to retrieve
pool_id: integer (optional)
Pool ID of application to retrieve
organization_id: integer (optional)
Organization ID of application to retrieve
include: string (optional)
Load available relationships: organization, survey_responses, pools

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "type": "applications",
      "id": "1",
      "attributes": {
        "grant_program_id": 2,
        "organization_id": 3,
        "pool_id": 25,
        "category": "Applicant",
        "category_date": "2015-08-15 00:00:00",
        "generated_report_id": 0,
        "removal_reason": 0,
        "action_dismissed": 0,
        "created_at": "2015-08-15 00:00:00",
        "updated_at": "2015-08-15 00:00:00",
        "deleted_at": "",
        "created_by": 1,
        "updated_by": 5,
        "deleted_by": 0
      }
    }
  ]
}

Show application
GET`/applications/{id}{?grant_program_id,pool_id,organization_id,include}`

Show a single application

Example URI

GET /applications/1?grant_program_id=&pool_id=&organization_id=&include=

URI Parameters

HideShow

id: integer (required) Example: 1
ID of application(s) to retrieve - can be comma separated for multiple, i.e. 1,2,3
grant_program_id: integer (optional)
Grant Program ID of application to retrieve
pool_id: integer (optional)
Pool ID of application to retrieve
organization_id: integer (optional)
Organization ID of application to retrieve
include: string (optional)
Load available relationships: organization, survey_responses, pools

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "type": "applications",
      "id": "1",
      "attributes": {
        "grant_program_id": 2,
        "organization_id": 3,
        "pool_id": 25,
        "category": "Applicant",
        "category_date": "2015-08-15 00:00:00",
        "generated_report_id": 0,
        "removal_reason": 0,
        "action_dismissed": 0,
        "created_at": "2015-08-15 00:00:00",
        "updated_at": "2015-08-15 00:00:00",
        "deleted_at": "",
        "created_by": 1,
        "updated_by": 5,
        "deleted_by": 0
      }
    }
  ]
}

Surveys ¶

Survey resource representation.

Show all surveys
GET`/surveys{?organization_id,include}`

Get a JSON representation of all the surveys.

Example URI

GET /surveys?organization_id=&include=

URI Parameters

HideShow

organization_id: integer (optional)
Organization ID of application to retrieve
include: string (optional)
Load available relationships: survey_responses

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "type": "surveys",
      "id": "1",
      "attributes": {
        "name": "CDP 2.0 Survey",
        "description": "CDP Survey"
      }
    }
  ]
}

Show survey
GET`/surveys/{id}{?organization_id,include}`

Show the specific survey(s)

Example URI

GET /surveys/1?organization_id=&include=

URI Parameters

HideShow

id: integer (required) Example: 1
ID of survey(s) to retrieve - can be comma separated for multiple, i.e. 1,2,3
organization_id: integer (optional)
Organization ID of application to retrieve
include: string (optional)
Load available relationships: survey_responses

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    "data": [
        {
            "type": "surveys",
            "id": "1",
            "attributes": {
                "name": "CDP 2.0 Survey",
                "description": "CDP Survey"
            }
        }
    ]
}
Meta Content resource representation.

Get a MetaContent record
GET`/metaContent/{meta_content_id}`

Get a JSON representation of all the answers.

Example URI

GET /metaContent/1

URI Parameters

HideShow

meta_content_id: integer (required) Example: 1
MetaContent ID to retrieve

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "id": 244,
    "identifier": "holiday_notice",
    "label": null,
    "group": 0,
    "display_name": "holiday_notice",
    "content_block": "Please note: On Friday, 12/14, the Support Center will close at 5:30pm ET for an     *            staff event. For assistance or more Support Center information, click the ? on the top right of yourn     *          page",
    "updated_at": {
      "date": "2019-01-15 02:22:19.000000",
      "timezone_type": 3,
      "timezone": "UTC"
    },
    "edit_user": {
      "full_name": "Charles Wolfe"
    }
  }
]

Get public MetaContent
GET`/publicMetaContent`

Get a JSON representation of all the answers.

Example URI

GET /publicMetaContent

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  [
    {
      "id": 1,
      "identifier": "help_support_knowledgebase_top_nav",
      "label": null,
      "group": 0,
      "display_name": "Help and Support Content",
      "content_block": "To contact support, dial 877-707-DATA (877-707-3282) or email help@culturaldata.orgn         * . Need help with something else? Try searching knowledgebase below.",
      "updated_at": {
        "date": "2016-08-26 04:36:57.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      },
      "edit_user": {
        "full_name": "Arin Sullivan"
      }
    }
  ]
]

Survey Responses ¶

Survey resource representation.

Show all survey_responses
GET`/survey_responses{?survey_id,include}`

Get a JSON representation of all the survey_responses.

Example URI

GET /survey_responses?survey_id=1&include=

URI Parameters

HideShow

survey_id: integer (required) Example: 1
Survey ID of responses to retrieve
organization_id: integer (optional)
Organization ID of survey responses to retrieve
include: string (optional)
Load available relationships: answers, organization_profile

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "type": "survey_responses",
      "id": "1",
      "attributes": {
        "fiscal_year_end": "2015-08-31",
        "status": "REVIEW_COMPLETED",
        "created": "2015-12-04 18:54:45",
        "updated": "2015-12-04 19:41:52"
      }
    }
  ]
}

Show survey_response
GET`/survey_responses/{id}{?include}`

Show the specific survey_response(s)

Example URI

GET /survey_responses/1?include=

URI Parameters

HideShow

id: integer (required) Example: 1
ID of survey response(s) to retrieve - can be comma separated for multiple, i.e. 1,2,3
include: string (optional)
Load available relationships: answers, organization_profile

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "type": "survey_responses",
      "id": "1",
      "attributes": {
        "fiscal_year_end": "2015-08-31",
        "status": "REVIEW_COMPLETED",
        "created": "2015-12-04 18:54:45",
        "updated": "2015-12-04 19:41:52"
      }
    }
  ]
}

Answers ¶

Answer resource representation.

Show all answers
GET`/answers{?survey_response_id,include}`

Get a JSON representation of all the answers.

Example URI

GET /answers?survey_response_id=1&include=

URI Parameters

HideShow

survey_response_id: integer (required) Example: 1
Survey Response ID of answers to retrieve
include: string (optional)
Load available relationships: survey_responses

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "type": "answers",
      "id": "1",
      "attributes": {
        "value": null,
        "completed": true,
        "created": "2015-11-13 17:56:10",
        "updated": "2015-11-13 17:57:45"
      }
    }
  ]
}

Show answer
GET`/answers/{id}{?question_id,include}`

Show the specific answer(s)

Example URI

GET /answers/1?question_id=&include=

URI Parameters

HideShow

id: integer (required) Example: 1
ID of answer(s) to retrieve - can be comma separated for multiple, i.e. 1,2,3
question_id: integer (optional)
ID of question to restrict answers by
include: string (optional)
Load available relationships: organizations,questions

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "type": "answers",
      "id": "1",
      "attributes": {
        "value": null,
        "completed": true,
        "created": "2015-11-13 17:56:10",
        "updated": "2015-11-13 17:57:45"
      }
    }
  ]
}

Questions ¶

Question resource representation.

Show all questions
GET`/questions`

Get a JSON representation of all the questions.

Example URI

GET /questions

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "type": "questions",
      "id": "1",
      "attributes": {
        "line": 21,
        "field": "question_field_name_slug",
        "name": "Question Field Name"
      }
    }
  ]
}

Show question
GET`/questions/{id}`

Show the specific question(s)

Example URI

GET /questions/1

URI Parameters

HideShow

id: integer (required) Example: 1
ID of question(s) to retrieve - can be comma separated for multiple, i.e. 1,2,3

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "type": "questions",
      "id": "1",
      "attributes": {
        "line": 21,
        "field": "question_field_name_slug",
        "name": "Question Field Name"
      }
    }
  ]
}

Studies ¶

Study resource representation.

Export a study
POST`/studies/{study_id}/export`

Starts a study export. Returns study json.

Example URI

POST /studies/1/export

URI Parameters

HideShow

study_id: integer (required) Example: 1
Study ID to export

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "id": 2,
    "title": "Chorus Operations Survey: 2016-17 Season",
    "slug": "chorus-operations-survey",
    "description": "The Chorus Operations Survey provides the most accurate...",
    "is_active": 0,
    "affiliation_id": 15,
    "required_num_fiscal_years": 1,
    "start_date": "2017-10-19 00:00:00",
    "end_date": "2018-01-26 00:00:00",
    "deadline": "2018-01-11 00:00:00",
    "created_at": "2017-08-21 20:29:20",
    "updated_at": "2017-08-21 20:29:20",
    "deleted_at": null
  }
]

Participant Contacts ¶

Participant Contact representation.

Fetch participants by study with organization details and optional orgname search
GET`/standalone/participants/fetchContactByOrgAndUserId`

Example URI

GET /standalone/participants/fetchContactByOrgAndUserId

Resource Group ¶

Grant Programs ¶

Show all grant programsGET/grant_programs{?organization_id,include}

Example URI

Headers

Body

Show grant programGET/grant_programs/{id}{?include}

Example URI

Headers

Body

Pools ¶

Show all poolsGET/pools{?grant_program_id,include}

Example URI

Headers

Body

Show PoolGET/pools/{id}{?include}

Example URI

Headers

Body

Reports ¶

Show all reportsGET/reports{?organization_id,include}

Example URI

Headers

Body

Show reportGET/reports/{id}{?include}

Example URI

Headers

Body

Download reportGET/reports/{id}/download

Example URI

Headers

Body

Headers

Users ¶

Show all usersGET/users{?organization_id,include}

Example URI

Headers

Body

Show userGET/users/{id}{?include}

Example URI

Headers

Body

Organizations ¶

Show all organizationsGET/organizations{?tax_id,updated_after,updated_before,include}

Example URI

Headers

Body

Show organizationGET/organizations/{id}{?include}

Example URI

Headers

Body

Organization Logo ¶

POST/orgLogo

Example URI

Organization Profiles ¶

Show all organization profilesGET/organization_profiles{?organization_id}

Example URI

Headers

Body

Show organizationGET/organization_profiles/{id}{?organization_id}

Example URI

Headers

Body

Applications ¶

Show all applicationsGET/applications{?grant_program_id,pool_id,organization_id,include}

Example URI

Headers

Body

Show applicationGET/applications/{id}{?grant_program_id,pool_id,organization_id,include}

Example URI

Headers

Body

Surveys ¶

Show all surveysGET/surveys{?organization_id,include}

Example URI

Headers

Body

Show surveyGET/surveys/{id}{?organization_id,include}

Example URI

Headers

Show all grant programs
GET`/grant_programs{?organization_id,include}`

Show grant program
GET`/grant_programs/{id}{?include}`

Show all pools
GET`/pools{?grant_program_id,include}`

Show Pool
GET`/pools/{id}{?include}`

Show all reports
GET`/reports{?organization_id,include}`

Show report
GET`/reports/{id}{?include}`

Download report
GET`/reports/{id}/download`

Show all users
GET`/users{?organization_id,include}`

Show user
GET`/users/{id}{?include}`

Show all organizations
GET`/organizations{?tax_id,updated_after,updated_before,include}`

Show organization
GET`/organizations/{id}{?include}`

POST`/orgLogo`

Show all organization profiles
GET`/organization_profiles{?organization_id}`

Show organization
GET`/organization_profiles/{id}{?organization_id}`

Show all applications
GET`/applications{?grant_program_id,pool_id,organization_id,include}`

Show application
GET`/applications/{id}{?grant_program_id,pool_id,organization_id,include}`

Show all surveys
GET`/surveys{?organization_id,include}`

Show survey
GET`/surveys/{id}{?organization_id,include}`

Get a MetaContent record
GET`/metaContent/{meta_content_id}`

Get public MetaContent
GET`/publicMetaContent`

Show all survey_responses
GET`/survey_responses{?survey_id,include}`

Show survey_response
GET`/survey_responses/{id}{?include}`

Show all answers
GET`/answers{?survey_response_id,include}`

Show answer
GET`/answers/{id}{?question_id,include}`

Show all questions
GET`/questions`

Show question
GET`/questions/{id}`

Export a study
POST`/studies/{study_id}/export`

Fetch participants by study with organization details and optional orgname search
GET`/standalone/participants/fetchContactByOrgAndUserId`