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": "L+HLNAYMzECnMY3skNiVWw==",
"guid": "34cbe12f-0c06-40cc-a731-8dec90d8955b",
"name": "sample string 1",
"storeID": 2,
"zoneID": 1,
"checkoutFormG_UID": "TN91Lu3/i0ugzx3s/8c1hg==",
"checkoutFormGuid": "2e75df4c-ffed-4b8b-a0cf-1decffc73586",
"displayToWho": 3,
"displayWhen": 4,
"start": "2026-04-02T05:48:02.198655",
"end": "2026-04-02T05:48:02.198655",
"deleted": true,
"updated": "2026-04-02T05:48:02.198655",
"possibleIntegerResponses": [
1,
2
],
"possibleTextResponses": [
"sample string 1",
"sample string 2"
],
"possibleGuidResponses": [
"5423705b-981f-4f90-a7d8-149fa9b92a1e",
"7768260d-5aee-46d3-87be-92e75c6b4346"
],
"allowsAllTextResponses": true,
"surveyForm": {
"$id": "2",
"id": 1,
"g_UID": "hZxfQ4uFO0WVFCVV5xgThQ==",
"guid": "435f9c85-858b-453b-9514-2555e7181385",
"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": "PpNoWlzoekefzXV96MDSxA==",
"previousFormGuid": "5a68933e-e85c-477a-9fcd-757de8c0d2c4",
"nextForm": 1,
"nextFormG_UID": "2QO+fwPOMEKQBF4GZp0OYg==",
"nextFormGuid": "7fbe03d9-ce03-4230-9004-5e06669d0e62",
"attributes": "sample string 10",
"updated": "2026-04-02T05:48:02.198655",
"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": "35XbrZW7BkK6bT1lXCbpfg==",
"checkoutFormGuid": "addb95df-bb95-4206-ba6d-3d655c26e97e",
"identifier": "C0a/IZVwtkG8BrTDrrts9w==",
"identifierGuid": "21bf460b-7095-41b6-bc06-b4c3aebb6cf7",
"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": "+5yeJStrLU6iHVTCGSdIiQ==",
"valueGuid": "259e9cfb-6b2b-4e2d-a21d-54c219274889",
"buttonText": "sample string 10",
"valueText": "sample string 11",
"drawImageAndButton": true,
"updated": "2026-04-02T05:48:02.198655",
"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-04-02T05:48:02.198655",
"imageData": "QEA=",
"readOnly": true
}
},
{
"$ref": "3"
}
],
"panels": [
{
"$id": "5",
"id": 1,
"checkoutFormID": 2,
"checkoutFormG_UID": "BJs8ifoS80iY0jhzL6qjjA==",
"checkoutFormGuid": "893c9b04-12fa-48f3-98d2-38732faaa38c",
"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
"912e121d-21a2-490b-a9eb-2978b7f49574"
application/xml, text/xml
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">912e121d-21a2-490b-a9eb-2978b7f49574</guid>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
PK .�\Nf�� 5 xl/workbook.xml � (� ��;�0D�H���ĀP��PѤM���K��َ��c�@J�ngv���E����>rV��
�75!�A2w�T�
�J惴/��A����-Ay�%ɕX��Z�Q�7�?,g,0�F /�
%�P�=��k����E���j"���o�F�qRLB�;�Fѹ���Z���"ɫ�L���3B;��Q��n�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
.�\W��' ' _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="R2a69f4f9738c4d3c" /></Relationships>PK .�\3qJX% � xl/worksheets/sheet1.xml � (� �Q�n� ���B�*]V%�*U�v�v��,q
j����? �4i� [~~��Tǻ،�)25l���:e�5L�(��Tٛ����q[��~<p�Z�Z��F4�֓��^9��j�L��x���=�8��T����?\n�(�dA+��@Su*�G��b_�i�7UB�+\ܯ��1>�n1y�j���_��e�b�-Ϩ�҇
������i�L�{z�yYî�����we�-vO���y�kyu�W��y^4����T�1���4��0����co8���aKh/DmR����PK .�\�k|i� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�1&M��ݰa[z��Q۲]�gc���V� �X��j4��'�|�lvo�D^0�ѻ�A�����)��v��'��D�cH���ԃ�9�)M��,S���1>�2�44Hu�R�XC��Lr8��3*|��4���髏�d3����~J�^B]*�'�Þ�]�֫�\K �fj)�'L�^��BFqƕᵖ�B�Me����s,�^:-���N�{�it'Zi.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 .�\j`�� � xl/sharedStrings.xml � (� 5�AN�0�b����
d�����dvc)����1���Vu�}�M}�����ҁB���1������bI��������6%a�_��yŒ�Rw����Q�4<����+���{6%e5ד�iA��?O|��&�1H�֡uv��&�{�M:y����u��`$��7�U�PK- .�\Nf�� 5 xl/workbook.xmlPK- .�\���� � [Content_Types].xmlPK-
.�\W��' ' V _rels/.relsPK- .�\3qJX% � � xl/worksheets/sheet1.xmlPK- .�\�k|i� P 9 xl/_rels/workbook.xml.relsPK- .�\Ѓc'2 E
~ xl/styles.xmlPK- .�\j`�� � � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
PK .�\��1�� 5 xl/workbook.xml � (� ����0��&�C��h�N\�z�[i�?ik��H�yۙ��v����imO>z0��5�bt%c�w�!�C3���$��Y)���F�)�r�q��� �r�.�X�y:Ĩ��A��w�Ts���1$9k��$l ��T�`�ERĀƚ�����DM���RM�]��.���|Ŝn�
V��w�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
.�\͝3�' ' _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="R8a1b266a42294a8d" /></Relationships>PK .�\3qJX% � xl/worksheets/sheet1.xml � (� �Q�n� ���B�*]V%�*U�v�v��,q
j����? �4i� [~~��Tǻ،�)25l���:e�5L�(��Tٛ����q[��~<p�Z�Z��F4�֓��^9��j�L��x���=�8��T����?\n�(�dA+��@Su*�G��b_�i�7UB�+\ܯ��1>�n1y�j���_��e�b�-Ϩ�҇
������i�L�{z�yYî�����we�-vO���y�kyu�W��y^4����T�1���4��0����co8���aKh/DmR����PK .�\w��� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�'4�i7lؖ^��q5�#�z6�+` \���F�{z�����z�6O�C�롮t���
=��Y�v���$R��v\"�+.�`SZ(���,b�t�c|�E�i�"�AHoki(p�$�ӂ�!zcF��^gt�0}��-b�a���O)�s��L�{���t�ѝ
�
[ �jj1�&��^�y!�q'&3
�g�Ue���Sȗ.��r��eǥl�Zj.[~V���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 .�\j`�� � xl/sharedStrings.xml � (� 5�AN�0�b����
d�����dvc)����1���Vu�}�M}�����ҁB���1������bI��������6%a�_��yŒ�Rw����Q�4<����+���{6%e5ד�iA��?O|��&�1H�֡uv��&�{�M:y����u��`$��7�U�PK- .�\��1�� 5 xl/workbook.xmlPK- .�\���� � � [Content_Types].xmlPK-
.�\͝3�' ' U _rels/.relsPK- .�\3qJX% � � xl/worksheets/sheet1.xmlPK- .�\w��� P 8 xl/_rels/workbook.xml.relsPK- .�\Ѓc'2 E
} xl/styles.xmlPK- .�\j`�� � � xl/sharedStrings.xmlPK � �