GET api/survey/{id}?relations={relations}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
|
| relations | boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
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. |
Response Formats
application/json, text/json
{
"g_UID": "GasP+jx3dkey8HMAA8HG9w==",
"guid": "fa0fab19-773c-4776-b2f0-730003c1c6f7",
"name": "sample string 1",
"storeID": 2,
"zoneID": 1,
"checkoutFormG_UID": "lKHTi6ewT0igi0Lnm73v8w==",
"checkoutFormGuid": "8bd3a194-b0a7-484f-a08b-42e79bbdeff3",
"displayToWho": 3,
"displayWhen": 4,
"start": "2026-06-03T18:32:52.9688456",
"end": "2026-06-03T18:32:52.9688456",
"deleted": true,
"updated": "2026-06-03T18:32:52.9688456",
"possibleIntegerResponses": [
1,
2
],
"possibleTextResponses": [
"sample string 1",
"sample string 2"
],
"possibleGuidResponses": [
"167ae998-02dd-464a-b950-2b0896fb8c52",
"caca9a63-d342-47e9-8d05-6cd072292a3e"
],
"allowsAllTextResponses": true,
"surveyForm": {
"$id": "2",
"id": 1,
"g_UID": "biuQTcKmOkmRkJL9Hy97Ag==",
"guid": "4d902b6e-a6c2-493a-9190-92fd1f2f7b02",
"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": "ur+07REWqkal+KzsU/vMTQ==",
"previousFormGuid": "edb4bfba-1611-46aa-a5f8-acec53fbcc4d",
"nextForm": 1,
"nextFormG_UID": "TaNmZjihyUeSgXBxA2htPw==",
"nextFormGuid": "6666a34d-a138-47c9-9281-707103686d3f",
"attributes": "sample string 10",
"updated": "2026-06-03T18:32:52.9688456",
"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": "FTPpxVd57kGwTBhJqTAqTg==",
"checkoutFormGuid": "c5e93315-7957-41ee-b04c-1849a9302a4e",
"identifier": "ST4wP21Y0k2n6w6h1QRPcw==",
"identifierGuid": "3f303e49-586d-4dd2-a7eb-0ea1d5044f73",
"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": "WEPhSpsnR0OofIn4dhkXjw==",
"valueGuid": "4ae14358-279b-4347-a87c-89f87619178f",
"buttonText": "sample string 10",
"valueText": "sample string 11",
"drawImageAndButton": true,
"updated": "2026-06-03T18:32:52.9688456",
"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:32:52.9688456",
"imageData": "QEA=",
"readOnly": true
}
},
{
"$ref": "3"
}
],
"panels": [
{
"$id": "5",
"id": 1,
"checkoutFormID": 2,
"checkoutFormG_UID": "CjTGOzSfWU+Au1JNBUlKWA==",
"checkoutFormGuid": "3bc6340a-9f34-4f59-80bb-524d05494a58",
"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/vnd.openxmlformats-officedocument.spreadsheetml.sheet
PK ��\y^�n� 5 xl/workbook.xml � (� ����0D�&�C���(�N\�z�^a��m��|K $��ξ>�����Q�������%�
���*ჴ/�]'��y+О�IraF�%j�K��B���Ѻ��qA)!5��;B���!arQc�;��-!����]DE�PP�ZxAItnmI���B�ស�69g�)ϛ,M�tco0����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
��\V�2�' ' _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="R57ef2a53c816458f" /></Relationships>PK ��\SB�=� �
xl/worksheets/sheet1.xml � (� ��Ks�@��
�~�ߏ��Jb�;�q1�f��TĶ����i�1�(T��������d�}�4��z�� ��Z��<^���|�C���V�o�R��3�:;K��2�7ga�͖*��@o�ڬ-t�D��M_C�X�35ֳ�D����T���l�-�M�R+ۤ*�-$�}�$���h0�M�]�^�C��M�A���6k\{�'������n>�A��xRl��zs���W�TooU��̍I����*+~�$�Y�{I�Y�o�y�4W8�3B��K�{��,�ɟr���ףR�z���Ă������zp
�D2!8:�'���2�0D��h��_ԱR��~e )�b�1�=��K=��� � �D��zQ�E�/̤@�J�g������y ���p�T�uI(���d���9��
U� ����*nw�*p�N�b��B Ld{*Tу�Y�K��z"