GET api/terminal/posKey/{posKey}?relations={relations}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| posKey | globally unique identifier |
Required |
|
| relations | boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
Terminal| Name | 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. |
Response Formats
application/json, text/json
Sample:
{
"id": 1,
"g_UID": "2+fHIBVc1kumpBjn/Kt1hg==",
"guid": "20c7e7db-5c15-4bd6-a6a4-18e7fcab7586",
"name": "sample string 3",
"description": "sample string 4",
"terminalNumber": 1,
"posKey": "VDIudREhGEmE81poY6iOWw==",
"linkedPOSKey": "752e3254-2111-4918-84f3-5a6863a88e5b",
"location": 1,
"zoneID": 1,
"currentMachineID": 1,
"storeID": 1,
"deleted": true,
"updated": "2026-04-03T06:16:42.5520332",
"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": "W/MgtBkcX0uoxaKTa2pfHA==",
"terminalGuid": "b420f35b-1c19-4b5f-a8c5-a2936b6a5f1c",
"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": "vW1ExIzdlEanRpSxwa+1IA==",
"identifierGuid": "c4446dbd-dd8c-4694-a746-94b1c1afb520",
"name": "sample string 1",
"storeID": 2,
"machineID": 3,
"scaleID": "sample string 4",
"lastPingLocal": "2026-04-03T06:16:42.5520332",
"lastSaleLocal": "2026-04-03T06:16:42.5520332",
"status": 0,
"statusDate": "2026-04-03T06:16:42.5520332",
"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/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Sample:
PK 2�\HSmN� 5 xl/workbook.xml � (� ��;�0D�H����|"!��I�"�
��d;"Ǐ1)]���ٷ�,�M̘ }Ԭ}�Z,B�5!~���:�q��(�� ��
t E�U��L�4�i=�h���u@G/ ��7��R��|B�Y�=%,>�h�uW�-D~SM�I!M����b�����#W�8<+8��9/Yv-+���5d��}PK 2�\���� � [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
2�\���4' ' _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="R2faeefa1fb9d4f71" /></Relationships>PK 2�\3��ݕ � xl/worksheets/sheet1.xml � (� ��]s�0��
��B�I:j�����ً�kVca*�!���T�ko4�眄�=d\%+g+3�t�B��L�j�Cw�/p�z4ة�SGR��S}�
�(��W���LB��L��ReI�����W�e<�c5�$2�} �3�
s����v�n��י����* ��
�q/v�dr9to����?��X����)��R����b肒�[�\|�9�7����Me��H����J��N�s�$�*�w�"���� z�ѹJ~�o�Z�סJ�:�=�0#� ��q��=���(
�/'���'^@��y������o�Y�gG=�0GP� L��*}����J�O�G�@pHŰ_/*�����y�*I;F
�S��g��At��u� �TY
�$
z 0F óu��1kTYCa�g�Av�mAH(�|Y���^��0G�L휬�6����uy��B�ci;[h+�M�&q�&P�� �$��i�6A��C�`Mb�&�&��&x�xj�I<wT�*�KbU�����ցXu}�@���:�ce}�Cn�17�u���
�F�u V'��Պ���Ťg���9m#�j�c�
O=s�=s/=s�[���S9aR1� 6C}�p�R6�@���䌉���&J�2+O��G��/PK 2�\Mޅ�� P xl/_rels/workbook.xml.rels � (� ��Mn� F��f_cl�ZUH6�t����, ms�.z�^���Z"u�MVh����>�?6��e&/�� V�@�io&78%{��n���,S��i�$?qQ����@i�#.2V~E�;ևE�\���R倴�뎆��Lr8����v����iA�� �W�qDL@2��D�~��T OF�^����0۪���7S��<c���ԅ�Vv}cL_��yS�Q4�)�M�Ne\��V�fV���s�.s�W�b�PK 2�\Ѓ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 2�\5AΫB � xl/sharedStrings.xml � (� �T]o�@|���p�sm�O��*J�� �Ԫ���N����9*���{L�v�7vfv�v=���g��g��|l8V� �i�0���32�T�Hs�cc�� W�����T.��V�bhےn1i�rͬs��ҡ�ز��"�,��^/�3`� 4/��o���%NO�n����l5�Ut@>~� K�4�d��f(�`���6���qHe�h���w�k���?a��S���E/�=����ݲ.~�r��0E����:�c�z�C�Z�����S��[�t{���$6��'� !��aM!�Q�̑�)jO m1�N�M��蹁o��������_{f azEĭ�*��X�E����������B�{��c����Y٬E�}f�� 8��>�_q��ś��*c�+��[�O7��p���J��f�*�:VUJ/t��LE�����tC�p����P�p��Ӳ?\�j>����bӡ�@["X���w�q�ڡ��:7�;�d���uʢ��ҁ��i��/6�<O0���|j=�Ҫ��y��p�f��Q�V-��4
��������/PK- 2�\HSmN� 5 xl/workbook.xmlPK- 2�\���� � [Content_Types].xmlPK-
2�\���4' ' V _rels/.relsPK- 2�\3��ݕ � � xl/worksheets/sheet1.xmlPK- 2�\Mޅ�� P � xl/_rels/workbook.xml.relsPK- 2�\Ѓc'2 E
� xl/styles.xmlPK- 2�\5AΫB � h xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
Sample:
PK 2�\�I��� 5 xl/workbook.xml � (� ����0��&�C��")��x��ҭ4П�5���H�yۙ��v�l��4fD5i_�!ؚ���?:�q��(!d���
t ��$&��~�����[�� �iE)&5n�����!a�IFc�����!� �_$�4S���Qrn��F��q����*~�E��/*��w%���PK 2�\���� � [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
2�\� ��' ' _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="R779f5d3ed95d4d10" /></Relationships>PK 2�\3��ݕ � xl/worksheets/sheet1.xml � (� ��]s�0��
��B�I:j�����ً�kVca*�!���T�ko4�眄�=d\%+g+3�t�B��L�j�Cw�/p�z4ة�SGR��S}�
�(��W���LB��L��ReI�����W�e<�c5�$2�} �3�
s����v�n��י����* ��
�q/v�dr9to����?��X����)��R����b肒�[�\|�9�7����Me��H����J��N�s�$�*�w�"���� z�ѹJ~�o�Z�סJ�:�=�0#� ��q��=���(
�/'���'^@��y������o�Y�gG=�0GP� L��*}����J�O�G�@pHŰ_/*�����y�*I;F
�S��g��At��u� �TY
�$
z 0F óu��1kTYCa�g�Av�mAH(�|Y���^��0G�L휬�6����uy��B�ci;[h+�M�&q�&P�� �$��i�6A��C�`Mb�&�&��&x�xj�I<wT�*�KbU�����ցXu}�@���:�ce}�Cn�17�u���
�F�u V'��Պ���Ťg���9m#�j�c�
O=s�=s/=s�[���S9aR1� 6C}�p�R6�@���䌉���&J�2+O��G��/PK 2�\�;N~� P xl/_rels/workbook.xml.rels � (� ��Kn� @��f_c0�'��M7٦� �b��i��E��+�R�H]t��h~OO��|���ަ�����-�,�V�n�}稟j�m7eL�s iņL��ҠN2dnF�:��IƔ���R�d���yI���Lr�����zP���yB� Ӌ�`#���=�~J���Ⱦk�͚�*t�
щ}�Z��ï�w���u�DxQs���*c���%�t�Ӳ�P�\0ި�J����_l� PK 2�\Ѓ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 2�\5AΫB � xl/sharedStrings.xml � (� �T]o�@|���p�sm�O��*J�� �Ԫ���N����9*���{L�v�7vfv�v=���g��g��|l8V� �i�0���32�T�Hs�cc�� W�����T.��V�bhےn1i�rͬs��ҡ�ز��"�,��^/�3`� 4/��o���%NO�n����l5�Ut@>~� K�4�d��f(�`���6���qHe�h���w�k���?a��S���E/�=����ݲ.~�r��0E����:�c�z�C�Z�����S��[�t{���$6��'� !��aM!�Q�̑�)jO m1�N�M��蹁o��������_{f azEĭ�*��X�E����������B�{��c����Y٬E�}f�� 8��>�_q��ś��*c�+��[�O7��p���J��f�*�:VUJ/t��LE�����tC�p����P�p��Ӳ?\�j>����bӡ�@["X���w�q�ڡ��:7�;�d���uʢ��ҁ��i��/6�<O0���|j=�Ҫ��y��p�f��Q�V-��4
��������/PK- 2�\�I��� 5 xl/workbook.xmlPK- 2�\���� � [Content_Types].xmlPK-
2�\� ��' ' V _rels/.relsPK- 2�\3��ݕ � � xl/worksheets/sheet1.xmlPK- 2�\�;N~� P � xl/_rels/workbook.xml.relsPK- 2�\Ѓc'2 E
� xl/styles.xmlPK- 2�\5AΫB � h xl/sharedStrings.xmlPK � �