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": "gpmia/3tK0GTW1pZwpuwZw==", "guid": "6ba29982-edfd-412b-935b-5a59c29bb067", "name": "sample string 3", "description": "sample string 4", "terminalNumber": 1, "posKey": "KqLqdtMe7UWNStT30WXWnw==", "linkedPOSKey": "76eaa22a-1ed3-45ed-8d4a-d4f7d165d69f", "location": 1, "zoneID": 1, "currentMachineID": 1, "storeID": 1, "deleted": true, "updated": "2025-08-02T23:17:04.1606347", "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": "dk5kkJ4DKk27Zi8+DZYFHg==", "terminalGuid": "90644e76-039e-4d2a-bb66-2f3e0d96051e", "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": "1e79nLTQ6U6BW8MAjaHxyg==", "identifierGuid": "9cfdeed5-d0b4-4ee9-815b-c3008da1f1ca", "name": "sample string 1", "storeID": 2, "machineID": 3, "scaleID": "sample string 4", "lastPingLocal": "2025-08-02T23:17:04.1606347", "lastSaleLocal": "2025-08-02T23:17:04.1606347", "status": 0, "statusDate": "2025-08-02T23:17:04.1606347", "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 "�[�o� 5 xl/workbook.xml � (� ����0��&�C��H�R8q���{)[�@����[J ��mgv�ۡ��co�>z2�� �1����%hNցI;a�f1I�"Vš����DRŅx�XT��\�+�Vp�$@�ӊ�L�ѥ�S��L�Vw1YC�7E3l�� ������܇�1�Jã�*���Pq�❽�(�~�_PK "�[���� � [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 "�[G� '' ' _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="R099429f7918842e5" /></Relationships>PK "�[��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 "�[b���� P xl/_rels/workbook.xml.rels � (� ��Kn�0@�b;q~��l��r����٦-g�G�jQ�5Rݰ���I3�����4�r~���"ˁ�V����C��fO#�8��0{W��@�0�9�Bӄ>�3��Q�Mb�z>�8aO���Lv����Uj�h�y"� �W�N^`t=�~J�_C�E*�'���H�D]��(������e$����'26�UUa+K���]e4:����K�Ni9Q����Y�^���o�b�PK "�[Ѓ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 "�[���*� ~ 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- "�[�o� 5 xl/workbook.xmlPK- "�[���� � � [Content_Types].xmlPK- "�[G� '' ' T _rels/.relsPK- "�[��T�� � xl/worksheets/sheet1.xmlPK- "�[b���� P � xl/_rels/workbook.xml.relsPK- "�[Ѓc'2 E � xl/styles.xmlPK- "�[���*� ~ i xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
PK "�[ �!.� 5 xl/workbook.xml � (� ����0D{$���`�\DN�4��K�!V�C�Q�|r(���vfg����t�z�sW�6�3�������]c��0J�b�id���� u`��1a{�h�J��B���C�E�_P ���~G��=$~���֝L�M��]̊hPX� P2;7Q�%.��p���%MD&bQgtco0����PK "�[���� � [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 "�[D5-�' ' _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="R259c1bcc5a594ffc" /></Relationships>PK "�[��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 "�[�<�~� P xl/_rels/workbook.xml.rels � (� ��Kn� @��f_�pH'�n�Ms�m��m��E��+�R�H]t��h~OO��|���ߦ��`L�w-,�:�����>H��U.�B"eť��ÆҤ{�T�|@W:��I�Ǝ�O�C����9n��x ���v����yB�� �WO�G�@�*v�[�)%z ��P�<��g��H#��BH �nj)_FL�^��L��%W(�\7�s��*ӫ��9�r�Ӽ<S��Fk�Fn���ћ��}PK "�[Ѓ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 "�[���*� ~ 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- "�[ �!.� 5 xl/workbook.xmlPK- "�[���� � [Content_Types].xmlPK- "�[D5-�' ' V _rels/.relsPK- "�[��T�� � xl/worksheets/sheet1.xmlPK- "�[�<�~� P � xl/_rels/workbook.xml.relsPK- "�[Ѓc'2 E � xl/styles.xmlPK- "�[���*� ~ l xl/sharedStrings.xmlPK � �