GET api/terminal/posKey/{posKey}?relations={relations}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
posKey

globally unique identifier

Required

relations

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

Terminal
NameDescriptionTypeAdditional 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": "Q73IuQJs20O7+xCLxSSQ3Q==",
  "guid": "b9c8bd43-6c02-43db-bbfb-108bc52490dd",
  "name": "sample string 3",
  "description": "sample string 4",
  "terminalNumber": 1,
  "posKey": "LxYA+44SNUqFZL0cLPrtwA==",
  "linkedPOSKey": "fb00162f-128e-4a35-8564-bd1c2cfaedc0",
  "location": 1,
  "zoneID": 1,
  "currentMachineID": 1,
  "storeID": 1,
  "deleted": true,
  "updated": "2025-06-14T06:09:09.0831392",
  "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": "3eCj0QX/GkyhzRs30s6Ulw==",
    "terminalGuid": "d1a3e0dd-ff05-4c1a-a1cd-1b37d2ce9497",
    "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": "PJ6DQjeF2UultfOE8mF/AA==",
    "identifierGuid": "42839e3c-8537-4bd9-a5b5-f384f2617f00",
    "name": "sample string 1",
    "storeID": 2,
    "machineID": 3,
    "scaleID": "sample string 4",
    "lastPingLocal": "2025-06-14T06:09:09.0831392",
    "lastSaleLocal": "2025-06-14T06:09:09.0831392",
    "status": 0,
    "statusDate": "2025-06-14T06:09:09.0831392",
    "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$1�Z茔(�5xl/workbook.xml �(�����0D�&�C��	AR8q����
