Page Comparison

Introduction

This API will allow the user to query for complete information on services. The API can be called without passing a ID parameter in the path to get a specific service. Please note that if you are searching for a list of services and don’t need all the information the \services call will be faster.

Authorization

The authorization will contain an API key and also will use an OAuth2 access token. An API key will be provided to each client that intends to consume this API. A development key and also a separate production key will be provided. If this key is not included then an authorization error will be returned.

...

Info

Scope Needed For This API - mi-cie.hub/read

Rest URL

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

1580269590/

services#Common

organizations#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 retrieval of a person record.

Code Block
[ { "id":

1

969,
    "

organization_id

name":

969, "location_id": 970

"CHILDREN'S ADVOCACY CENTER OF SOUTHWEST MICHIGAN",
    "

source

alternate_

service_id

name": "

1106"

BERRIEN COUNTY COUNCIL FOR CHILDREN, CHILDRENS ADVOCACY CENTER

"program_id": 2048

OF SOUTHWEST MICHIGAN",
    "

program

organization_type": "

CHILDREN'S

Nonprofit

ADVOCACY

CENTER

Incorporated",
    "

name

source_id":

"COUNSELING SERVICES AND PREVENTION FOR CHILDREN WHO ARE ABUSED"

78135838,
    "

alternate_name

source":

null

"icarol",
    "description": "

Provides

Supports

forensic

children

interviews

through

for

sexually

coordinated

abused

response

children,

to

counseling

child

services

abuse

for

that

sexually

includes

abused children

prevention,

including

assessment

adults survivors of child sexual abuse, and prevention education.

and intervention.",
    "email": "info@swmichigancac.org",
    "url":

null

"www.swmichigancac.org",
    "

email

tax_status": null,
    "

status

tax_id":

1

"38-2265793",
    "

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

schedule_notes": "Mon, Wed 9am-8pm; Tue, Thu-Fri 9am-5pm",
    "year_incorporated": "1986",
    "

area

legal_

served_description

status":

"Berrien

null,

Cass

and

Van

Buren

Counties

"contact": null,
    "region": "GRYP",
    "

contacts

locations": [
      {
        "id": "

2048

970",
        "

organization_id

url": "

969

www.swmichigancac.org",
        "name": "CHILDREN'S ADVOCACY CENTER OF SOUTHWEST

"location_id": "970"

MICHIGAN",
        "

service_id

source": "

1

icarol",
        "

service_at_location_id

latitude": "42.0225356",
        "

name

longitude": "86.4205098",
        "

title

source_id": "78174387",
        "

department

description": "

",

Located on Old US 31 near intersection of Marquette

"email": ""

Woods Road and US-31",
        "

hasPhone

alternate_name": "

1"

BERRIEN COUNTY COUNCIL FOR CHILDREN, CHILDRENS ADVOCACY CENTER

}

OF SOUTHWEST MICHIGAN",

],

regular

schedule_

schedule

notes":

[

"Mon, Wed 9am-8pm; Tue,

{

Thu-Fri 9am-5pm",
        "

id

transportation": "

9212

No public transportation available",
        "organization_id": "969",
        "

service

organization_

id

name": "

1

CHILDREN'S ADVOCACY CENTER OF SOUTHWEST MICHIGAN",
        "

service

accessibility_

at

for_

location_id

disabilities": ""

,


      }
    ],
    "

weekday": "",

programs": [
      {
        "

opens_at

id": "2048",
        "

closes_at

name": "CHILDREN'S ADVOCACY CENTER",
        "

administrative

alternate_

hours

name": "",
        "

service

organization_

hours

id": "

Mon

969"

and

Wed

8:30am-8pm;

Tue

and

Thu 8:30am-5pm; Fri 8:30am-4pm",

 }
    ],
    "

site_hours

services":

""

}

],

phones

id":

