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": "kRnce+GHREWrb+0BbEUJfQ==", "guid": "7bdc1991-87e1-4544-ab6f-ed016c45097d", "name": "sample string 1", "storeID": 2, "zoneID": 1, "checkoutFormG_UID": "w6zxOKhuwkiYQ2cvwCfpng==", "checkoutFormGuid": "38f1acc3-6ea8-48c2-9843-672fc027e99e", "displayToWho": 3, "displayWhen": 4, "start": "2025-08-02T23:27:47.1822814", "end": "2025-08-02T23:27:47.1822814", "deleted": true, "updated": "2025-08-02T23:27:47.1822814", "possibleIntegerResponses": [ 1, 2 ], "possibleTextResponses": [ "sample string 1", "sample string 2" ], "possibleGuidResponses": [ "11a45f6a-8c40-4e0d-a6dd-045a30e692d3", "878ddf95-aff0-40c2-9a26-afb0e5d679db" ], "allowsAllTextResponses": true, "surveyForm": { "$id": "2", "id": 1, "g_UID": "o6fyIn5NHUyAi3BhV45osg==", "guid": "22f2a7a3-4d7e-4c1d-808b-7061578e68b2", "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": "D3jfMnJBCUGMQdbAixi5hg==", "previousFormGuid": "32df780f-4172-4109-8c41-d6c08b18b986", "nextForm": 1, "nextFormG_UID": "6PAnU0qJckySbBTTBBZ4Rg==", "nextFormGuid": "5327f0e8-894a-4c72-926c-14d304167846", "attributes": "sample string 10", "updated": "2025-08-02T23:27:47.1822814", "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": "J7M/rBb5nE+XvTbpWpXRsA==", "checkoutFormGuid": "ac3fb327-f916-4f9c-97bd-36e95a95d1b0", "identifier": "WNQtHQmeXkCPan9jkxEjzg==", "identifierGuid": "1d2dd458-9e09-405e-8f6a-7f63931123ce", "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": "rjxy0T+kwkK9eHpuw8IG3Q==", "valueGuid": "d1723cae-a43f-42c2-bd78-7a6ec3c206dd", "buttonText": "sample string 10", "valueText": "sample string 11", "drawImageAndButton": true, "updated": "2025-08-02T23:27:47.1822814", "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-08-02T23:27:47.1822814", "imageData": "QEA=", "readOnly": true } }, { "$ref": "3" } ], "panels": [ { "$id": "5", "id": 1, "checkoutFormID": 2, "checkoutFormG_UID": "e59hQkqgpkW3ikecab61AQ==", "checkoutFormGuid": "42619f7b-a04a-45a6-b78a-479c69beb501", "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
"68083d49-5611-48af-b617-1fd644db9c0f"
application/xml, text/xml
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">68083d49-5611-48af-b617-1fd644db9c0f</guid>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
PK w�[�f� 5 xl/workbook.xml � (� ����0��J}�(��*����k��L��(NE�!�n�|����_��/�ѳ��7T��*�p��^�w��Z�(���iRtvxk0��Yvef�5(�C���a�� F� A�Jeh{>R�� L2{��$l��T�`�ER� �D�$�66�S�+�{^d��%/��E9��`����/PK w�[���� � [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�[��U' ' _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="Ra29abb1fcde44331" /></Relationships>PK w�[���% � xl/worksheets/sheet1.xml � (� �QMo� �+���4k��$դ��n�ۙ%NA 8����6M�e����{6��{6�u�L�UMC�2� F�=��T�3ٛ����qG[��~8r��Z� hB�#����r�:���Q��<ϲ-����T����?\n�(�dA���@]�*�G��bW���˄|W8�_1�c|�b��V�%,��$�W�Z����7��Q]�*ROC�K7�*� ���Ϊ�����j�mۼ���!Γ�XʋK��$ͳ�.-�̦r`�Q��%�A܅y�:+�{� �o�K�[B{!�h�����_PK w�[�w�� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8vLi��ݰa[z��Q;�]�gc���V���X��j4��'�|���o�H^0���XUA��\��)��%l7��2�h�9���b6�yEiT'+?����$SNCOg���G��zACɀk&ٟg��3(|��4�K���h��=�~J�^�2ȓ�`�E�o�@֊V�Л��t1�z}�3Z�/-5��/o+ce@��B�t�T���Tkx��qh�����PK w�[Ѓ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 w�[D�RQ� � xl/sharedStrings.xml � (� 5�An� E����u�Sa���$ f#�������%�.���zߟ�"��Q�8H{0R �5e|�v�R��S\*� ��8OĢM�93��Z�8C�t�+`K���� ���u��h��7c�.1�cݑ�V����n�<כ�=u'ut֪����;���\ץ�i4���~�u{� PK- w�[�f� 5 xl/workbook.xmlPK- w�[���� � � [Content_Types].xmlPK- w�[��U' ' U _rels/.relsPK- w�[���% � � xl/worksheets/sheet1.xmlPK- w�[�w�� P 8 xl/_rels/workbook.xml.relsPK- w�[Ѓc'2 E } xl/styles.xmlPK- w�[D�RQ� � � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
PK w�[ E� 5 xl/workbook.xml � (� ����0��&�C��� N\�zm�-ik��H�yۙ��v�����\K>��!�%U1�9cA(4v�G;���(��9)��ډ�Aف�y� jg��}�3�V�=Bb42�-��B���C�����d6��o�H��")b�`Ik�@IrnMI���\��β�x���$ĕ��V��w�PK w�[���� � [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�[`Y#' ' _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="R6a8232843ff445cd" /></Relationships>PK w�[���% � xl/worksheets/sheet1.xml � (� �QMo� �+���4k��$դ��n�ۙ%NA 8����6M�e����{6��{6�u�L�UMC�2� F�=��T�3ٛ����qG[��~8r��Z� hB�#����r�:���Q��<ϲ-����T����?\n�(�dA���@]�*�G��bW���˄|W8�_1�c|�b��V�%,��$�W�Z����7��Q]�*ROC�K7�*� ���Ϊ�����j�mۼ���!Γ�XʋK��$ͳ�.-�̦r`�Q��%�A܅y�:+�{� �o�K�[B{!�h�����_PK w�[�� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞� N���ݰa[z��Q۲]�gc���V� �X��j4��'�|�lvo�D^0���ʂA+����)�v��'��D4��$��I�?P��Y��y���]�E�i��(�c+��f�����N�Q⣓�m�L_]8F���D0u�S���"S�<���֊��k��-z3����_��|!#��W�cϰ䜗7�1"�zN!_z�,/��7��� �f}Q�W��PK w�[Ѓ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 w�[D�RQ� � xl/sharedStrings.xml � (� 5�An� E����u�Sa���$ f#�������%�.���zߟ�"��Q�8H{0R �5e|�v�R��S\*� ��8OĢM�93��Z�8C�t�+`K���� ���u��h��7c�.1�cݑ�V����n�<כ�=u'ut֪����;���\ץ�i4���~�u{� PK- w�[ E� 5 xl/workbook.xmlPK- w�[���� � � [Content_Types].xmlPK- w�[`Y#' ' U _rels/.relsPK- w�[���% � � xl/worksheets/sheet1.xmlPK- w�[�� P 8 xl/_rels/workbook.xml.relsPK- w�[Ѓc'2 E ~ xl/styles.xmlPK- w�[D�RQ� � � xl/sharedStrings.xmlPK � �