PUT api/terminal/{id}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id | globally unique identifier |
Required |
Body Parameters
TerminalName | Description | Type | Additional information |
---|---|---|---|
ID | integer |
None. |
|
G_UID | Collection of byte |
None. |
|
Guid |
unique identifier |
globally unique identifier |
None. |
Name | string |
String length: inclusive between 0 and 64 |
|
Description | string |
String length: inclusive between 0 and 64 |
|
TerminalNumber | integer |
None. |
|
POSKey | Collection of byte |
None. |
|
LinkedPOSKey |
unique identifier |
globally unique identifier |
None. |
Location | integer |
None. |
|
ZoneID | integer |
None. |
|
CurrentMachineID | integer |
None. |
|
StoreID | integer |
None. |
|
Deleted | boolean |
None. |
|
Updated | date |
None. |
|
CurrentMachine |
Provides info about the current machine assigned to this terminal |
Machine |
Relation. This field may not always be loaded or used for updates. |
CurrentLane |
Provides status info about the current machine assigned to this terminal |
Lane |
Relation. This field may not always be loaded or used for updates. |
Request Formats
application/json, text/json
Sample:
{ "id": 1, "g_UID": "yOyYLQxdGUOB812f2Plriw==", "guid": "2d98ecc8-5d0c-4319-81f3-5d9fd8f96b8b", "name": "sample string 3", "description": "sample string 4", "terminalNumber": 1, "posKey": "++DlRw2xr0mk7zaeyP6KRw==", "linkedPOSKey": "47e5e0fb-b10d-49af-a4ef-369ec8fe8a47", "location": 1, "zoneID": 1, "currentMachineID": 1, "storeID": 1, "deleted": true, "updated": "2025-08-02T23:27:00.0814755", "currentMachine": { "$id": "2", "id": 1, "storeScaleID": 2, "scaleID": "sample string 3", "scaleName": "sample string 4", "description": "sample string 5", "scaleLocation": 1, "zoneID": 1, "storeID": 1, "scaleType": 1, "checkFrequency": 1, "testWeight": 1.1, "terminalG_UID": "LZyb59FeXk6O6K56DUrA7w==", "terminalGuid": "e79b9c2d-5ed1-4e5e-8ee8-ae7a0d4ac0ef", "storeName": "sample string 6", "zoneName": "sample string 7", "scaleLocationName": "sample string 8", "settingsZone": { "$id": "3", "id": 1, "storeID": 2, "name": "sample string 3", "machines": [ { "$ref": "2" }, { "$ref": "2" } ] }, "terminal": { "$ref": "1" } }, "currentLane": { "$id": "4", "identifier": "EY3qxu7WHUyI0WmHbJxBvQ==", "identifierGuid": "c6ea8d11-d6ee-4c1d-88d1-69876c9c41bd", "name": "sample string 1", "storeID": 2, "machineID": 3, "scaleID": "sample string 4", "lastPingLocal": "2025-08-02T23:27:00.0814755", "lastSaleLocal": "2025-08-02T23:27:00.0814755", "status": 0, "statusDate": "2025-08-02T23:27:00.0814755", "statusName": "None", "storeName": "sample string 5", "machineName": "sample string 6", "zoneName": "sample string 7" } }
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.