PUT api/survey/{id}

Request Information

URI Parameters

Name	Description	Type	Additional information
id		globally unique identifier	Required

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

Sample:

{
  "g_UID": "siRmwNghPUqFmxHX+OpBRg==",
  "guid": "c06624b2-21d8-4a3d-859b-11d7f8ea4146",
  "name": "sample string 1",
  "storeID": 2,
  "zoneID": 1,
  "checkoutFormG_UID": "OtWqWoQ8ukqfzOUV1WSfqQ==",
  "checkoutFormGuid": "5aaad53a-3c84-4aba-9fcc-e515d5649fa9",
  "displayToWho": 3,
  "displayWhen": 4,
  "start": "2025-08-02T23:15:57.0020218",
  "end": "2025-08-02T23:15:57.0020218",
  "deleted": true,
  "updated": "2025-08-02T23:15:57.0020218",
  "possibleIntegerResponses": [
    1,
    2
  ],
  "possibleTextResponses": [
    "sample string 1",
    "sample string 2"
  ],
  "possibleGuidResponses": [
    "b578020b-0c43-42d4-a8af-631620b19bbe",
    "46da39da-4de2-4afc-954e-d44c744e0d96"
  ],
  "allowsAllTextResponses": true,
  "surveyForm": {
    "$id": "2",
    "id": 1,
    "g_UID": "nu7tGAH2wk+a42tIVwZiRw==",
    "guid": "18edee9e-f601-4fc2-9ae3-6b4857066247",
    "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": "OH5pi+7TZEKAyyfwT85vSA==",
    "previousFormGuid": "8b697e38-d3ee-4264-80cb-27f04fce6f48",
    "nextForm": 1,
    "nextFormG_UID": "lINq7QkQgEye3zMHqwEWqA==",
    "nextFormGuid": "ed6a8394-1009-4c80-9edf-3307ab0116a8",
    "attributes": "sample string 10",
    "updated": "2025-08-02T23:15:57.0020218",
    "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": "PUWmLLlo3Uif7Mn6Q8rAiA==",
        "checkoutFormGuid": "2ca6453d-68b9-48dd-9fec-c9fa43cac088",
        "identifier": "JPxMvR3+ZEKIN7pF/JAUzQ==",
        "identifierGuid": "bd4cfc24-fe1d-4264-8837-ba45fc9014cd",
        "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": "cKlbdXm+OkCqXyXocZLvmw==",
        "valueGuid": "755ba970-be79-403a-aa5f-25e87192ef9b",
        "buttonText": "sample string 10",
        "valueText": "sample string 11",
        "drawImageAndButton": true,
        "updated": "2025-08-02T23:15:57.0020218",
        "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:15:57.0020218",
          "imageData": "QEA=",
          "readOnly": true
        }
      },
      {
        "$ref": "3"
      }
    ],
    "panels": [
      {
        "$id": "5",
        "id": 1,
        "checkoutFormID": 2,
        "checkoutFormG_UID": "Tmt5ooIhNkmGtb3i7i0XqQ==",
        "checkoutFormGuid": "a2796b4e-2182-4936-86b5-bde2ee2d17a9",
        "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:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.