POST api/surveys
Request Information
URI Parameters
None.
Body Parameters
Survey| Name | 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": "rxdWDQCGP0y8AQnWgfOdQw==",
"guid": "0d5617af-8600-4c3f-bc01-09d681f39d43",
"name": "sample string 1",
"storeID": 2,
"zoneID": 1,
"checkoutFormG_UID": "Buc0J4YwtUqgudbKN9z15g==",
"checkoutFormGuid": "2734e706-3086-4ab5-a0b9-d6ca37dcf5e6",
"displayToWho": 3,
"displayWhen": 4,
"start": "2026-06-03T18:31:23.6003718",
"end": "2026-06-03T18:31:23.6003718",
"deleted": true,
"updated": "2026-06-03T18:31:23.6003718",
"possibleIntegerResponses": [
1,
2
],
"possibleTextResponses": [
"sample string 1",
"sample string 2"
],
"possibleGuidResponses": [
"3dafd878-9701-4833-83b3-ca593d1c8070",
"579dd6b1-38a4-4aa9-8399-8cf1e42a5c02"
],
"allowsAllTextResponses": true,
"surveyForm": {
"$id": "2",
"id": 1,
"g_UID": "atHfGfVwi0yeK1942v/Feg==",
"guid": "19dfd16a-70f5-4c8b-9e2b-5f78daffc57a",
"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": "IQqxrpoj9kGr5/KnFMPaYA==",
"previousFormGuid": "aeb10a21-239a-41f6-abe7-f2a714c3da60",
"nextForm": 1,
"nextFormG_UID": "wpY4pwlEvUCKU857YeYctQ==",
"nextFormGuid": "a73896c2-4409-40bd-8a53-ce7b61e61cb5",
"attributes": "sample string 10",
"updated": "2026-06-03T18:31:23.6003718",
"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": "qptcaryg10KgK/MkY4jMkg==",
"checkoutFormGuid": "6a5c9baa-a0bc-42d7-a02b-f3246388cc92",
"identifier": "YNt/kMO3ek6vfKfazsMJ7A==",
"identifierGuid": "907fdb60-b7c3-4e7a-af7c-a7dacec309ec",
"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": "h1SX+j1TSEi1b+0/4JZ5Dw==",
"valueGuid": "fa975487-533d-4848-b56f-ed3fe096790f",
"buttonText": "sample string 10",
"valueText": "sample string 11",
"drawImageAndButton": true,
"updated": "2026-06-03T18:31:23.6003718",
"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": "2026-06-03T18:31:23.6003718",
"imageData": "QEA=",
"readOnly": true
}
},
{
"$ref": "3"
}
],
"panels": [
{
"$id": "5",
"id": 1,
"checkoutFormID": 2,
"checkoutFormG_UID": "YZTUDQJ9h0qNBJbCJwBrjQ==",
"checkoutFormGuid": "0dd49461-7d02-4a87-8d04-96c227006b8d",
"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
"369e0ab4-f7a8-4f29-886d-d0587e1aa50d"
application/xml, text/xml
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">369e0ab4-f7a8-4f29-886d-d0587e1aa50d</guid>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
PK ��\��e�� 5 xl/workbook.xml � (� ����0��&�C���R8q����
�m�?ik���'�x�3;�����imO>z0��%�1����H�N֡�v���$��ٮS
ֶyk4��9O����&H�]i����m��Q+J�2�:s���1,r2���I�b�)����EKZCJ�֖4��j�YWޤ-$]v�YNw�l�]}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
��\F�`' ' _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="R0d2f728027c24b33" /></Relationships>PK ��\TYJ% � xl/worksheets/sheet1.xml � (� �Q�N�0��(w���eLm'�i�� �кK�&����瓤!q�Ė��{v���lrmͷ��3�-v�^j>��nϏM� ]��,��;P͕��A�*0�mpj=��>�t�������E�e� �RN����?\n$�]�`���HmySu:�G�����Ӗ3�T ��aq�b��D��䥫y������_�u��i�o�<��(6T���nft�gF�һ�Ϋ���7Y�?�w��,����vr��Z^]��&i���ME�0J���8�KN����MV�9������~�tF�@I���/PK ��\��r�� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8 n>�i7lؖ^`j�㨉�.г��H\�H�J,�t5��ӓf>�?�۷id/���lE�#+�l��)�����F�i"�a,��Ё�q~�<HC���dSG;?aL�����=�2�+��f��y���փ�G'O����:�(ۣ�)v�S
��,Q�=�vM�u.+��nD����B<�~���L�U� ��my���AO�9�t�Ӳ�PÖ���\5������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 ��\^_*� � xl/sharedStrings.xml � (� 5�An� E��fO i�
�E���9�Ԍc$3�\5�/Yt��������g�C���=�w�Pb�G�ϛv��"G�SOP��E�jS��Z�wcd�(���Bܒ��k��adY �LD5��`mg2&5��kӂ�8}o���M���᭻�ů����q<\�s]�ўܙ��'����WߴW�PK- ��\��e�� 5 xl/workbook.xmlPK- ��\���� � [Content_Types].xmlPK-
��\F�`' ' V _rels/.relsPK- ��\TYJ% � � xl/worksheets/sheet1.xmlPK- ��\��r�� P 9 xl/_rels/workbook.xml.relsPK- ��\Ѓc'2 E
xl/styles.xmlPK- ��\^_*� � � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
PK ��\co {� 5 xl/workbook.xml � (� ����0D�&�C��
��N\�z���6Ж�5��B $��ξ>Z���v�{�sWP3����h���NC��{1+�j���[� ,93氇���R
�.�X~p���A�J�2����s����G9k��$l �����"*b@cA+@It�mAO��\M�#A-���5�,M���`����/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
��\F|b' ' _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="R744aacca94e741df" /></Relationships>PK ��\TYJ% � xl/worksheets/sheet1.xml � (� �Q�N�0��(w���eLm'�i�� �кK�&����瓤!q�Ė��{v���lrmͷ��3�-v�^j>��nϏM� ]��,��;P͕��A�*0�mpj=��>�t�������E�e� �RN����?\n$�]�`���HmySu:�G�����Ӗ3�T ��aq�b��D��䥫y������_�u��i�o�<��(6T���nft�gF�һ�Ϋ���7Y�?�w��,����vr��Z^]��&i���ME�0J���8�KN����MV�9������~�tF�@I���/PK ��\{��$� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�M����vÆm���8��ؑ�=�����ĂMW��==i���c�{�B>��6��0�ʵ��8G����v��c���K+64`b�֜ehĐ��l�h�G�)��P��#�Qq?g�-�.����=:u��?����S0D�}G���R�װ��S��>'�-��e]hY90~7�/�_��|&#d]�8.K�B�����AO�s���s�yy��5QR�\�+)�j��/�_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 ��\^_*� � xl/sharedStrings.xml � (� 5�An� E��fO i�
�E���9�Ԍc$3�\5�/Yt��������g�C���=�w�Pb�G�ϛv��"G�SOP��E�jS��Z�wcd�(���Bܒ��k��adY �LD5��`mg2&5��kӂ�8}o���M���᭻�ů����q<\�s]�ўܙ��'����WߴW�PK- ��\co {� 5 xl/workbook.xmlPK- ��\���� � � [Content_Types].xmlPK-
��\F|b' ' U _rels/.relsPK- ��\TYJ% � � xl/worksheets/sheet1.xmlPK- ��\{��$� P 8 xl/_rels/workbook.xml.relsPK- ��\Ѓc'2 E
} xl/styles.xmlPK- ��\^_*� � � xl/sharedStrings.xmlPK � �