Swagger Guide
- Pete Richardson
Swagger URLs
We have a swagger page to test out the API calls. The following are the links
Region | Swagger URL |
|---|---|
Michigan Region Development | |
Michigan Region UAT | |
Michigan Region Production |
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
Step 1 - Hit the Authorize Button in the top right hand corner
Step 2 - Enter in client id and secret
In the dialog that appears enter in the client id and secret for the environment that was given to you from the CIE Support person. Also make sure that the scope at the bottom is selected.
Step 3 - Make your calls
Once you have done this you will be logged into the swagger page and can now make your API calls.
Category ID Calls:
tableNames: organizations, locations, services, contacts
URLs:
/tableName/{id}
/tableName/complete/{id}
Category ID Call (single result) | |
|---|---|
Workflow | Result |
| An array of 1 result should display |
Category Calls:
tableNames: organizations, locations, services, contacts
URLs:
/tableName
/tableName/complete
Category Call (multiple results) | |
|---|---|
Workflow | Result |
| An array of up to 10 results should display |
Category Call Filtered (multiple results) | |
|---|---|
Workflow | Result |
Select the desired Call | 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 |
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 | |