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": "U5GUBbA1LEuu19ira1pj0g==", "guid": "05949153-35b0-4b2c-aed7-d8ab6b5a63d2", "name": "sample string 1", "storeID": 2, "zoneID": 1, "checkoutFormG_UID": "uJouS9jmH02TU83AzZNJow==", "checkoutFormGuid": "4b2e9ab8-e6d8-4d1f-9353-cdc0cd9349a3", "displayToWho": 3, "displayWhen": 4, "start": "2025-10-05T00:04:07.2915007", "end": "2025-10-05T00:04:07.2915007", "deleted": true, "updated": "2025-10-05T00:04:07.2915007", "possibleIntegerResponses": [ 1, 2 ], "possibleTextResponses": [ "sample string 1", "sample string 2" ], "possibleGuidResponses": [ "b9214536-b8dd-4022-a0a3-27f1143782cf", "09e5d816-a1ba-48d3-bb46-2a774207b948" ], "allowsAllTextResponses": true, "surveyForm": { "$id": "2", "id": 1, "g_UID": "V8e2d31tyEW0AaPHhFCTZQ==", "guid": "77b6c757-6d7d-45c8-b401-a3c784509365", "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": "YjPyu0lOqkGRe2DZATDBmQ==", "previousFormGuid": "bbf23362-4e49-41aa-917b-60d90130c199", "nextForm": 1, "nextFormG_UID": "TQcv5RMMZEmvYJDGJpJVEg==", "nextFormGuid": "e52f074d-0c13-4964-af60-90c626925512", "attributes": "sample string 10", "updated": "2025-10-05T00:04:07.2915007", "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": "tHTuu2z7FkO9bowkpWOE8w==", "checkoutFormGuid": "bbee74b4-fb6c-4316-bd6e-8c24a56384f3", "identifier": "4UI0L3Jlm02JQJ4G+J2e3Q==", "identifierGuid": "2f3442e1-6572-4d9b-8940-9e06f89d9edd", "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": "TeVks81g+EiRdDU7lTv62Q==", "valueGuid": "b364e54d-60cd-48f8-9174-353b953bfad9", "buttonText": "sample string 10", "valueText": "sample string 11", "drawImageAndButton": true, "updated": "2025-10-05T00:04:07.2915007", "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-10-05T00:04:07.2915007", "imageData": "QEA=", "readOnly": true } }, { "$ref": "3" } ], "panels": [ { "$id": "5", "id": 1, "checkoutFormID": 2, "checkoutFormG_UID": "XSyw11bwSE2L4QIXm0jVUw==", "checkoutFormGuid": "d7b02c5d-f056-4d48-8be1-02179b48d553", "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 � E[p���� 5 xl/workbook.xml � (� ����0D�&�C��@�DR8q����Z�������Ϸ@ ��mgv�������\O>f���5U1�cA(4NnD�v�y1I�bNJ-�u�m�FVdمy jg��c�+�V=Bb4Ê2�-m�B���q �L�Vw6 [C�7��~�(b�`M[�@��ܺ���J��^���J��q.:�;{�q��n�PK � E[���� � [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 � E[����' ' _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="R5db74ce87a884293" /></Relationships>PK � E[�dP�� � xl/worksheets/sheet1.xml � (� ��[s�0 �� ��B�ik�e�nׇ�gVce*����7"��ؾ(L�sN������,���{j=��x�6����/G��N߳�R�g�uv��e�o.�0�-Ue�ި�[�4�rs���z��gj�g�D����T���L�-�M�����6�������*��?�c�_����п�S�{�hP��b�����I�h���y�}P�a�����\-��*��ݽ�ߖ� ���^eů����|/����x�/�(Ì$���l��:�]W.=*���"��� rvZ�K=��'�� H$���zR��Q/H C���:�I+u�^�4�˸�Xp�$<�神7�*$���(���fR �@���[�z��o ��3���0�v@����'` !ٓ <V~ա*D��=X� ��]֍#8@�cSX��l�CU=H�\B��a6A�T�u �y��Y@p��P��5D( �C D��>����."a�� �yo��⇇�8��Q���yi1l��WW�2+�8sje���A��ז�u��m�K�61��M�v �&&]����.���}��m�K�6��%d���H� �ɁX�>;+�b��ÁX��:+ٟĊv�@�lCS�c�P�>�Yq_;+�.�����(�ms�ڄI���[.��� zh�Y;���� $�������c�V$�绽8��:����`����Y���|/�t�u���<~Î�PK � E[Y��L� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�N�VM�aö��=N�&vd�@�Ƃ#q�"A*�`��h~OO��|����Ɓ�P��w �B #���]��)ٻv�͞Ly"v�Y^q��.�i�y��?���È)����#��K!�y�3����C�����>���`���1vD �CK���R� �L�h�/�(WI.Q��0~3����_��|.���d-V�H%���t�<��/=w��gj��B�dEU{Q�W��PK � E[Ѓ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 � E[�s� K xl/sharedStrings.xml � (� �Tmo�0�+V����v���*Q4��'�5�|�u�����K��%?/�;�ٳ�J�G�(��{qyta��ǹw���S�!q-�2���c"1g�8�J��EbQB�105h�<[qr[{���� T�0��IXq�=V�F��K�<�h��������-n?6�YH�Y��`#E{�+�b;2ئ�}�j��%�LC7.���� rXI�?32�T�K��ϔ[b$�5���W����¡| �3�2W��G�ok��nO�WQ{E/�2't���5���}��3T��3���.��Q�S?�?ʓ�� �|1��$�I*��yU+p�l�p��K�C ��ԇ���#?�Y�"�� �����]��6������(�g��-h��^K�����µ"Mz���}���������_�k�&$� ��v�~m�0�����7X|PK- � E[p���� 5 xl/workbook.xmlPK- � E[���� � � [Content_Types].xmlPK- � E[����' ' T _rels/.relsPK- � E[�dP�� � � xl/worksheets/sheet1.xmlPK- � E[Y��L� P � xl/_rels/workbook.xml.relsPK- � E[Ѓc'2 E : xl/styles.xmlPK- � E[�s� K � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
PK � E[Ђ� 5 xl/workbook.xml � (� ��=�0��J�C�4��0�t��=�i"ȏ�T�� A u�d���Ϯm�N�|�\ik�ޛ�R�s��]�Af���� ��q=��KT�fIRP�3�B+Džq���a9c� �#z9o(Ʉ��|"�Z?{ \\����]MB��MUvlDE�XC�<��PC Ė"4��H��KC�yz��`��/PK � E[���� � [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 � E[G���' ' _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="Ra636fadde68c4353" /></Relationships>PK � E[�dP�� � xl/worksheets/sheet1.xml � (� ��[s�0 �� ��B�ik�e�nׇ�gVce*����7"��ؾ(L�sN������,���{j=��x�6����/G��N߳�R�g�uv��e�o.�0�-Ue�ި�[�4�rs���z��gj�g�D����T���L�-�M�����6�������*��?�c�_����п�S�{�hP��b�����I�h���y�}P�a�����\-��*��ݽ�ߖ� ���^eů����|/����x�/�(Ì$���l��:�]W.=*���"��� rvZ�K=��'�� H$���zR��Q/H C���:�I+u�^�4�˸�Xp�$<�神7�*$���(���fR �@���[�z��o ��3���0�v@����'` !ٓ <V~ա*D��=X� ��]֍#8@�cSX��l�CU=H�\B��a6A�T�u �y��Y@p��P��5D( �C D��>����."a�� �yo��⇇�8��Q���yi1l��WW�2+�8sje���A��ז�u��m�K�61��M�v �&&]����.���}��m�K�6��%d���H� �ɁX�>;+�b��ÁX��:+ٟĊv�@�lCS�c�P�>�Yq_;+�.�����(�ms�ڄI���[.��� zh�Y;���� $�������c�V$�绽8��:����`����Y���|/�t�u���<~Î�PK � E[���t� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�NM��ݰa���=��&vd�О�G� XE�Tb�������4����ޞ���b��w-�A��\��)�����G��D��I^q����DiT'?����$SNCOg���GZ2VѰd�-�.3���>{u�Х?��͇c�� �A�S?�H��� �E���ʎ�k���M-�ˈ���;_�Tyͪ�WF4]sW+�} ��K�ey�Vw�cY*�0!�*�j��/6_PK � E[Ѓ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 � E[�s� K xl/sharedStrings.xml � (� �Tmo�0�+V����v���*Q4��'�5�|�u�����K��%?/�;�ٳ�J�G�(��{qyta��ǹw���S�!q-�2���c"1g�8�J��EbQB�105h�<[qr[{���� T�0��IXq�=V�F��K�<�h��������-n?6�YH�Y��`#E{�+�b;2ئ�}�j��%�LC7.���� rXI�?32�T�K��ϔ[b$�5���W����¡| �3�2W��G�ok��nO�WQ{E/�2't���5���}��3T��3���.��Q�S?�?ʓ�� �|1��$�I*��yU+p�l�p��K�C ��ԇ���#?�Y�"�� �����]��6������(�g��-h��^K�����µ"Mz���}���������_�k�&$� ��v�~m�0�����7X|PK- � E[Ђ� 5 xl/workbook.xmlPK- � E[���� � � [Content_Types].xmlPK- � E[G���' ' U _rels/.relsPK- � E[�dP�� � � xl/worksheets/sheet1.xmlPK- � E[���t� P � xl/_rels/workbook.xml.relsPK- � E[Ѓc'2 E ; xl/styles.xmlPK- � E[�s� K � xl/sharedStrings.xmlPK � �