GET api/possettingheader/{section}/{keyName}

Get a POS setting header belonging to the current user

Request Information

URI Parameters

NameDescriptionTypeAdditional information
section

Section under which this setting header belongs

string

Required

keyName

unique key/name used to identify this setting header

string

Required

Body Parameters

None.

Response Information

Resource Description

POSSettingHeader
NameDescriptionTypeAdditional information
Type

Type that this setting is (bool, enum, json, ect)

CheckoutSettingType

None.

PossibleValues

JSON that Defines the possible values that 'Value' can be. Excluded if the type is self-expanatory (E.G a bool has possible values of 'true' and 'false')

string

None.

DefaultValue

The default value of this setting

string

None.

Description

User-readable description of what this setting does

string

None.

Section

Section under which this setting is saved

string

None.

SubSection

Sub section / tab under which this setting is displayed in the UI

string

None.

KeyName

Keyname under which this setting is saved. Combo of Section + KeyName is unique per setting

string

None.

Scope

Defines the level/scope that this setting applies at

CheckoutSettingScope

None.

Response Formats

application/json, text/json

Sample:
{
  "type": 0,
  "possibleValues": "sample string 1",
  "defaultValue": "sample string 2",
  "description": "sample string 3",
  "section": "sample string 4",
  "subSection": "sample string 5",
  "keyName": "sample string 6",
  "scope": 0
}

application/xml, text/xml

Sample:
<POSSettingHeader xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://gapsolutions.com.au/schema/ezimanager">
  <DefaultValue>sample string 2</DefaultValue>
  <Description>sample string 3</Description>
  <KeyName>sample string 6</KeyName>
  <PossibleValues>sample string 1</PossibleValues>
  <Scope>Terminal</Scope>
  <Section>sample string 4</Section>
  <SubSection>sample string 5</SubSection>
  <Type>Long</Type>
</POSSettingHeader>

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Sample:
PKd3�\��{�5xl/workbook.xml �(�����0��&�C��h���x��}�[�@����Ǘ�@������S�仆�cۻ�����\��j�N4��v���8I���i���m�EqI����C4�6C�+�V<�1�~EY0�W�c���ip�����l2���o�X`�Ţ��%�!g�s�%?s�s3
	(QɦM�욤��;����PKd3�\����	�[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
d3�\{�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="R0217b674a03a4362" /></Relationships>PKd3�\���Axl/worksheets/sheet1.xml �(���O�� ��
ýA�F��n6��:=�g��U����ĦQ��֋�<ϋ�xG����W*$�]
�Ɓ�v/YwJ�EU_"��%=ﲦT�wr+RX+u�"$������3��\�E�+})N�W+���v
�	��M��R�fg	o����<�����V��Y��d����@�*��x{$�,1�F{�0Û���}�8�)t�,xo�&@I��Ҩ�?Pv���7N�i��eCt���9��Tu
�
���h��H�۟����}��葻��M�;���8���|����V����+�`�~8��J?��q�B��
��Kb���z�ˣ[��V��*��{ ̴�>���P��='u�_3'A����6��ċM�)��	wJ�ڄ7%�6�O�7����&�)q���N �=C�7Cb9�,C����_�Yλd��2Kz��̢~[@fY�Y��$�e�z���^*��+*L����oPKd3�\js�Pxl/_rels/workbook.xml.rels �(���KN�0@�b͞�F���ݰ��{�DM��v=�����ĂMW��==i���c�}�Fv����FN{3���S�5l7�=���D�9���b}J��Q�4a,�L.w�����Ϩ��B�d�-�.3���4={}�ȥ?��Շc����R?�ȯA�
lg�$Cִ���RT50~7��.#�_��|!��Ja�URaI���L���K
��K�ey�&IӮ�VR�Z�W5~��/PKd3�\Ѓ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��PKd3�\��&���xl/sharedStrings.xml �(�}�]K�0�r��M�"mw�Ca��,=k�I�I��{��B�r������|X��!�v����P�^������3�{iB�' �6mMYEj�����V��y�,��yA>��i�ֈUU���9S.a̵�$�~Kp��
�ֱ�&��m-��?ٳ#�{��$����A&���H�c>�v������<��$�Q�N��oq@�����p�g$�7��=�W`�2��|^�2_�y=���(My��E�G�'PK-d3�\��{�5xl/workbook.xmlPK-d3�\����	��[Content_Types].xmlPK-
d3�\{�t''U_rels/.relsPK-d3�\Î���A�xl/worksheets/sheet1.xmlPK-d3�\js�P�xl/_rels/workbook.xml.relsPK-d3�\Ѓc'2E
%xl/styles.xmlPK-d3�\��&����xl/sharedStrings.xmlPK��	

application/vnd.ms-excel

Sample:
PKd3�\�B�5xl/workbook.xml �(�����0D�&�C��E�QR8q����B��@[����[ �x�3;�v��|W;ב��m�}A����дh ܀6��b��ŜR���5o�6�#�汇��
�]h����dh���mi��"�fO�c�e2ֺ�I�b�)1ö�YZAJf�.�Q�s�������ՙ�Ntco0����PKd3�\����	�[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
d3�\Q	�''_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="Re605f089b6804b9c" /></Relationships>PKd3�\���Axl/worksheets/sheet1.xml �(���O�� ��
ýA�F��n6��:=�g��U����ĦQ��֋�<ϋ�xG����W*$�]
�Ɓ�v/YwJ�EU_"��%=ﲦT�wr+RX+u�"$������3��\�E�+})N�W+���v
�	��M��R�fg	o����<�����V��Y��d����@�*��x{$�,1�F{�0Û���}�8�)t�,xo�&@I��Ҩ�?Pv���7N�i��eCt���9��Tu
�
���h��H�۟����}��葻��M�;���8���|����V����+�`�~8��J?��q�B��
��Kb���z�ˣ[��V��*��{ ̴�>���P��='u�_3'A����6��ċM�)��	wJ�ڄ7%�6�O�7����&�)q���N �=C�7Cb9�,C����_�Yλd��2Kz��̢~[@fY�Y��$�e�z���^*��+*L����oPKd3�\FL���Pxl/_rels/workbook.xml.rels �(���An� E��f_���*N6�t��ۊ
Hۜ���W(J��H]t��?��4����f����C���WZ��d�N�ܭ`���q�)߈��#�Ol�`L�?PՈ����hsǸ�Ȕ�0P/�QHk�
%���p���3fR���iA���W�qDL@2�:��"���T O����z��J�M���@���b:����B�m�hk{�����(���K�2.�T+�Lh^עa���ѫ��PKd3�\Ѓ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��PKd3�\��&���xl/sharedStrings.xml �(�}�]K�0�r��M�"mw�Ca��,=k�I�I��{��B�r������|X��!�v����P�^������3�{iB�' �6mMYEj�����V��y�,��yA>��i�ֈUU���9S.a̵�$�~Kp��
�ֱ�&��m-��?ٳ#�{��$����A&���H�c>�v������<��$�Q�N��oq@�����p�g$�7��=�W`�2��|^�2_�y=���(My��E�G�'PK-d3�\�B�5xl/workbook.xmlPK-d3�\����	��[Content_Types].xmlPK-
d3�\Q	�''U_rels/.relsPK-d3�\Î���A�xl/worksheets/sheet1.xmlPK-d3�\FL���P�xl/_rels/workbook.xml.relsPK-d3�\Ѓc'2E
'xl/styles.xmlPK-d3�\��&����xl/sharedStrings.xmlPK��