[

"1",

{

"url": "www.swmichigancac.org",
        "

id

fees": "

18427

No fees",
        "name": "COUNSELING SERVICES AND PREVENTION FOR CHILDREN WHO

"organization_id": "

ARE ABUSED",
        "

service_id

email": "

1

info@swmichigancac.org",
        "

service_at_location_id

source": "icarol",
        "

number

status": "

2695569640

1",
        "

extension

program": "CHILDREN'S ADVOCACY CENTER",
        "

phone_type_hierarchy

language":

"1

 "Translation services available",
        "

type

licenses": "

Main

",
        "

department

wait_time": "",
        "

language

program_id": "",
        "description": "

" }

Provides forensic interviews for sexually abused children, counseling services for sexually abused children, including adults survivors of child sexual abuse, and prevention education.",

],

service_taxonomy

eligibility":

[ {

"Children and families of suspected child abuse in Southwest Michigan",
        "location_id": "

8192

970",
        "service_

id

area": "

1

Berrien, Cass and Van Buren Counties",
        "

taxonomy_id

accreditations": "

FN-1500.1900-150

",
        "

taxonomy

alternate_

detail

name": "

Child Abuse Prevention

",
        "

category

city": "

Mental

Saint

Health Evalua

Joseph",
        "

subcategory

county": "

Counseling Services" }

Berrien",

],

    "region": "

physical_address": [

GRYP",
        "country": "United

{

States",
        "

id

address_1": "

5362

4938 Niles Road",
        "

organization

address_

id

2": "",
        "

location

address_

id

3": "

970

",
        "

attention

address_4": "",
        "

address_1

attention": "

4938 Niles Road

",
        "

address

is_

2

physical": "1",
        "

address

postal_

3

code": "49085",
        "

address

state_

4

province": "MI",
        "

city

organization_id":

"Saint Joseph",

"969"
      }
    ],
    "

county

phones":

"Berrien",

[
      {
        "

region

id": "2187227",
        "

state_province

type": "

MI

Main",
        "

postal_code

number": "

49085

2695569640",
        "

country

language": "

USA" }

",

],

locations

extension":

[

"",

{

"id

"department": "

970

",
        "

organization_id

description": "

969

",
        "

organization_name

confidential":

"CHILDREN'S ADVOCACY CENTER OF SOUTHWEST MICHIGAN

 "0",
        "

name

organization_id": "

CHILDREN'S ADVOCACY CENTER OF SOUTHWEST MICHIGAN

969",
        "phone_type_hierarchy": "1",
        "

alternate_name

service_at_location_id": ""

,

},

"url": "www.swmichigancac.org",

 {
        "

description

id": "2187228"

Located on

Old

US 31

near

intersection

of

Marquette

Woods

Road

and US-31

"type": "Fax",
        "

accessibility_for_disabilities

number": "2695569643",
        "

transportation

language": "

No public transportation available

",
        "

latitude

extension": "

42.0225356

",
        "

longitude

department": "

86.4205098

}

], "service_area_served": [

"description": "",

{

"confidential": "0",
        "organization_id": "

23308

969",
        "

service

phone_type_

id

hierarchy": "

1

14",
        "

type

service_at_location_id": "

county",

"
      }
    ],
    "

name

regular_schedule":

"Berrien"

[
      {

},

{

"id": "1248184",
        "

id

weekday": "

23309

",
        "

service

opens_

id

at": "

1

",
        "

type

closes_at": "

county

",
        "

name

site_hours": "

Cass

",

},

{

"service_hours": "",
        "organization_id": "

23310

969",
        "source_service_id": "

1

",
        "

type

administrative_hours": "

county

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

name

service_at_location_id": "

Van Buren

"
      }
    ],

}

 "schedule": []
  }

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

Example CURL for this API Call

The following is an example CURL for calling this api.

...

Versions Compared

Old Version 1

New Version Current

Key

Introduction

Authorization

Rest URL

Swagger Definitions

Headers

Request

Response

Example CURL for this API Call