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
SurveyName | 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": "UHmNcayy30CUDQjskWFkig==", "guid": "718d7950-b2ac-40df-940d-08ec9161648a", "name": "sample string 1", "storeID": 2, "zoneID": 1, "checkoutFormG_UID": "4DuDhUfIokK+WPwM9Hx0vQ==", "checkoutFormGuid": "85833be0-c847-42a2-be58-fc0cf47c74bd", "displayToWho": 3, "displayWhen": 4, "start": "2025-08-02T23:20:21.8532951", "end": "2025-08-02T23:20:21.8532951", "deleted": true, "updated": "2025-08-02T23:20:21.8532951", "possibleIntegerResponses": [ 1, 2 ], "possibleTextResponses": [ "sample string 1", "sample string 2" ], "possibleGuidResponses": [ "09dc8722-5e3f-42a2-a266-78132056f7f6", "43e65578-b265-483d-a810-bbf8c2729283" ], "allowsAllTextResponses": true, "surveyForm": { "$id": "2", "id": 1, "g_UID": "3D/rboY/CUCWPODbN+qChA==", "guid": "6eeb3fdc-3f86-4009-963c-e0db37ea8284", "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": "aPA+YUMTkki1BU5GBAeKog==", "previousFormGuid": "613ef068-1343-4892-b505-4e4604078aa2", "nextForm": 1, "nextFormG_UID": "nWt+x35WY02sv7VxW4D1Tw==", "nextFormGuid": "c77e6b9d-567e-4d63-acbf-b5715b80f54f", "attributes": "sample string 10", "updated": "2025-08-02T23:20:21.8532951", "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": "ceoDzTxnYES6Uc1KULQAXg==", "checkoutFormGuid": "cd03ea71-673c-4460-ba51-cd4a50b4005e", "identifier": "iv1n70vQ6kChilcPYtK8sw==", "identifierGuid": "ef67fd8a-d04b-40ea-a18a-570f62d2bcb3", "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": "1o78fBUio0Kgm5UxnBWaVw==", "valueGuid": "7cfc8ed6-2215-42a3-a09b-95319c159a57", "buttonText": "sample string 10", "valueText": "sample string 11", "drawImageAndButton": true, "updated": "2025-08-02T23:20:21.8532951", "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": "2025-08-02T23:20:21.8532951", "imageData": "QEA=", "readOnly": true } }, { "$ref": "3" } ], "panels": [ { "$id": "5", "id": 1, "checkoutFormID": 2, "checkoutFormG_UID": "iK+UeRsqXU6UQfNy+qSLZg==", "checkoutFormGuid": "7994af88-2a1b-4e5d-9441-f372faa48b66", "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 ��[��\�� 5 xl/workbook.xml � (� ����0��&�C��h��x��}[i�ݦ��Ǘ�@������S��{IԳ�l�}ɻ].DP'rh�]K�@�� j[��&�6h��$I*<5��i�J���GhB�Ͱ�h˫ぱbn��8�EN�Vw6�XC�7U,��bQ̂�����Ź7%?s�s= ��J!�i&�� %��;����PK ��[���� � [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 ��[Km==' ' _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="Ra213dcdfe97b4988" /></Relationships>PK ��[���� � xl/worksheets/sheet1.xml � (� ��]s�0�� ��BN>H�Q;m���v�ؽf5V�"�ڟ�A d��F��yO�{^�08��W·J�(Y]���,�G�ס��/~�|4�&�[�T*w4���ҡ���͙�g�����K6j��I�������b��8���j����O�*��Q�2�d��)��M��yq�x�/��� 摮������н��)v4(�ߑ�f���{��I��q7��`�<)I��Z��|�loU�̵I��̒UV|:q���u����F�|�W�c (�H��uf�Y�����^�K=>��0g\F� A��I�'����QTBp|\OK==��ױRǾ�J]P�Wz�\ �` ������/�1��b��g>��^4�"�1I��=zY�e��H"�{�N�7�*0���=!)cRc�� "߭P���U܀|��*pP'����:�=��kV����� z T�:�T?"B߂"$��P��b�QƁ,�W��!�A���[���[� ���?Ű�y8���I�m]���ˬqzjezV~�����iK�K@����M��i�]���I�`m�Km�K�6q�%D����M<X3L}� ��Oİ�ق��� ��/�p��1��Z��[_�>\�wE�ݗ�����`��q�X�y��3�0���t��m��Aw�=�3��=&8x�c�0dt��t��raÒ�ӫ=[��� f-����kO-H`d�oLå~_T�$Ir����;�PK ��[���� P xl/_rels/workbook.xml.rels � (� ��An� E��f_�mJ�*N6�t���Ɗ �&9[=R�P�J-���&+4��i������<O� }�m�,����-c���f���$c�̸���Ђ�qy�4(���[ЦN��,c*�@�r@Z1&��p�$�˂�!��n�:�h�`zr�b��~���O��(�D�[�1����M��'�л��x�0�z}י/yUW��wuW#=���Ӧs�<��Tr��D�%�92qU�7�b�PK ��[Ѓ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 ��[}@�� K xl/sharedStrings.xml � (� �TY��0�+V�sH�HV-�+�R� �tU���U�N=�e鯯iW=�U_,�;����S��#X�F^D-L%���6�[?��WFC�=vSN�9��«��a����c`ZЎ��pr[����+��QaE���R{L�NS�%��:-?w0��+d9����f1��TN��v�:���αl�Ӿs�\��5�O��[��{\�a&�U��ȰCm���t?Rn����0��E| z!lڊ_�� ��*Xh�=ط���xM��'���T����J����G�:��S={� ��Ց���9��y�����M��Ө��c��Qb��Q��s�U�ٺ�f�9���`�/�4�ӄ'�����إ���m��k��g�{�S�r� �;�`�^K���óµb��2�g��[��?5���K����`i*P̗���;8��_�Oo�~��+PK- ��[��\�� 5 xl/workbook.xmlPK- ��[���� � � [Content_Types].xmlPK- ��[Km==' ' U _rels/.relsPK- ��[���� � � xl/worksheets/sheet1.xmlPK- ��[���� P � xl/_rels/workbook.xml.relsPK- ��[Ѓc'2 E @ xl/styles.xmlPK- ��[}@�� K � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
PK ��[@&��� 5 xl/workbook.xml � (� ����0��&�C����G '.^=x_�bhK�||�o�vfg�>X�>�m�Gw�箠2�>g��5���ь��: a���lӨ+[�5���$91�e����t����C^"��( ��r�!�O� �h,u'��9�~S<����� %ѹ���)q���ġ9%"=^��fte�0Ζ��PK ��[���� � [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 ��[H_��' ' _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="Rda639a99b3ee4b0c" /></Relationships>PK ��[���� � xl/worksheets/sheet1.xml � (� ��]s�0�� ��BN>H�Q;m���v�ؽf5V�"�ڟ�A d��F��yO�{^�08��W·J�(Y]���,�G�ס��/~�|4�&�[�T*w4���ҡ���͙�g�����K6j��I�������b��8���j����O�*��Q�2�d��)��M��yq�x�/��� 摮������н��)v4(�ߑ�f���{��I��q7��`�<)I��Z��|�loU�̵I��̒UV|:q���u����F�|�W�c (�H��uf�Y�����^�K=>��0g\F� A��I�'����QTBp|\OK==��ױRǾ�J]P�Wz�\ �` ������/�1��b��g>��^4�"�1I��=zY�e��H"�{�N�7�*0���=!)cRc�� "߭P���U܀|��*pP'����:�=��kV����� z T�:�T?"B߂"$��P��b�QƁ,�W��!�A���[���[� ���?Ű�y8���I�m]���ˬqzjezV~�����iK�K@����M��i�]���I�`m�Km�K�6q�%D����M<X3L}� ��Oİ�ق��� ��/�p��1��Z��[_�>\�wE�ݗ�����`��q�X�y��3�0���t��m��Aw�=�3��=&8x�c�0dt��t��raÒ�ӫ=[��� f-����kO-H`d�oLå~_T�$Ir����;�PK ��[�"&^� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8I���ݰ��N<N�&�e����G� XEWb�������4����-39���-Yuo䤇NA=ݬ�8�'�8YO��-�!�'J}?�"|f,��Q�-"�� Ԋ�(�e�s�R�2��b�?D�����O����w�#b rn���O��k(�H��-�!W�粬�=��������w��`� �>X��2�p(_���N��r�ƺ�u���5c\]���_l� PK ��[Ѓ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 ��[}@�� K xl/sharedStrings.xml � (� �TY��0�+V�sH�HV-�+�R� �tU���U�N=�e鯯iW=�U_,�;����S��#X�F^D-L%���6�[?��WFC�=vSN�9��«��a����c`ZЎ��pr[����+��QaE���R{L�NS�%��:-?w0��+d9����f1��TN��v�:���αl�Ӿs�\��5�O��[��{\�a&�U��ȰCm���t?Rn����0��E| z!lڊ_�� ��*Xh�=ط���xM��'���T����J����G�:��S={� ��Ց���9��y�����M��Ө��c��Qb��Q��s�U�ٺ�f�9���`�/�4�ӄ'�����إ���m��k��g�{�S�r� �;�`�^K���óµb��2�g��[��?5���K����`i*P̗���;8��_�Oo�~��+PK- ��[@&��� 5 xl/workbook.xmlPK- ��[���� � [Content_Types].xmlPK- ��[H_��' ' V _rels/.relsPK- ��[���� � � xl/worksheets/sheet1.xmlPK- ��[�"&^� P � xl/_rels/workbook.xml.relsPK- ��[Ѓc'2 E B xl/styles.xmlPK- ��[}@�� K � xl/sharedStrings.xmlPK � �