Companies (CRD) API Guide
Get Companies - Successfully
GET /v1/companies
Query Parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
searchCriteria |
Array[String] |
true |
|
page |
Integer |
true |
|
size |
Integer |
true |
|
sort |
Array[String] |
true |
Example request
$ curl 'http://localhost:8080/v1/companies' -i -X GETExample response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 250
{
"objects" : [ {
"uicCode" : 5,
"name" : "Beste Company",
"url" : null,
"startValidity" : null,
"endValidity" : null,
"shortName" : "ShortName",
"freeText" : null,
"countryCodeIso" : "CH"
} ],
"totalCount" : 1
}Get Company - Successfully
GET /v1/companies/5
Path Variables
| Path Variable | Type | Optional | Description |
|---|---|---|---|
uic |
Integer |
false |
Example request
$ curl 'http://localhost:8080/v1/companies/5' -i -X GETExample response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 190
{
"uicCode" : 5,
"name" : "Beste Company",
"url" : null,
"startValidity" : null,
"endValidity" : null,
"shortName" : "ShortName",
"freeText" : null,
"countryCodeIso" : "CH"
}