Page Comparison

...

The following are the URLs for this API.

Environment

URL

UAT

GET https://directory-uat.mi-cie.org/v1/services/complete/{id}

GET https://directory-uat.mi-cie.org/v1/services/complete/

Production

GET https://directory.mi-cie.org/v1/services/complete/{id}

GET https://directory.mi-cie.org/v1/services/complete

Swagger Definitions

The following are the URLs for this API.

Environment	URL
UAT	https://directory-uat.mi-cie.org/v1/swagger#/services/get_services_complete https://directory-uat.mi-cie.org/v1/swagger#/services/get_services_complete__serviceId_

Headers

The following will be headers that will need to be supplied

Header	Description
x-api-key	This will be a key that will provided by a community information exchange administrator.
ContentType	application/json
Authorization	This will be the access token that was retrieved using your client id and secret

Request

Note that the person ID passed as a parameter in the URL as documented in the REST URL section.

Data Element	Description	Default
Path Parameter
`id`	This will be the service id of the requested record in the directory. *Please note that this is only needed if you want to get a specific service payload for a ID.
Query String
`query`	A query parameter that will filter out the services that will be returned. This is an json object and The following lists commonly used query strings used for this API https://brightstreetgroup.atlassian.net/wiki/spaces/CIEP/pages/1576763393/services#Common-Queries
`page`	This will be which page of data that the user wants to be returned.	Default to Page 1
`per_page`	This will be the number of records that can be queried at a time. The maximum that can be queried is 30.	Default to 10

Response

The following will be the response values from the calling of the API. The error responses will conform ]to the following specification. https://tools.ietf.org/html/rfc7807 .

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, "source_id_programAtSite":

null

78189075,
    "source_id_program": 78143321,
    "source": "icarol",
    "program_id": null,
    "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

"www.swmichigancac.org",
    "email":

null

"info@swmichigancac.org",
    "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",
    "schedule_notes": "Mon, Wed 9am-8pm; Tue, Thu-Fri 9am-5pm",
    "accreditations": null,
    "licenses": null,
    "eligibility": "Children and families of suspected child abuse in Southwest Michigan",
    "language": "

Interpretation

Translation 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": [

],

"regular_schedule":

[

{
        "id": "

128090

213229",
        "

organization_id

name": "Stephanie Crider",
        "

service_id

email": "scrider@swmichigancac.org",
        "

source_service_id

title": "

1106

Family Advocate",
        "

service_at_location_id

hasPhone": "0",
        "

weekday

department": "",
        "

opens

service_

at

id": "",
        "

closes

location_

at

id": "",
        "

administrative

organization_

hours

id": "",
        "source_service_

hours

id": "

Mon and Wed 8:30am-8pm; Tue and Thu 8:30am-5pm; Fri 8:30am-4pm

1106",
        "

site_hours

service_at_location_id": ""
      }
    ],
    "

phones

regular_schedule": [
      {
        "id": "

317064

1222828",
        "

organization_id

weekday": "",
        "

service

opens_

id

at": "",
        "

source

closes_

service_id

at": "

1106

",
        "service_

at_location_id

id": "",
        "

number

site_hours": "

2695569640

",
        "

extension

service_hours": "Mon, Wed 9am-8pm; Tue, Thu-Fri 9am-5pm",
        "

phone

organization_

type_hierarchy

id": "

1

",
        "

type

source_service_id": "

Main

1106",
        "

department

administrative_hours": "",
        "

language

service_at_location_id": ""

,

"description": "",

],

confidential

schedule":

"0"

}

],

service_taxonomy

id":

[

"39",

{

"id

"byday": "

169075

SU",
        "

source_service_id

notes": "

1106

",
        "

taxonomy

opens_

id

at": "

FN-1500.1900-150

03:08",
        "

taxonomy

closes_

detail

at": "

Child Abuse Prevention

15:08",
        "service_id": "1",
        "

category

organization_id": "

Mental Health Evaluation, Treatment & Supportive Services

",
        "

subcategory

source_service_id": "

Abuse Counseling

},

   "phone_type_hierarchy": "1000",

{

"

"service_at_location_id": "

169079",

"
      }
    ],
    "

source_

service_

id

taxonomy":

"1106",

[
      {

"taxonomy_id": "RP-1400.8000-800",

taxonomy_detail

id": "

Sexual Assault Counseling

1313333",
        "category": "Mental Health Evaluation, Treatment & Supportive Services",
        "subcategory": "Counseling Services"

}

   "taxonomy_id":

],

