{"id":14752,"date":"2025-12-01T11:18:29","date_gmt":"2025-12-01T11:18:29","guid":{"rendered":"https:\/\/www.snapsurveys.com\/support-snapxmp\/?post_type=epkb_post_type_1&p=14752"},"modified":"2025-12-01T11:56:43","modified_gmt":"2025-12-01T11:56:43","slug":"snap-xmp-developer-api-api-reference","status":"publish","type":"epkb_post_type_1","link":"https:\/\/www.snapsurveys.com\/support-snapxmp\/snapxmp\/snap-xmp-developer-api-api-reference\/","title":{"rendered":"API Reference"},"content":{"rendered":"\n

This document covers the most recent version 3.0 of the API in build 1.0.0.1381.<\/p>\n\n\n\n

Please note<\/strong> that from Monday 5th December 2022 usage of the API became chargeable. The charge is that 0.1 unit will be consumed each time a survey response is delivered by the API.  This applies if the same survey response is delivered by the API multiple times. The survey responses are delivered using the Get Survey Responses endpoint.<\/p>\n\n\n\n

List of API endpoints<\/h3>\n\n\n\n
Endpoint<\/th>Description<\/th><\/tr><\/thead>
Get User Info<\/a><\/td>Returns information for the authenticated user. <\/td><\/tr>
Get Survey List<\/a><\/td> Returns a list of surveys that are accessible by the user. <\/td><\/tr>
Get Survey<\/a><\/td> Returns the details for a specific survey ID. <\/td><\/tr>
Get Survey Variables<\/a><\/td> Returns the details for a specific survey ID. <\/td><\/tr>
Get Survey Variable<\/a><\/td> Returns the details for a specific variable ID.<\/td><\/tr>
Get Survey Responses <\/a><\/td>Gets the responses for a specific survey ID.
Please note<\/strong> that from Monday 5th December 2022 usage of the API became chargeable. When one survey response is delivered by the API, 0.1 unit will be consumed.<\/td><\/tr>
Get Participant List<\/a><\/td> Returns a list of participants for a survey.<\/td><\/tr>
Get Participant<\/a><\/td> Returns the details for a specific participant in a survey.<\/td><\/tr>
Add Participant<\/a><\/td> Add a new participant to a survey.<\/td><\/tr>
Update Participant<\/a><\/td> Update an existing participant of a survey.<\/td><\/tr>
Delete Participant<\/a><\/td> Delete a participant from a survey.<\/td><\/tr>
Get Participant Subjects<\/a><\/td> Returns a list of subjects for a participant of a survey.<\/td><\/tr>
Get Participant Subject<\/a><\/td> Returns the details of a specific subject for a participant of a survey.<\/td><\/tr>
Add Participant Subject<\/a><\/td> Add a new subject to a participant of a survey.<\/td><\/tr>
Update Participant Subject<\/a><\/td> Update an existing subject for a participant of a survey.<\/td><\/tr>
Delete Participant Subject<\/a><\/td> Delete a subject from a participant of a survey.<\/td><\/tr>
Bulk Participant Import<\/a><\/td>Add many participants to a survey.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Get User Info<\/h3>\n\n\n\n

Get information for the authenticated user. <\/p>\n\n\n\n

Endpoint<\/h4>\n\n\n\n
Method<\/th>URL<\/th><\/tr><\/thead>
GET<\/td>https:\/\/<servername>\/snaponline\/api\/account<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Get information for the authenticated user.<\/p>\n\n\n\n

Parameters<\/h4>\n\n\n\n

Path parameters<\/h5>\n\n\n\n

None<\/p>\n\n\n\n

Query string parameters<\/h5>\n\n\n\n

None<\/p>\n\n\n\n

Sample Request<\/h4>\n\n\n\n
curl --location --request GET 'https:\/\/<servername>\/snaponline\/api\/account' \\\n--header 'X-USERNAME: {USERNAME}' \\\n--header 'X-API-KEY: {APIKEY}'\\\n--header 'X-VERSION: 3.0'\n<\/code><\/pre>\n\n\n\n
(In the above code, replace {APIKEY} with your actual API key and {USERNAME} with your actual username.)<\/p>\n\n\n\n
Sample Response<\/h4>\n\n\n\n
200 OK with body:<\/p>\n\n\n\n
{\n \"username\": \"jbloggs@snapsurveys.com\", \n \"fullname\": \"Joe Bloggs\",\n \"emailAddress\": \"jbloggs@snapsurveys.com\"\n}\n<\/code><\/pre>\n\n\n\n
Response Definitions<\/h4>\n\n\n\n
Response Item<\/th>Description<\/th>Data Type<\/th><\/tr><\/thead>
username<\/td>The username for the user.<\/td>String<\/td><\/tr>
fullname<\/td>The full name of the user.<\/td>String<\/td><\/tr>
emailAddress<\/td>The email address of the user.<\/td>String<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
HTTP Status Codes<\/h4>\n\n\n\n
    \n
  • 200 OK<\/li>\n<\/ul>\n\n\n\n
    Get Survey List<\/h3>\n\n\n\n
    Get a list of surveys that are accessible by the user. This includes surveys that are shared to the user.<\/p>\n\n\n\n
    Endpoint<\/h4>\n\n\n\n
    Method<\/th>URL<\/th><\/tr><\/thead>
    GET<\/td>https:\/\/<servername>\/snaponline\/api\/surveys<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
    Get a list of surveys that are accessible by the user.<\/p>\n\n\n\n
    Parameters<\/h4>\n\n\n\n
    Path parameters<\/h5>\n\n\n\n
    None<\/p>\n\n\n\n
    Query string parameters<\/h5>\n\n\n\n
    None<\/p>\n\n\n\n
    Sample Request<\/h4>\n\n\n\n
    curl --location --request GET 'https:\/\/<servername>\/snaponline\/api\/surveys' \\\n--header 'X-USERNAME: {USERNAME}' \\\n--header 'X-API-KEY: {APIKEY}' \\\n--header 'X-VERSION: 3.0'<\/code><\/pre>\n\n\n\n
    (In the above code, replace {APIKEY} with your actual API key and {USERNAME} with your actual username.)<\/p>\n\n\n\n
    Sample Response<\/h4>\n\n\n\n
    200 OK with body:<\/p>\n\n\n\n
    [\n    {\n        \"id\": \"2c4be70c-fe6d-4883-9fd3-629943bec836\",\n        \"ownerId\": \"644f58a7-8526-4901-af7d-20969e5c68e4\", \n        \"ownerName\": \"a@example.com\", \n        \"name\": \"APIv3 Example Survey\", \n        \"path\": [ \n            \"Your work\", \n            \"APIv3\"\n        ], \n        \"title\": \"APIv3 Example Survey\", \n        \"url\": \"https:\/\/<servername>\/snaponline\/Home\/Index\/2c4be70c-fe6d-4883-9fd3-629943bec836\", \n        \"interviewUrl\": \"https:\/\/<servername>\/interview\/2c4be70c-fe6d-4883-9fd3-629943bec836\", \n        \"interviewPreviewUrl\": \"https:\/\/<servername>\/interview\/2c4be70c-fe6d-4883-9fd3-629943bec836?preview=true\", \n        \"isPublished\": true, \n        \"lastPublishedDate\": \"2025-08-05T09:15:43.92\",\n        \"interviewingState\": \"Started\",\n        \"startInterviewingScheduleDate\": null,\n        \"endInterviewingScheduleDate\": null,\n        \"interviewingScheduleTimeZone\": null,\n        \"numberOfResponses\": 5,\n        \"numberOfPartials\": 0,\n        \"responsesLastChanged\": \"2025-08-05T15:25:32.267\",\n        \"shareFilter\": \"\",\n        \"shareContext\": \"\"\n    },\n    {\n        \"id\": \"de8e8ca3-b7e7-4810-93e6-84c65da7e7aa\",\n        \"ownerId\": \"644f58a7-8526-4901-af7d-20969e5c68e4\", \n        \"ownerName\": \"b@example.com\", \n        \"name\": \"Test 1\", \n        \"path\": [ \n            \"Your work\"\n        ], \n        \"title\": \"\", \n        \"url\": \"https:\/\/<servername>\/snaponline\/Home\/Index\/de8e8ca3-b7e7-4810-93e6-84c65da7e7aa\", \n        \"interviewUrl\": \"https:\/\/<servername>\/interview\/de8e8ca3-b7e7-4810-93e6-84c65da7e7aa\", \n        \"interviewPreviewUrl\": \"https:\/\/<servername>\/interview\/de8e8ca3-b7e7-4810-93e6-84c65da7e7aa?preview=true\", \n        \"isPublished\": false, \n        \"lastPublishedDate\": \"2025-08-05T09:15:43.92\",\n        \"interviewingState\": \"Started\",\n        \"startInterviewingScheduleDate\": null,\n        \"endInterviewingScheduleDate\": null,\n        \"interviewingScheduleTimeZone\": null,\n        \"numberOfResponses\": 10,\n        \"numberOfPartials\": 0,\n        \"responsesLastChanged\": \"2025-08-05T15:25:32.267\",\n        \"shareFilter\": \"\",\n        \"shareContext\": \"\"\n    }\n]\n<\/code><\/pre>\n\n\n\n
    Response Definitions<\/h4>\n\n\n\n
    Response Item<\/th>Description<\/th>Data Type<\/th><\/tr><\/thead>
    id<\/td>The survey Id.<\/td>String: containing a GUID<\/td><\/tr>
    ownerId<\/td>The owner Id of the survey.<\/td>String: containing a GUID <\/td><\/tr>
    ownerName<\/td>The owner name of the survey.<\/td>String<\/td><\/tr>
    name<\/td>The display name of the survey.<\/td>String<\/td><\/tr>
    path<\/td>The path to the survey.<\/td>List: containing strings<\/td><\/tr>
    title<\/td>The title used in the questionnaire.<\/td>String<\/td><\/tr>
    url<\/td>The url of the survey in Snap Online.<\/td>String<\/td><\/tr>
    interviewUrl<\/td>The interview url.<\/td>String<\/td><\/tr>
    interviewPreviewUrl<\/td>The preview interview url.<\/td>String<\/td><\/tr>
    isPublished<\/td>Whether the survey is published.<\/td>Boolean<\/td><\/tr>
    lastPublishedDate<\/td>The date time of when the survey was last published.<\/td>String: containing DateTime<\/td><\/tr>
    interviewingState<\/td>The current interviewing state.<\/td>String:
    “Scheduled”,
    \u201cNotStarted\u201d,
    \u201cStarted\u201d \u2013 when live,
    \u201cPaused\u201d,
    \u201cStopped\u201d \u2013 when closed,
    \u201cTooManyRespondents”<\/td><\/tr>
    startInterviewingScheduleDate<\/td>The interviewing start date and time.<\/td>String: containing DateTime or null<\/td><\/tr>
    endInterviewingScheduleDate<\/td>The interviewing end date and time.<\/td>String: containing DateTime or null<\/td><\/tr>
    interviewingScheduleTimeZone<\/td>The interviewing start\/end timezone.<\/td>String or null<\/td><\/tr>
    numberOfResponses<\/td>The number of responses submitted.<\/td>Integer<\/td><\/tr>
    numberOfPartials<\/td>The number of partial responses.<\/td>Integer<\/td><\/tr>
    responsesLastChanged 
    <\/td>    		The date and time that the list of responses for the survey was last changed, i.e. response added, deleted or edited.<\/td>String: containing DateTime<\/td><\/tr>
    shareFilter<\/td>Filter applied to the survey for this user.<\/td>String: “” if no share filter.<\/td><\/tr>
    shareContext<\/td>Context applied to the survey for this user.<\/td>String: “” if no share filter.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
    HTTP Status Codes<\/h4>\n\n\n\n
      \n
    • 200 OK<\/li>\n<\/ul>\n\n\n\n
      Get Survey<\/h3>\n\n\n\n
      Get details of a survey.<\/p>\n\n\n\n
      Endpoint<\/h4>\n\n\n\n
      Method<\/th>URL<\/th><\/tr><\/thead>
      GET<\/td>https:\/\/<servername>\/snaponline\/api\/surveys\/{surveyId}<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
      Gets the details of a specific survey identified by the surveyId <\/strong>path variable.<\/p>\n\n\n\n
      Parameters<\/h4>\n\n\n\n
      Path parameters<\/h5>\n\n\n\n
      Path parameter<\/th>Description<\/th><\/tr><\/thead>
      {surveyId}<\/td>The id of the survey. This is the survey GUID and not the Interview URL.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
      Query string parameters<\/h5>\n\n\n\n
      None<\/p>\n\n\n\n
      Sample Request<\/h4>\n\n\n\n
      curl --location --request GET 'https:\/\/<servername>\/snaponline\/api\/surveys\/2c4be70c-fe6d-4883-9fd3-629943bec836' \\\n--header 'X-USERNAME: {USERNAME}' \\\n--header 'X-API-KEY: {APIKEY}' \\\n--header 'X-VERSION: 3.0'<\/code><\/pre>\n\n\n\n
      (In the above code, replace {APIKEY} with your actual API key and {USERNAME} with your actual username.)<\/p>\n\n\n\n
      Sample Response<\/h4>\n\n\n\n
      200 OK with body:<\/p>\n\n\n\n
      {\n     \"id\": \"2c4be70c-fe6d-4883-9fd3-629943bec836\",\n     \"ownerId\": \"644f58a7-8526-4901-af7d-20969e5c68e4\", \n     \"ownerName\": \"a@example.com\", \n     \"name\": \"APIv3 Example Survey\", \n     \"path\": [ \n         \"Your work\", \n         \"APIv3\"\n     ], \n     \"title\": \"APIv3 Example Survey\", \n     \"url\": \"https:\/\/<servername>\/snaponline\/Home\/Index\/2c4be70c-fe6d-4883-9fd3-629943bec836\", \n     \"interviewUrl\": \"https:\/\/<servername>\/interview\/2c4be70c-fe6d-4883-9fd3-629943bec836\", \n     \"interviewPreviewUrl\": \"https:\/\/<servername>\/interview\/2c4be70c-fe6d-4883-9fd3-629943bec836?preview=true\", \n     \"isPublished\": true, \n     \"lastPublishedDate\": \"2025-08-05T09:15:43.92\",\n     \"interviewingState\": \"Started\",\n     \"startInterviewingScheduleDate\": null,\n     \"endInterviewingScheduleDate\": null,\n     \"interviewingScheduleTimeZone\": null,\n     \"numberOfResponses\": 5,\n     \"numberOfPartials\": 0,\n     \"responsesLastChanged\": \"2025-08-05T15:25:32.267\",\n     \"shareFilter\": \"\",\n     \"shareContext\": \"\"\n}\n<\/code><\/pre>\n\n\n\n
      Response Definitions<\/h4>\n\n\n\n
      Response Item<\/th>Description<\/th>Data Type<\/th><\/tr><\/thead>
      id<\/td>The survey Id.<\/td>String: containing a GUID<\/td><\/tr>
      ownerId<\/td>The owner Id of the survey.<\/td>String: containing a GUID <\/td><\/tr>
      ownerName<\/td>The owner name of the survey.<\/td>String<\/td><\/tr>
      name<\/td>The display name of the survey.<\/td>String<\/td><\/tr>
      path<\/td>The path to the survey.<\/td>List: containing strings<\/td><\/tr>
      title<\/td>The title used in the questionnaire.<\/td>String<\/td><\/tr>
      url<\/td>The url of the survey in Snap Online.<\/td>String<\/td><\/tr>
      interviewUrl<\/td>The interview url.<\/td>String<\/td><\/tr>
      interviewPreviewUrl<\/td>The preview interview url.<\/td>String<\/td><\/tr>
      isPublished<\/td>Whether the survey is published.<\/td>Boolean<\/td><\/tr>
      lastPublishedDate<\/td>The date time of when the survey was last published.<\/td>String: containing DateTime<\/td><\/tr>
      interviewingState<\/td>The current interviewing state.<\/td>String:
      “Scheduled”
      \u201cNotStarted\u201d,
      \u201cStarted\u201d \u2013 when live,
      \u201cPaused\u201d,
      \u201cStopped\u201d \u2013 when closed,
      \u201cTooManyRespondents\u201d<\/td><\/tr>
      startInterviewingScheduleDate<\/td>The interviewing start date and time.<\/td>String: containing DateTime or null<\/td><\/tr>
      endInterviewingScheduleDate<\/td>The interviewing end date and time.<\/td>String: containing DateTime or null<\/td><\/tr>
      interviewingScheduleTimeZone<\/td>The interviewing start\/end timezone.<\/td>String or null<\/td><\/tr>
      numberOfResponses<\/td>The number of responses submitted.<\/td>Integer<\/td><\/tr>
      numberOfPartials<\/td>The number of partial responses.<\/td>Integer<\/td><\/tr>
      responsesLastChanged 
      <\/td>      		The date and time that the list of responses for the survey was last changed, i.e. response added, deleted or edited.<\/td>String: containing DateTime<\/td><\/tr>
      shareFilter<\/td>Filter applied to the survey for this user.<\/td>String: “” if no share filter.<\/td><\/tr>
      shareContext<\/td>Context applied to the survey for this user.<\/td>String: “” if no share context.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
      HTTP Status Codes<\/h4>\n\n\n\n
        \n
      • 200 OK<\/li>\n<\/ul>\n\n\n\n
        Get Survey Variables<\/h3>\n\n\n\n
        Get details of all of the variables for a survey.<\/p>\n\n\n\n
        Endpoint<\/h4>\n\n\n\n
        Method<\/th>URL<\/th><\/tr><\/thead>
        GET<\/td>https:\/\/<servername>\/snaponline\/api\/surveys\/{surveyId}\/variables<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
        Get details of all of the variables of the specific survey identified by the surveyId <\/strong>path variable.<\/p>\n\n\n\n
        Parameters<\/h4>\n\n\n\n
        Path parameters<\/h5>\n\n\n\n
        Path parameter<\/th>Description<\/th><\/tr><\/thead>
        {surveyId}<\/td>The id of the survey. This is the survey GUID and not the Interview URL.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
        Query string parameters<\/h5>\n\n\n\n
         Query string parameter <\/th> Required \/ Optional <\/th> Description <\/th> Type <\/th> Range <\/th> Default <\/th><\/tr><\/thead>
        includeCodes<\/td>Optional<\/td>Whether to return code information for the variable in the response.<\/td>Boolean<\/td>N\/A<\/td>true<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
        Sample Request<\/h4>\n\n\n\n
        curl --location --request GET 'https:\/\/<servername>\/snaponline\/api\/surveys\/6834a5f1-46e5-4b12-9e0c-a38a3d9be12c\/variables' \\\n--header 'X-USERNAME: {USERNAME}' \\\n--header 'X-API-KEY: {APIKEY}' \\\n--header 'X-VERSION: 3.0'<\/code><\/pre>\n\n\n\n
        (In the above code, replace {APIKEY} with your actual API key and {USERNAME} with your actual username.)<\/p>\n\n\n\n
        Sample Response<\/h4>\n\n\n\n
        200 OK with body (when \u2018includeCodes\u2019 is false): <\/p>\n\n\n\n
        {\n    \"surveyId\": \"6834a5f1-46e5-4b12-9e0c-a38a3d9be12c\",\n    \"variables\": [        \n        {\n            \"order\": 14,\n            \"variableId\": \"V46\",\n            \"label\": \"What was the main form of transport used to get to the at...\",\n            \"name\": \"Q1\",\n            \"questionText\": \"What was the main form of transport used to get to the attraction?\",\n            \"variableTypeId\": 6,\n            \"paraDataTypeId\": -2,\n            \"responseTypeId\": 1,\n            \"variableType\": \"Question\",\n            \"paraDataType\": \"NOT_PARA_DATA\",\n            \"responseType\": \"Single\",\n            \"codeCount\": 7\n        },\n        {\n            \"order\": 15,\n            \"variableId\": \"V48\",\n            \"label\": \"Which facilities did you visit?\",\n            \"name\": \"Q2\",\n            \"questionText\": \"Which facilities did you visit?\",\n            \"variableTypeId\": 6,\n            \"paraDataTypeId\": -2,\n            \"responseTypeId\": 2,\n            \"variableType\": \"Question\",\n            \"paraDataType\": \"NOT_PARA_DATA\",\n            \"responseType\": \"Multiple\",\n            \"codeCount\": 3\n        },\n        {\n            \"order\": 16,\n            \"variableId\": \"V52\",\n            \"label\": \"Please tell us if there were any issues, otherwise leave ...\",\n            \"name\": \"Q3\",\n            \"questionText\": \"Please tell us if there were any issues, otherwise leave blank.\",\n            \"variableTypeId\": 6,\n            \"paraDataTypeId\": -2,\n            \"responseTypeId\": 4,\n            \"variableType\": \"Question\",\n            \"paraDataType\": \"NOT_PARA_DATA\",\n            \"responseType\": \"Literal\",\n            \"codeCount\": 0\n        }\n    ]\n}\n<\/code><\/pre>\n\n\n\n
         200 OK with body (when \u2018includeCodes\u2019 is true): <\/p>\n\n\n\n
        {\n    \"surveyId\": \"6834a5f1-46e5-4b12-9e0c-a38a3d9be12c\",\n    \"variables\": [        \n        {\n            \"order\": 14,\n            \"variableId\": \"V46\",\n            \"label\": \"What was the main form of transport used to get to the at...\",\n            \"name\": \"Q1\",\n            \"questionText\": \"What was the main form of transport used to get to the attraction?\",\n            \"variableTypeId\": 6,\n            \"paraDataTypeId\": -2,\n            \"responseTypeId\": 1,\n            \"variableType\": \"Question\",\n            \"paraDataType\": \"NOT_PARA_DATA\",\n            \"responseType\": \"Single\",\n            \"codeCount\": 7,\n            \"codes\": [\n                {\n                    \"codeIndex\": 1,\n                    \"codeValue\": 3,\n                    \"codeLabel\": \"Walk\"\n                },\n                {\n                    \"codeIndex\": 2,\n                    \"codeValue\": 5,\n                    \"codeLabel\": \"Bike\"\n                },\n                {\n                    \"codeIndex\": 3,\n                    \"codeValue\": 8,\n                    \"codeLabel\": \"Motorbike\"\n                },\n                {\n                    \"codeIndex\": 4,\n                    \"codeValue\": 4,\n                    \"codeLabel\": \"Car\"\n                },\n                {\n                    \"codeIndex\": 5,\n                    \"codeValue\": 6,\n                    \"codeLabel\": \"Bus\"\n                },\n                {\n                    \"codeIndex\": 6,\n                    \"codeValue\": 9,\n                    \"codeLabel\": \"Train\"\n                },\n                {\n                    \"codeIndex\": 7,\n                    \"codeValue\": 10,\n                    \"codeLabel\": \"Plane\"\n                }\n            ]\n        },\n        {\n            \"order\": 15,\n            \"variableId\": \"V48\",\n            \"label\": \"Which facilities did you visit?\",\n            \"name\": \"Q2\",\n            \"questionText\": \"Which facilities did you visit?\",\n            \"variableTypeId\": 6,\n            \"paraDataTypeId\": -2,\n            \"responseTypeId\": 2,\n            \"variableType\": \"Question\",\n            \"paraDataTypeId\": \"NOT_PARA_DATA\",\n            \"responseType\": \"Multiple\",\n            \"codeCount\": 3,\n            \"codes\": [\n                {\n                    \"codeIndex\": 1,\n                    \"codeValue\": 1,\n                    \"codeLabel\": \"Restaurant \/ Cafe\"\n                },\n                {\n                    \"codeIndex\": 2,\n                    \"codeValue\": 2,\n                    \"codeLabel\": \"Gift Shop\"\n                },\n                {\n                    \"codeIndex\": 3,\n                    \"codeValue\": 3,\n                    \"codeLabel\": \"Customer Services\"\n                }\n            ]\n        },\n        {\n            \"order\": 16,\n            \"variableId\": \"V52\",\n            \"label\": \"Please tell us if there were any issues, otherwise leave ...\",\n            \"name\": \"Q3\",\n            \"questionText\": \"Please tell us if there were any issues, otherwise leave blank.\",\n            \"variableTypeId\": 6,\n            \"paraDataTypeId\": -2,\n            \"responseTypeId\": 4,\n            \"variableType\": \"Question\",\n            \"paraDataType\": \"NOT_PARA_DATA\",\n            \"responseType\": \"Literal\",\n            \"codeCount\": 0,\n            \"codes\": []\n        }\n    ]\n}\n<\/code><\/pre>\n\n\n\n
        Response Definitions<\/h4>\n\n\n\n
         Response Item <\/th> Description <\/th> Data Type <\/th><\/tr><\/thead>
        surveyId<\/td>The survey Id.<\/td>String: containing GUID<\/td><\/tr>
        variables<\/td>The list of variables.<\/td>List: containing objects<\/td><\/tr>
        variables\/order<\/td>The positional order of the variable.<\/td>Integer<\/td><\/tr>
        variables\/variableId<\/td>The V number of the variable<\/td>String<\/td><\/tr>
        variables\/label<\/td>The label of the variable.<\/td>String<\/td><\/tr>
        variables\/name<\/td>The name of the variable.<\/td>String<\/td><\/tr>
        variables\/questionText<\/td>The question text of the variable. i.e. the question shown to the respondent.<\/td>String<\/td><\/tr>
        variables\/variableTypeId<\/td>The numeric code for the variable type.<\/td>Integer: Unknown = 0, Precoded = 1, Numeric = 2, Alphanumeric = 3, Derived = 5, Question = 6, Note = 7<\/td><\/tr>
        variables\/paraDataTypeId<\/td>The numeric code for the para data variable.<\/td>Integer: SITE=0, NAME=1, DATE=2, START=3, END=4, DURATION=5, CASE=6, RESET=7, ENDDATE=8, INTERVIEWER=9, PASSWORD=10, LANGUAGE=11, FORMAT=12, URL=13, SURV_INDEX=14, LOCATION=15, RECORDING=16, PAGE=17, PANEL=18, SERVERDATE=19, SERVERTIME=20, UNKNOWN=-1, NOT_PARA_DATA = -2<\/td><\/tr>
        variables\/responseTypeId<\/td>The numeric code for the response type.<\/td>Integer:   Unknown = 0, Single = 1, Multiple = 2, Quantity = 3, Literal = 4, None = 5, Date = 6, Time = 7<\/td><\/tr>
        variables\/variableType<\/td>The type of the variable.<\/td>String:   \u201cUnknown\u201d, \u201cPrecoded\u201d, \u201cNumeric\u201d, \u201cAlphanumeric\u201d, \u201cDerived\u201d, \u201cQuestion\u201d, \u201cNote\u201d.<\/td><\/tr>
        variables\/paraDataType<\/td>The type of the para data variable.<\/td>String: “SITE”, “NAME”, “DATE”, “START”, “END”, “DURATION”, “CASE”, “RESET”, “ENDDATE”, “INTERVIEWER”, “PASSWORD”, “LANGUAGE”, “FORMAT”, “URL”, “SURV_INDEX”, “LOCATION”, “RECORDING”, “PAGE”, “PANEL”, “SERVERDATE”, “SERVERTIME”, “UNKNOWN”, “NOT_PARA_DATA”<\/td><\/tr>
        variables\/responseType<\/td>The response type of the answer.<\/td>String: \u201cUnknown\u201d, \u201cSingle\u201d, \u201cMultiple\u201d, \u201cQuantity\u201d, \u201cLiteral\u201d, \u201cNone\u201d, \u201cDate\u201d, \u201cTime\u201d<\/td><\/tr>
        variables\/codeCount<\/td>If a choice question this states the number of codes. If not a choice question then this will be 0.<\/td>Integer<\/td><\/tr>
        variables\/codes<\/td>A list of variable codes. This section will only appear if the includeCodes <\/strong>query parameter is true or omitted AND the variable is a choice question.<\/td>List: containing Objects<\/td><\/tr>
        variables\/codes\/codeIndex<\/td>The index of the variable code.<\/td>Integer<\/td><\/tr>
        variables\/codes\/codeValue<\/td>The value of the variable code.<\/td>Integer<\/td><\/tr>
        variables\/codes\/codeLabel<\/td>The label of the variable code.<\/td>String<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
        HTTP Status Codes<\/h4>\n\n\n\n
          \n
        • 200 OK<\/li>\n<\/ul>\n\n\n\n
          Get Survey Variable<\/h3>\n\n\n\n
          Get the details of a variable of a survey.<\/p>\n\n\n\n
          Endpoint<\/h4>\n\n\n\n
          Method<\/th>URL<\/th><\/tr><\/thead>
          GET<\/td>https:\/\/<servername>\/snaponline\/api\/surveys\/{surveyId}\/variables\/{variableId}<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
          Get the details of the specific variable identified by the variableId <\/strong>path variable of the specific survey identified by the surveyId <\/strong>path variable.<\/p>\n\n\n\n
          Parameters<\/h4>\n\n\n\n
          Path parameters<\/h5>\n\n\n\n
          Path parameter<\/th>Description<\/th><\/tr><\/thead>
          {surveyId}<\/td>The id of the survey. This is the survey GUID and not the Interview URL.<\/td><\/tr>
          {variableId}<\/td>The unique V number of the variable.
          This is the variable Id property returned in the Get Survey Variables end-point.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
          Query string parameters<\/h5>\n\n\n\n
          None<\/p>\n\n\n\n
          Sample Request<\/h4>\n\n\n\n
          curl --location --request GET 'https:\/\/localhost\/snaponline\/api\/surveys\/e819df57-0a01-4592-a7aa-8918dbe54e00\/variables\/V46' \\\n--header 'X-USERNAME: {USERNAME}' \\\n--header 'X-API-KEY: {APIKEY}' \\\n--header 'X-VERSION: 3.0'\n<\/code><\/pre>\n\n\n\n
          (In the above code, replace {APIKEY} with your actual API key and {USERNAME} with your actual username.)<\/p>\n\n\n\n
          Sample Response<\/h4>\n\n\n\n
          200 OK with body:<\/p>\n\n\n\n
          {\n    \"surveyId\": \"6834a5f1-46e5-4b12-9e0c-a38a3d9be12c\",\n    \"variable\": {\n        \"order\": 15,\n        \"variableId\": \"V48\",\n        \"label\": \"Which facilities did you visit?\",\n        \"name\": \"Q2\",\n        \"questionText\": \"Which facilities did you visit?\",\n        \"variableTypeId\": 6,\n        \"paraDataTypeId\": -2,\n        \"responseTypeId\": 2,\n        \"variableType\": \"Question\",\n        \"paraDataType\": \"NOT_PARA_DATA\",\n        \"responseType\": \"Multiple\",\n        \"codeCount\": 3,\n        \"codes\": [\n            {\n                \"codeIndex\": 1,\n                \"codeValue\": 1,\n                \"codeLabel\": \"Restaurant \/ Cafe\"\n            },\n            {\n                \"codeIndex\": 2,\n                \"codeValue\": 2,\n                \"codeLabel\": \"Gift Shop\"\n            },\n            {\n                \"codeIndex\": 3,\n                \"codeValue\": 3,\n                \"codeLabel\": \"Customer Services\"\n            }\n        ]\n    }\n}\n\n<\/code><\/pre>\n\n\n\n
          Response Definitions<\/h4>\n\n\n\n
           Response Item <\/th> Description <\/th> Data Type <\/th><\/tr><\/thead>
          surveyId<\/td>The survey Id.<\/td>String: containing GUID<\/td><\/tr>
          variable<\/td>The variable.<\/td>Object<\/td><\/tr>
          variable\/order<\/td>The positional order of the variable.<\/td>Integer<\/td><\/tr>
          variable\/variableId<\/td>The V number of the variable<\/td>String<\/td><\/tr>
          variable\/label<\/td>The label of the variable.<\/td>String<\/td><\/tr>
          variable\/name<\/td>The name of the variable.<\/td>String<\/td><\/tr>
          variable\/questionText<\/td>The question text of the variable. i.e. the question shown to the respondent.<\/td>String<\/td><\/tr>
          variable\/variableTypeId<\/td>The numeric code for the variable type.<\/td>Integer: 
          Unknown = 0, Precoded = 1, Numeric = 2, Alphanumeric = 3, Derived = 5, Question = 6, Note = 7<\/td><\/tr>
          variable\/paraDataTypeId<\/td>The numeric code for the para data variable.<\/td>Integer: SITE=0, NAME=1, DATE=2, START=3, END=4, DURATION=5, CASE=6, RESET=7, ENDDATE=8, INTERVIEWER=9, PASSWORD=10, LANGUAGE=11, FORMAT=12, URL=13, SURV_INDEX=14, LOCATION=15, RECORDING=16, PAGE=17, PANEL=18, SERVERDATE=19, SERVERTIME=20, UNKNOWN=-1, NOT_PARA_DATA = -2<\/td><\/tr>
          variable\/responseTypeId<\/td>The numeric code for the response type.<\/td>Integer:   
          Unknown = 0, Single = 1, Multiple = 2, Quantity = 3, Literal = 4, None = 5, Date = 6, Time = 7<\/td><\/tr>
          variable\/variableType<\/td>The type of the variable.<\/td>String:   
          \u201cUnknown\u201d, \u201cPrecoded\u201d, \u201cNumeric\u201d, \u201cAlphanumeric\u201d, \u201cDerived\u201d, \u201cQuestion\u201d, \u201cNote\u201d.<\/td><\/tr>
          variable\/paraDataType<\/td>The type of the para data variable.<\/td>String: “SITE”, “NAME”, “DATE”, “START”, “END”, “DURATION”, “CASE”, “RESET”, “ENDDATE”, “INTERVIEWER”, “PASSWORD”, “LANGUAGE”, “FORMAT”, “URL”, “SURV_INDEX”, “LOCATION”, “RECORDING”, “PAGE”, “PANEL”, “SERVERDATE”, “SERVERTIME”, “UNKNOWN”, “NOT_PARA_DATA”<\/td><\/tr>
          variable\/responseType<\/td>The response type of the answer.<\/td>String:
          \u201cUnknown\u201d, \u201cSingle\u201d, \u201cMultiple\u201d, \u201cQuantity\u201d, \u201cLiteral\u201d, \u201cNone\u201d, \u201cDate\u201d, \u201cTime\u201d<\/td><\/tr>
          variable\/codeCount<\/td>If a choice question this states the number of codes. If not a choice question then this will be 0.<\/td>Integer<\/td><\/tr>
          variable\/codes<\/td>A list of codes.<\/td>List: containing objects<\/td><\/tr>
          variable\/codes\/codeIndex<\/td>The index of the variable code.<\/td>Integer<\/td><\/tr>
          variable\/codes\/codeValue<\/td>The value of the variable code.<\/td>Integer<\/td><\/tr>
          variable\/codes\/codeLabel<\/td>The label of the variable code.<\/td>String<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
          HTTP Status Codes<\/h4>\n\n\n\n
            \n
          • 200 OK <\/li>\n\n\n\n
          • 404 Not Found \u2013 if survey variable does not exist.<\/li>\n<\/ul>\n\n\n\n
            Get Survey Responses<\/h3>\n\n\n\n
            Get the responses of a survey.<\/p>\n\n\n\n
            You can <\/p>\n\n\n\n
              \n
            • use our recommended approach<\/strong>, which is to use the startingFrom <\/strong>token so you only get the responses that have been submitted or modified since your last call.<\/li>\n\n\n\n
            • get all the responses each call and will be charged for each response for every call.<\/li>\n<\/ul>\n\n\n\n
              Please note<\/strong> that from Monday 5th December 2022 usage of the API became chargeable. The charge is that 0.1 unit will be consumed each time a survey response is delivered by the API.  This applies if the same survey response is delivered by the API multiple times. The survey responses are delivered using the Get Survey Responses endpoint.<\/p>\n\n\n\n
              Endpoint<\/h4>\n\n\n\n
              Method<\/th>URL<\/th><\/tr><\/thead>
              GET<\/td>https:\/\/<servername>\/snaponline\/api\/surveys\/{surveyId}\/responses<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
              Get the responses of the specific survey identified with the surveyId <\/strong>path variable.<\/p>\n\n\n\n
              Parameters<\/h4>\n\n\n\n
              Path parameters<\/h5>\n\n\n\n
              Path parameter<\/th>Description<\/th><\/tr><\/thead>
              {surveyId}<\/td>The id of the survey. This is the survey GUID and not the Interview URL.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
              Query string parameters<\/h5>\n\n\n\n
              Query string parameter<\/th>Required \/ Optional<\/th>Description<\/th>Type<\/th>Range<\/th>Default<\/th><\/tr><\/thead>
              maxResponses<\/td>Optional<\/td>The number of responses to return.<\/td>Integer<\/td>1-5000<\/td>5000<\/td><\/tr>
              startingFrom<\/td>Optional<\/td>We recommended always using the startingFrom token. <\/strong>
              Returns responses from the startingFrom <\/strong>token. This value is \u201c0\u201d to start at the beginning, or a token to start from a particular point in the responses collection.   Example: #IBCGEGG.
              To get the next set of responses (if the output UpToDate <\/strong>property is false) feed the progress token of the output into the startingFrom <\/strong>token and make the call.
              NB<\/strong> the # needs to be URL encoded e.g. %23IBCGEGG<\/td>              		String<\/td>N\/A<\/td>\u201c0\u201d<\/td><\/tr>
              returnCaseIds<\/td>Optional<\/td>Whether to return the case ID in the response.<\/td>Boolean<\/td>N\/A<\/td>false<\/td><\/tr>
              useCodeLabels<\/td>Optional<\/td>Whether to return code labels (true) or code indexes (false) for choice questions.<\/td>Boolean<\/td>N\/A<\/td>false<\/td><\/tr>
              variables<\/td>Optional<\/td>Determines which variables to return in each response.  
              Default returns all variables.

              This is a comma separated list of V numbers. Can also use ~ to specify a range of variables.

              Example: V10~V12,V15 will return V10, V11, V12 and V15.<\/td>              		String<\/td>N\/A<\/td>\u201c\u201d<\/td><\/tr>
              filter<\/td>Optional<\/td>The Snap XMP filter to use.
              The default does not use a filter.

              Example: (ID.endDate>=2021\/01\/01) and (ID.endDate<=2021\/06\/01)<\/td>              		String<\/td>N\/A<\/td>“”<\/td><\/tr>
              useVariableNames<\/td>Optional<\/td>If false the variables are identified by an id <\/strong>property and the value will be the variable V number.

              If true the variables are identified by a name <\/strong>property instead of an id <\/strong>property and the value will be the actual variable name.<\/td>              		Boolean<\/td>N\/A<\/td>false<\/td><\/tr>
              latestCasesOnly<\/td>Optional<\/td>If false, the output will include a response for every edit. If true, the output edits will be rolled into fewer responses.<\/td>Boolean<\/td>N\/A<\/td>false<\/td><\/tr>
              excludeDeletedCases<\/td>Optional<\/td>Excludes cases that have been deleted. You will never see a response\/status<\/strong> of deleted<\/strong>.<\/td>Boolean<\/td>N\/A<\/td>fasle<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
              Note: There are two ways to identify the V number required in the variables <\/strong>parameter:

              1. Make the Get Survey Variables call and examine the result.<\/p>\n\n\n\n
              2. Snap XMP Desktop: Tick the UniqueIDs <\/strong>checkbox in the Variable Tailoring<\/strong> dialog. A new Id<\/strong> column will then be visible in the Variables <\/strong>screen.<\/p>\n\n\n\n
              Sample Request<\/h4>\n\n\n\n
              curl --location --request GET 'https:\/\/<servername>\/snaponline\/api\/surveys\/c23a0fd8-6219-4130-a6a7-f312829e56eb\/responses?maxResponses=100&variables= \nV16,V45~V47&returnCaseIds=true&useCodeLabels=true&startingFrom=0' \\\n--header 'X-USERNAME: {USERNAME}' \\\n--header 'X-API-KEY: {APIKEY}' \\\n--header 'X-VERSION: 3.0' \\\n--data-raw ''<\/code><\/pre>\n\n\n\n
              (In the above code, replace {APIKEY} with your actual API key and {USERNAME} with your actual username.)<\/p>\n\n\n\n
              Sample Response<\/h4>\n\n\n\n
              200 OK with body:<\/p>\n\n\n\n
              {\n    \"surveyId\": \"c23a0fd8-6219-4130-a6a7-f312829e56eb\",\n    \"startingFrom\": \"0\",\n    \"progress\": \"#IBCGEGG\",\n    \"upToDate\": \"false\",\n    \"responses\": [\n        {\n            \"status\": \"new\",\n            \"caseId\": \"8e4591b0-c1e3-4612-88b4-7b96cd28dd2d\",\n            \"variables\": [\n                {\n                    \"id\": \"V46\",\n                    \"v\": \"Plane\"\n                },\n                {\n                    \"id\": \"V48\",\n                    \"v\": \"\\\"Restaurant \/ Cafe\\\",\\\"Gift Shop\\\",\\\"Customer Services\\\"\"\n                },\n                {\n                    \"id\": \"V52\",\n                    \"s\": \"NR\"\n                }\n            ]\n        },\n        {\n            \"status\": \"new\",\n            \"caseId\": \"5458bfcb-97df-4326-879d-4868406761ae\",\n            \"variables\": [\n                {\n                    \"id\": \"V46\",\n                    \"v\": \"Bike\"\n                },\n                {\n                    \"id\": \"V48\",\n                    \"v\": \"\\\"Gift Shop\\\"\"\n                },\n                {\n                    \"id\": \"V52\",\n                    \"v\": \"Very busy.\"\n                }\n            ]\n        }\n    ]\n}\n<\/code><\/pre>\n\n\n\n
              Follow on Sample Request using the progress response item<\/h4>\n\n\n\n
              In the sample response above, progress <\/strong>represents where you have got to in the data file. This token is then used as the startingFrom <\/strong>value in the next \/Responses request, to retrieve responses that have been submitted or modified since your last call.<\/p>\n\n\n\n
              “progress”: “#IBCGEGG”,<\/p>\n\n\n\n
              Use this token as the startingFrom <\/strong>parameter in order to retrieve responses that have been submitted or modified since your last call.<\/p>\n\n\n\n
              NB<\/strong> the # needs to be URL encoded e.g. %23IBCGEGG<\/p>\n\n\n\n
              Sample Request example using the progress token<\/h4>\n\n\n\n
              curl --location --request GET 'https:\/\/<servername>\/snaponline\/api\/surveys\/c23a0fd8-6219-4130-a6a7-f312829e56eb\/responses?maxResponses=100&variables= \nV16,V45~V47&returnCaseIds=true&useCodeLabels=true&startingFrom=%23IBCGEGG' \\\n--header 'X-USERNAME: {USERNAME}' \\\n--header 'X-API-KEY: {APIKEY}' \\\n--header 'X-VERSION: 3.0' \\\n--data-raw ''<\/code><\/pre>\n\n\n\n
              Response Definitions<\/h4>\n\n\n\n
               Response Item <\/th> Description <\/th> Data Type <\/th><\/tr><\/thead>
              surveyId<\/td>The survey Id you selected based on the survey Id in the request.<\/td>String: containing GUID<\/td><\/tr>
              filter<\/td>The filter used. Only appears if the filter <\/strong>query parameter was provided.<\/td>String<\/td><\/tr>
              startingFrom<\/td>The startingFrom <\/strong>token in the request. This is recommended<\/strong>.<\/td>String<\/td><\/tr>
              progress<\/td>The ending token. This token can be used as the startingFrom <\/strong>parameter in the next call.<\/td>String<\/td><\/tr>
              upToDate<\/td>Whether the most recent response is included.<\/td>Boolean<\/td><\/tr>
              responses<\/td>The responses.

              The number of responses will be based on the maxResponses <\/strong>request parameter.<\/td>              		List: containing objects<\/td><\/tr>
              responses\/status<\/td>\u201cnew\u201d if this is a brand new response, \u201cupdated\u201d if the response has been edited in Snap XMP Desktop or \u201cdeleted\u201d if the response has been deleted (although you will only see deleted responses if you have also set the returnCaseIds parameter to true and the excludeDeletedCases parameter to false)<\/strong>.<\/td>String<\/td><\/tr>
              responses\/caseId<\/td>The case Id of the response.<\/td>String (Default: Guid)<\/td><\/tr>
              responses\/variables<\/td>The variables in the response.

              This will either be all the variables in the response or restricted to those specified in the variables request parameter.<\/td>              		List: containing objects<\/td><\/tr>
              responses\/variables\/id<\/td>If the useVariablesName <\/strong>parameter is false or not provided: The variable Id (V number).<\/td>String<\/td><\/tr>
              responses\/variables\/name<\/td>If the useVariablesName <\/strong>parameter is true: The variable Id (name).<\/td>String<\/td><\/tr>
              responses\/variables\/s<\/td>The status code of the variable. This field will only appear if the outcome of the variable is not \u201cOK\u201d.   <\/td>String:   \u201cNR\u201d for no reply, \u201cNA\u201d for not asked, \u201cERR\u201d for error.<\/td><\/tr>
              responses\/variables\/v<\/td>The value of the variable.

              For choice questions this will either be the code label if the useCodeLabels <\/strong>parameter is true or the code index if it is false.<\/td>              		String \u2013 even if returning numbers.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
              HTTP Status Codes<\/h4>\n\n\n\n
                \n
              • 200 OK<\/li>\n\n\n\n
              • 400 Bad Request\n
                  \n
                • If maxResponses <\/strong>parameter is not between 1 and 5000.<\/li>\n\n\n\n
                • If variables <\/strong>parameter is invalid or a variable does not exist.<\/li>\n\n\n\n
                • If startingFrom <\/strong>parameter is invalid.<\/li>\n\n\n\n
                • If the filter <\/strong>parameter is invalid.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
                • 500\n
                    \n
                  • If something else went wrong while trying to extract the responses from the survey <\/li>\n<\/ul>\n<\/li>\n<\/ul>\n\n\n\n
                    Get Participant List<\/h3>\n\n\n\n
                    Get the details of the current participants of a survey.<\/p>\n\n\n\n
                    Endpoint<\/h4>\n\n\n\n
                     Method               <\/th> Url <\/th><\/tr><\/thead>
                    GET<\/td>https:\/\/snaponline\/api\/surveys\/{surveyId}\/participants<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
                    Get the details of current participants of the specific survey identified by the surveyId <\/strong>path variable.<\/p>\n\n\n\n
                    Parameters<\/h4>\n\n\n\n
                    Path parameters<\/h5>\n\n\n\n
                     Path parameter <\/th> Description <\/th><\/tr><\/thead>
                    {surveyId}<\/td>The id of the survey. This is the survey GUID and not the Interview URL.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
                    Query string parameters<\/h5>\n\n\n\n
                     Query string parameter <\/th> Required \/ Optional <\/th> Description <\/th> Type <\/th> Range <\/th>Default<\/th><\/tr><\/thead>
                    maxParticipants<\/td>Optional<\/td>The number of participants to return.<\/td>Integer<\/td>1-5000<\/td>5000<\/td><\/tr>
                    startingFrom<\/td>Optional<\/td>Returns participants from the startingFrom <\/strong>token. This value is \u201c0\u201d to start at the beginning or a token to start from a particular point in the participants collection.   Example: #IBCGEGG.   To get the next set of participants (if the output UpToDate <\/strong>property is false) feed the progress token of the output into the startingFrom <\/strong>token and make the call again.<\/td>String<\/td>N\/A<\/td>\u201c0\u201d<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
                    Sample Request<\/h4>\n\n\n\n
                    curl --location --request GET 'https:\/\/ <servername>\/snaponline\/api\/surveys\/20dbe888-ec99-4895-b094-e34084f9408f\/participants?startingFrom=0&maxParticipants=2' \\\n--header 'X-USERNAME: {USERNAME}' \\\n--header 'X-API-KEY: {APIKEY}' \\\n--header 'X-VERSION: 3.0'\n<\/code><\/pre>\n\n\n\n
                    (In the above code, replace {APIKEY} with your actual API key and {USERNAME} with your actual username.)<\/p>\n\n\n\n
                    Sample Response<\/h4>\n\n\n\n
                    200 OK with body:<\/p>\n\n\n\n
                    {\n    \"surveyId\": \"20dbe888-ec99-4895-b094-e34084f9408f\",\n    \"startingFrom\": \"0\",\n    \"progress\": \"#ECDEHDIHBB\",\n    \"upToDate\": false,\n    \"participants\": [\n        {\n            \"id\": \"e8623247-5aa9-4bbb-864b-5c76b1749c7a\",\n            \"enabled\": true,\n            \"invitationSection\": {\n                \"optedOut\": false,\n                \"sendInvitations\": true,\n                \"emailAddress\": \"a@example.com\"\n            },\n            \"loginSection\": {\n                \"login\": \"A\",\n                \"password\": null,\n                \"interviewer\": null,\n                \"status\": \"NotStarted\"\n            }\n        },\n        {\n            \"id\": \"e8623247-5aa9-4bbb-864b-5c76b1749c7b\",\n            \"enabled\": true,\n            \"invitationSection\": {\n                \"optedOut\": false,\n                \"sendInvitations\": true,\n                \"emailAddress\": \"b@example.com\"\n            },\n            \"loginSection\": {\n                \"login\": \"B\",\n                \"password\": null,\n                \"interviewer\": null,\n                \"status\": \"NotStarted\"\n            }\n        }\n    ]\n}\n<\/code><\/pre>\n\n\n\n
                    Response Definitions<\/h4>\n\n\n\n
                     Response Item <\/th> Description <\/th> Data Type <\/th><\/tr><\/thead>
                    surveyId<\/td>The survey Id you selected based on the survey Id in the request.<\/td>String: containing GUID<\/td><\/tr>
                    startingFrom<\/td>The startingFrom <\/strong>token in the request.<\/td>String<\/td><\/tr>
                    progress<\/td>The ending token. This token can be used as the startingFrom <\/strong>parameter in the next call.<\/td>String<\/td><\/tr>
                    upToDate<\/td>Whether the most recent participant is included.<\/td>String: containing Boolean<\/td><\/tr>
                    participants<\/td>The participants.

                    The number of participants will be based on the maxParticipants <\/strong>request parameter.<\/td>                    		List: containing objects<\/td><\/tr>
                    participants\/id<\/td>The id of the participant.<\/td>String: containing GUID<\/td><\/tr>
                    participants\/enabled<\/td>Whether the participant is enabled.<\/td>Boolean<\/td><\/tr>
                    participants\/loginSection<\/td>The login section for a logged on survey participant. Section will be omitted if not a logged on survey.<\/td>Object<\/td><\/tr>
                    participants\/loginSection\/login<\/td>If a logged on survey this will be the login name otherwise null.<\/td>String or null<\/td><\/tr>
                    participants\/loginSection\/password<\/td>If a logged on survey and a password is required this will be the password otherwise null or \u201c\u201d.<\/td>String or null<\/td><\/tr>
                    participants\/loginSection\/interviewer<\/td>If the survey allows synchronisation of participants with SOI but the API user does not have Manage participants for SOI<\/strong> permission this will be null. If survey does not allow synchronisation of participants to SOI this will be null. If the survey allows synchronisation of participants to SOI and the API user has Manage participants for SOI<\/strong> permission this will be either \u201c\u201d signifying that all interviewers will have access or an email address of the interviewer.<\/td>String or null<\/td><\/tr>
                    participants\/loginSection\/status<\/td>If the survey is a logged on but not a group questionnaire then this is the status of the participant.   If the survey is a logged on and group questionnaire then this is the overall status for the participant across all the questionnaires.   If the survey is invite only then the status will be null.

                     <\/td>                    		String or null:   
                    For non group questionnaire:   
                    \u201cNotStarted\u201d \u2013 the participant has not started the questionnaire. 
                    \u201cStarted\u201d the participant has started the questionnaire. 
                    \u201cPartial\u201d \u2013 a partial response has been taken.
                    \u201cSaved\u201d \u2013 the participant has saved the questionnaire. 
                    \u201cCompleted\u201d \u2013 the participant has completed the questionnaire.
                    \u201cSubmitted\u201d \u2013 the researcher has submitted a partial response.   
                    For group questionnaire:  
                    \u201cNotStarted\u201d \u2013 the participant has not started any of the questionnaires. 
                    \u201cStarted\u201d –  the participant has started at least one of the questionnaires. 
                    \u201cCompleted\u201d \u2013 the participant has completed all of the questionnaires. This includes whether a researcher submitted a partial.<\/td><\/tr>
                    participants\/invitationSection<\/td>The invitation section for an invited survey participant. Section will be omitted if not an invited survey.<\/td>Object<\/td><\/tr>
                    participants\/ invitationSection\/emailAddress<\/td>If an invited survey this will be the email address of the participant or empty string if not an invite survey.<\/td>String<\/td><\/tr>
                    participants\/invitationSection\/ sendInvitations<\/td>Whether invitations are to be sent.<\/td>Boolean<\/td><\/tr>
                    participants\/invitationSection\/ optedOut<\/td>Whether the user is opted out from emails.<\/td>Boolean<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
                    HTTP Status Codes<\/h4>\n\n\n\n
                    200 OK<\/p>\n\n\n\n
                    Get Participant<\/h3>\n\n\n\n
                    Get the details of a participant of a survey.<\/p>\n\n\n\n
                    Endpoint<\/h4>\n\n\n\n
                     Method               <\/th> Url <\/th><\/tr><\/thead>
                    GET<\/td>https:\/\/snaponline\/api\/surveys\/{surveyId}\/participants\/{participantUniqueId}<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
                    Get details of the specific participant identified by the participantUniqueId<\/strong> path variable of the specific survey identified by the surveyId <\/strong>path variable.<\/p>\n\n\n\n
                    Parameters<\/h4>\n\n\n\n
                    Path parameters<\/h5>\n\n\n\n
                     Path parameter <\/th> Description <\/th><\/tr><\/thead>
                    {surveyId}<\/td>The id of the survey. This is the survey GUID and not the Interview URL.<\/td><\/tr>
                    {participantUniqueId}<\/td>This is either the login name if a logged in survey or else the email address.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
                    Query string parameters<\/h5>\n\n\n\n
                    None<\/p>\n\n\n\n
                    Sample Request<\/h4>\n\n\n\n
                    curl --location --request GET 'https:\/\/ <servername>\/snaponline\/api\/surveys\/20dbe888-ec99-4895-b094-e34084f9408f\/participants\/A' \\\n--header 'X-USERNAME: {USERNAME}' \\\n--header 'X-API-KEY: {APIKEY}' \\\n--header 'X-VERSION: 3.0'<\/code><\/pre>\n\n\n\n
                    (In the above code, replace {APIKEY} with your actual API key and {USERNAME} with your actual username.)<\/p>\n\n\n\n
                    Sample Responses<\/h4>\n\n\n\n
                    The response structure is determined by the participant feature configuration of the survey. This is shown in the participant import wizard of Snap Online.<\/p>\n\n\n\n
                    If the configuration has Allow Snap Online to track respondents<\/strong> ticked it is a logged on survey and a loginSection<\/strong> will be included. If the configuration has Send email invites \/ reminders<\/strong> ticked then an invitationSection<\/strong> will be included.<\/p>\n\n\n\n
                    The invitationSection<\/strong> will always include an inviteSeeding<\/strong> section even if there isn\u2019t any seeding.<\/p>\n\n\n\n
                    The loginSection<\/strong> will always have a questionnaireSeeding<\/strong> section even if there isn\u2019t any seeding.<\/p>\n\n\n\n
                    If the configuration has Group Questionnaire<\/strong> ticked then there will be one or more subjects inside the loginSection<\/strong> section and each subjectName<\/strong> property will be a non empty string.<\/p>\n\n\n\n
                    If the configuration does not have Group Questionnaire<\/strong> ticked then there will be exactly one subject inside the loginSection<\/strong> section and the subjectName<\/strong> property will be an empty string.<\/p>\n\n\n\n
                    200 OK with body (invite only participant with some invite seeding):<\/p>\n\n\n\n
                    {\n    \"invitationSection\": {\n        \"optedOut\": false,\n        \"sendInvitations\": true,\n        \"emailAddress\": \"a@example.com\",\n        \"invitationSeeding\": {\n            \"forenames\": \"A\",\n            \"surname\": \"A\"\n        }\n    }, \n    \"id\": \"e8623247-5aa9-4bbb-864b-5c76b1749c7a\",   \n    \"enabled\": true\n}\n<\/code><\/pre>\n\n\n\n
                    200 OK with body (log on and invite participant \u2013 group questionnaire):<\/p>\n\n\n\n
                    {\n    \"invitationSection\": {\n        \"optedOut\": false,\n        \"sendInvitations\": true,\n        \"emailAddress\": \"a@example.com\",\n        \"invitationSeeding\": {\n            \"forenames\": \"A\",\n            \"surname\": \"A\"\n        }\n    },\n    \"loginSection\": {\n        \"login\": \"A\",\n        \"password\": null,\n        \"interviewer\": null,\n        \"status\": \"NotStarted\",\n        \"subjects\": [\n            {\n                \"subjectName\": \"L1\",\n                \"questionnaireSeeding\": {\n                    \"v53\": \"L1\",\n                    \"v48\": \"2;3\",\n                    \"v50\": \"A\",\n                    \"v51\": \"A\",\n                    \"v46\": \"4\"\n                },\n                \"status\": \"NotStarted\"\n            }\n        ]\n    },\n    \"id\": \"e8623247-5aa9-4bbb-864b-5c76b1749c7a\",\n    \"enabled\": true\n}\n<\/code><\/pre>\n\n\n\n
                    Response Definitions<\/h4>\n\n\n\n
                     Response Item <\/th> Description <\/th> Data Type <\/th><\/tr><\/thead>
                    id<\/td>The participant id.<\/td>String: containing GUID<\/td><\/tr>
                    enabled<\/td>Whether the participant is enabled.<\/td>Boolean<\/td><\/tr>
                    invitationSection<\/td>The invitation section for an invited survey participant. Section will be omitted if not an invited survey.<\/td>Object<\/td><\/tr>
                    invitationSection\/optedOut<\/td>Whether invitations are to be sent.<\/td>Boolean<\/td><\/tr>
                    invitationSection\/sendInvitations<\/td>Whether the user is opted out from emails.<\/td>Boolean<\/td><\/tr>
                    invitationSection\/emailAddress<\/td>The email address.<\/td>String<\/td><\/tr>
                    invitationSection\/inviteSeeding<\/td>The invite seeding.   This is a dictionary of properties in the form \u201c<invite key>\u201d : \u201c<value>\u201d<\/td>Object<\/td><\/tr>
                    loginSection<\/td>The login section for a logged on survey participant. Section will be omitted if not a logged on survey.<\/td>Object<\/td><\/tr>
                    loginSection\/login<\/td>If a logged on survey this will be the login name otherwise null.<\/td>String or null<\/td><\/tr>
                    loginSection\/password<\/td>If a logged on survey and a password is required this will be the password otherwise null or \u201c\u201d.<\/td>String or null<\/td><\/tr>
                    loginSection\/interviewer<\/td>If the survey allows synchronisation of participants with SOI but the API user does not have Manage participants for SOI<\/strong> permission this will be null. If survey does not allow synchronisation of participants to SOI this will be null. If the survey allows synchronisation of participants to SOI and the API user has Manage participants for SOI<\/strong> permission this will be either \u201c\u201d signifying that all interviewers will have access or an email address of the interviewer.<\/td>String or null<\/td><\/tr>
                    loginSection\/status<\/td>This is the overall status.   If the survey is a logged on but not a group questionnaire, then this is the status of the participant.   If the survey is a logged on and group questionnaire, then this is the overall status for the participant across all the questionnaires.   If the survey is invite only then the status will be null.

                    <\/td>                    		String or null:   
                    For non group questionnaire:   
                    \u201cNotStarted\u201d \u2013 the participant has not started the questionnaire. 
                    \u201cStarted\u201d the participant has started the questionnaire. 
                    \u201cPartial\u201d \u2013 a partial response has been taken. 
                    \u201cSaved\u201d \u2013 the participant has saved the questionnaire. 
                    \u201cCompleted\u201d \u2013 the participant has completed the questionnaire.
                    \u201cSubmitted\u201d \u2013 the researcher has submitted a partial response.   
                    For group questionnaire:  
                    \u201cNotStarted\u201d \u2013 the participant has not started any of the questionnaires.
                    \u201cStarted\u201d – the participant has started at least one of the questionnaires.
                    \u201cCompleted\u201d \u2013 the participant has completed all of the questionnaires. This includes whether a researcher submitted a partial.<\/td><\/tr>
                    loginSection\/subjects<\/td>The subjects for the participant.   For a group questionnaire there will be one or more. For a non-group questionnaire there will just be one.<\/td>List<\/td><\/tr>
                    loginSection\/subjects\/subjectName<\/td>For a group questionnaire subjectName <\/strong>will not be an empty string.   For a non group questionnaire the subjectName <\/strong>must be an empty string.<\/td>String<\/td><\/tr>
                    loginSection\/subjects\/ questionnaireSeeding<\/td>The questionnaire seeding for the subject.   This is a dictionary of properties in the form \u201c<variable V number>\u201d : \u201c<value>\u201d.<\/td>Object<\/td><\/tr>
                    loginSection\/subjects\/status<\/td>This is the subject status.

                     <\/td>                    		String or null:   
                    \u201cNotStarted\u201d \u2013 the participant has not started the questionnaire.
                    \u201cStarted\u201d the participant has started the questionnaire. 
                    \u201cPartial\u201d \u2013 a partial response has been taken. 
                    \u201cSaved\u201d \u2013 the participant has saved the questionnaire.
                    \u201cCompleted\u201d \u2013 the participant has completed the questionnaire.
                    \u201cSubmitted\u201d \u2013 the researcher has submitted a partial response.  <\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
                    HTTP Status Codes<\/h4>\n\n\n\n
                    200 OK<\/p>\n\n\n\n
                    404 Not Found<\/p>\n\n\n\n
                    Add Participant<\/h3>\n\n\n\n
                    Add a new participant to a survey.<\/p>\n\n\n\n
                    Endpoint<\/h4>\n\n\n\n
                     Method               <\/th> Url <\/th><\/tr><\/thead>
                    POST<\/td>https:\/\/snaponline\/api\/surveys\/{surveyId}\/participants<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
                    Add a new participant to the specific survey identified by the surveyId <\/strong>path variable.<\/p>\n\n\n\n
                    Parameters<\/h4>\n\n\n\n
                    Path parameters<\/h5>\n\n\n\n
                     Path parameter <\/th> Description <\/th><\/tr><\/thead>
                    {surveyId}<\/td>The id of the survey. This is the survey GUID and not the Interview URL.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
                    Query string parameters<\/h5>\n\n\n\n
                    None<\/p>\n\n\n\n
                    Request body data<\/h4>\n\n\n\n
                    Requires request body of JSON object e.g.:<\/p>\n\n\n\n
                    {\n    \"invitationSection\": {\n        \"optedOut\": false,\n        \"sendInvitations\": true,\n        \"emailAddress\": \"a@example.com\",\n        \"invitationSeeding\": {\n            \"forenames\": \"A\",\n            \"surname\": \"A\"\n        }\n    },\n    \"loginSection\": {\n        \"login\": \"A\",\n        \"password\": null,\n        \"interviewer\": null,\n        \"status\": \"NotStarted\",\n        \"subjects\": [\n            {\n                \"subjectName\": \"L1\",\n                \"questionnaireSeeding\": {\n                    \"v53\": \"L1\",\n                    \"v48\": \"2;3\",\n                    \"v50\": \"A\",\n                    \"v51\": \"A\",\n                    \"v46\": \"4\"\n                },\n                \"status\": \"NotStarted\"\n            }\n        ]\n    },\n    \"enabled\": true\n}\n<\/code><\/pre>\n\n\n\n
                    Note. The above example is creating a participant in a survey where the participant feature requires that the participant be invited and that the participant has to provide credentials to view the questionnaire. Therefore, you must specify both the invitationSection<\/strong> section and the loginSection<\/strong> section in the call. The example is also for a group questionnaire and it will create one subject for the participant. In a non-group questionnaire, you must provide one subject and the subjectName<\/strong> property should be an empty string.<\/p>\n\n\n\n
                    For an invite only survey do not include a loginSection<\/strong> section. For a logged on only survey do not include an invitationSection<\/strong> section.<\/p>\n\n\n\n
                    The status<\/strong> properties are read-only so will be ignored if specified.<\/p>\n\n\n\n
                    If the survey allows interviewers for SOI then you specify the interviewer in the interviewer <\/strong>property. The interviewer must be the email address of a user that has SOI access to the survey. If you don\u2019t want to specify an interviewer set it to an empty string. If the survey does not allow interviewers set it to null.<\/p>\n\n\n\n
                    Sample Request<\/h4>\n\n\n\n
                    curl --location --request POST 'https:\/\/ <servername>\/snaponline\/api\/surveys\/20dbe888-ec99-4895-b094-e34084f9408f\/participants' \\\n--header 'X-USERNAME: {USERNAME}' \\\n--header 'X-API-KEY: {APIKEY}' \\\n--header 'X-VERSION: 3.0' \\\n--header 'Content-Type: application\/json' \\\n--data-raw '{\n    \"invitationSection\": {\n        \"optedOut\": false,\n        \"sendInvitations\": true,\n        \"emailAddress\": \"a@example.com\",\n        \"invitationSeeding\": {\n            \"forenames\": \"E\",\n            \"surname\": \"E\"\n        }\n    },\n    \"loginSection\": {\n        \"login\": \"E\",\n        \"password\": null,\n        \"interviewer\": null,\n        \"status\": \"NotStarted\",\n        \"subjects\": [\n            {\n                \"subjectName\": \"L1\",\n                \"questionnaireSeeding\": {\n                    \"v53\": \"L1\",\n                    \"v48\": \"2;3\",\n                    \"v50\": \"A\",\n                    \"v51\": \"A\",\n                    \"v46\": \"4\"\n                },\n                \"status\": \"NotStarted\"\n            }\n        ]\n    },\n    \"enabled\": true\n}'\n<\/code><\/pre>\n\n\n\n
                    (In the above code, replace {APIKEY} with your actual API key and {USERNAME} with your actual username.)<\/p>\n\n\n\n
                    Note. The status <\/strong>field is read-only. If you send it into the request body as in the sample request above it will be ignored.<\/p>\n\n\n\n
                    Sample Response<\/h4>\n\n\n\n
                    {\n    \"invitationSection\": {\n        \"optedOut\": false,\n        \"sendInvitations\": true,\n        \"emailAddress\": \"a@example.com\",\n        \"invitationSeeding\": {}\n    },\n    \"loginSection\": {\n        \"login\": \"E\",\n        \"password\": null,\n        \"interviewer\": null,\n        \"status\": \"NotStarted\",\n        \"subjects\": [\n            {\n                \"subjectName\": \"L1\",\n                \"questionnaireSeeding\": {\n                    \"v48\": \"2;3\",\n                    \"v50\": \"A\",\n                    \"v53\": \"L1\",\n                    \"v51\": \"A\",\n                    \"v46\": \"4\"\n                },\n                \"status\": \"NotStarted\"\n            }\n        ]\n    },\n    \"id\": \"91188b33-0149-48ed-bf65-b9ecbc741f8d\",\n    \"enabled\": true\n}\n<\/code><\/pre>\n\n\n\n
                    Response Definitions<\/h4>\n\n\n\n
                     Response Item <\/th> Description <\/th> Data Type <\/th><\/tr><\/thead>
                    id<\/td>The participant id.<\/td>String: containing GUID<\/td><\/tr>
                    enabled<\/td>Whether the participant is enabled.<\/td>Boolean<\/td><\/tr>
                    invitationSection<\/td>The invitation section for an invited survey participant. Section will be omitted if not an invited survey.<\/td>Object<\/td><\/tr>
                    invitationSection\/optedOut<\/td>Whether invitations are to be sent.<\/td>Boolean<\/td><\/tr>
                    invitationSection\/sendInvitations<\/td>Whether the user is opted out from emails.<\/td>Boolean<\/td><\/tr>
                    invitationSection\/emailAddress<\/td>The email address.<\/td>String<\/td><\/tr>
                    invitationSection\/inviteSeeding<\/td>The invite seeding.   This is a dictionary of properties in the form \u201c<invite key>\u201d : \u201c<value>\u201d<\/td>Object<\/td><\/tr>
                    loginSection<\/td>The login section for a logged on survey participant. Section will be omitted if not a logged on survey.<\/td>Object<\/td><\/tr>
                    loginSection\/login<\/td>If a logged on survey this will be the login name otherwise null.<\/td>String or null<\/td><\/tr>
                    loginSection\/password<\/td>If a logged on survey and a password is required this will be the password otherwise null or \u201c\u201d.<\/td>String or null<\/td><\/tr>
                    loginSection\/interviewer<\/td>If the survey allows synchronisation of participants with SOI but the API user does not have Manage participants for SOI<\/strong> permission this will be null. If survey does not allow synchronisation of participants to SOI this will be null. If the survey allows synchronisation of participants to SOI and the API user has Manage participants for SOI<\/strong> permission this will be either \u201c\u201d signifying that all interviewers will have access or an email address of the interviewer.<\/td>String or null<\/td><\/tr>
                    loginSection\/status<\/td>This is the overall status.   If the survey is a logged on but not a group questionnaire then this is the status of the participant. If the survey is a logged on and group questionnaire then this is the overall status for the participant across all the questionnaires. If the survey is invite only then the status will be null.

                     <\/td>                    		String or null:   For non group questionnaire:   \u201cNotStarted\u201d \u2013 the participant has not started the questionnaire. \u201cStarted\u201d the participant has started the questionnaire. \u201cPartial\u201d \u2013 a partial response has been taken. \u201cSaved\u201d \u2013 the participant has saved the questionnaire. \u201cCompleted\u201d \u2013 the participant has completed the questionnaire. \u201cSubmitted\u201d \u2013 the researcher has submitted a partial response.   For group questionnaire:   \u201cNotStarted\u201d \u2013 the participant has not started any of the questionnaires. \u201cStarted\u201d –  the participant has started at least one of the questionnaires. \u201cCompleted\u201d \u2013 the participant has completed all of the questionnaires. This includes whether a researcher submitted a partial.<\/td><\/tr>
                    loginSection\/subjects<\/td>The subjects for the participant.   For a group questionnaire there will be one or more. For a non-group questionnaire there will just be one.<\/td>List<\/td><\/tr>
                    loginSection\/subjects\/subjectName<\/td>For a group questionnaire subject name will not be an empty string.   For a non group questionnaire the subject name must be an empty string.<\/td>String<\/td><\/tr>
                    loginSection\/subjects\/ questionnaireSeeding<\/td>The questionnaire seeding for the subject.   This is a dictionary of properties in the form \u201c<variable V number>\u201d : \u201c<value>\u201d.<\/td>Object<\/td><\/tr>
                    loginSection\/subjects\/status<\/td>This is the subject status.

                     <\/td>                    		String or null:   \u201cNotStarted\u201d \u2013 the participant has not started the questionnaire. \u201cStarted\u201d the participant has started the questionnaire. \u201cPartial\u201d \u2013 a partial response has been taken. \u201cSaved\u201d \u2013 the participant has saved the questionnaire. \u201cCompleted\u201d \u2013 the participant has completed the questionnaire. \u201cSubmitted\u201d \u2013 the researcher has submitted a partial response.  <\/td><\/tr>
                    enabled<\/td>Whether the participant is enabled.<\/td>Boolean<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
                    HTTP Status Codes<\/h4>\n\n\n\n
                    201 Created<\/p>\n\n\n\n
                    The response headers will include a Location key where the value is the URL to call to get the participant.<\/p>\n\n\n\n
                    400 Bad Request \u2013 various including:<\/p>\n\n\n\n
                    {\n    \"message\": \"Participants require a login section.\"\n}\n\n\"message\": \"You must provide a login name.\"\n\"message\": \"Participants require an invitation section.\"\n\"message\": \"Participants should not have an invitation section.\"\n\"message\": \"Participants should not have a login section.\"\n\"message\": \"The unique participant id provided in the URL must be the same as in the request body.\"\n\"message\": \"Not allowed to add, update or delete an interviewer.\"\n\"message\": \"Must provide an interviewer property and value cannot be null.\"\n\"message\": \"Interviewer does not have access to the survey.\"\n\"message\": Participants for this survey must have one subject.\"\n\"message\": \"Participants for this survey must only have one subject and the subject name must be an empty string.\"\n\"message\": \"Participants for this survey must have at least one subject.\"\n\"message\": \"Subject name cannot be blank for a group questionnaire.\"\n\"message\": \"Participant cannot be opted out and have send invitations enabled at the same time.\"\n\"message\": \"The unique participant id provided in the URL must be the same as in the request body.\"\n\"message\": \"You must provide a valid email address.\"\n\"message\": \"If an email address is provided, it must be valid.\"\n\"message\": \"Another participant already has this login name.\"\n\"message\": \"Participants for this survey must have unique subjects.\"\n\"message\": \"Participant to update does not exist.\"\n\"message\": \"Participant subjects do not match.\"\n\"message\": \"Another participant already has this email address.\"\n\"message\": \"Survey does not support participants.\"\n\"message\": \"Participants cannot be added, updated or deleted whilst an import is scheduled or running.\"\n\"message\": \"Participant invite seeding does not have a '<invite item>' seeding property.\"\n\"message\": \"Participant questionnaire seeding does not have a '<questionnaire item>}' seeding property.\"\n\"message\": \"Survey does not have a '<questionnaire item>' variable.\"\n\"message\": \"Survey variable '<questionnaire item>' is single choice. Multiple values are not allowed.\"\n\"message\": \"Survey variable '<questionnaire item>' cannot contain duplicate code values.\"\n\"message\": \"Survey variable '<questionnaire item>' does not contain code value '<code value>'.\"\n<\/code><\/pre>\n\n\n\n
                    Update Participant<\/h3>\n\n\n\n
                    Update an existing participant of a survey.<\/p>\n\n\n\n
                    Endpoint<\/h4>\n\n\n\n
                     Method               <\/th> Url <\/th><\/tr><\/thead>
                    PUT<\/td>https:\/\/snaponline\/api\/surveys\/{surveyId}\/participants\/{participantUniqueId}<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
                    Update the existing specific participant identified by the participantUniqueId<\/strong> path variable of the specific survey identified by the surveyId<\/strong> path variable.<\/p>\n\n\n\n
                    Parameters<\/h4>\n\n\n\n
                    Path parameters<\/h5>\n\n\n\n
                     Path parameter <\/th> Description <\/th><\/tr><\/thead>
                    {surveyId}<\/td>The id of the survey. This is the survey GUID and not the Interview URL.<\/td><\/tr>
                    {participantUniqueId}<\/td>This is either the login name if a logged in survey or else the email address.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
                    Query string parameters<\/h5>\n\n\n\n
                    None<\/p>\n\n\n\n
                    Request body data<\/h4>\n\n\n\n
                    Requires request body of JSON object e.g.:<\/p>\n\n\n\n
                    {\n    \"invitationSection\": {\n        \"optedOut\": false,\n        \"sendInvitations\": true,\n        \"emailAddress\": \"a@example.com\",\n        \"inviteSeeding\": {\n            \"surname\": \"D\",\n            \"forenames\": \"David\"\n        }\n    },\n    \"loginSection\": {\n        \"login\": \"A4\",\n        \"password\": null,\n        \"interviewer\": \"\",\n        \"status\": \"NotStarted\",\n        \"subjects\": [\n            {\n                \"subjectName\": \"Alton Towers\",\n                \"questionnaireSeeding\": {\n                    \"v45\": \"David\",\n                    \"v46\": \"D\"\n                },\n                \"status\": \"NotStarted\"\n            },\n            {\n                \"subjectName\": \"Chester Zoo\",\n                \"questionnaireSeeding\": {\n                    \"v45\": \"David\",\n                    \"v46\": \"D\"\n                },\n                \"status\": \"NotStarted\"\n            }\n        ]\n    },\n    \"enabled\": true\n}\n<\/code><\/pre>\n\n\n\n
                    Note. The above example is updating a participant in a survey where the participant feature requires that the participant be invited and that the participant has to provide credentials to view the questionnaire. Therefore, you must specify both the invitationSection<\/strong> section and the logonSection<\/strong> section in the call. The example is also for a group questionnaire and it will create two subjects for the participant. In a non-group questionnaire you must provide one subject and the subjectName<\/strong> property should be an empty string.<\/p>\n\n\n\n
                    For an invite only survey do not include a loginSection<\/strong> section. For a logged on only survey do not include an invitationSection<\/strong> section.<\/p>\n\n\n\n
                    The status<\/strong> properties are read-only so will be ignored if specified.<\/p>\n\n\n\n
                    If the survey allows interviewers for SOI then you specify the interviewer in the interviewer property. The interviewer must be the email address of a user that has SOI access to the survey. If you don\u2019t want to specify an interviewer set it to an empty string. If the survey does not allow interviewers set it to null.<\/p>\n\n\n\n
                    Sample Request<\/h4>\n\n\n\n
                    curl --location --request PUT 'https:\/\/ <servername>\/snaponline\/api\/surveys\/20dbe888-ec99-4895-b094-e34084f9408f\/participants\/E' \\\n--header 'X-USERNAME: {USERNAME}' \\\n--header 'X-API-KEY: {APIKEY}' \\\n--header 'X-VERSION: 3.0' \\\n--header 'Content-Type: application\/json' \\\n--data-raw '{\n    \"invitationSection\": {\n        \"optedOut\": false,\n        \"sendInvitations\": true,\n        \"emailAddress\": \"a@example.com\",\n        \"invitationSeeding\": {}\n    },\n    \"loginSection\": {\n        \"login\": \"E\",\n        \"password\": null,\n        \"interviewer\": null,\n        \"status\": \"NotStarted\",\n        \"subjects\": [\n            {\n                \"subjectName\": \"L1\",\n                \"questionnaireSeeding\": {\n                    \"v48\": \"2;3\",\n                    \"v50\": \"A\",\n                    \"v53\": \"L1\",\n                    \"v51\": \"A\",\n                    \"v46\": \"6\"\n                },\n                \"status\": \"NotStarted\"\n            }\n        ]\n    },\n    \"enabled\": true\n}'\n<\/code><\/pre>\n\n\n\n
                    (In the above code, replace {APIKEY} with your actual API key and {USERNAME} with your actual username.)<\/p>\n\n\n\n
                    Note. The status <\/strong>field is read-only. If you send it into the request body as in the sample request above it will be ignored<\/p>\n\n\n\n
                    Sample Response<\/h4>\n\n\n\n
                    {\n    \"invitationSection\": {\n        \"optedOut\": false,\n        \"sendInvitations\": true,\n        \"emailAddress\": \"a@example.com\",\n        \"invitationSeeding\": {}\n    },\n    \"loginSection\": {\n        \"login\": \"E\",\n        \"password\": null,\n        \"interviewer\": null,\n        \"status\": \"NotStarted\",\n        \"subjects\": [\n            {\n                \"subjectName\": \"L1\",\n                \"questionnaireSeeding\": {\n                    \"v48\": \"2;3\",\n                    \"v50\": \"A\",\n                    \"v53\": \"L1\",\n                    \"v51\": \"A\",\n                    \"v46\": \"6\"\n                },\n                \"status\": \"NotStarted\"\n            }\n        ]\n    },\n    \"id\": \"91188b33-0149-48ed-bf65-b9ecbc741f8d\",\n    \"enabled\": true\n}\n<\/code><\/pre>\n\n\n\n
                    Response Definitions<\/h4>\n\n\n\n
                     Response Item <\/th> Description <\/th> Data Type <\/th><\/tr><\/thead>
                    id<\/td>The participant id.<\/td>String: containing GUID<\/td><\/tr>
                    enabled<\/td>Whether the participant is enabled.<\/td>Boolean<\/td><\/tr>
                    invitationSection<\/td>The invitation section for an invited survey participant. Section will be omitted if not an invited survey.<\/td>Object<\/td><\/tr>
                    invitationSection\/optedOut<\/td>Whether invitations are to be sent.<\/td>Boolean<\/td><\/tr>
                    invitationSection\/sendInvitations<\/td>Whether the user is opted out from emails.<\/td>Boolean<\/td><\/tr>
                    invitationSection\/emailAddress<\/td>The email address.<\/td>String<\/td><\/tr>
                    invitationSection\/inviteSeeding<\/td>The invite seeding.   This is a dictionary of properties in the form \u201c<invite key>\u201d : \u201c<value>\u201d<\/td>Object<\/td><\/tr>
                    loginSection<\/td>The login section for a logged on survey participant. Section will be omitted if not a logged on survey.<\/td>Object<\/td><\/tr>
                    loginSection\/login<\/td>If a logged on survey this will be the login name otherwise null.<\/td>String or null<\/td><\/tr>
                    loginSection\/password<\/td>If a logged on survey and a password is required this will be the password otherwise null or \u201c\u201d.<\/td>String or null<\/td><\/tr>
                    loginSection\/interviewer<\/td>If the survey allows synchronisation of participants with SOI but the API user does not have Manage participants for SOI<\/strong> permission this will be null. If survey does not allow synchronisation of participants to SOI this will be null. If the survey allows synchronisation of participants to SOI and the API user has Manage participants for SOI<\/strong> permission this will be either \u201c\u201d signifying that all interviewers will have access or an email address of the interviewer.<\/td>String or null<\/td><\/tr>
                    loginSection\/status<\/td>This is the overall status.   If the survey is a logged on but not a group questionnaire then this is the status of the participant.   If the survey is a logged on and group questionnaire then this is the overall status for the participant across all the questionnaires.   If the survey is invite only then the status will be null.

                     <\/td>                    		String or null:   
                    For non group questionnaire:   
                    \u201cNotStarted\u201d \u2013 the participant has not started the questionnaire. 
                    \u201cStarted\u201d the participant has started the questionnaire. 
                    \u201cPartial\u201d \u2013 a partial response has been taken. 
                    \u201cSaved\u201d \u2013 the participant has saved the questionnaire. 
                    \u201cCompleted\u201d \u2013 the participant has completed the questionnaire. 
                    \u201cSubmitted\u201d \u2013 the researcher has submitted a partial response.   
                    For group questionnaire:  
                    \u201cNotStarted\u201d \u2013 the participant has not started any of the questionnaires. 
                    \u201cStarted\u201d – the participant has started at least one of the questionnaires. 
                    \u201cCompleted\u201d \u2013 the participant has completed all of the questionnaires. This includes whether a researcher submitted a partial.<\/td><\/tr>
                    loginSection\/subjects<\/td>The subjects for the participant.   For a group questionnaire there will be one or more. For a non-group questionnaire there will just be one.<\/td>List<\/td><\/tr>
                    loginSection\/subjects\/subjectName<\/td>For a group questionnaire subjectName<\/strong> will not be an empty string.   For a non group questionnaire the subjectName<\/strong> must be an empty string.<\/td>String<\/td><\/tr>
                    loginSection\/subjects\/ questionnaireSeeding<\/td>The questionnaire seeding for the subject.   This is a dictionary of properties in the form \u201c<variable V number>\u201d : \u201c<value>\u201d.<\/td>Object<\/td><\/tr>
                    loginSection\/subjects\/status<\/td>This is the subject status.

                     <\/td>                    		String or null:   
                    \u201cNotStarted\u201d \u2013 the participant has not started the questionnaire.
                    \u201cStarted\u201d the participant has started the questionnaire. 
                    \u201cPartial\u201d \u2013 a partial response has been taken. 
                    \u201cSaved\u201d \u2013 the participant has saved the questionnaire.
                    \u201cCompleted\u201d \u2013 the participant has completed the questionnaire.
                    \u201cSubmitted\u201d \u2013 the researcher has submitted a partial response.  <\/td><\/tr>
                    enabled<\/td>Whether the participant is enabled.<\/td>Boolean<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
                    HTTP Status Codes<\/h4>\n\n\n\n
                    200 OK<\/p>\n\n\n\n
                    404 Not Found with:<\/p>\n\n\n\n
                    {\n    \"message\": \"Participant not found.\"\n}\n<\/code><\/pre>\n\n\n\n
                    400 Bad Request \u2013 various including:<\/p>\n\n\n\n
                    {\n    \"message\": \"Participants require a login section.\"\n}\n\n\"message\": \"You must provide a login name.\"\n\"message\": \"Participants require an invitation section.\"\n\"message\": \"Participants should not have an invitation section.\"\n\"message\": \"Participants should not have a login section.\"\n\"message\": \"The unique participant id provided in the URL must be the same as in the request body.\"\n\"message\": \"Not allowed to add, update or delete an interviewer.\"\n\"message\": \"Must provide an interviewer property and value cannot be null.\"\n\"message\": \"Interviewer does not have access to the survey.\"\n\"message\": Participants for this survey must have one subject.\"\n\"message\": \"Participants for this survey must only have one subject and the subject name must be an empty string.\"\n\"message\": \"Participants for this survey must have at least one subject.\"\n\"message\": \"Subject name cannot be blank for a group questionnaire.\"\n\"message\": \"Participant cannot be opted out and have send invitations enabled at the same time.\"\n\"message\": \"The unique participant id provided in the URL must be the same as in the request body.\"\n\"message\": \"You must provide a valid email address.\"\n\"message\": \"If an email address is provided, it must be valid.\"\n\"message\": \"Participant with this login name does not exist.\"\n\"message\": \"Participant with this login name already exists.\"\n\"message\": \"Participants for this survey must have unique subjects.\"\n\"message\": \"Participant to update does not exist.\"\n\"message\": \"Participant subjects do not match.\"\n\"message\": \"Participant with this email address does not exist.\"\n\"message\": \"Survey does not support participants.\"\n\"message\": \"Participants cannot be added, updated or deleted whilst an import is scheduled or running.\"\n\"message\": \"Participant invite seeding does not have a '<invite item>' seeding property.\"\n\"message\": \"Participant questionnaire seeding does not have a '<questionnaire item>}' seeding property.\"\n\"message\": \"Survey does not have a '<questionnaire item>' variable.\"\n\"message\": \"Survey variable '<questionnaire item>' is single choice. Multiple values are not allowed.\"\n\"message\": \"Survey variable '<questionnaire item>' cannot contain duplicate code values.\"\n\"message\": \"Survey variable '<questionnaire item>' does not contain code value '<code value>'.\"\n<\/code><\/pre>\n\n\n\n
                    Delete Participant<\/h3>\n\n\n\n
                    Delete an existing participant of a survey.<\/p>\n\n\n\n
                    Endpoint<\/h4>\n\n\n\n
                     Method               <\/th> Url <\/th><\/tr><\/thead>
                    DELETE<\/td>https:\/\/snaponline\/api\/surveys\/{surveyId}\/participants\/{participantUniqueId}<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
                    Delete the existing participant identified by the participantUniqueId <\/strong>path variable of the specific survey identified by the surveyId <\/strong>path variable.<\/p>\n\n\n\n
                    Parameters<\/h4>\n\n\n\n
                    Path parameters<\/h5>\n\n\n\n
                     Path parameter <\/th> Description <\/th><\/tr><\/thead>
                    {surveyId}<\/td>The id of the survey. This is the survey GUID and not the Interview URL.<\/td><\/tr>
                    {participantUniqueId}<\/td>This is either the login name if a logged in survey or else the email address.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
                    Query string parameters<\/h5>\n\n\n\n
                    None<\/p>\n\n\n\n
                    Sample Request<\/h4>\n\n\n\n
                    curl --location --request DELETE 'https:\/\/ <servername>\/snaponline\/api\/surveys\/20dbe888-ec99-4895-b094-e34084f9408f\/participants\/E' \\\n--header 'X-USERNAME: {USERNAME}' \\\n--header 'X-API-KEY: {APIKEY}' \\\n--header 'X-VERSION: 3.0'\n<\/code><\/pre>\n\n\n\n
                    (In the above code, replace {APIKEY} with your actual API key and {USERNAME} with your actual username.)<\/p>\n\n\n\n
                    Sample Response<\/h4>\n\n\n\n
                    No response<\/p>\n\n\n\n
                    Response Definitions<\/h4>\n\n\n\n
                    No response definition<\/p>\n\n\n\n
                    HTTP Status Codes<\/h4>\n\n\n\n
                    200 OK<\/p>\n\n\n\n
                    404 Not Found<\/p>\n\n\n\n
                    Get Participant Subjects<\/h3>\n\n\n\n
                    Get the details of the subjects of a participant of a survey.<\/p>\n\n\n\n
                    Endpoint<\/h4>\n\n\n\n
                     Method               <\/th> Url <\/th><\/tr><\/thead>
                    GET<\/td>https:\/\/snaponline\/api\/surveys\/{surveyId}\/participants\/{participantUniqueId}\/subjects<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
                    Get the details of the subjects of the specific participant identified by the participantUniqueId<\/strong> path variable of the specific survey identified by the surveyId<\/strong> path variable.<\/p>\n\n\n\n
                    Parameters<\/h4>\n\n\n\n
                    Path parameters<\/h5>\n\n\n\n
                     Path parameter <\/th> Description <\/th><\/tr><\/thead>
                    {surveyId}<\/td>The id of the survey. This is the survey GUID and not the Interview URL.<\/td><\/tr>
                    {participantUniqueId}<\/td>This is either the login name if a logged in survey or else the email address.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
                    Query string parameters<\/h5>\n\n\n\n
                    None<\/p>\n\n\n\n
                    Sample Request<\/h4>\n\n\n\n
                    curl --location --request GET 'https:\/\/ <servername>\/snaponline\/api\/surveys\/20dbe888-ec99-4895-b094-e34084f9408f\/participants\/A\/subjects' \\\n--header 'X-USERNAME: {USERNAME}' \\\n--header 'X-API-KEY: {APIKEY}' \\\n--header 'X-VERSION: 3.0' \\\n--data-raw ''\n<\/code><\/pre>\n\n\n\n
                    (In the above code, replace {APIKEY} with your actual API key and {USERNAME} with your actual username.)<\/p>\n\n\n\n
                    Sample Response<\/h4>\n\n\n\n
                    [\n    {\n        \"subjectName\": \"L1\",\n        \"questionnaireSeeding\": {\n            \"v53\": \"L1\",\n            \"v48\": \"2;3\",\n            \"v50\": \"A\",\n            \"v51\": \"A\",\n            \"v46\": \"4\"\n        },\n        \"status\": \"NotStarted\"\n    }\n]\n<\/code><\/pre>\n\n\n\n
                    Response Definitions<\/h4>\n\n\n\n
                     Response Item <\/th> Description <\/th> Data Type <\/th><\/tr><\/thead>
                    subjectName<\/td>For a group questionnaire, the subject name will not be an empty string.   For a non-group questionnaire, the subject name will always be an empty string.<\/td>String<\/td><\/tr>
                    questionnaireSeeding<\/td>The questionnaire seeding for the subject. This is a dictionary of properties in the form \u201c<variable V number>\u201d : \u201c<value>\u201d.<\/td>Object<\/td><\/tr>
                    status<\/td>This is the subject status.

                     <\/td>                    		String or null:   
                    \u201cNotStarted\u201d \u2013 the participant has not started the questionnaire. 
                    \u201cStarted\u201d the participant has started the questionnaire.
                    \u201cPartial\u201d \u2013 a partial response has been taken. 
                    \u201cSaved\u201d \u2013 the participant has saved the questionnaire. 
                    \u201cCompleted\u201d \u2013 the participant has completed the questionnaire. 
                    \u201cSubmitted\u201d \u2013 the researcher has submitted a partial response.  <\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
                    HTTP Status Codes<\/h4>\n\n\n\n
                    200 OK<\/p>\n\n\n\n
                    404 Not Found<\/p>\n\n\n\n
                    Get Participant Subject<\/h3>\n\n\n\n
                    Get the details of a subject of a participant of a survey.<\/p>\n\n\n\n
                    Endpoint<\/h4>\n\n\n\n
                     Method               <\/th> Url <\/th><\/tr><\/thead>
                    GET<\/td>https:\/\/snaponline\/api\/surveys\/{surveyId}\/participants\/{participantUniqueId}\/subjects\/{subjectName}<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
                    Get the details of the specific subject identified by the subjectName<\/strong> path variable of the specific participant identified by the participantUniqueId<\/strong> path variable of the specific survey identified by the surveyId<\/strong> path variable.<\/p>\n\n\n\n
                    Parameters<\/h4>\n\n\n\n
                    Path parameters<\/h5>\n\n\n\n
                     Path parameter <\/th> Description <\/th><\/tr><\/thead>
                    {surveyId}<\/td>The id of the survey. This is the survey GUID and not the Interview URL.<\/td><\/tr>
                    {participantUniqueId}<\/td>This is either the login name if a logged in survey or else the email address.<\/td><\/tr>
                    {subjectName}<\/td>The name of the subject.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
                    Query string parameters<\/h5>\n\n\n\n
                    None<\/p>\n\n\n\n
                    Sample Request<\/h4>\n\n\n\n
                    curl --location --request GET 'https:\/\/ <servername>\/snaponline\/api\/surveys\/20dbe888-ec99-4895-b094-e34084f9408f\/participants\/A\/subjects\/L1' \\\n--header 'X-USERNAME: {USERBNAME}' \\\n--header 'X-API-KEY: {APIKEY}' \\\n--header 'X-VERSION: 3.0' \\\n--data-raw ''\n<\/code><\/pre>\n\n\n\n
                    (In the above code, replace {APIKEY} with your actual API key and {USERNAME} with your actual username.)<\/p>\n\n\n\n
                    Sample Response<\/h4>\n\n\n\n
                    {\n    \"subjectName\": \"L1\",\n    \"questionnaireSeeding\": {\n        \"v53\": \"L1\",\n        \"v48\": \"2;3\",\n        \"v50\": \"A\",\n        \"v51\": \"A\",\n        \"v46\": \"4\"\n    },\n    \"status\": \"NotStarted\"\n}\n<\/code><\/pre>\n\n\n\n
                    Response Definitions<\/h4>\n\n\n\n
                     Response Item <\/th> Description <\/th> Data Type <\/th><\/tr><\/thead>
                    subjectName<\/td>For a group questionnaire, the  subject name will not be an empty string.   For a non-group questionnaire, the subject name will always be an empty string.<\/td>String<\/td><\/tr>
                    questionnaireSeeding<\/td>The questionnaire seeding for the subject. This is a dictionary of properties in the form \u201c<variable V number>\u201d : \u201c<value>\u201d.<\/td>Object<\/td><\/tr>
                    status<\/td>This is the subject status.

                     <\/td>                    		String or null:   
                    \u201cNotStarted\u201d \u2013 the participant has not started the questionnaire. 
                    \u201cStarted\u201d the participant has started the questionnaire.
                    \u201cPartial\u201d \u2013 a partial response has been taken. 
                    \u201cSaved\u201d \u2013 the participant has saved the questionnaire. 
                    \u201cCompleted\u201d \u2013 the participant has completed the questionnaire. 
                    \u201cSubmitted\u201d \u2013 the researcher has submitted a partial response.  <\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
                    HTTP Status Codes<\/h4>\n\n\n\n
                    200 OK<\/p>\n\n\n\n
                    404 Not Found<\/p>\n\n\n\n
                    Add Participant Subject<\/h3>\n\n\n\n
                    Add a new subject to a participant of a survey.<\/p>\n\n\n\n
                    Endpoint<\/h4>\n\n\n\n
                     Method               <\/th> Url <\/th><\/tr><\/thead>
                    POST<\/td>https:\/\/snaponline\/api\/surveys\/{surveyId}\/participants\/{participantUniqueId}\/subjects<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
                    Add the new subject of the specific participant identified by the participantUniqueId<\/strong> path variable of the specific survey identified by the surveyId<\/strong> path variable.<\/p>\n\n\n\n
                    Parameters<\/h4>\n\n\n\n
                    Path parameters<\/h5>\n\n\n\n
                     Path parameter <\/th> Description <\/th><\/tr><\/thead>
                    {surveyId}<\/td>The id of the survey. This is the survey GUID and not the Interview URL.<\/td><\/tr>
                    {participantUniqueId}<\/td>This is either the login name if a logged in survey or else the email address.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
                    Query string parameters<\/h5>\n\n\n\n
                    None<\/p>\n\n\n\n
                    Request body data<\/h4>\n\n\n\n
                    Requires request body of JSON object e.g.:<\/p>\n\n\n\n
                    {\n    \"subjectName\": \"Chester Zoo2\",\n    \"questionnaireSeeding\": {\n        \"v46\": \"D\",\n        \"v45\": \"David\"\n    },\n    \"status\": \"NotStarted\"\n}\n<\/code><\/pre>\n\n\n\n
                    Note. For a group questionnaire the subjectName <\/strong>must be a non-empty string. It is not possible to add a subject to a non-group questionnaire as there is only one subject with a subjectName <\/strong>of empty string. In the example above we are setting two of the seeding values for the subject. The status <\/strong>property is ignored if included. This means that you can take the output of a get subject call, modify the seeding and pass it in the add subject call without having to remove the status <\/strong>property.<\/p>\n\n\n\n
                    Sample Request<\/h4>\n\n\n\n
                    curl --location --request POST 'https:\/\/ <servername>\/snaponline\/api\/surveys\/20dbe888-ec99-4895-b094-e34084f9408f\/participants\/A\/subjects' \\\n--header 'X-USERNAME: {USERNAME}' \\\n--header 'X-API-KEY: {APIKEY}' \\\n--header 'X-VERSION: 3.0' \\\n--header 'Content-Type: application\/json' \\\n--data-raw '{\n    \"subjectName\": \"L5\",\n    \"questionnaireSeeding\": {\n        \"v53\": \"L5\",\n        \"v48\": \"2;3\",\n        \"v50\": \"A\",\n        \"v51\": \"A\",\n        \"v46\": \"4\"\n    },\n    \"status\": \"NotStarted\"\n}'\n<\/code><\/pre>\n\n\n\n
                    (In the above code, replace {APIKEY} with your actual API key and {USERNAME} with your actual username.)<\/p>\n\n\n\n
                    Sample Response<\/h4>\n\n\n\n
                    {\n    \"subjectName\": \"L5\",\n    \"questionnaireSeeding\": {\n        \"v48\": \"2;3\",\n        \"v50\": \"A\",\n        \"v53\": \"L5\",\n        \"v51\": \"A\",\n        \"v46\": \"4\"\n    },\n    \"status\": \"NotStarted\"\n}\n<\/code><\/pre>\n\n\n\n
                    Response Definitions<\/h2>\n\n\n\n
                     Response Item <\/th> Description <\/th> Data Type <\/th><\/tr><\/thead>
                    subjectName<\/td>For a group questionnaire subject name will not be an empty string.   For a non-group questionnaire, the subject name must be an empty string.<\/td>String<\/td><\/tr>
                    questionnaireSeeding<\/td>The questionnaire seeding for the subject. This is a dictionary of properties in the form \u201c<variable V number>\u201d : \u201c<value>\u201d.<\/td>Object<\/td><\/tr>
                    status<\/td>This is the subject status.

                     <\/td>                    		String or null:   
                    \u201cNotStarted\u201d \u2013 the participant has not started the questionnaire. 
                    \u201cStarted\u201d the participant has started the questionnaire.
                    \u201cPartial\u201d \u2013 a partial response has been taken. 
                    \u201cSaved\u201d \u2013 the participant has saved the questionnaire. 
                    \u201cCompleted\u201d \u2013 the participant has completed the questionnaire. 
                    \u201cSubmitted\u201d \u2013 the researcher has submitted a partial response.  <\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
                    HTTP Status Codes<\/h4>\n\n\n\n
                    200 OK<\/p>\n\n\n\n
                    404 Not Found with:<\/p>\n\n\n\n
                    {\n    \"message\": \"Participant not found.\"\n}\n<\/code><\/pre>\n\n\n\n
                    400 Bad Request with:<\/p>\n\n\n\n
                    {\n    \"message\": \"Must provide a subject.\"\n}\n\n\"message\": \"Survey is not a group questionnaire. Cannot add subjects.\"\n\"message\": \"Participant questionnaire seeding does not have a '<questionnaire seeding>' seeding property.\"\n\"message\": \"Participant already has that subject.\"\n\"message\": \"Could not add subject.\"\n\"message\": \"Participant invite seeding does not have a '<invite key>' seeding property.\"\n\"message\": \"Survey variable '<questionnaire item>' does not contain code value '<code value>'.\"\n\"message\": \"Participant questionnaire seeding does not have a '<questionnaire item>' seeding property.\"\n\"message\": \"Survey does not have a '<questionnaire item>' variable.\"\n\"message\": \"Survey variable '<questionnaire item>' is single choice. Multiple values are not allowed.\"\n\"message\": \"Survey variable '<questionnaire item>' cannot contain duplicate code values.\"\n<\/code><\/pre>\n\n\n\n
                    Update Participant Subject<\/h3>\n\n\n\n
                    Update an existing subject of a participant of a survey.<\/p>\n\n\n\n
                    Endpoint<\/h4>\n\n\n\n
                     Method               <\/th> Url <\/th><\/tr><\/thead>
                    PUT<\/td>https:\/\/snaponline\/api\/surveys\/{surveyId}\/participants\/{participantUniqueId}\/subjects\/{subjectName}<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
                    Update the existing specific subject identified by the subjectName<\/strong> path variable of the specific participant identified by the participantUniqueId<\/strong> path variable of the specific survey identified by the surveyId<\/strong> path variable.<\/p>\n\n\n\n
                    Parameters<\/h4>\n\n\n\n
                    Path parameters<\/h5>\n\n\n\n
                     Path parameter <\/th> Description <\/th><\/tr><\/thead>
                    {surveyId}<\/td>The id of the survey. This is the survey GUID and not the Interview URL.<\/td><\/tr>
                    {participantUniqueId}<\/td>This is either the login name if a logged in survey or else the email address.<\/td><\/tr>
                    {subjectName}<\/td>The name of the subject.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
                    Query string parameters<\/h5>\n\n\n\n
                    None.<\/p>\n\n\n\n
                    Request body data<\/h4>\n\n\n\n
                    Requires request body of JSON object e.g.:<\/p>\n\n\n\n
                    {\n    \"subjectName\": \"Chester Zoo2\",\n    \"questionnaireSeeding\": {\n        \"v46\": \"D\",\n        \"v45\": \"David\"\n    },\n    \"status\": \"NotStarted\"\n}\n<\/code><\/pre>\n\n\n\n
                    Note. The subjectName <\/strong>property must be the same as the subjectName <\/strong>path variable. It is not possible to rename a subject with this call. In the case of a non-group questionnaire the subjectName <\/strong>path variable should be null.<\/p>\n\n\n\n
                    In the example above we are changing two of the seeding values for the subject. The status <\/strong>property is ignored if included. This means that you can take the output of a get subject call, modify the seeding and pass it in the add subject call without having to remove the status <\/strong>property.<\/p>\n\n\n\n
                    Sample Request<\/h4>\n\n\n\n
                    curl --location --request PUT 'https:\/\/ <servername>\/snaponline\/api\/surveys\/20dbe888-ec99-4895-b094-e34084f9408f\/participants\/A\/subjects\/L5' \\\n--header 'X-USERNAME: {USERNAME}' \\\n--header 'X-API-KEY: {APIKEY}' \\\n--header 'X-VERSION: 3.0' \\\n--header 'Content-Type: application\/json' \\\n--data-raw '{\n    \"subjectName\": \"L5\",\n    \"questionnaireSeeding\": {\n        \"v48\": \"2;3\",\n        \"v50\": \"A\",\n        \"v53\": \"L5\",\n        \"v51\": \"A\",\n        \"v46\": \"6\"\n    },\n    \"status\": \"NotStarted\"\n}'\n<\/code><\/pre>\n\n\n\n
                    (In the above code, replace {APIKEY} with your actual API key and {USERNAME} with your actual username.)<\/p>\n\n\n\n
                    Sample Response<\/h4>\n\n\n\n
                    {\n    \"subjectName\": \"L5\",\n    \"questionnaireSeeding\": {\n        \"v48\": \"2;3\",\n        \"v50\": \"A\",\n        \"v53\": \"L5\",\n        \"v51\": \"A\",\n        \"v46\": \"6\"\n    },\n    \"status\": \"NotStarted\"\n}\n<\/code><\/pre>\n\n\n\n
                    Response Definitions<\/h2>\n\n\n\n
                     Response Item <\/th> Description <\/th> Data Type <\/th><\/tr><\/thead>
                    subjectName<\/td>For a group questionnaire subject name will not be an empty string.   For a non-group questionnaire, the subject name must be an empty string.<\/td>String<\/td><\/tr>
                    questionnaireSeeding<\/td>The questionnaire seeding for the subject. This is a dictionary of properties in the form \u201c<variable V number>\u201d : \u201c<value>\u201d.<\/td>Object<\/td><\/tr>
                    status<\/td>This is the subject status.

                     <\/td>                    		String or null:   
                    \u201cNotStarted\u201d \u2013 the participant has not started the questionnaire. 
                    \u201cStarted\u201d the participant has started the questionnaire.
                    \u201cPartial\u201d \u2013 a partial response has been taken. 
                    \u201cSaved\u201d \u2013 the participant has saved the questionnaire. 
                    \u201cCompleted\u201d \u2013 the participant has completed the questionnaire. 
                    \u201cSubmitted\u201d \u2013 the researcher has submitted a partial response.  <\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
                    HTTP Status Codes<\/h4>\n\n\n\n
                    200 OK<\/p>\n\n\n\n
                    404 Not Found with:<\/p>\n\n\n\n
                    {\n    \"message\": \"Participant not found.\"\n}\n<\/code><\/pre>\n\n\n\n
                    400 Bad Request with:<\/p>\n\n\n\n
                    {\n    \"message\": \"Subject name must match subject details.\"\n}\n\n\"message\": \"Survey is not a group questionnaire. Cannot add subjects.\"\n\"message\": \"Participant does not have this subject.\"\n\"message\": \"Could not update subject.\"\n\"message\": \"Participant invite seeding does not have a '<invite key>' seeding property.\"\n\"message\": \"Survey variable '<questionnaire item>' does not contain code value '<code value>'.\"\n\"message\": \"Participant questionnaire seeding does not have a '<questionnaire item>' seeding property.\"\n\"message\": \"Survey does not have a '<questionnaire item>' variable.\"\n\"message\": \"Survey variable '<questionnaire item>' is single choice. Multiple values are not allowed.\"\n\"message\": \"Survey variable '<questionnaire item>' cannot contain duplicate code values.\"\n<\/code><\/pre>\n\n\n\n
                    Delete Participant Subject<\/h3>\n\n\n\n
                    Delete a subject from a participant of a survey.<\/p>\n\n\n\n
                    Endpoint<\/h4>\n\n\n\n
                     Method <\/th> Url <\/th><\/tr><\/thead>
                    DELETE<\/td>https:\/\/snaponline\/api\/surveys\/{surveyId}\/participants\/{participantUniqueId}\/subjects\/{subjectName}<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
                    Delete the specific subject identified by the subjectName<\/strong> path variable from the specific participant identified by the participantUniqueId<\/strong> path variable of the specific survey identified by the surveyId<\/strong> path variable.<\/p>\n\n\n\n
                    Note: You cannot delete the subject of a non-group questionnaire. On a group questionnaire you cannot delete a subject if there would be no subjects remaining.<\/p>\n\n\n\n
                    Parameters<\/h4>\n\n\n\n
                    Path parameters<\/h5>\n\n\n\n
                     Path parameter <\/th> Description <\/th><\/tr><\/thead>
                    {surveyId}<\/td>The id of the survey. This is the survey GUID and not the Interview URL.<\/td><\/tr>
                    {participantUniqueId}<\/td>This is either the login name if a logged in survey or else the email address.<\/td><\/tr>
                    {subjectName}<\/td>The name of the subject.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
                    Query string parameters<\/h5>\n\n\n\n
                    None<\/p>\n\n\n\n
                    Sample Request<\/h4>\n\n\n\n
                    curl --location --request DELETE 'https:\/\/ <servername>\/snaponline\/api\/surveys\/20dbe888-ec99-4895-b094-e34084f9408f\/participants\/A\/subjects\/L5' \\\n--header 'X-USERNAME: {USERNAME}' \\\n--header 'X-API-KEY: {APIKEY}' \\\n--header 'X-VERSION: 3.0' \\\n--data-raw ''\n<\/code><\/pre>\n\n\n\n
                    (In the above code, replace {APIKEY} with your actual API key and {USERNAME} with your actual username.)<\/p>\n\n\n\n
                    Sample Response<\/h4>\n\n\n\n
                    No response<\/p>\n\n\n\n
                    Response Definitions<\/h4>\n\n\n\n
                    No  response definition<\/p>\n\n\n\n
                    HTTP Status Codes<\/h2>\n\n\n\n
                    200 OK<\/p>\n\n\n\n
                    400 Bad Request<\/p>\n\n\n\n
                      \n
                    • If trying to delete a subject from non-group questionnaire.<\/li>\n\n\n\n
                    • If trying to delete last remaining subject from a group questionnaire.<\/li>\n<\/ul>\n\n\n\n
                      404 Not Found<\/p>\n\n\n\n
                      Bulk Participant Import<\/h3>\n\n\n\n
                      Add multiple participants to a survey with each request. The number allowed is a system setting managed by the System administrator. Our subscription servers current limit is 100 participants which may change over time. Please see the \u201cHTTP Status code of overall call\u201d section below for more information<\/p>\n\n\n\n
                      Endpoint<\/h4>\n\n\n\n
                       Method               <\/th> Url <\/th><\/tr><\/thead>
                      POST<\/td>https:\/\/snaponline\/api\/surveys\/{surveyId}\/participants\/bulkimport<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
                      Add new participants to the specific survey identified by the surveyId<\/strong> path variable.<\/p>\n\n\n\n
                      Parameters<\/h4>\n\n\n\n
                      Path parameters<\/h5>\n\n\n\n
                       Path parameter <\/th> Description <\/th><\/tr><\/thead>
                      {surveyId}<\/td>The id of the survey. This is the survey GUID and not the Interview URL.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
                      Query string parameters<\/h5>\n\n\n\n
                      None<\/p>\n\n\n\n
                      Request body data<\/h4>\n\n\n\n
                      Requires request body of JSON objects e.g.:<\/p>\n\n\n\n
                      [\n    {\n        \"invitationSection\": {\n            \"optedOut\": false,\n            \"sendInvitations\": true,\n            \"emailAddress\": \"a@example.com\",\n            \"invitationSeeding\": {\n                \"forenames\": \"A\",\n                \"surname\": \"A\"\n            }\n        },\n        \"loginSection\": {\n            \"login\": \"A\",\n            \"password\": null,\n            \"interviewer\": null,\n            \"status\": \"NotStarted\",\n            \"subjects\": [\n                {\n                    \"subjectName\": \"L1\",\n                    \"questionnaireSeeding\": {\n                        \"v53\": \"L1\",\n                        \"v48\": \"2;3\",\n                        \"v50\": \"A\",\n                        \"v51\": \"A\",\n                        \"v46\": \"4\"\n                    },\n                    \"status\": \"NotStarted\"\n                }\n            ]\n        },\n        \"enabled\": true\n    },\n    {\n        \"invitationSection\": {\n            \"optedOut\": false,\n            \"sendInvitations\": true,\n            \"emailAddress\": \"b@example.com\",\n            \"invitationSeeding\": {\n                \"forenames\": \"B\",\n                \"surname\": \"B\"\n            }\n        },\n        \"loginSection\": {\n            \"login\": \"B\",\n            \"password\": null,\n            \"interviewer\": null,\n            \"status\": \"NotStarted\",\n            \"subjects\": [\n                {\n                    \"subjectName\": \"L1\",\n                    \"questionnaireSeeding\": {\n                        \"v53\": \"L1\",\n                        \"v48\": \"2;3\",\n                        \"v50\": \"B\",\n                        \"v51\": \"B\",\n                        \"v46\": \"4\"\n                    },\n                    \"status\": \"NotStarted\"\n                }\n            ]\n        },\n        \"enabled\": true\n    }\n]\n\n<\/code><\/pre>\n\n\n\n
                      Note. The above example is creating participants in a survey where the participant feature requires that the participant be invited and that the participant has to provide credentials to view the questionnaire. Therefore, you must specify both the invitationSection<\/strong> section and the loginSection<\/strong> section in the call. The example is also for a group questionnaire and it will create one subject for the participant. In a non-group questionnaire, you must provide one subject and the subjectName<\/strong> property should be an empty string.<\/p>\n\n\n\n
                      For an invite only survey do not include a loginSection<\/strong> section. For a logged on only survey do not include an invitationSection<\/strong> section.<\/p>\n\n\n\n
                      The status<\/strong> properties are read-only so will be ignored if specified.<\/p>\n\n\n\n
                      If the survey allows interviewers for SOI then you specify the interviewer in the interviewer<\/strong> property. The interviewer must be the email address of a user that has SOI access to the survey. If you don\u2019t want to specify an interviewer set it to an empty string. If the survey does not allow interviewers set it to null.<\/p>\n\n\n\n
                      Sample Request<\/h4>\n\n\n\n
                      curl --location 'https:\/\/<servername>\/snaponline\/api\/surveys\/0048ed9b-38b6-45ce-9d0c-106dd4929aac\/participants\/bulkimport' \\\n--header 'X-USERNAME: {USERNAME}' \\\n--header 'X-API-KEY: {APIKEY}' \\\n--header 'X-VERSION: 3.0' \\\n--header 'Content-Type: application\/json' \\\n--data-raw '[\n    {\n        \"invitationSection\": {\n            \"optedOut\": false,\n            \"sendInvitations\": true,\n            \"emailAddress\": \"a@example.com\",\n            \"invitationSeeding\": {\n                \"forenames\": \"A\",\n                \"surname\": \"A\"\n            }\n        },\n        \"loginSection\": {\n            \"login\": \"A\",\n            \"password\": null,\n            \"interviewer\": null,\n            \"status\": \"NotStarted\",\n            \"subjects\": [\n                {\n                    \"subjectName\": \"L1\",\n                    \"questionnaireSeeding\": {\n                        \"v53\": \"L1\",\n                        \"v48\": \"2;3\",\n                        \"v50\": \"A\",\n                        \"v51\": \"A\",\n                        \"v46\": \"4\"\n                    },\n                    \"status\": \"NotStarted\"\n                }\n            ]\n        },\n        \"enabled\": true\n    },\n    {\n        \"invitationSection\": {\n            \"optedOut\": false,\n            \"sendInvitations\": true,\n            \"emailAddress\": \"b@example.com\",\n            \"invitationSeeding\": {\n                \"forenames\": \"B\",\n                \"surname\": \"B\"\n            }\n        },\n        \"loginSection\": {\n            \"login\": \"B\",\n            \"password\": null,\n            \"interviewer\": null,\n            \"status\": \"NotStarted\",\n            \"subjects\": [\n                {\n                    \"subjectName\": \"L1\",\n                    \"questionnaireSeeding\": {\n                        \"v53\": \"L1\",\n                        \"v48\": \"2;3\",\n                        \"v50\": \"B\",\n                        \"v51\": \"B\",\n                        \"v46\": \"4\"\n                    },\n                    \"status\": \"NotStarted\"\n                }\n            ]\n        },\n        \"enabled\": true\n    }\n]'\n<\/code><\/pre>\n\n\n\n
                      (In the above code, replace {APIKEY} with your actual API key and {USERNAME} with your actual username.)<\/p>\n\n\n\n
                      Note. The status <\/strong>field is read-only. If you send it into the request body as in the sample request above it will be ignored.<\/p>\n\n\n\n
                      Sample Response<\/h4>\n\n\n\n
                      [\n    {\n        \"participantUniqueId\": \"A\",\n        \"id\": \"\",\n        \"status\": 400,\n        \"message\": \"Another participant already has this login name.\"\n    },\n    {\n        \"participantUniqueId\": \"B\",\n        \"id\": \"6f70015a-7a58-4a66-b8ab-51a785b87599\",\n        \"status\": 200,\n        \"message\": \"\"\n    }\n]\n<\/code><\/pre>\n\n\n\n
                      Response Definitions<\/h4>\n\n\n\n
                       Response Item <\/th> Description <\/th> Data Type <\/th><\/tr><\/thead>
                      participantUniqueId<\/td>The unique id of the participant.<\/td>String<\/td><\/tr>
                      id<\/td>The participant id.<\/td>String: containing GUID<\/td><\/tr>
                      status<\/td>The HTTP Status code for this attempted participant add. 200 for a successful add.<\/td>Number<\/td><\/tr>
                      message<\/td>If the add was successful then the property will be “” otherwise the description of why the participant could not be added. Similar possibilities to the add participant endpoint.<\/td>String<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
                      HTTP Status Code of overall call<\/h4>\n\n\n\n
                      200 <\/p>\n\n\n\n
                      General checks have passed and the response lists the result of each separate participant add.<\/p>\n\n\n\n
                      400 Bad Request:<\/p>\n\n\n\n
                      {\n    \"message\": \"Maximum number of participants in bulk import cannot exceed: 100.\"\n}<\/code><\/pre>\n\n\n\n
                      Note. The value is a system property. It can be changed and may not be 100.<\/p>\n","protected":false},"excerpt":{"rendered":"
                      This document covers the most recent version 3.0 of the API in build 1.0.0.1381. Please note that from Monday 5th December 2022 usage of the API became chargeable. The charge is that 0.1 unit will be consumed each time a survey response is delivered by the API.  This applies if the same survey response is […]<\/p>\n","protected":false},"author":16,"featured_media":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_acf_changed":false,"inline_featured_image":false,"footnotes":""},"epkb_post_type_1_category":[111],"epkb_post_type_1_tag":[],"class_list":["post-14752","epkb_post_type_1","type-epkb_post_type_1","status-publish","hentry","epkb_post_type_1_category-snap-online-developer-api"],"acf":[],"yoast_head":"\nAPI Reference | SnapSurveys<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.snapsurveys.com\/support-snapxmp\/snapxmp\/snap-xmp-developer-api-api-reference\/\" \/>\n<meta property=\"og:locale\" content=\"en_GB\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"API Reference | SnapSurveys\" \/>\n<meta property=\"og:description\" content=\"This document covers the most recent version 3.0 of the API in build 1.0.0.1381. Please note that from Monday 5th December 2022 usage of the API became chargeable. The charge is that 0.1 unit will be consumed each time a survey response is delivered by the API.  This applies if the same survey response is […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.snapsurveys.com\/support-snapxmp\/snapxmp\/snap-xmp-developer-api-api-reference\/\" \/>\n<meta property=\"og:site_name\" content=\"SnapSurveys\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/snapsurveys\" \/>\n<meta property=\"article:modified_time\" content=\"2025-12-01T11:56:43+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:site\" content=\"@snapsurveys\" \/>\n<meta name=\"twitter:label1\" content=\"Estimated reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"34 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.snapsurveys.com\/support-snapxmp\/snapxmp\/snap-xmp-developer-api-api-reference\/\",\"url\":\"https:\/\/www.snapsurveys.com\/support-snapxmp\/snapxmp\/snap-xmp-developer-api-api-reference\/\",\"name\":\"API Reference | SnapSurveys\",\"isPartOf\":{\"@id\":\"https:\/\/www.snapsurveys.com\/support-snapxmp\/#website\"},\"datePublished\":\"2025-12-01T11:18:29+00:00\",\"dateModified\":\"2025-12-01T11:56:43+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/www.snapsurveys.com\/support-snapxmp\/snapxmp\/snap-xmp-developer-api-api-reference\/#breadcrumb\"},\"inLanguage\":\"en-GB\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.snapsurveys.com\/support-snapxmp\/snapxmp\/snap-xmp-developer-api-api-reference\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.snapsurveys.com\/support-snapxmp\/snapxmp\/snap-xmp-developer-api-api-reference\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/www.snapsurveys.com\/support-snapxmp\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Snap XMP Support\",\"item\":\"https:\/\/www.snapsurveys.com\/support-snapxmp\/snapxmp-archive\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"API Reference\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.snapsurveys.com\/support-snapxmp\/#website\",\"url\":\"https:\/\/www.snapsurveys.com\/support-snapxmp\/\",\"name\":\"Snap XMP Support Hub\",\"description\":\"Support documentation for Snap Surveys products\",\"publisher\":{\"@id\":\"https:\/\/www.snapsurveys.com\/support-snapxmp\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/www.snapsurveys.com\/support-snapxmp\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-GB\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/www.snapsurveys.com\/support-snapxmp\/#organization\",\"name\":\"Snap Surveys\",\"url\":\"https:\/\/www.snapsurveys.com\/support-snapxmp\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-GB\",\"@id\":\"https:\/\/www.snapsurveys.com\/support-snapxmp\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/www.snapsurveys.com\/support-snapxmp\/wp-content\/uploads\/2020\/06\/snap-surveys-logo-fc.svg\",\"contentUrl\":\"https:\/\/www.snapsurveys.com\/support-snapxmp\/wp-content\/uploads\/2020\/06\/snap-surveys-logo-fc.svg\",\"width\":867,\"height\":159,\"caption\":\"Snap Surveys\"},\"image\":{\"@id\":\"https:\/\/www.snapsurveys.com\/support-snapxmp\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/www.facebook.com\/snapsurveys\",\"https:\/\/x.com\/snapsurveys\",\"https:\/\/www.linkedin.com\/company\/snapsurveys\"]}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"API Reference | SnapSurveys","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.snapsurveys.com\/support-snapxmp\/snapxmp\/snap-xmp-developer-api-api-reference\/","og_locale":"en_GB","og_type":"article","og_title":"API Reference | SnapSurveys","og_description":"This document covers the most recent version 3.0 of the API in build 1.0.0.1381. Please note that from Monday 5th December 2022 usage of the API became chargeable. The charge is that 0.1 unit will be consumed each time a survey response is delivered by the API.  This applies if the same survey response is […]","og_url":"https:\/\/www.snapsurveys.com\/support-snapxmp\/snapxmp\/snap-xmp-developer-api-api-reference\/","og_site_name":"SnapSurveys","article_publisher":"https:\/\/www.facebook.com\/snapsurveys","article_modified_time":"2025-12-01T11:56:43+00:00","twitter_card":"summary_large_image","twitter_site":"@snapsurveys","twitter_misc":{"Estimated reading time":"34 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/www.snapsurveys.com\/support-snapxmp\/snapxmp\/snap-xmp-developer-api-api-reference\/","url":"https:\/\/www.snapsurveys.com\/support-snapxmp\/snapxmp\/snap-xmp-developer-api-api-reference\/","name":"API Reference | SnapSurveys","isPartOf":{"@id":"https:\/\/www.snapsurveys.com\/support-snapxmp\/#website"},"datePublished":"2025-12-01T11:18:29+00:00","dateModified":"2025-12-01T11:56:43+00:00","breadcrumb":{"@id":"https:\/\/www.snapsurveys.com\/support-snapxmp\/snapxmp\/snap-xmp-developer-api-api-reference\/#breadcrumb"},"inLanguage":"en-GB","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.snapsurveys.com\/support-snapxmp\/snapxmp\/snap-xmp-developer-api-api-reference\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.snapsurveys.com\/support-snapxmp\/snapxmp\/snap-xmp-developer-api-api-reference\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.snapsurveys.com\/support-snapxmp\/"},{"@type":"ListItem","position":2,"name":"Snap XMP Support","item":"https:\/\/www.snapsurveys.com\/support-snapxmp\/snapxmp-archive\/"},{"@type":"ListItem","position":3,"name":"API Reference"}]},{"@type":"WebSite","@id":"https:\/\/www.snapsurveys.com\/support-snapxmp\/#website","url":"https:\/\/www.snapsurveys.com\/support-snapxmp\/","name":"Snap XMP Support Hub","description":"Support documentation for Snap Surveys products","publisher":{"@id":"https:\/\/www.snapsurveys.com\/support-snapxmp\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.snapsurveys.com\/support-snapxmp\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-GB"},{"@type":"Organization","@id":"https:\/\/www.snapsurveys.com\/support-snapxmp\/#organization","name":"Snap Surveys","url":"https:\/\/www.snapsurveys.com\/support-snapxmp\/","logo":{"@type":"ImageObject","inLanguage":"en-GB","@id":"https:\/\/www.snapsurveys.com\/support-snapxmp\/#\/schema\/logo\/image\/","url":"https:\/\/www.snapsurveys.com\/support-snapxmp\/wp-content\/uploads\/2020\/06\/snap-surveys-logo-fc.svg","contentUrl":"https:\/\/www.snapsurveys.com\/support-snapxmp\/wp-content\/uploads\/2020\/06\/snap-surveys-logo-fc.svg","width":867,"height":159,"caption":"Snap Surveys"},"image":{"@id":"https:\/\/www.snapsurveys.com\/support-snapxmp\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/snapsurveys","https:\/\/x.com\/snapsurveys","https:\/\/www.linkedin.com\/company\/snapsurveys"]}]}},"_links":{"self":[{"href":"https:\/\/www.snapsurveys.com\/support-snapxmp\/wp-json\/wp\/v2\/epkb_post_type_1\/14752","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.snapsurveys.com\/support-snapxmp\/wp-json\/wp\/v2\/epkb_post_type_1"}],"about":[{"href":"https:\/\/www.snapsurveys.com\/support-snapxmp\/wp-json\/wp\/v2\/types\/epkb_post_type_1"}],"author":[{"embeddable":true,"href":"https:\/\/www.snapsurveys.com\/support-snapxmp\/wp-json\/wp\/v2\/users\/16"}],"replies":[{"embeddable":true,"href":"https:\/\/www.snapsurveys.com\/support-snapxmp\/wp-json\/wp\/v2\/comments?post=14752"}],"version-history":[{"count":87,"href":"https:\/\/www.snapsurveys.com\/support-snapxmp\/wp-json\/wp\/v2\/epkb_post_type_1\/14752\/revisions"}],"predecessor-version":[{"id":15113,"href":"https:\/\/www.snapsurveys.com\/support-snapxmp\/wp-json\/wp\/v2\/epkb_post_type_1\/14752\/revisions\/15113"}],"wp:attachment":[{"href":"https:\/\/www.snapsurveys.com\/support-snapxmp\/wp-json\/wp\/v2\/media?parent=14752"}],"wp:term":[{"taxonomy":"epkb_post_type_1_category","embeddable":true,"href":"https:\/\/www.snapsurveys.com\/support-snapxmp\/wp-json\/wp\/v2\/epkb_post_type_1_category?post=14752"},{"taxonomy":"epkb_post_type_1_tag","embeddable":true,"href":"https:\/\/www.snapsurveys.com\/support-snapxmp\/wp-json\/wp\/v2\/epkb_post_type_1_tag?post=14752"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}