Versions Compared

Old Version 2

changes.mady.by.user Jonathan Draugelis

Saved on

compared with

New Version 3

changes.mady.by.user Amanda Wakefield

Saved on

Key

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

...

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
"program_id": 2048
FOR CHILDREN, CHILDRENS ADVOCACY CENTER OF
"program":
SOUTHWEST
"CHILDREN'S ADVOCACY CENTER"
MICHIGAN",
    "
name
organization_type": "
COUNSELING
Nonprofit
SERVICES
-
AND
Incorporated",
PREVENTION
FOR
CHILDREN
WHO ARE ABUSED"
 "source_id": 78135838,
    "
alternate_name
source":
null
"icarol",
    "description": "
Provides
Supports
forensic
children
interviews
through
for
a
sexually
coordinated
abused
response
children,
to
counseling
child
services
abuse
for
that
sexually
includes
abused children
prevention,
including adults survivors of child sexual abuse, and prevention education
assessment and intervention.",
    "
url
email":
null
"info@swmichigancac.org",
    "
email
url":
null
"www.swmichigancac.org",
    "tax_status":
1
null,
    "
interpretation
tax_
services
id":
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.
 "38-2265793",
    "
wait_time": null, "fees"
year_incorporated": "
No fees
1986",
    "
accreditations
legal_status": null,
    "
licenses
contact": null,
    "
eligibility
region": "
Children and families of suspected child abuse in Southwest Michigan
GRYP",
    "
language
locations":
"Interpretation
[
services
available",
"payment_accepted": "Not applicable", "required_document": "Referral information",
{
        "
service_area
id": "970"
Berrien
,
Cass
and
Van
Buren
Counties",
     "
area
organization_
served_description
id": "
Berrien
969",
Cass and
Van
Buren
Counties",
     "
region
organization_name": "
GRYP", "contacts": [
CHILDREN'S ADVOCACY CENTER OF SOUTHWEST MICHIGAN",
{
"source_id": "78174387",
        "
id
source": "
2048
icarol",
        "
organization_id
name": "
969
CHILDREN'S ADVOCACY CENTER OF SOUTHWEST MICHIGAN",
        "
location
alternate_
id
name": "
970
BERRIEN COUNTY COUNCIL FOR CHILDREN, CHILDRENS ADVOCACY CENTER OF SOUTHWEST MICHIGAN",
        "
service_id
url": "
1
www.swmichigancac.org",
        "
service_at_location_id
description": "
",
Located on Old US 31 near intersection of
"name": ""
Marquette Woods Road and US-31",
        "
title
accessibility_for_disabilities": "",
        "
department
transportation": "No public transportation available",
        "
email
latitude": "42.0225356",
        "
hasPhone
longitude": "
1
86.4205098"
      }
    ],
    "
regular_schedule
programs": [
      {
        "id": "
9212
2048",
        "organization_id": "969",
        "
service_id
name": "
1
CHILDREN'S ADVOCACY CENTER",
        "
service_at_location_id
alternate_name": ""
      }
    ],
    "services": [
"weekday": "",
 {
        "
opens_at
id": "1",
        "
closes
organization_
at
id": "969",
        "
administrative
location_
hours
id": "970",
        "source_service_
hours
id":
"Mon and Wed 8:30am-8pm; Tue and Thu 8:30am-5pm; Fri 8:30am-4pm
"1106",
        "
site
source_id_
hours
programAtSite": "78189075",
} 
"source_id_program": "78143321",
],
     "
phones
source": "icarol",
[
{
"program_id": "",
        "
id
program":
"18427
 "CHILDREN'S ADVOCACY CENTER",
        "
organization_id
name": "
",
COUNSELING SERVICES AND PREVENTION FOR CHILDREN WHO ARE
"service_id": "1"
ABUSED",
        "
service_at_location_id
alternate_name": "",
        "
number
description": "
2695569640", "extension": "", "phone_type_hierarchy": "1
Provides forensic interviews for sexually abused children, counseling services for sexually abused children, including adults survivors of child sexual abuse, and prevention education.",
        "
type
url": "
Main
www.swmichigancac.org",
        "
department
email": "info@swmichigancac.org",
        "
language
status": "1",
        "
description
interpretation_services": ""
}
,
],
   
