Versions Compared

Old Version 5

changes.mady.by.user Pete Richardson

Saved on

compared with

New Version 6

changes.mady.by.user Jonathan Draugelis

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

HTTP Status Code

Description

Response Example

200

Successful call with no service matching the query passed in.

Code Block
[]

200

Successful retrieval of a service complete record.

 

Code Block
[
  {
    "id": 1,
    "organization_id": 969,
    "location_id": 970,
    "source_service_id": "1106",
    "program_id": 2048,
    "program": "CHILDREN'S ADVOCACY CENTER",
    "name": "COUNSELING SERVICES AND PREVENTION FOR CHILDREN WHO ARE ABUSED",
    "alternate_name": null,
    "description": "Provides forensic interviews for sexually abused children, counseling services for sexually abused children, including adults survivors of child sexual abuse, and prevention education.",
    "url": null,
    "email": null,
    "status": 1,
    "interpretation_services": null,
    "application_process": "Referral required from Child Protective Services or Law Enforcement for forensic interviewing services. Therapy services available to children and adult survivors of child sexual abuse.",
    "wait_time": null,
    "fees": "No fees",
    "accreditations": null,
    "licenses": null,
    "eligibility": "Children and families of suspected child abuse in Southwest Michigan",
    "language": "Interpretation services available",
    "payment_accepted": "Not applicable",
    "required_document": "Referral information",
    "service_area": "Berrien, Cass and Van Buren Counties",
    "area_served_description": "Berrien, Cass and Van Buren Counties",
    "region": "GRYP",
    "contacts": [
      {
        "id": "2048",
        "organization_id": "969",
        "location_id": "970",
        "service_id": "1",
        "service_at_location_id": "",
        "name": "",
        "title": "",
        "department": "",
        "email": "",
        "hasPhone": "1"
      }
    ],
    "regular_schedule": [
      {
        "id": "9212",
        "organization_id": "",
        "service_id": "1",
        "service_at_location_id": "",
        "weekday": "",
        "opens_at": "",
        "closes_at": "",
        "administrative_hours": "",
        "service_hours": "Mon and Wed 8:30am-8pm; Tue and Thu 8:30am-5pm; Fri 8:30am-4pm",
        "site_hours": ""
      }
    ],
    "phones": [
      {
        "id": "18427",
        "organization_id": "",
        "service_id": "1",
        "service_at_location_id": "",
        "number": "2695569640",
        "extension": "",
        "phone_type_hierarchy": "1",
        "type": "Main",
        "department": "",
        "language": "",
        "description": ""
      }
    ],
    "service_taxonomy": [
      {
        "id": "8192",
        "service_id": "1",
        "taxonomy_id": "FN-1500.1900-150",
        "taxonomy_detail": "Child Abuse Prevention",
        "category": "",
        "subcategory": ""
      },
      {
        "id": "8193",
        "service_id": "1",
        "taxonomy_id": "RP-1400.8000-020.15",
        "taxonomy_detail": "Child Abuse Counseling",
        "category": "Mental Health Evalua",
        "subcategory": "Abuse Counseling"
      },
      {
        "id": "8194",
        "service_id": "1",
        "taxonomy_id": "RP-1400.8000-800",
        "taxonomy_detail": "Sexual Assault Counseling",
        "category": "Mental Health Evalua",
        "subcategory": "Counseling Services"
      }
    ],
    "physical_address": [
      {
        "id": "5362",
        "organization_id": "",
        "location_id": "970",
        "attention": "",
        "address_1": "4938 Niles Road",
        "address_2": "",
        "address_3": "",
        "address_4": "",
        "city": "Saint Joseph",
        "county": "Berrien",
        "region": "",
        "state_province": "MI",
        "postal_code": "49085",
        "country": "USA"
      }
    ],
    "locations": [
      {
        "id": "970",
        "organization_id": "969",
        "organization_name": "CHILDREN'S ADVOCACY CENTER OF SOUTHWEST MICHIGAN",
        "name": "CHILDREN'S ADVOCACY CENTER OF SOUTHWEST MICHIGAN",
        "alternate_name": "",
        "url": "www.swmichigancac.org",
        "description": "Located on Old US 31 near intersection of Marquette Woods Road and US-31",
        "accessibility_for_disabilities": "",
        "transportation": "No public transportation available",
        "latitude": "42.0225356",
        "longitude": "86.4205098"
      }
    ],
    "service_area_served": [
      {
        "id": "23308",
        "service_id": "1",
        "type": "county",
        "name": "Berrien"
      },
      {
        "id": "23309",
        "service_id": "1",
        "type": "county",
        "name": "Cass"
      },
      {
        "id": "23310",
        "service_id": "1",
        "type": "county",
        "name": "Van Buren"
      }
    ]
  }
]

 

403

Request is unauthorized and will not be processed. This will happen if the authorization header does not contain a valid client id and secret.

 

 

Code Block
{
  "message": "Forbidden"
}

 

 

500

INTERNAL SERVER ERROR

Code Block

  {
  "type": "cie-directory/unkown-error",
  "title": "There was an error retrieving the services",
  "detail": "{\n\t\"stack\": \"Error: Error message\\n    at ServiceController.GetServicesAllComplete (/var/task/src/services/service-controller.js:214:13)\\n    at processTicksAndRejections (internal/process/task_queues.js:97:5)\\n    at async Runtime.exports.getServicesAllCompleteHandler [as handler] (/var/task/src/services/handler.js:73:22)\",\n\t\"message\": \"Error message\"\n}",
  "instance": "7a025b91-f1ff-4e4f-be75-42390fb02dd2"
}
 
 
400
Request is malformed and will not be processed.
 
 Code Block
{
  "type": "cie-directory/validation-error",
  "title": "Invalid Parameter",
  "detail": "parameter per_page was greater then the max allowed for this endpoint. per_page: 10000 max_allowed: 100",
  "instance": "237869a1-67f0-4a68-9500-734b3956517b"
}





 
Example CURL for this API Call
...