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": "atQgYUJ9ukuNZWtbr695eQ==", "guid": "6120d46a-7d42-4bba-8d65-6b5bafaf7979", "name": "sample string 3", "description": "sample string 4", "terminalNumber": 1, "posKey": "GJhh3hPTxUKO6lEgEpOkIA==", "linkedPOSKey": "de619818-d313-42c5-8eea-51201293a420", "location": 1, "zoneID": 1, "currentMachineID": 1, "storeID": 1, "deleted": true, "updated": "2025-06-14T06:44:57.5792846", "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": "ns/OIzKrok6gTx+GR0HerA==", "terminalGuid": "23cecf9e-ab32-4ea2-a04f-1f864741deac", "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": "cXMgfP+p/0y4Dr1e7os45w==", "identifierGuid": "7c207371-a9ff-4cff-b80e-bd5eee8b38e7", "name": "sample string 1", "storeID": 2, "machineID": 3, "scaleID": "sample string 4", "lastPingLocal": "2025-06-14T06:44:57.5792846", "lastSaleLocal": "2025-06-14T06:44:57.5792846", "status": 0, "statusDate": "2025-06-14T06:44:57.5792846", "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 �5�Z�� 5 xl/workbook.xml � (� ��;�0D�H����!�!CE�6EzK��َ��F �K�3;�vج��h=����+l ����ԵJ�.ڠZv����E��}/Z�u���<�FQF-N��� �������s��ӆ�\(��'B���)pvA.�^w5 �B�7���(.���{$8����-�2<�&k��s��IҤp�����PK �5�Z���� � [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 �5�Z�`L�' ' _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="R205ba69d5d8b44ef" /></Relationships>PK �5�Z��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 �5�Z�Y�A� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�i'BM��m����&vd�@�Ƃ#q�"A*�`��h~OO��|���ަ����� � F�l��9�5춛�*���s`iņ��G��4����l��O*��w|VxR���%n��x��?D���y"� �W�O�'����w�)~ y����L�RK�W���Ƣ�%0~7�/#�_��|!c�.j��(օi�2��d��O�^:-�5\�+�9U"������~PK �5�ZЃ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 �5�Z���*� ~ 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�Z�� 5 xl/workbook.xmlPK- �5�Z���� � [Content_Types].xmlPK- �5�Z�`L�' ' V _rels/.relsPK- �5�Z��T�� � xl/worksheets/sheet1.xmlPK- �5�Z�Y�A� P � xl/_rels/workbook.xml.relsPK- �5�ZЃc'2 E � xl/styles.xmlPK- �5�Z���*� ~ l xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
PK �5�Z9D�� 5 xl/workbook.xml � (� ����0��&�C��` )��x�བ�4П�5���H�yۙ��v�l��4fD5i_�!ؚ�P̟�w�8�B��E��Cg�[��e%q0� ������X�:`� ��V�bR��x@�.�f�d4�����"�)�`�ERH3 �X`%��78���2�����_�T��;���w�PK �5�Z���� � [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 �5�Z����' ' _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="R6a5913b26cd04214" /></Relationships>PK �5�Z��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 �5�Z=��A� P xl/_rels/workbook.xml.rels � (� ��An� E��f_�-��*$�n�Ms�c�Hۜ���W(j��H]t��?��4����f�6O�C��PW:��� N�� �m7{�T�7��H�%ؔ�{J��8�X�]�f�r�(}T҆�����Lr8/��7f����iF�� �W��"& L~�H����T ���=�-�� �k���Л��t�0�z]�BFc˅yff��Z�Tƪ��S yӥSj���b�5�;���2'z�/�_PK �5�ZЃ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 �5�Z���*� ~ 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�Z9D�� 5 xl/workbook.xmlPK- �5�Z���� � � [Content_Types].xmlPK- �5�Z����' ' U _rels/.relsPK- �5�Z��T�� � xl/worksheets/sheet1.xmlPK- �5�Z=��A� P � xl/_rels/workbook.xml.relsPK- �5�ZЃc'2 E � xl/styles.xmlPK- �5�Z���*� ~ j xl/sharedStrings.xmlPK � �