Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel7

...

Region

Swagger URL

Michigan Region Development

MI-CIE Development Social Services Directory

Michigan Region UAT

MI-CIE UAT Social Services Directory

Michigan Region Production

MI-CIE Production Social Services Directory

Southeast Michigan Region Development

SEMI-CIE Development Social Services Directory

Southeast Michigan Region UAT

SEMI-CIE UAT Social Services Directory

Southeast Michigan Region Production

SEMI-CIE Production Social Services Directory

Northeast Michigan Region Development

NEMI-CIE Development Social Services Directory

Northeast Michigan Region UAT

NEMI-CIE UAT Social Services Directory

Northeast Michigan Region Production

NEMI-CIE Production Social Services Directory

Authorization

The API’s need to have a bearer access token. The swagger pages have a method built in to get the access token. The following are the steps

...

  1. /tableName/{id}

  2. /tableName/complete/{id}

Category ID Call (single result)

Workflow

Result

  • Select the desired Call

  • Select “Try it out”

  • Enter in a valid x-api-key that you received from CIE support.

  • Enter in a valid id

  • Select Execute

An array of 1 result should display

...

  1. /tableName

  2. /tableName/complete

Category Call (multiple results)

Workflow

Result

  • Select the desired Call

  • Select “Try it out”

  • Enter in a valid x-api-key that you received from CIE support.

  • Select Execute

An array of up to 10 results should display

Category Call Filtered (multiple results)

Workflow

Result

Select the desired Call
Select "Try it out"
Enter a valid x-api-key
Enter desired parameter(s) - (Parameter descriptions below)
Select Execute

An array of up to 10 results should display

Filtered call field descriptions:

Parameters

Parameter

Description

page

Display which page of data to return - default is 1
'page' can be iterated over to return all the data in a number of successive calls.

per_page

Display number of results per page - default is 10

sort_by

Which data field to sort by - default is 'id'

order_by

Sort by asc or desc - default is asc

query

Query Guide

...