GET vehicle/get?VehicleLP={VehicleLP}&Token={Token}

Retrieve vehicle data for specific vehicle. Application privilege "View" for licensed agenda "Vehicles" required. Data may also be restricted by record permission "View" of agenda "Vehicles"

Request Information

Authorization

  • Authorization by token required

Availability

  • Method can be used

URI Parameters

NameDescriptionTypeAdditional information
VehicleLP

License plate of the vehicle

 string

Required

String length: inclusive between 0 and 100
Token

The action is authorized by this token. Token should generated by calling action "POST login". Expiration time of each token is 20 seconds

 globally unique identifier

Required

Body Parameters

None.

Response Information

Response Codes

Http CodeError NumberDescription
200 request succesfully done 0 Successfully done
400 bad request 1002 Entry parameter missing or parameter bindigs failed
401 unauthorized 1000 Token {0} not found
401 unauthorized 1001 Token {0} already expired
401 unauthorized 1006 Ip filter violated for ip client address [{0}]
401 unauthorized 1007 Ip filter [{0}] parsing failed
401 unauthorized 1008 Request rate policy violated for [{0}]
403 server refuses fo fulfill the request 1101 Application privilege View for licensed agenda Vehicles violated for vehicle [{0}]
404 required resource does not exist on the server 1100 Vehicle [{0}] not found
415 unsupported Media Type The request entity has a media type which the server or resource does not support. Only application/json and application/xml are supported
500 internal error Server exception description

Resource Description

VehicleGetResp
NameDescriptionTypeAdditional information
VehicleLP

License plate of the vehicle

 string

None.
Type

Type of the vehicle. {Default value is 0 and the meaning is: 0 - personal; 1 - truck; 2 - motorcycle, 3 - trailer, 4 - other }

 integer

None.
Model

Model name of the vehicle

 string

None.
OrganizationStructure

The involvement of the vehicle in the organization structure. This is mandatory parameter for non-cloud solution. Do not use for cloud solution.

 string

None.
IdentifierEntryCode

Entry code of the vehicle

 string

None.
IdentifierCard1

First card identifier of the vehicle

 string

None.
IdentifierCard2

Another card identifier of the vehicle

 string

None.
Desc

The description of the vehicle

 string

None.
Lock

The access lock flag of the vehicle identifiers {The meaning is: 0 - at least one identifier of the vehicle is not locked; 1 - all identifiers of the vehicle are locked }

 integer

None.
Identifiers

A list of all vehicle identifiers

 Collection of Identifier

None.
TimeLastChange

The last change time of the data record. Can be used to check manual modification of data record

 date

None.
UdsCollection

The collection of available user defined columns of the agenda in the system:


Any user defined columns have not been found

 Collection of UdsOut

None.

Response Formats

application/json

Sample: 
{"VehicleLP":"1AB2345","Type":0,"Model":"Škoda Superb","OrganizationStructure":"Structure - Company - Office 1","IdentifierEntryCode":"693723","IdentifierCard1":"A1B2C3D4E5","IdentifierCard2":"B1C2D3E4F5","Desc":null,"Lock":0,"Identifiers":[{"InternalNrLong":"A1B2C3D4E5","Type":0,"Status":0,"Holder":null,"HolderDefault":0,"TimeLastChange":"\/Date(-62135596800000)\/","RegistrationNr":null,"Technology":0,"Lock":0,"Security":0,"ValidFrom":null,"ValidTo":null,"UdsCollection":null},{"InternalNrLong":"B1C2D3E4F5","Type":0,"Status":0,"Holder":null,"HolderDefault":0,"TimeLastChange":"\/Date(-62135596800000)\/","RegistrationNr":null,"Technology":0,"Lock":0,"Security":0,"ValidFrom":null,"ValidTo":null,"UdsCollection":null}],"TimeLastChange":"\/Date(1761748056078)\/","UdsCollection":[{"SystemName":"a3s1","Name":"TestUDS_1","Value":"text in column","IsExtern":0,"DataType":"nvarchar(100)"},{"SystemName":"a3s2","Name":"TestUDS_2","Value":"2022-01-26T05:55:22","IsExtern":0,"DataType":"datetime"},{"SystemName":"a3s3","Name":"TestUDS_3","Value":"1","IsExtern":0,"DataType":"bit"}]}

application/xml

Sample: 

<Response>
  <VehicleLP>1AB2345</VehicleLP>
  <Type>0</Type>
  <Model>Škoda Superb</Model>
  <OrganizationStructure>Structure - Company - Office 1</OrganizationStructure>
  <Lock>0</Lock>
  <Identifiers>
    <Identifier>
      <InternalNrLong>A1B2C3D4E5</InternalNrLong>
      <Type>0</Type>
      <Status>0</Status>
      <HolderDefault>0</HolderDefault>
      <TimeLastChange>0001-01-01T00:00:00</TimeLastChange>
      <Technology>0</Technology>
      <Lock>0</Lock>
      <Security>0</Security>
    </Identifier>
    <Identifier>
      <InternalNrLong>B1C2D3E4F5</InternalNrLong>
      <Type>0</Type>
      <Status>0</Status>
      <HolderDefault>0</HolderDefault>
      <TimeLastChange>0001-01-01T00:00:00</TimeLastChange>
      <Technology>0</Technology>
      <Lock>0</Lock>
      <Security>0</Security>
    </Identifier>
  </Identifiers>
  <TimeLastChange>2025-10-29T14:27:36.0783975Z</TimeLastChange>
  <UdsCollection>
    <UdsOut>
      <SystemName>a3s1</SystemName>
      <Name>TestUDS_1</Name>
      <Value>text in column</Value>
      <IsExtern>0</IsExtern>
      <DataType>nvarchar(100)</DataType>
    </UdsOut>
    <UdsOut>
      <SystemName>a3s2</SystemName>
      <Name>TestUDS_2</Name>
      <Value>2022-01-26T05:55:22</Value>
      <IsExtern>0</IsExtern>
      <DataType>datetime</DataType>
    </UdsOut>
    <UdsOut>
      <SystemName>a3s3</SystemName>
      <Name>TestUDS_3</Name>
      <Value>1</Value>
      <IsExtern>0</IsExtern>
      <DataType>bit</DataType>
    </UdsOut>
  </UdsCollection>
</Response>