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": "EwkTkIZVp0SNeGHG/sSS9g==", "guid": "90130913-5586-44a7-8d78-61c6fec492f6", "name": "sample string 1", "storeID": 2, "zoneID": 1, "checkoutFormG_UID": "m/SQlmxk60S3KbFCCY1HYA==", "checkoutFormGuid": "9690f49b-646c-44eb-b729-b142098d4760", "displayToWho": 3, "displayWhen": 4, "start": "2025-06-14T07:09:29.0803941", "end": "2025-06-14T07:09:29.0803941", "deleted": true, "updated": "2025-06-14T07:09:29.0803941", "possibleIntegerResponses": [ 1, 2 ], "possibleTextResponses": [ "sample string 1", "sample string 2" ], "possibleGuidResponses": [ "f1c8a415-d0b2-41fb-ac66-2db06f512664", "5869eed5-16e3-4db7-a82c-83d1ab455b49" ], "allowsAllTextResponses": true, "surveyForm": { "$id": "2", "id": 1, "g_UID": "1mQXWORz7U+ny2MEIQ1P9w==", "guid": "581764d6-73e4-4fed-a7cb-6304210d4ff7", "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": "LHC50fI14kSNGWKXpDa7bw==", "previousFormGuid": "d1b9702c-35f2-44e2-8d19-6297a436bb6f", "nextForm": 1, "nextFormG_UID": "jnk72XVADEuJ48F/lLAqpg==", "nextFormGuid": "d93b798e-4075-4b0c-89e3-c17f94b02aa6", "attributes": "sample string 10", "updated": "2025-06-14T07:09:29.0803941", "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": "tnqlNfGa5k2hXD21x/zT9w==", "checkoutFormGuid": "35a57ab6-9af1-4de6-a15c-3db5c7fcd3f7", "identifier": "45qXuYAt/kK4gYBO2CWFLw==", "identifierGuid": "b9979ae3-2d80-42fe-b881-804ed825852f", "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": "sUFEusW/+0uugFxYGB78lw==", "valueGuid": "ba4441b1-bfc5-4bfb-ae80-5c58181efc97", "buttonText": "sample string 10", "valueText": "sample string 11", "drawImageAndButton": true, "updated": "2025-06-14T07:09:29.0803941", "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-06-14T07:09:29.0803941", "imageData": "QEA=", "readOnly": true } }, { "$ref": "3" } ], "panels": [ { "$id": "5", "id": 1, "checkoutFormID": 2, "checkoutFormG_UID": "PI4kbgjWtU+aQ2Q3bpewSw==", "checkoutFormGuid": "6e248e3c-d608-4fb5-9a43-64376e97b04b", "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 .9�Z��D-� 5 xl/workbook.xml � (� ����0D�&�C���8q����B�H[����[J ��mgv��T�u���������T�0���^�������tOf�A�������q~eG�/���J���'� �Dz\Q����@H�4{(�}����.&ak�����/�"4ִ� �$�&jz�ĕ*wQp�}^pp����V��w�PK .9�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 .9�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="R8ae7f6ddd4634923" /></Relationships>PK .9�Z{ � � xl/worksheets/sheet1.xml � (� ��Ks�@�� �~�ߏ��Jb�;�q1�f��TĶ����i�1�(T�vs�����3Yy*�b��0 ���3=�ׯC�=_���h���[�T*����ҡ����Yf��J�,��6k�&Qnn��P/�L���=Q�<D �0U�(7[e�x���j���6�����վT�k4�Ǧ���^�C��M�A���6k\{�'������n>�A��xRl��zs���W�TooU��̍I����*+>�$�Y�{I�Y|o�y�4W8�3B��K�{��,�ɟr���ףR�z�. #HB,� �����zp �D2!8:�'���2�0D��h��_ԱR����@Rf��C��R�k�D� 'BA�]����]�I� ��Ύ�e���v ����n���� �$�J� B��@xH�n�*s}�y�J��ݻ��Gp��&��&�=��Aڬ�%�����S�� �3H�C ,�) �˞ Ua�B�B9��@$�P��A$,0- ���-�� b�?ŬGy4�z�Ų����0�Y1����̨��A��Ӗ�e��m�K�61��M\w �&&]����.���m��m�K�6q�%d�xp8f���@,W��e��|��@,c_���/bY;u ��� �!}�N�,�/���UA��� q��f5a����V���V��kVg�[kT���̟ň +�����[�<�^��Q�Π�3�@��{�@����1 ��uQ��s���� ;�PK .9�Z�;�O� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞� V>�i7lؖ^��'q�Ķl��Xp$��U$p%l����I3����ۺ��a����`@�H�f3�p��]��f���i"���VL�A��( R�*Ba���_EL����(&�c5�9���pv���Y⣕�M�L_�?����0��S ��"Q�<���ce�1T�W� ��L-�����;�d����Z�m�:^��2ZxT�ѧK�Ny9S�9�wM�J5(���ѫ��~PK .9�ZЃ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 .9�Z-��V� K xl/sharedStrings.xml � (� �T�n�0����u��I�%i`�%yY1l����d����On�]bg�"@��P�"������ ��N���B����mo܉Ð�*�� �N��Y�H�JN���~����Pq�t �F�T���}� �K ��A�W\(��Q4u���%�60��#�,����j��4��xQ�c�x�؆���q?�Z�y ��Ѝ�>x�o����-#�N��=���N�!F�_�R��$�,���wQ�%���{�Z+����#���]�E�k)� ���T��<@��g/�"A�i �?�� i8r��&��|�N���M�<9@��!9� �j v��n�R&ip�ӽ��InS��ݏ��݇q��"'��fk���=��k)!'��лF��[��9�a�V��^e�,�<�����y=��Xs��xk]�Do��{��^�"�~} ?��� f�PK- .9�Z��D-� 5 xl/workbook.xmlPK- .9�Z���� � � [Content_Types].xmlPK- .9�Z�*^' ' U _rels/.relsPK- .9�Z{ � � � xl/worksheets/sheet1.xmlPK- .9�Z�;�O� P � xl/_rels/workbook.xml.relsPK- .9�ZЃc'2 E ? xl/styles.xmlPK- .9�Z-��V� K � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
PK .9�Z�Fk[� 5 xl/workbook.xml � (� ����0��J}�(��WT���ҵCwL� JR��o �ԭ��|�||6vh��G������S��=*p3���X>H�b���ڈ�B�YE9�8��F�^N�n�Xn����7��iu>fO��[e0���I�b�)��U KZ�JV�ޖ4��2h�6N���"k�+=����w�PK .9�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 .9�Z;�a' ' _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="R7b5d183de9cc48a4" /></Relationships>PK .9�Z{ � � xl/worksheets/sheet1.xml � (� ��Ks�@�� �~�ߏ��Jb�;�q1�f��TĶ����i�1�(T�vs�����3Yy*�b��0 ���3=�ׯC�=_���h���[�T*����ҡ����Yf��J�,��6k�&Qnn��P/�L���=Q�<D �0U�(7[e�x���j���6�����վT�k4�Ǧ���^�C��M�A���6k\{�'������n>�A��xRl��zs���W�TooU��̍I����*+>�$�Y�{I�Y|o�y�4W8�3B��K�{��,�ɟr���ףR�z�. #HB,� �����zp �D2!8:�'���2�0D��h��_ԱR����@Rf��C��R�k�D� 'BA�]����]�I� ��Ύ�e���v ����n���� �$�J� B��@xH�n�*s}�y�J��ݻ��Gp��&��&�=��Aڬ�%�����S�� �3H�C ,�) �˞ Ua�B�B9��@$�P��A$,0- ���-�� b�?ŬGy4�z�Ų����0�Y1����̨��A��Ӗ�e��m�K�61��M\w �&&]����.���m��m�K�6q�%d�xp8f���@,W��e��|��@,c_���/bY;u ��� �!}�N�,�/���UA��� q��f5a����V���V��kVg�[kT���̟ň +�����[�<�^��Q�Π�3�@��{�@����1 ��uQ��s���� ;�PK .9�Z�= �� P xl/_rels/workbook.xml.rels � (� ��Kn� @��f_�m�XU�l��6�0Ɗ �&9[=R�P�J�#u�MV��==i���c��L#yCg[�3�tj�}����n�{EL�s iņL��3�A�D�܌6u��)�=��<�i�XM���Lr�����z��s�4������c0��A�c?�@o!�ȋja/�Z�e�VJ�� }�Z��ï�w���R������1£z�>]z�,/Ԛ�**�l�)ɫ���ѻ��|PK .9�ZЃ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 .9�Z-��V� K xl/sharedStrings.xml � (� �T�n�0����u��I�%i`�%yY1l����d����On�]bg�"@��P�"������ ��N���B����mo܉Ð�*�� �N��Y�H�JN���~����Pq�t �F�T���}� �K ��A�W\(��Q4u���%�60��#�,����j��4��xQ�c�x�؆���q?�Z�y ��Ѝ�>x�o����-#�N��=���N�!F�_�R��$�,���wQ�%���{�Z+����#���]�E�k)� ���T��<@��g/�"A�i �?�� i8r��&��|�N���M�<9@��!9� �j v��n�R&ip�ӽ��InS��ݏ��݇q��"'��fk���=��k)!'��лF��[��9�a�V��^e�,�<�����y=��Xs��xk]�Do��{��^�"�~} ?��� f�PK- .9�Z�Fk[� 5 xl/workbook.xmlPK- .9�Z���� � [Content_Types].xmlPK- .9�Z;�a' ' V _rels/.relsPK- .9�Z{ � � � xl/worksheets/sheet1.xmlPK- .9�Z�= �� P � xl/_rels/workbook.xml.relsPK- .9�ZЃc'2 E A xl/styles.xmlPK- .9�Z-��V� K � xl/sharedStrings.xmlPK � �