Transport Company API Guide
Get all Transport Companies - Successfully
GET /v1/transport-companies
Query Parameters
Parameter | Type | Optional | Description |
---|---|---|---|
searchCriteria |
Array[String] |
true |
|
statusChoices |
Array[String] |
true |
Must be one of ["OPERATOR","CURRENT","SUPERVISION","OPERATING_PART","LIQUIDATED","INACTIVE","FORMER_OPERATING_PART"] |
page |
Integer |
true |
|
size |
Integer |
true |
|
sort |
Array[String] |
true |
Example request
$ curl 'http://localhost:8080/v1/transport-companies' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 384
{
"objects" : [ {
"id" : 5,
"number" : "#0001",
"abbreviation" : null,
"description" : "Beste Company",
"businessRegisterName" : null,
"transportCompanyStatus" : null,
"businessRegisterNumber" : null,
"enterpriseId" : "enterprisige ID",
"ricsCode" : null,
"businessOrganisationNumbers" : null,
"comment" : null
} ],
"totalCount" : 1
}
Get single Transport Company - Successfully
GET /v1/transport-companies/5
Path Variables
Path Variable | Type | Optional | Description |
---|---|---|---|
id |
Integer |
false |
Example request
$ curl 'http://localhost:8080/v1/transport-companies/5' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 318
{
"id" : 5,
"number" : "#0001",
"abbreviation" : null,
"description" : "Beste Company",
"businessRegisterName" : null,
"transportCompanyStatus" : null,
"businessRegisterNumber" : null,
"enterpriseId" : "enterprisige ID",
"ricsCode" : null,
"businessOrganisationNumbers" : null,
"comment" : null
}