"
service
application_
taxonomy
process":
[
"- Referral required from Child Protective Services
{
or Law Enforcement for forensic interviewing services  -
"id": "8192", "service_id": "1
Therapy services available to children and adult survivors of child sexual abuse",
        "
taxonomy
wait_
id
time": "
FN-1500.1900-150
",
        "
taxonomy_detail
fees": "
Child
No
Abuse Prevention
fees",
        "
category
accreditations": "",
        "
subcategory
licenses": "",
},
  "eligibility": "Children and families of
{
suspected child abuse in Southwest Michigan",
"id":
"8193",
    "language": "Translation services
"service_id": "1
available as needed",
        "
taxonomy
payment_
id
accepted": "
RP-1400.8000-020.15
Not applicable",
        "
taxonomy
required_
detail
document": "
Child
Referral
Abuse Counseling
information",
        "
category
service_area": "
Mental Health Evalua
Berrien, Cass and Van Buren Counties",
        "area_served_description": "Berrien, Cass and
"subcategory": "Abuse Counseling
Van Buren Counties"
      }
,

    ],
{
   "physical_address": [
"id": "8194",
 {
        "
service_
id": "
1
32300",
        "
taxonomy
organization_id": "
RP-1400.8000-800
969",
        "
taxonomy_detail
attention":
"Sexual Assault
Counseling
"",
        "
category
address_1": "
Mental
4938
Health
Niles
Evalua
Road",
        "
subcategory
address_2": "
Counseling Services
"
,
}
], "physical_address
"address_3":
[ 
"",
{
"id
"address_4": "
5362
",
        "
organization_id
city": "Saint Joseph",
        "
location_id
county": "
970
Berrien",
        "
attention
region": "GRYP",
        "
address
state_
1
province": "
4938 Niles Road
MI",
        "
address
postal_
2
code": "49085",
        "
address_3
country": "United States"
,

      }
"address_4": ""
 ],
    "phones": [
"city": "Saint Joseph",
    {
        "
county
id": "
Berrien
1066097",
        "
region
organization_id": "969",
        "
state_province
service_at_location_id": "
MI
",
        "
postal_code
number": "
49085
2695569640",
        "
country
extension": "
USA
",
} 
  "phone_type_hierarchy": "1",
],
     "
locations
type":
[ {
"Main",
        "
id
department": "
970
",
        "
organization_id
language": "
969
",
        "
organization_name
description": "
CHILDREN'S ADVOCACY CENTER OF SOUTHWEST MICHIGAN
",
        "
name
confidential": "
CHILDREN'S ADVOCACY CENTER OF SOUTHWEST MICHIGAN"
0"
      },
      {
"alternate_name
       "id": "1066098",
        "
url
organization_id": "
www.swmichigancac.org
969",
        "
description
service_at_location_id": ""
Located
,
on
Old
US
31
near
intersection
of
Marquette
Woods Road and US-31
"number": "2695569643",
        "
accessibility_for_disabilities
extension": "",
        "
transportation
phone_type_hierarchy":
"No public transportation available
 "14",
        "
latitude
type": "
42.0225356
Fax",
        "
longitude
department": "
86.4205098" 
",
}
],
"service_area_served
"language":
[
"",
{
"id
"description": "
23308
",
        "
service_id
confidential": "
1
0"
,
"type": "county",
}
    ],
    "
name
regular_schedule": [
"Berrien"
     {
},
{
"id": "667143",
        "organization_id": "
23309
969",
        "source_service_id": "
1
",
        "
type
service_at_location_id": "
county
",
        "
name
weekday": "
Cass
",
},
{
"opens_at": "",
        
"
id
closes_at": "
23310
",
        "
service
administrative_
id
hours": "
1
Mon, Wed 9am-8pm; Tue, Thu-Fri 9am-5pm",
        "
type
service_hours": "
county
",
        "
name
site_hours": "
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"
}

 

Example CURL for this API Call

...