�m�-ik��-H�yۙ�};b��Zۓ��/\Iec��o$j�';����:
!J�b��T��m�M`	�s8@P�x�FOW�?,?:��KĠ��AZ����C�����l���oJ,��bQĀƒ���Ź�%=S�
��r�9f�^�4Mr��w�`���PK$1�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
$1�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="R628c1674e97248d9" /></Relationships>PK$1�Z�:��	xl/worksheets/sheet1.xml �(����r�@�_��~a�KM%1朵�b���1P��y�D`
����|O���2���7ΧJ�H'z�uT�ԫ(y���|�C�W��^�Y�T�<�F��
�|;��l�8�<�U��[�4rs���z���j���X%��`~�6An���h���h�+ۦ*X�)ěC�8�w:^E&z�����Ľ��r:.�ߑ�g'k��%��(nW��߃����Y�u�����AE�an�DK�Ro����QQ:׉���s��p�J�����,���װVt�ҡ�b�2�!@B.��Wz|�c�QH��a.�ѓJO���) Ʉ�hXO+=���Uz�虇�p@0�g�畞�~�ҋ�~�C�29�L@6���^^�wjÀK�G�5^��cb�1HRy&Bm:�.=��ė*k���!OHB� �����`�5*�!N`x&Bm6�N�I9$�Ica
���r0̂<��S�w�rۄ/V�f����L��̥�)����"n�l�}��Y��m�O�61��M��	�&�o�}B���>!�ij�b���X�NU_-H��o�Sן�S؅i*��}�ߠJd��
��4�ւt:1� �V�Y�N/�yޟ�󡏠N+Nx�{�{�{���A�N��L�!��B)D��K���w��̘м�t�u��r
�¦�PK$1�Z$W���Pxl/_rels/workbook.xml.rels �(���KN�0@�b͞�1N���ݰ���d�DM��v=�����ĂMW��==i���c�y�Fv&g�3�,�v�]�h*جW;uL���Ҋ

�1�O��i�!s3��1�O:��w|�x�q)D����L�����3f@zvx���?����c�"����~J�_C�%*�m���֕�JR��R����e�����/d����X�
���L�=�/ѧK/������J�)Q��j��/�_PK$1�ZЃc'2E
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$1�ZRFv�A�xl/sharedStrings.xml �(��T]o�0}���`�y�!�
�6h���U4i�49�
XM��v��i�}I�Iy�=�~�܌�f)z�x.Ɩg�As��fl�W�8���D0�������'#�42�B����ŕ�(���(;/@&�eF�1��Q���@g��n�d�Ѽzl���J��0=�����n6r�d�T���}���5�ɠ��@Q�m�mR+�$]�Y��>~Z�î�>p��.��������RJzN�w�K��x)hh��.透�_��@��r�4d�����ߚd<�Q̂����b�I�=7�i��.k��HV�`4%��P�u:h�I�^�'��#���q�3��4!������l�u\��޾���1�ޙ���������=v2���Jf-:��3�����Z'u}\�tfV�]50�}��`�G�]��@���7[]!�1ѥ2���̌P:^`N�������2�bu��B�
�<���q��}P�`�Q���7`>�a0���\]X/��������@kc�*�����D�
H{�3H�}3�ڏ��kG�<�|�W�g��)(�v��4�����s�v�PK-$1�Z茔(�5xl/workbook.xmlPK-$1�Z����	��[Content_Types].xmlPK-
$1�Z���'''U_rels/.relsPK-$1�Z�:��	�xl/worksheets/sheet1.xmlPK-$1�Z$W���P�xl/_rels/workbook.xml.relsPK-$1�ZЃc'2E
�xl/styles.xmlPK-$1�ZRFv�A�m	xl/sharedStrings.xmlPK��

application/vnd.ms-excel

Sample:
PK$1�Z���5xl/workbook.xml �(�����0D�&�C�� *�N\�z��6Ж�5��$޼��ξ>Z�=���G����2��`����h⮵NC�ҽ�m[%����vL�s�CP�x�O�?,?8��KĠ��AZ�w���C��g���d���o�ϰ�bVĀƒ���ٹ5%M)q�����7Y��Yz�\Ѝ��8[W_PK$1�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
$1�ZeMJ�''_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="Rc7ce23465eb9486f" /></Relationships>PK$1�Z�:��	xl/worksheets/sheet1.xml �(����r�@�_��~a�KM%1朵�b���1P��y�D`
����|O���2���7ΧJ�H'z�uT�ԫ(y���|�C�W��^�Y�T�<�F��
�|;��l�8�<�U��[�4rs���z���j���X%��`~�6An���h���h�+ۦ*X�)ěC�8�w:^E&z�����Ľ��r:.�ߑ�g'k��%��(nW��߃����Y�u�����AE�an�DK�Ro����QQ:׉���s��p�J�����,���װVt�ҡ�b�2�!@B.��Wz|�c�QH��a.�ѓJO���) Ʉ�hXO+=���Uz�虇�p@0�g�畞�~�ҋ�~�C�29�L@6���^^�wjÀK�G�5^��cb�1HRy&Bm:�.=��ė*k���!OHB� �����`�5*�!N`x&Bm6�N�I9$�Ica
���r0̂<��S�w�rۄ/V�f����L��̥�)����"n�l�}��Y��m�O�61��M��	�&�o�}B���>!�ij�b���X�NU_-H��o�Sן�S؅i*��}�ߠJd��
��4�ւt:1� �V�Y�N/�yޟ�󡏠N+Nx�{�{�{���A�N��L�!��B)D��K���w��̘м�t�u��r
�¦�PK$1�Z
�Pxl/_rels/workbook.xml.rels �(���Kn�0@�b;�ML*�n�R.�'�ؑmh9[=R�P�Jm����h~OO��|�Xo�Ɓ�ɇ��d&��Egz��p���
�����D��)��bC
]��#�;u��D6u�GS�[>i<��B�%�s�2��2���iz�'���l��_�?��(;h�R���5�,Q��L
�J�\�R��
�񻩅x(�z}�3Ԧ\U��R+!�*�iO�9�t�Ӽ<Sk*4����B^���_l�PK$1�ZЃc'2E
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$1�ZRFv�A�xl/sharedStrings.xml �(��T]o�0}���`�y�!�
�6h���U4i�49�
XM��v��i�}I�Iy�=�~�܌�f)z�x.Ɩg�As��fl�W�8���D0�������'#�42�B����ŕ�(���(;/@&�eF�1��Q���@g��n�d�Ѽzl���J��0=�����n6r�d�T���}���5�ɠ��@Q�m�mR+�$]�Y��>~Z�î�>p��.��������RJzN�w�K��x)hh��.透�_��@��r�4d�����ߚd<�Q̂����b�I�=7�i��.k��HV�`4%��P�u:h�I�^�'��#���q�3��4!������l�u\��޾���1�ޙ���������=v2���Jf-:��3�����Z'u}\�tfV�]50�}��`�G�]��@���7[]!�1ѥ2���̌P:^`N�������2�bu��B�
�<���q��}P�`�Q���7`>�a0���\]X/��������@kc�*�����D�
H{�3H�}3�ڏ��kG�<�|�W�g��)(�v��4�����s�v�PK-$1�Z���5xl/workbook.xmlPK-$1�Z����	��[Content_Types].xmlPK-
$1�ZeMJ�''U_rels/.relsPK-$1�Z�:��	�xl/worksheets/sheet1.xmlPK-$1�Z
�P�xl/_rels/workbook.xml.relsPK-$1�ZЃc'2E
�xl/styles.xmlPK-$1�ZRFv�A�o	xl/sharedStrings.xmlPK��