POST api/surveys
Request Information
URI Parameters
None.
Body Parameters
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. |
Request Formats
application/json, text/json
{ "g_UID": "uEXAzx09LEmuc/3xEar7VA==", "guid": "cfc045b8-3d1d-492c-ae73-fdf111aafb54", "name": "sample string 1", "storeID": 2, "zoneID": 1, "checkoutFormG_UID": "VuGwMJ94xki95LIx3fG8yA==", "checkoutFormGuid": "30b0e156-789f-48c6-bde4-b231ddf1bcc8", "displayToWho": 3, "displayWhen": 4, "start": "2025-06-14T06:53:32.8092416", "end": "2025-06-14T06:53:32.8092416", "deleted": true, "updated": "2025-06-14T06:53:32.8092416", "possibleIntegerResponses": [ 1, 2 ], "possibleTextResponses": [ "sample string 1", "sample string 2" ], "possibleGuidResponses": [ "82c96e54-5544-4180-abb4-12d4821974d4", "ada44b3f-3b63-41c4-92ef-6ade8563ae4c" ], "allowsAllTextResponses": true, "surveyForm": { "$id": "2", "id": 1, "g_UID": "SF/Cm99Vr0eygGlWtJAa5A==", "guid": "9bc25f48-55df-47af-b280-6956b4901ae4", "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": "P8eBbsiCf0W88B3h0BlCkA==", "previousFormGuid": "6e81c73f-82c8-457f-bcf0-1de1d0194290", "nextForm": 1, "nextFormG_UID": "39LTojtYiUukZ+gqfL0n6A==", "nextFormGuid": "a2d3d2df-583b-4b89-a467-e82a7cbd27e8", "attributes": "sample string 10", "updated": "2025-06-14T06:53:32.8092416", "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": "k+sELZPlf0mBEl6gUvfVjw==", "checkoutFormGuid": "2d04eb93-e593-497f-8112-5ea052f7d58f", "identifier": "nulE12mgoEODLNl7obzY3g==", "identifierGuid": "d744e99e-a069-43a0-832c-d97ba1bcd8de", "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": "0JqprUAtbEq0Khe81bb0qw==", "valueGuid": "ada99ad0-2d40-4a6c-b42a-17bcd5b6f4ab", "buttonText": "sample string 10", "valueText": "sample string 11", "drawImageAndButton": true, "updated": "2025-06-14T06:53:32.8092416", "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-14T06:53:32.8092416", "imageData": "QEA=", "readOnly": true } }, { "$ref": "3" } ], "panels": [ { "$id": "5", "id": 1, "checkoutFormID": 2, "checkoutFormG_UID": "GHd86dxJ8Eq/iUWpJGLYHw==", "checkoutFormGuid": "e97c7718-49dc-4af0-bf89-45a92462d81f", "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/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
globally unique identifierResponse Formats
application/json, text/json
"581dbb27-30f9-484f-af19-3005838de3c9"
application/xml, text/xml
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">581dbb27-30f9-484f-af19-3005838de3c9</guid>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
PK �6�Z���� 5 xl/workbook.xml � (� ����0��&�C��R���x��}��4П�5��$���~;�d��3����]I�lΘo{T�OƢ�;a���{1#�l�6�[����s8B�F�^ZOW�?,oB�{Ġ��@jZ�s����/2[��$l ��T����E KZC J�ޕ4���2�fi�pH�ir�ӝ�� ����PK �6�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 �6�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="R9f81972e73a3447b" /></Relationships>PK �6�Z[(��% � xl/worksheets/sheet1.xml � (� �QMo� �+��B��KU�jRUm�i���'�a����6M�e����{6��nFvGm͋,�l���C�g�?���tWR �������~: A�#)� l����!u����-��� X/�<� ��A�����l��Ɂ�3�TFj˛�Ӂ=�g��?���J�w ��Y������y?�KR~u��^Σ���|��6��8R���qo�yO�;�j���v���,��fؖ��3y4kyu)V��y�^6�Å�T�1��Pr�)�{k�J�bo8���WaK�.�\R����PK �6�Z�� � P xl/_rels/workbook.xml.rels � (� ��Kn� ���f_c㇒*N6�t��<c�Hۜ���W(j��H]t�����>�?6��y"/���lUQA+����9�춛N<���K � =��GJ�48�P�m�h�gS��py�RV��9n��xY�?D��(q��yF� �W�O� F G��=���>�"Q�<�+��J0^�u�0̀л��x�0�z]�L��N�Zp��؈N�U�p��9����)o�9� e#��Q�5'z�/�_PK �6�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 �6�ZR:�� � xl/sharedStrings.xml � (� 5�An� E��f���&�J9A{ b�1�\ϸJn������������B� i,1�}��kcA��a)�<�A]�cU���"��<ΘʊT��l9H��y�0D�%/�h̛�!���$Uj����?WA�N�ٶ�v;�7����dOS���hζ���wZ��}]_�PK- �6�Z���� 5 xl/workbook.xmlPK- �6�Z���� � � [Content_Types].xmlPK- �6�Z��(�' ' U _rels/.relsPK- �6�Z[(��% � � xl/worksheets/sheet1.xmlPK- �6�Z�� � P 8 xl/_rels/workbook.xml.relsPK- �6�ZЃc'2 E ~ xl/styles.xmlPK- �6�ZR:�� � � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
PK �6�Z�f*� 5 xl/workbook.xml � (� ����0��J}�(� �E��ҵCwL� ?JR��o�[7�����E۩�z"9+Wښ�ޛ�1�G��.ڠ �A[ >H�bz�V�D�Y�$9�8�Z�QG7�?,g,B�FD/� %A(ڜO�Tk����E���j���o����"*�@bM[�@It�}MSJl)��[� O��ʇ��V��w�PK �6�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 �6�ZW5N' ' _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="R6f305f787a0040db" /></Relationships>PK �6�Z[(��% � xl/worksheets/sheet1.xml � (� �QMo� �+��B��KU�jRUm�i���'�a����6M�e����{6��nFvGm͋,�l���C�g�?���tWR �������~: A�#)� l����!u����-��� X/�<� ��A�����l��Ɂ�3�TFj˛�Ӂ=�g��?���J�w ��Y������y?�KR~u��^Σ���|��6��8R���qo�yO�;�j���v���,��fؖ��3y4kyu)V��y�^6�Å�T�1��Pr�)�{k�J�bo8���WaK�.�\R����PK �6�Z�!.t� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8N�⠦ݰa[z��3��&vd�@�Ƃ#q�"A*�`��h~OO��|���ަ����� �,FV�n�}���$춛=��D0�XZ�����yP�&��ɦ�v~R���{�E���_2����CtZ��:Md�`���1�쀾���O)�KY�{��c]R!�EזJK`�fj!�G �^��B�mݽ�Z�e��MezꞣO�^:-��J֕,��UY�zU]���_l� PK �6�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 �6�ZR:�� � xl/sharedStrings.xml � (� 5�An� E��f���&�J9A{ b�1�\ϸJn������������B� i,1�}��kcA��a)�<�A]�cU���"��<ΘʊT��l9H��y�0D�%/�h̛�!���$Uj����?WA�N�ٶ�v;�7����dOS���hζ���wZ��}]_�PK- �6�Z�f*� 5 xl/workbook.xmlPK- �6�Z���� � � [Content_Types].xmlPK- �6�ZW5N' ' U _rels/.relsPK- �6�Z[(��% � � xl/worksheets/sheet1.xmlPK- �6�Z�!.t� P 8 xl/_rels/workbook.xml.relsPK- �6�ZЃc'2 E xl/styles.xmlPK- �6�ZR:�� � � xl/sharedStrings.xmlPK � �