"RP-1400.8000-800",
        "

physical

taxonomy_

address

detail":

[

"Sexual Assault

Counseling",

{

"

"source_service_id": "

5559",

1106"
      },

"organization_id": "",

 {
        "

location_

id": "

970

1313332",
        "

attention

category": "Mental Health Evaluation, Treatment & Supportive Services",
        "

address_1

subcategory": "

4938

Abuse

Niles Road

Counseling",
        "

address

taxonomy_

2

id": "RP-1400.8000-020.15",
        "

address

taxonomy_

3

detail": "Child Abuse Counseling",
        "

address

source_service_

4

id": "1106"

,

},

"city":

"Saint Joseph",

   {
        "

county

id": "

Berrien

1313332",
        "

region

category": "Child/Adolescent",
        "

state_province

subcategory": "

MI

Violence/Abuse Services",
        "

postal

taxonomy_

code

id": "

49085

RP-1400.8000-020.15",
        "

country

taxonomy_detail": "

USA

Child Abuse Counseling",

}

  "source_service_id": "1106"

],

"locations": [

},

{
        "id": "

970

1313331",
        "

organization_id

category": "

969

",
        "

organization_name

subcategory": "

CHILDREN'S ADVOCACY CENTER OF SOUTHWEST MICHIGAN

",
        "

source

taxonomy_id": "FN-1500.1900-150",
        "

source

taxonomy_detail": "

data

Child Abuse

warehouse

Prevention",
        "

name

source_service_id": "1106"

CHILDREN'S

ADVOCACY

CENTER

OF

SOUTHWEST MICHIGAN",

  }
    ],
    "

alternate

physical_

name

address":

"",

 [
      {
        "

url

id": "

www.swmichigancac.org

32302",
        "

description

city": "

Located

Saint

on

Joseph",

Old

US

31

near

intersection

of

Marquette

Woods

Road and US-31

"county": "Berrien",

"accessibility_for_disabilities

"region": "GRYP",
        "country": "United States",
        "address_1": "4938 Niles Road",
        "address_2": "",

"transportation": "No public transportation available

"address_3": "",
        "address_4": "",
        "attention": "",
        "is_physical": "1",
        "location_id": "970",
        "postal_code": "49085",
        "state_province": "MI",
        "organization_id": ""
      }
    ],
    "locations": [
      {
        "id": "970",
        "url": "www.swmichigancac.org",
        "name": "CHILDREN'S ADVOCACY CENTER OF SOUTHWEST MICHIGAN",
        "source": "icarol",
        "latitude": "42.0225356",
        "longitude": "86.4205098",
        "source_id": "78174387",
        "description": "Located on Old US 31 near intersection of Marquette Woods Road and US-31",
        "alternate_name": "BERRIEN COUNTY COUNCIL FOR CHILDREN, CHILDRENS ADVOCACY CENTER OF SOUTHWEST MICHIGAN",
        "schedule_notes": "Mon, Wed 9am-8pm; Tue, Thu-Fri 9am-5pm",
        "transportation": "No public transportation available",
        "organization_id": "969",
        "

latitude

organization_name": "

42.0225356

CHILDREN'S ADVOCACY CENTER OF SOUTHWEST MICHIGAN",
        "

longitude

accessibility_for_disabilities": "

86.4205098

"
      }
    ],
    "service_area_served": [
      {
        "id": "

186123

134785",
        "

service_id

name": "Berrien",
        "

source_service_id

type": "

1106

county",
        "

type

service_id": "

county

",

"name"

"source_service_id": "

Berrien

1106"
      },
      {
        "id": "

186124

134786",
        "

service_id

name": "Cass",
        "

source_service_id

type": "

1106

county",
        "

type

service_id": "

county

",
        "

name

source_service_id": "

Cass

1106"
      },
      {
        "id": "

186125

134787",
        "

service_id

name": "Van Buren",
        "

source_service_id

type": "

1106

county",
        "

type

service_id": "

county

",
        "

name

source_service_id": "

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" }

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"
}

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"
}

401

Unauthorized

Code Block
{ "message": "Unauthorized" }

502

Bad Gateway. Our API services maybe down

Code Block
{ "message": "Internal Server Error" }

Example CURL for this API Call

...

Versions Compared

Old Version 9

New Version Current

Key

Swagger Definitions

Headers

Request

Response

Example CURL for this API Call