GET api/terminals?Name={Name}&Skip={Skip}&Take={Take}&StoreID={StoreID}&ZoneID={ZoneID}&LocationID={LocationID}&IncludeDeleted={IncludeDeleted}&Relations={Relations}&MachineAssigned={MachineAssigned}&TerminalNumber={TerminalNumber}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
Name |
Filter by terminal name |
string |
None. |
Skip |
How many records to skip over |
integer |
None. |
Take |
Max number of records that should be returned in the result |
integer |
None. |
StoreID |
Only return terminals from this store; leave null for all stores |
integer |
None. |
ZoneID |
Only return terminals from this zone; leave null for all zones |
integer |
None. |
LocationID |
Only return terminals from this lane location; leave null for all locations |
integer |
None. |
IncludeDeleted |
True if you would like soft-deleted records to be returned. Defaults to false |
boolean |
None. |
Relations |
Load relational fields such as currentMachine |
boolean |
None. |
MachineAssigned |
True to only load records that currently have a machine assinged; false to load only unassigned terminals; null for both |
boolean |
None. |
TerminalNumber |
If provided only terminals with this terminal number will be returned |
integer |
None. |
Body Parameters
None.
Response Information
Resource Description
PageListOfTerminalName | Description | Type | Additional information |
---|---|---|---|
Type | string |
None. |
|
List | Collection of Terminal |
None. |
|
Skip |
Number of records to skip over |
integer |
None. |
Take |
Number of records to take |
integer |
None. |
TotalCount | integer |
Relation. This field may not always be loaded or used for updates. |
Response Formats
application/json, text/json
{ "type": "Terminal", "list": [ { "$id": "2", "id": 1, "g_UID": "XqRHX/1NH0CYon8Ivxd0JQ==", "guid": "5f47a45e-4dfd-401f-98a2-7f08bf177425", "name": "sample string 3", "description": "sample string 4", "terminalNumber": 1, "posKey": "JMoqTmeB3k+fkiZSFScecg==", "linkedPOSKey": "4e2aca24-8167-4fde-9f92-265215271e72", "location": 1, "zoneID": 1, "currentMachineID": 1, "storeID": 1, "deleted": true, "updated": "2025-10-04T23:59:29.175944", "currentMachine": { "$id": "3", "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": "FjV4qCjCSk2ePKG1hAgC/Q==", "terminalGuid": "a8783516-c228-4d4a-9e3c-a1b5840802fd", "storeName": "sample string 6", "zoneName": "sample string 7", "scaleLocationName": "sample string 8", "settingsZone": { "$id": "4", "id": 1, "storeID": 2, "name": "sample string 3", "machines": [ { "$ref": "3" }, { "$ref": "3" } ] }, "terminal": { "$ref": "2" } }, "currentLane": { "$id": "5", "identifier": "nTtFxqB3lUKXhQMOt/stQg==", "identifierGuid": "c6453b9d-77a0-4295-9785-030eb7fb2d42", "name": "sample string 1", "storeID": 2, "machineID": 3, "scaleID": "sample string 4", "lastPingLocal": "2025-10-04T23:59:29.175944", "lastSaleLocal": "2025-10-04T23:59:29.175944", "status": 0, "statusDate": "2025-10-04T23:59:29.175944", "statusName": "None", "storeName": "sample string 5", "machineName": "sample string 6", "zoneName": "sample string 7" } }, { "$ref": "2" } ], "skip": 1, "take": 1, "totalCount": 1 }
application/xml
Sample not available.
text/xml
Sample not available.
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
PK n�D[��)D� 5 xl/workbook.xml � (� ����0D�&�C��� )��x��}-�m�-ik��-H�yۙ�};|��Zۓ��/]Eecɘ5����]g���{1�uJ`c�[� ,M�s8@P�x�FOW�?,?:��KĠ��AZ���C�����l���o�/��bQĀƊ6��Ź�=S�J�{��h�H�gV�Ev�;{�q����PK n�D[���� � [Content_Types].xml � (� ���J�0�_��*M�D��V�*��d� �d�k��<�H���V���= ��|�o��|����������+�����7l���e۶~=E�"�zlXO�@Ճ��C�3]HNR~���R��uU�<���������a��36��b7םQ �1Z�$�8z�R��3 tP��-c�� g����_M��Of���~O�s�T���� ����P<�D��e=1Z��a2�b ��%#H'�2}���e�B)��~j/F�t��PK n�D[�ܶ' ' _rels/.rels � (� <?xml version="1.0" encoding="utf-8"?><Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships"><Relationship Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="xl/workbook.xml" Id="R4ea27ce4dd974cbd" /></Relationships>PK n�D[��T�� xl/worksheets/sheet1.xml � (� ��M��0����{���Xm���[�C{v�k1�l'�ϯ1,M�(j/`{�w����?��\��R�$�@��e,��5����m^m+�����u�C�V�P�F�$zk�Q���9"�4�{]�����Ȉ�;_ʶ�d��_rٓ�T7�R\���k鳏�M���@!@e�R�j ƛ���u�|���V�K(�݀Z4�ܹz�*�u�I,h*���J���@��d��fِ�2ob����l�V��(yO2��,��|C����a/f�l�X����|�}�Ǻd�%��c��-:B"�mBqg8��M]-�s��������ճ_�0�k�'|)q�.�v&>� rK|Y�د���8��d!���x��ӕ�}�&��߉;��?���&���I¼h� 3Y^w�PK n�D[} ��� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�NMpP�nذ-��������.г��H\�H�J,�t5��ӓf>�?�۷id/��]��ȡo�5pL�F�v���hR���0G�W\l�Oi��<bO�������a2)�����鈗BT<,p�d��L�!zk��lj\��_}8Ğ(ۛ�Qj��9�"S�=� �Ti�E�y��^�����b:����ֈU�QֺU��Uez�}J!_z�,/�$ +K#����������PK n�D[Ѓc'2 E xl/styles.xml � (� �S�j�0��&0���0�^�]v��:��d;��H��Kj�vG�Mz�zOHr�iB8v �F��WEG�?s�Oh�lff�uZМ���ށh�R���6�'��2��������ɳ�UŦ`<Қo���x���8��K�6BC ^�کĖ��B���n��f8����9� ����CUk��#��U�ub��WUB;��k���&� AR>��� ��im��ΑF���YO��%�}� ��LJ\in�,���9oy}��y.�$��6��ųNJ�c��T��rĘ)փBR淶�E3ʟ�\��q��PK n�D[���*� ~ xl/sharedStrings.xml � (� ePMK�0�+!w��i���z� XO"�g6y�y���כUa{��)�_��$r+�Q��6��J�t�7R썏�\����%�lE���<�jMv�`H� 0+1��AӔ��4p���(�t0��qF��3�����.�� J�u����{t�����M�\g�+o��ߖ�)84~��CPM�,�H= BrV��o^w߮5hH��=xR��QO���R���p�� PK- n�D[��)D� 5 xl/workbook.xmlPK- n�D[���� � � [Content_Types].xmlPK- n�D[�ܶ' ' U _rels/.relsPK- n�D[��T�� � xl/worksheets/sheet1.xmlPK- n�D[} ��� P � xl/_rels/workbook.xml.relsPK- n�D[Ѓc'2 E � xl/styles.xmlPK- n�D[���*� ~ j xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
PK n�D[.��B� 5 xl/workbook.xml � (� ����0D�H��C *��)үa�-�!���p�t�vfg�N>�qc:�Q���+��f��Z�0��k�SF�^̴���2�[��Eg氇 ��BZO�?,oB�bP��R 5-�;B��S��g9k��$l ��T>ö�Y ZA Jf��4��er<:���<�@�^��7X����PK n�D[���� � [Content_Types].xml � (� ���J�0�_��*M�D��V�*��d� �d�k��<�H���V���= ��|�o��|����������+�����7l���e۶~=E�"�zlXO�@Ճ��C�3]HNR~���R��uU�<���������a��36��b7םQ �1Z�$�8z�R��3 tP��-c�� g����_M��Of���~O�s�T���� ����P<�D��e=1Z��a2�b ��%#H'�2}���e�B)��~j/F�t��PK n�D[s�t�' ' _rels/.rels � (� <?xml version="1.0" encoding="utf-8"?><Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships"><Relationship Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="xl/workbook.xml" Id="Ra36caab832de42a6" /></Relationships>PK n�D[��T�� xl/worksheets/sheet1.xml � (� ��M��0����{���Xm���[�C{v�k1�l'�ϯ1,M�(j/`{�w����?��\��R�$�@��e,��5����m^m+�����u�C�V�P�F�$zk�Q���9"�4�{]�����Ȉ�;_ʶ�d��_rٓ�T7�R\���k鳏�M���@!@e�R�j ƛ���u�|���V�K(�݀Z4�ܹz�*�u�I,h*���J���@��d��fِ�2ob����l�V��(yO2��,��|C����a/f�l�X����|�}�Ǻd�%��c��-:B"�mBqg8��M]-�s��������ճ_�0�k�'|)q�.�v&>� rK|Y�د���8��d!���x��ӕ�}�&��߉;��?���&���I¼h� 3Y^w�PK n�D[��!_� P xl/_rels/workbook.xml.rels � (� ��An� E��f_c\�(N6�t�����9[=R�P�J-���&+4��i������m���0Y�BU�@�(�Ofh�����v��Y�t#��$=1��1F��4� �Ф��~�1�~�N���ޗ��9���pv���zR�h�iA� �W�aD�@�[���U��@���]Y�*�Uk$��7S�<c����3��`�iŅ�5kn*3J��s�iӹSgj}��U�5KsZ�5z�/�_PK n�D[Ѓc'2 E xl/styles.xml � (� �S�j�0��&0���0�^�]v��:��d;��H��Kj�vG�Mz�zOHr�iB8v �F��WEG�?s�Oh�lff�uZМ���ށh�R���6�'��2��������ɳ�UŦ`<Қo���x���8��K�6BC ^�کĖ��B���n��f8����9� ����CUk��#��U�ub��WUB;��k���&� AR>��� ��im��ΑF���YO��%�}� ��LJ\in�,���9oy}��y.�$��6��ųNJ�c��T��rĘ)փBR淶�E3ʟ�\��q��PK n�D[���*� ~ xl/sharedStrings.xml � (� ePMK�0�+!w��i���z� XO"�g6y�y���כUa{��)�_��$r+�Q��6��J�t�7R썏�\����%�lE���<�jMv�`H� 0+1��AӔ��4p���(�t0��qF��3�����.�� J�u����{t�����M�\g�+o��ߖ�)84~��CPM�,�H= BrV��o^w߮5hH��=xR��QO���R���p�� PK- n�D[.��B� 5 xl/workbook.xmlPK- n�D[���� � [Content_Types].xmlPK- n�D[s�t�' ' V _rels/.relsPK- n�D[��T�� � xl/worksheets/sheet1.xmlPK- n�D[��!_� P � xl/_rels/workbook.xml.relsPK- n�D[Ѓc'2 E � xl/styles.xmlPK- n�D[���*� ~ m xl/sharedStrings.xmlPK � �