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

1106,
    "source_id_programAtSite": 78189075,
    "source_id_program": 78143321,
    "source": "icarol",
    "program_id":

2048

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": [
      {
        "id": "

2048

213229",
        "

organization_id

name": "

969

Stephanie Crider",
        "

location_id

email": "

970

scrider@swmichigancac.org",
        "

service_id

title": "

1

Family Advocate",
        "hasPhone": "0",
        "

service_at_location_id

department": "",
        "

name

service_id": "",
        "

title

location_id": "",
        "

department

organization_id": "",
        "

email

source_service_id": "1106",
        "

hasPhone

service_at_location_id": "

1

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

9212

1222828",
        "

organization_id

weekday": "",
        "

service

opens_

id

at": "

1

",
        "

service

closes_at

_location_id

": "",
        "

weekday

service_id": "",
        "

opens

site_

at

hours": "",
        "

closes

service_

at

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

administrative

organization_

hours

id": "",
        "source_service_

hours

id": "1106"

Mon

and

Wed

8:30am-8pm;

Tue

and

Thu

8:30am-5pm;

Fri

8:30am-4pm

"administrative_hours": "",
        "

site_hours

service_at_location_id": ""
      }
    ],
    "

phones

schedule": [
      {
        "id": "

18427

39",
        "

organization_id

byday": "SU",
        "

service_id

notes": "

1

",
        "

service

opens_at

_location_id

": "03:08",
        "

number

closes_at": "

2695569640

15:08",
        "

extension

service_id": "1",
        "

phone_type_hierarchy

description": "

1

",
        "

type

source_service_id": "

Main",

"
      }
    ],
    "

department

phones":

"",

 [
      {
        "

language

id": "2124953",
        "

description

type": "Main Site Phone",

}

"number": "2695569640",

],

service_taxonomy

language": "",

[

{

"extension": "",
        "

id

department": "

8192

",
        "service_id": "

1

",
        "

taxonomy_id

description": "

FN-1500.1900-150

",
        "

taxonomy

location_

detail

id": "

Child Abuse Prevention

970",
        "

category

source_service_id": "1106"

Mental

Health

Evalua",

},

"subcategory": "Counseling Services"

}

"id": "1313332",

],

physical_address

category":

[

"Mental Health Evaluation, Treatment & Supportive

{

Services",
        "

id

subcategory": "

5362

Abuse Counseling",
        "

organization

taxonomy_id": "RP-1400.8000-020.15",
        "

location

taxonomy_

id

detail": "

970",

Child

"attention": "

Abuse Counseling",
        "

address

source_service_

1

id": "1106"

4938

Niles

Road",

},

"address_2": "",

 {
        "

address_3

id": "1313332",
        "

address_4

category": "Child/Adolescent",
        "

city

subcategory": "

Saint

Violence/Abuse

Joseph

Services",
        "

county

taxonomy_id": "

Berrien

RP-1400.8000-020.15",
        "

region

taxonomy_detail": "Child Abuse Counseling",
        "

state

source_service_

province

id": "

MI",

postal_code

id": "

49085

1313331",
        "

country

category": "

USA

",

}

 "subcategory": "",

],

locations

taxonomy_id":

[ {

"FN-1500.1900-150",
        "

id

taxonomy_detail": "

970

Child Abuse Prevention",
        "

organization

source_service_id": "

969

1106"

,

"organization_name": "CHILDREN'S ADVOCACY CENTER OF SOUTHWEST MICHIGAN"

}
    ],

"name

"physical_address":

"CHILDREN'S ADVOCACY CENTER OF SOUTHWEST MICHIGAN",

 [
      {
        "

alternate_name

id": "32302",
        "

url

city": "

www.swmichigancac.org

Saint Joseph",
        "

description

county": "Berrien"

Located

on

Old

US

31

near

intersection

of

Marquette Woods Road and US-31",

"region": "GRYP",
        "

accessibility_for_disabilities

country": "United States",
        "

transportation

address_1": "

No

public

Niles

transportation available

Road",
        "

latitude

address_2": "

42.0225356

",
        "

longitude

address_3": "

86.4205098

",

}

"address_4": "",

],

service_area_served

attention":

[

"",

{

"is_physical": "1",
        "location_id": "

23308

970",
        "

service

postal_

id

code": "

1

49085",
        "

type

state_province": "

county

MI",
        "

name

organization_id": "

Berrien

"
      }

,

],

{

  "locations": [

"id": "23309",

 {
        "

service_

id": "

1

970",
        "

type

url": "

county

www.swmichigancac.org",
        "name": "

Cass"

CHILDREN'S ADVOCACY CENTER OF SOUTHWEST MICHIGAN",

},

{

"source": "icarol",
        "

id

latitude": "

23310

42.0225356",
        "

service_id

longitude": "

1

86.4205098",
        "

type

source_id": "

county

78174387",
        "

name

description": "

Van

Located

Buren"

on Old US 31 near intersection of

}

Marquette Woods Road

] } ]

and US-31",

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

alternate_name": "

Forbidden"

BERRIEN

}

COUNTY COUNCIL FOR CHILDREN,

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

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",
        "organization_name": "CHILDREN'S ADVOCACY CENTER OF SOUTHWEST MICHIGAN",
        "accessibility_for_disabilities": ""
      }
    ],
    "service_area_served": [
      {
        "id": "134785",
        "name": "Berrien",
        "type": "county",
        "service_id": "",
        "source_service_id": "1106"
      },
      {
        "id": "134786",
        "name": "Cass",
        "type": "county",
        "service_id": "",
        "source_service_id": "1106"
      },
      {
        "id": "134787",
        "name": "Van Buren",
        "type": "county",
        "service_id": "",
        "source_service_id": "1106"
      }
    ]
  }
]

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

237869a1

7a025b91-

67f0

f1ff-

4a68

4e4f-

9500

be75-

734b3956517b

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 5

New Version Current

Key

Swagger Definitions

Headers

Request

Response

Example CURL for this API Call