Introduction
Endpoint
Action name | get industries |
|---|---|
HTTP path | /api/industries |
HTTP method | POST |
Attributes of the HTTP request
token | string | required | A security token provided from Authentication endpoint. |
|---|
Attributes of the HTTP response
Success response | |||
|---|---|---|---|
JSON array of objects containing: | |||
id | int | required | An unique identifier of the industry. |
name | string | required | A industry’s name. |
Failed response | |||
error | string | required | It contains a reason for the failed request. |
Examples
HTTP Request |
# HTTP POST
# /api/industries
# 'Content-Type': 'application/json'
# 'Accept': 'application/json'
{
"token": "some long string value"
}
|
Successful HTTP Response |
# HTTP 200 status code
# 'Content-Type': 'application/json'
[
{
"id": 1,
"name": "Industry1"
},
{
"id": 2,
"name": "Industry2"
}
]
|
Failed HTTP Response |
# HTTP 200 status code
# 'Content-Type': 'application/json'
{
"error": "API User is not existing or deactivated."
}
|