GET api/survey/{id}?relations={relations}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
|
| relations | boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
Survey| Name | Description | Type | Additional information |
|---|---|---|---|
| G_UID |
Survey Identifier |
Collection of byte |
None. |
| Guid |
Survey GUID |
globally unique identifier |
None. |
| Name |
User-readable name of the survey |
string |
String length: inclusive between 0 and 60 |
| StoreID |
Store this survey will display in |
integer |
None. |
| ZoneID |
Zone this survey will display in; null = all zones |
integer |
None. |
| CheckoutFormG_UID |
Survey Identifier |
Collection of byte |
None. |
| CheckoutFormGuid |
Survey Form GUID |
globally unique identifier |
None. |
| DisplayToWho | SurveyAnswerer |
None. |
|
| DisplayWhen | DisplaySurveyWhen |
None. |
|
| Start | date |
None. |
|
| End | date |
None. |
|
| Deleted |
Soft deletion flag |
boolean |
None. |
| Updated | date |
None. |
|
| PossibleIntegerResponses |
List of possible integer/number answers that can be answered using this survey |
Collection of integer |
Relation. This field may not always be loaded or used for updates. |
| PossibleTextResponses |
List of possible text answers that can be answered using this survey |
Collection of string |
Relation. This field may not always be loaded or used for updates. |
| PossibleGuidResponses |
List of possible guid answers that can be answered using this survey |
Collection of globally unique identifier |
Relation. This field may not always be loaded or used for updates. |
| AllowsAllTextResponses |
true if this survey allows all text-based answers; PossibleTextResponses will still be populated with any pre-configured text responses This is true if the surveys checkoutform contains a InputDisplayPanel as this allows any text to be inputted |
boolean |
Relation. This field may not always be loaded or used for updates. |
| SurveyForm | CheckoutForm |
Relation. This field may not always be loaded or used for updates. |
Response Formats
application/json, text/json
{
"g_UID": "vglxF5EvCUiLKGzWQxBftA==",
"guid": "177109be-2f91-4809-8b28-6cd643105fb4",
"name": "sample string 1",
"storeID": 2,
"zoneID": 1,
"checkoutFormG_UID": "QRINA5bg90q8oFQA+sUVLA==",
"checkoutFormGuid": "030d1241-e096-4af7-bca0-5400fac5152c",
"displayToWho": 3,
"displayWhen": 4,
"start": "2026-04-03T06:24:11.3303135",
"end": "2026-04-03T06:24:11.3303135",
"deleted": true,
"updated": "2026-04-03T06:24:11.3303135",
"possibleIntegerResponses": [
1,
2
],
"possibleTextResponses": [
"sample string 1",
"sample string 2"
],
"possibleGuidResponses": [
"66d8d4c3-e944-48c6-b03a-b40a9bacf69f",
"ecf0dbb7-44b7-485d-9e47-45a70f5d192f"
],
"allowsAllTextResponses": true,
"surveyForm": {
"$id": "2",
"id": 1,
"g_UID": "FNpNFmYAZEOc+S4lpL8cRw==",
"guid": "164dda14-0066-4364-9cf9-2e25a4bf1c47",
"zoneID": 3,
"storeID": 4,
"name": "sample string 5",
"formType": "sample string 6",
"locationX": 1,
"locationY": 1,
"width": 1,
"height": 1,
"maximised": true,
"resizable": true,
"backgroundImage": "sample string 7",
"backgroundColour": "sample string 8",
"backgroundColourA": 1,
"backgroundColourR": 1,
"backgroundColourG": 1,
"backgroundColourB": 1,
"fontFamily": "sample string 9",
"fontSize": 1.1,
"fontStyle": 1,
"previousForm": 1,
"previousFormG_UID": "Rbz/Qms6jEWgJACigyA7cw==",
"previousFormGuid": "42ffbc45-3a6b-458c-a024-00a283203b73",
"nextForm": 1,
"nextFormG_UID": "xAQB/mKno0G7gnO2GYy09Q==",
"nextFormGuid": "fe0104c4-a762-41a3-bb82-73b6198cb4f5",
"attributes": "sample string 10",
"updated": "2026-04-03T06:24:11.3303135",
"positioning": 1,
"contentPanel": "sample string 11",
"selectionMode": 1,
"maximumSelections": 1,
"alteredInStore": true,
"deleted": true,
"blueprintID": 1,
"preserveLayout": true,
"mainCheckoutFormName": "sample string 13",
"nextCheckoutForm": {
"$ref": "2"
},
"previousCheckoutForm": {
"$ref": "2"
},
"buttons": [
{
"$id": "3",
"id": 1,
"checkoutFormID": 2,
"checkoutFormG_UID": "y2JVSUahIU2ycDRCgxrBfQ==",
"checkoutFormGuid": "495562cb-a146-4d21-b270-3442831ac17d",
"identifier": "WqmMEJgkvEK5/XslW1HKgw==",
"identifierGuid": "108ca95a-2498-42bc-b9fd-7b255b51ca83",
"name": "sample string 5",
"plu": 1,
"locationX": 1,
"locationY": 1,
"width": 1,
"height": 1,
"anchor": 1,
"backgroundImage": "sample string 6",
"backgroundImageID": 1,
"backgroundImageUrl": "sample string 7",
"topColour": 1,
"textColour": 1,
"bottomColour": 1,
"borderColour": 1,
"borderWidth": 1,
"radius": 1,
"gradientMode": 1,
"dropShadow": true,
"shadowWidth": 1,
"highLightOnPush": true,
"fontFamily": "sample string 8",
"fontSize": 1.1,
"fontStyle": 1,
"textAlign": 1,
"imageAlign": 1,
"wordBreak": true,
"verticalText": true,
"buttonFunction": 1,
"buttonValue": 1,
"valueG_UID": "lHoeMSy0U02uvTNXQEM1hw==",
"valueGuid": "311e7a94-b42c-4d53-aebd-335740433587",
"buttonText": "sample string 10",
"valueText": "sample string 11",
"drawImageAndButton": true,
"updated": "2026-04-03T06:24:11.3303135",
"action": "sample string 12",
"valueForm": {
"$ref": "2"
},
"image": {
"$id": "4",
"name": "sample string 3.sample string 4",
"imageID": 2,
"imageName": "sample string 3",
"imageExtension": "sample string 4",
"lastUpdate": "2026-04-03T06:24:11.3303135",
"imageData": "QEA=",
"readOnly": true
}
},
{
"$ref": "3"
}
],
"panels": [
{
"$id": "5",
"id": 1,
"checkoutFormID": 2,
"checkoutFormG_UID": "qAA5QP7dCUOLeZCeDy8I3A==",
"checkoutFormGuid": "403900a8-ddfe-4309-8b79-909e0f2f08dc",
"panelType": "sample string 4",
"name": "sample string 5",
"locationX": 6,
"locationY": 7,
"width": 8,
"height": 9,
"anchor": 10,
"fontFamily": "sample string 11",
"fontSize": 12.1,
"fontStyle": 13,
"backgroundColour": 14,
"textColour": 15,
"attributes": "sample string 16"
},
{
"$ref": "5"
}
]
}
}
application/xml
Sample not available.
text/xml
Sample not available.
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
PK 3�\,G ζ 5 xl/workbook.xml � (� ����0��&�C���b�N\�z�^�V�O�||K $���~;t2nh��G�ڗ��}�$���cAǝ0N��{#����V�ɳ�B�,H�}/�����X�{�����Ը���s����'���l"���o�&�v��LA�Fɹw>b�J�/n�I�����8㍽�(Y�_PK 3�\���� � [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
3�\�:kX' ' _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="R14af8f02651d4541" /></Relationships>PK 3�\��m�� �
xl/worksheets/sheet1.xml � (� ��]s�@��
�}a��ތ�Ib�G�4�����F&"`��� �P1�Ip�9g��'o\��V·N�0^]����,��뷡��ߤ{9���=]j�9_���]f������RGA���6k�8���|L��x�gz϶�^g>F���^��*]���=���n��#D��U�kw4���}z'ы�{S�:�h�ÿB�Kk���M�������|袜�[�$��5q�zlW�4����m���X��ū4��D�>:����]8ϖ�x�N)E
��3ۦY�.�K��z|���BR �&���Гj� �(������BO�ze�G��:V��'u�����S� D
��B/����@
�Ib���^zYϋp%1b�
)z�Ы�}#����θo@eaP� �Dƃ��%���W�����AY7 _ݻ,T����\SX@�T�ǡ����P �s �Ǡ� T%�ؼ��!)T�C�B�j��G� ��ϡ�!TE��3W�$3��SD�0�a5�`4H❓����te�|ę���Y�1B�c�-��6M�M�&1n�Iܶ �$&m�5��6���}�M�M�&��&T��ޑ��Sb��܁X��t V�?:+���J�gbE;�@�l}S�c�p�>�Yq_w V�7m[y�K�����5�&�����r���`]�C}ͺ���`f�q�oc?C�Ν�>u؊��|��7�������`����:�צ��|_��$�3�����v�PK 3�\�r�Y� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�
qH��ݰa[z��3��&vd�@�Ƃ#q�"�+�`��|��$����f�6O셜�i`� `d��F34p
�]��fO�����x�߀aYs}f2q�[7c������\�����Lv8/����QѣU��L��_�;zM��
�iy~ �,R�=u
앬�}��U��"�����|8O����DF�C+kI���(����FG�sp�S����խ�Z*j�#�ċ����PK 3�\Ѓ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 3�\|>[˾ K xl/sharedStrings.xml � (� �Tێ�0�+�I�4��&+h��J�h��
��L���v���K���R��>�gv�T)��ѩ�c�sSH}L���֟xI�B(�!�Z@��d3DbΪ1�J��Eb^B%005h����O{��
,�Ra��(����M�)���-?70��#d6����n������3�6��boD]lC�[���\-�y �'��~���2,$�J��;��{*A��
K�d���..�P@Ћ��q�7�r�`� �`��F#�5��询�\�TʜЭ�j��Gh���cZ$��W-���.��������O&|�O�����(D|x�']��V�ٺ�fQ��^Dq���#?������ ���a�w=[��g�{�Q
rr�
�;�`e��H��g�k� �U���ͷ:��n^Ͻ�"�B7!���0X���wpn�>�����
��PK- 3�\,G ζ 5 xl/workbook.xmlPK- 3�\���� � � [Content_Types].xmlPK-
3�\�:kX' ' U _rels/.relsPK- 3�\��m�� �
� xl/worksheets/sheet1.xmlPK- 3�\�r�Y� P � xl/_rels/workbook.xml.relsPK- 3�\Ѓc'2 E
> xl/styles.xmlPK- 3�\|>[˾ K � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
PK 3�\�~�� 5 xl/workbook.xml � (� ����0��&�C��U*)��x��}�E�O�||o�vfg�1������sW�.�3������5NA�ҽ�i[�`e��B؉�9 H�}'�������;Ġ��@jZ�w����C��g���d���oJ̰�bVD�V��ٹ=z���2�+�F�$I֦�3�{� ��.�PK 3�\���� � [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
3�\Ty�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="Ra5fde49b161841bd" /></Relationships>PK 3�\��m�� �
xl/worksheets/sheet1.xml � (� ��]s�@��
�}a��ތ�Ib�G�4�����F&"`��� �P1�Ip�9g��'o\��V·N�0^]����,��뷡��ߤ{9���=]j�9_���]f������RGA���6k�8���|L��x�gz϶�^g>F���^��*]���=���n��#D��U�kw4���}z'ы�{S�:�h�ÿB�Kk���M�������|袜�[�$��5q�zlW�4����m���X��ū4��D�>:����]8ϖ�x�N)E
��3ۦY�.�K��z|���BR �&���Гj� �(������BO�ze�G��:V��'u�����S� D
��B/����@
�Ib���^zYϋp%1b�
)z�Ы�}#����θo@eaP� �Dƃ��%���W�����AY7 _ݻ,T����\SX@�T�ǡ����P �s �Ǡ� T%�ؼ��!)T�C�B�j��G� ��ϡ�!TE��3W�$3��SD�0�a5�`4H❓����te�|ę���Y�1B�c�-��6M�M�&1n�Iܶ �$&m�5��6���}�M�M�&��&T��ޑ��Sb��܁X��t V�?:+���J�gbE;�@�l}S�c�p�>�Yq_w V�7m[y�K�����5�&�����r���`]�C}ͺ���`f�q�oc?C�Ν�>u؊��|��7�������`����:�צ��|_��$�3�����v�PK 3�\�V��� P xl/_rels/workbook.xml.rels � (� ��An� E������up'�n�Ms�c���9[=R�P�J-���&+4�鍆�����m���89�Ѳ��Un�����;Aw��f��F4��$=���ѯ���"c�<���.,SF�:��=�
9�^3����?D����ѩ�� �W�� %F���D�]��HTJ����[�u\UU�k�J㳛�E<����\�A��B+�����`xƐ6�;�q�V
�+Q5�*e-JuQcW�b�PK 3�\Ѓ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 3�\|>[˾ K xl/sharedStrings.xml � (� �Tێ�0�+�I�4��&+h��J�h��
��L���v���K���R��>�gv�T)��ѩ�c�sSH}L���֟xI�B(�!�Z@��d3DbΪ1�J��Eb^B%005h����O{��
,�Ra��(����M�)���-?70��#d6����n������3�6��boD]lC�[���\-�y �'��~���2,$�J��;��{*A��
K�d���..�P@Ћ��q�7�r�`� �`��F#�5��询�\�TʜЭ�j��Gh���cZ$��W-���.��������O&|�O�����(D|x�']��V�ٺ�fQ��^Dq���#?������ ���a�w=[��g�{�Q
rr�
�;�`e��H��g�k� �U���ͷ:��n^Ͻ�"�B7!���0X���wpn�>�����
��PK- 3�\�~�� 5 xl/workbook.xmlPK- 3�\���� � � [Content_Types].xmlPK-
3�\Ty�t' ' U _rels/.relsPK- 3�\��m�� �
� xl/worksheets/sheet1.xmlPK- 3�\�V��� P � xl/_rels/workbook.xml.relsPK- 3�\Ѓc'2 E
? xl/styles.xmlPK- 3�\|>[˾ K � xl/sharedStrings.xmlPK � �