GET api/v{version}/Orders/GetById/{id}?key={key}
Returns an order with the spcecified id
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
key |
The API key |
string |
Required |
id |
The id of the order |
string |
Required |
version | string |
None. |
Body Parameters
None.
Response Information
Resource Description
OrderOutDTOName | Description | Type | Additional information |
---|---|---|---|
AlarmEndTime | boolean |
None. |
|
AssetID | integer |
None. |
|
AssetIn | boolean |
None. |
|
AssetName | string |
None. |
|
AssetOut | boolean |
None. |
|
AssetReady | boolean |
None. |
|
AssetWait | boolean |
None. |
|
CallWhenReady | boolean |
None. |
|
Completed | boolean |
None. |
|
CustomerID | integer |
None. |
|
CustomerNotes |
Customer's remarks. |
string |
None. |
CustomerWaiting | boolean |
None. |
|
DateCreated | date |
None. |
|
EditByFirm | boolean |
None. |
|
LocationDepartmentID | integer |
None. |
|
Mileage | integer |
None. |
|
OrderCategory |
The mobility service of the order. |
OrderCategory |
None. |
OrderID |
ID of the order. |
string |
None. |
OrderType | OrderType |
None. |
|
PasserBy | boolean |
None. |
|
PlanCodes |
All tasks scheduled for the order. |
Collection of PlanCodeOutDTO |
None. |
PointOfTimeAssetIn | date |
None. |
|
PointOfTimeAssetOut | date |
None. |
|
Price | decimal number |
None. |
|
Reference |
Reference for the order. |
string |
None. |
ReplacementCar | boolean |
None. |
|
RushOrder | boolean |
None. |
|
Status |
Status of the order. |
OrderStatus |
None. |
UserInitials | string |
None. |
|
WorkcardNr | string |
None. |
|
WorkNotes |
Internal remarks from the workshop. |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "AlarmEndTime": true, "AssetID": 1, "AssetIn": true, "AssetName": "sample string 3", "AssetOut": true, "AssetReady": true, "AssetWait": true, "CallWhenReady": true, "Completed": true, "CustomerID": 1, "CustomerNotes": "sample string 9", "CustomerWaiting": true, "DateCreated": "2025-07-15T04:17:17.4608844+02:00", "EditByFirm": true, "LocationDepartmentID": 1, "Mileage": 13, "OrderCategory": "None", "OrderID": "sample string 14", "OrderType": "NormalOrder", "PasserBy": true, "PlanCodes": [ { "Code": "sample string 1", "Color": "sample string 2", "Description": "sample string 3", "ExternalID": "sample string 4", "NumberOfHours": 1.0, "OABCategoryId": 1, "PlanCodeID": 1, "Sequence": 1, "SpecializationID": 1 }, { "Code": "sample string 1", "Color": "sample string 2", "Description": "sample string 3", "ExternalID": "sample string 4", "NumberOfHours": 1.0, "OABCategoryId": 1, "PlanCodeID": 1, "Sequence": 1, "SpecializationID": 1 } ], "PointOfTimeAssetIn": "2025-07-15T04:17:17.4608844+02:00", "PointOfTimeAssetOut": "2025-07-15T04:17:17.4608844+02:00", "Price": 16.0, "Reference": "sample string 17", "ReplacementCar": true, "RushOrder": true, "Status": "Requested", "UserInitials": "sample string 20", "WorkcardNr": "sample string 21", "WorkNotes": "sample string 22" }