API version 1 Common list
1. List Common Lists by list type (api1/commonlists)
This method will answer with a collection of iinsight's common lists (common list oriented data). The collection wil be in JSON format.
The results would be paginated, having a maximum of 100 records per page and can be filter by name and list type name. An empty collection and a status code 200 response, means that there is no records in the specified page.
URL
| Server | URL | HTTP type |
|---|---|---|
| UAT | https://api-usa-uat.iinsightonline.com/api1/commonlists | GET |
| PRODUCTION | https://api-usa.iinsightonline.com/api1/commonlists | GET |
Authorization
| Parameter | Value | Mandatory |
|---|---|---|
| Type | Bearer Token | Yes |
| Token | The token is generated using the /auth/login method | Yes |
Query Params
| Parameter | Value | Mandatory |
|---|---|---|
| list_type_name | Common list type name. Options: additional_referral_particulars, additional_services, age, appointments_categories, appointments_status, appointments_titles, biller, cancellation_reason, case_status, cost_details, cause, claim_type, client_current_work_status, client_status_at_referral, closure_codes, closure_status, delay_to_ommencement, department, diagnosed_injury, document_status, document_titles, emergencies, employer_segment, employment_status, ethnicity, gender, interpreter_required, jobtitle, language, location_status, nature_injury, outcome, position, prior_status, progress_codes, reason_for_referral_personal, reason_for_referral_work, reason_for_referral, referral_category, referral_source, referral_type, revenue_centre, revenue_centres, risk_category, suitable_employment_goal, task_status, task_titles, teams, title, tax. | Yes |
| search | Search by common list name. (i.e.: example) | No |
| limit | The limit amount of items. (i.e.: 1) | No |
| page | The page number of the paginated results. (i.e.: 1) | No |
| sort_type | Sort column type. Options: asc, desc | No |
Response
[
{
"id": "1",
"name": "xxxx"
},
{
"id": "2",
"name": "xxxx xx, xxx"
},
]