ATK PRO / API REFERENCE
Machine API (1.0)
This is the ATK Pro Machine API reference for creating, updating, deleting, and listing machines.
The Machine guide is organised into separate Create new, Update, List, and Delete sections.
Create new machine
Use POST /Machine/UpsertAsync to create a machine. Create and Update are documented separately so developers can follow the correct workflow for each task.
Update machine
Use POST /Machine/UpsertAsync with the existing machineID to update a machine.
List machines
Use GET /Machine/GetByUserID to retrieve Machine data associated with a user identifier.
How to identify the correct machine
A machine can contain several recognisable identifiers, including its Machine ID, registration number, number plate, VIN, engine number, and serial number. The current Machine API contract uses machineID to select an existing record for updates and userID to retrieve the published machine list. companyID links the machine to a company; the endpoint expects the numeric ID, not the company name.
Important: the Machine endpoints shown here do not publish a general search operation for company name, registration number, number plate, VIN, engine number, or serial number. Do not implement those fields as lookup filters unless a separate ATKPRO search endpoint is provided.
Delete machine
Use POST /Admin/DeleteMasterMethod with tableName=Machines, primaryKeyName=MachineID, and the machine identifier supplied as primaryKeyID.
Create new
Create a Machine record by supplying the available machine details. Use a new or empty machineID value for the create workflow.
Create new machine
/Machine/UpsertAsyncCreates or updates a Machine record. For an update, `machineID` is the record selector. Fields such as `registrationNR`, `numberPlate`, `vINNumber`, `engineNumber`, and `serialNumber` are useful business identifiers stored on the record, but this published operation does not use them as search filters.
Query parameters
machineID | integer <int32> Machine identifier. |
name | string Machine name. |
currentHourKm | number <double> Current hour or kilometer reading. |
companyID | integer <int32> Company identifier. |
serviceFrequency | integer <int32> Service frequency value. |
serviceTimeFrameMonths | string Service time frame expressed in months. |
machineGroupID | integer <int32> Machine group identifier. |
usageCalculation | integer <int32> (UsageCalculation) Enum: 0 1 2Usage calculation enum value. The source contract publishes numeric values without labels. |
machineType | integer <int32> (MachineType) Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13Machine type enum value. The source contract publishes numeric values without labels. |
normalConsumption | number <double> Normal consumption value. |
vINNumber | string VIN number. Parameter casing is preserved from the source contract. |
engineNumber | string Engine number. |
manYear | integer <int32> Manufacturing year. |
color | string Machine colour. |
licenceDiskExpiryDate | string <date-time> Licence disk expiry date. |
registrationNR | string Registration number. |
fuelTankCapacity | number <double> Fuel tank capacity. |
dryRate | number <double> Dry rate value. |
make | string Machine manufacturer or make. |
serialNumber | string Machine serial number. |
modelNumber | string Machine model number. |
description | string Machine description. |
numberPlate | string Vehicle number plate. |
driverOperatorName | string Driver or operator name. |
dateAquired | string <date-time> Date acquired. The parameter spelling is preserved from the source contract. |
machineUnitOfMeasure | integer <int32> (MachineUnitOfMeasure) Enum: 0 1 2 3Machine unit-of-measure enum value. The source contract publishes numeric values without labels. |
warrantyExpiryHrKm | number <double> Warranty expiry reading in hours or kilometres. |
warrantyMonths | integer <int32> Warranty duration in months. |
bothService | boolean Boolean service flag. |
warrantyExpiryMonths | integer <int32> Warranty expiry value in months. |
primaryOperatorUserID | integer <int32> Primary operator user identifier. |
secondaryOperatorUserID | integer <int32> Secondary operator user identifier. |
tertiaryOperatorUserID | integer <int32> Tertiary operator user identifier. |
mechanicUserID | integer <int32> Mechanic user identifier. |
Example request
curl --request POST --url 'http://dev.bedamsure.com/Machine/UpsertAsync?name=Excavator%201&companyID=1'Update machine
/Machine/UpsertAsyncCreates or updates a Machine record. For an update, `machineID` is the record selector. Fields such as `registrationNR`, `numberPlate`, `vINNumber`, `engineNumber`, and `serialNumber` are useful business identifiers stored on the record, but this published operation does not use them as search filters.
Supply the existing machineID to update that machine.
Query parameters
machineID | integer <int32> Machine identifier. |
name | string Machine name. |
currentHourKm | number <double> Current hour or kilometer reading. |
companyID | integer <int32> Company identifier. |
serviceFrequency | integer <int32> Service frequency value. |
serviceTimeFrameMonths | string Service time frame expressed in months. |
machineGroupID | integer <int32> Machine group identifier. |
usageCalculation | integer <int32> (UsageCalculation) Enum: 0 1 2Usage calculation enum value. The source contract publishes numeric values without labels. |
machineType | integer <int32> (MachineType) Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13Machine type enum value. The source contract publishes numeric values without labels. |
normalConsumption | number <double> Normal consumption value. |
vINNumber | string VIN number. Parameter casing is preserved from the source contract. |
engineNumber | string Engine number. |
manYear | integer <int32> Manufacturing year. |
color | string Machine colour. |
licenceDiskExpiryDate | string <date-time> Licence disk expiry date. |
registrationNR | string Registration number. |
fuelTankCapacity | number <double> Fuel tank capacity. |
dryRate | number <double> Dry rate value. |
make | string Machine manufacturer or make. |
serialNumber | string Machine serial number. |
modelNumber | string Machine model number. |
description | string Machine description. |
numberPlate | string Vehicle number plate. |
driverOperatorName | string Driver or operator name. |
dateAquired | string <date-time> Date acquired. The parameter spelling is preserved from the source contract. |
machineUnitOfMeasure | integer <int32> (MachineUnitOfMeasure) Enum: 0 1 2 3Machine unit-of-measure enum value. The source contract publishes numeric values without labels. |
warrantyExpiryHrKm | number <double> Warranty expiry reading in hours or kilometres. |
warrantyMonths | integer <int32> Warranty duration in months. |
bothService | boolean Boolean service flag. |
warrantyExpiryMonths | integer <int32> Warranty expiry value in months. |
primaryOperatorUserID | integer <int32> Primary operator user identifier. |
secondaryOperatorUserID | integer <int32> Secondary operator user identifier. |
tertiaryOperatorUserID | integer <int32> Tertiary operator user identifier. |
mechanicUserID | integer <int32> Mechanic user identifier. |
Example request
curl --request POST --url 'http://dev.bedamsure.com/Machine/UpsertAsync?machineID=123&name=Excavator%201&companyID=1'List machines
/Machine/GetByUserIDRetrieves Machine data associated with a supplied user identifier. The source contract does not describe the response structure.
Query parameters
userID | integer <int32> User identifier used to retrieve associated Machine data. |
Example request
curl --request GET --url 'http://dev.bedamsure.com/Machine/GetByUserID?userID=123'Delete machine
/Admin/DeleteMasterMethodDeletes a Machine record through ATKPRO’s shared delete method. Set `tableName` to `Machines`, set `primaryKeyName` to `MachineID`, and pass the machine identifier as `primaryKeyID`.
Query parameters
primaryKeyID | integer <int32> Machine identifier to delete. |
tableName | string Use `Machines` for this operation. |
primaryKeyName | string Use `MachineID` for this operation. |
Example request
curl --request POST --url 'http://dev.bedamsure.com/Admin/DeleteMasterMethod?primaryKeyID=123&tableName=Machines&primaryKeyName=MachineID'