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": "Eb7YK5WeckiFEEdsplCBfQ==", "guid": "2bd8be11-9e95-4872-8510-476ca650817d", "name": "sample string 1", "storeID": 2, "zoneID": 1, "checkoutFormG_UID": "sf85lX9ugEOZILL4U4QEcw==", "checkoutFormGuid": "9539ffb1-6e7f-4380-9920-b2f853840473", "displayToWho": 3, "displayWhen": 4, "start": "2025-10-04T23:59:16.3133373", "end": "2025-10-04T23:59:16.3133373", "deleted": true, "updated": "2025-10-04T23:59:16.3133373", "possibleIntegerResponses": [ 1, 2 ], "possibleTextResponses": [ "sample string 1", "sample string 2" ], "possibleGuidResponses": [ "43b59a74-c3f0-4b7c-9355-26cb3df8a8c0", "9fc06191-78b6-453a-b845-62321f7e13bd" ], "allowsAllTextResponses": true, "surveyForm": { "$id": "2", "id": 1, "g_UID": "igWZQfDOOEiGEuWKembenA==", "guid": "4199058a-cef0-4838-8612-e58a7a66de9c", "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": "koaiHJ7tpUOHFfVr+7ZOcA==", "previousFormGuid": "1ca28692-ed9e-43a5-8715-f56bfbb64e70", "nextForm": 1, "nextFormG_UID": "4DOk+rELB0uA6hIzuu5tXQ==", "nextFormGuid": "faa433e0-0bb1-4b07-80ea-1233baee6d5d", "attributes": "sample string 10", "updated": "2025-10-04T23:59:16.3133373", "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": "FEbaHCUqd0O0xuj1l0DfUg==", "checkoutFormGuid": "1cda4614-2a25-4377-b4c6-e8f59740df52", "identifier": "rKs0qjRO/0Oew/EejQXzjQ==", "identifierGuid": "aa34abac-4e34-43ff-9ec3-f11e8d05f38d", "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": "glskgh6LNkiiw1Mr+PqlTQ==", "valueGuid": "82245b82-8b1e-4836-a2c3-532bf8faa54d", "buttonText": "sample string 10", "valueText": "sample string 11", "drawImageAndButton": true, "updated": "2025-10-04T23:59:16.3133373", "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-04T23:59:16.3133373", "imageData": "QEA=", "readOnly": true } }, { "$ref": "3" } ], "panels": [ { "$id": "5", "id": 1, "checkoutFormID": 2, "checkoutFormG_UID": "gOm+ON9YfUaB5gMO2GV9MQ==", "checkoutFormGuid": "38bee980-58df-467d-81e6-030ed8657d31", "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
"cd1dca8e-17b9-487d-a3ba-177b2f1c7020"
application/xml, text/xml
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">cd1dca8e-17b9-487d-a3ba-177b2f1c7020</guid>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
PK h�D[���߶ 5 xl/workbook.xml � (� ����0��&�C��h )��x��ҭm�?ik��-%�x�3;������i�>z4�� �1����K�,��v�z�b��E�����o &�SQT��Ȣ�&H�^h�����x� Q�J3ep��!D�fS�2k��Dd ��Ͱ�"+d��w,2��s� >b�k����+/J^��y%���`����/PK h�D[���� � [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�D[��%�' ' _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="R6cc3ae8b9ccd469e" /></Relationships>PK h�D[�ƀ�% � xl/worksheets/sheet1.xml � (� �Q�n� ���J�6UV%�&U�v�v��,q j����? �4i� [~~��T��،�)25���:e�5L�(��Tٛ����qG[��~<r�Z�Z� �hB�'����r�{���I��|�enq>H9�F+���hQtɂV*-����T`��ž��o��|W��_1�c|�b��Ր%,��$�W�:��4�7Z�Q]�*ROK�K7�*� ���.��]���}�{,�CY�K`��<鏵���+M�</����l*��y\r�]�wn��ϱ7� ����˰%�"�6)��\�PK h�D[P���� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�i���vÆm�{�DMl�v���G� XEWb�������4����ݿ-3yA�'�;�3�0r�C�Z���y�~��'qE���R/F\�όE;ʸ�����Z.N|@�b��.e�-�/�C4JM�8/��`�j�ɏ�ȑ�C?%O�!�"ȓ���c�JV�J6X�Z�wS��2������`��Eۈ�(��]eF�P>/�:��Dm]��WR��-������PK h�D[Ѓ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 h�D[�g� � xl/sharedStrings.xml � (� 5�AN�0�b�=k' ��= �x�Ğ�X��!3A�{́c��U��e3_tH�<Cq`�cM��3|��uQ�[e���5x5m�2ê��X+q��r�;qKn�(� ���� L�i���ܓ-�L�'kӂ99����M���S�"N�����=Nc��a���2��8��y��ۿ�m��/PK- h�D[���߶ 5 xl/workbook.xmlPK- h�D[���� � � [Content_Types].xmlPK- h�D[��%�' ' U _rels/.relsPK- h�D[�ƀ�% � � xl/worksheets/sheet1.xmlPK- h�D[P���� P 8 xl/_rels/workbook.xml.relsPK- h�D[Ѓc'2 E } xl/styles.xmlPK- h�D[�g� � � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
PK h�D[��7ٶ 5 xl/workbook.xml � (� ����0��&�C����J�����������ě����o���Z��#�r[��{�3�%��6�k+�i_Ls.�u�<K�(c�B+� ��B���Eh]��尠$E����bj�8�Yc�;��-!��*f�v1+�@bIk�@���ڒƔ�\��~��� �����Ӎ�� ����PK h�D[���� � [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�D[>�j�' ' _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="R4507895262054b55" /></Relationships>PK h�D[�ƀ�% � xl/worksheets/sheet1.xml � (� �Q�n� ���J�6UV%�&U�v�v��,q j����? �4i� [~~��T��،�)25���:e�5L�(��Tٛ����qG[��~<r�Z�Z� �hB�'����r�{���I��|�enq>H9�F+���hQtɂV*-����T`��ž��o��|W��_1�c|�b��Ր%,��$�W�:��4�7Z�Q]�*ROK�K7�*� ���.��]���}�{,�CY�K`��<鏵���+M�</����l*��y\r�]�wn��ϱ7� ����˰%�"�6)��\�PK h�D[m��� P xl/_rels/workbook.xml.rels � (� ��Kn�0@�b;��#�n��\�8�8"�#۴�l]�H�B-*� ���h~OO����Zo?Ɓ�����A�\��N�)�%l7�2��`�)��b� 㴢4(����Ц�v~�1����TG�!-k��3�I�� �CtZ� ��:�h�0}w�b����(��%�Y�yi�ʼX֒K]�E� �>L-�������d�,�e����X#=��ѧKϝ��ge������E�����PK h�D[Ѓ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 h�D[�g� � xl/sharedStrings.xml � (� 5�AN�0�b�=k' ��= �x�Ğ�X��!3A�{́c��U��e3_tH�<Cq`�cM��3|��uQ�[e���5x5m�2ê��X+q��r�;qKn�(� ���� L�i���ܓ-�L�'kӂ99����M���S�"N�����=Nc��a���2��8��y��ۿ�m��/PK- h�D[��7ٶ 5 xl/workbook.xmlPK- h�D[���� � � [Content_Types].xmlPK- h�D[>�j�' ' U _rels/.relsPK- h�D[�ƀ�% � � xl/worksheets/sheet1.xmlPK- h�D[m��� P 8 xl/_rels/workbook.xml.relsPK- h�D[Ѓc'2 E } xl/styles.xmlPK- h�D[�g� � � xl/sharedStrings.xmlPK � �