API: Document Category
- Shaon Karim (Unlicensed)
- Maciej Szewczyk
Owned by Shaon Karim (Unlicensed)
GET /api/v3/document-category
Request parameter:
No Request parameter
Filtering parameters:
| Parameter | Type | IN | Example | Description |
|---|---|---|---|---|
| module | integer | QUERY | filters[module]=1 | Filtering by module id = value (1=Contact) |
Response data:
Metadata: object.
| Parameter | Type | Description |
|---|---|---|
| count | int | Number of all results marching criteria |
| status | int | Response status (same as in http code) |
Data: object.data[array]
| Parameter | Type | Description |
|---|---|---|
| id | integer | Contact id |
| sort | integer | Ordering column |
| name | string | Name in DE language |
| name_e | string | Name in EN language |
| name_f | string | Name in FR language |
| name_i | string | Name in IT language |
| module | array | Related module |
| module[id] | integer | Contact id |
| module[name] | string | Module name in DE language |
| module[name_e] | string | Module name in EN language |
| module[name_f] | string | Module name in FR language |
| module[name_i] | string | Module name in IT language |
Response (Error):
| Parameter | Type | Description |
|---|---|---|
| code | integer | An error code |
| error | string | A message containing some information about the error |
| errors | array | List of errors devided by field in associative array {field_name:error message} |
API: _ Default behavior #Authentication defaults
Request
curl -X GET https://public.brokerstar.biz/api/v3/document-category --header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpYXQiOjE2NTg[...]cm5hbWUiOiJkZW1vLWRlIn0.VTVp[...]cqIg'
Response (Success)
200 OK
{
"count": "10",
"data": [
{
"sort": 10,
"name_e": "Mandate",
"name_f": "Mandat",
"name_i": "Mandato",
"module": {
"name_e": "Address book",
"name_f": "Carnet d'adresses",
"name_i": "Indirizzario",
"id": 1,
"name": "Contacts (Adressbuch)"
},
"id": 1,
"name": "Mandat"
},
[...]
],
"status": 200
}
Or one of
- API: _ Default behavior #Authentication defaults
- API: _ Default behavior #List defaults