Get metadata response

meta objectrequired

httpStatusHttp status code (string)required

HTTP status code.

requestIdrequestId (string)required

The unique identifier of the associated request.

noticeAn informational string about the request. (string)

Additional information about this response.

result objectrequired

SurveyIDSurvey Id (string)required

The unique identifier for this survey.

Possible values: Value must match regular expression ^SV_[a-zA-Z0-9]{11,15}$

SurveyNamestringrequired

The name of the survey.

SurveyDescriptionstringnullablerequired

The description of the survey.

SurveyOwnerIDUser Id (string)required

The unique identifier for a specific user.

Possible values: Value must match regular expression ^UR_[a-zA-Z0-9]{11,15}$

SurveyBrandIDstringrequired

The brand ID associated with the survey.

DivisionIDstringnullablerequired

SurveyLanguagestringrequired

The default language of the survey.

SurveyActiveResponseSetResponse Set Id (string)required

A unique identifier for the response set.

Possible values: Value must match regular expression ^RS_[a-zA-Z0-9]{11,15}$

SurveyStatusSurvey status (string)required

The distribution status of the survey, or a flag indicating that it's a library block

Possible values: [Inactive, Active, Pending, LibBlock, Deactive, Temporary]

SurveyStartDatestring<date-time>nullablerequired

The date and time the survey starts.

SurveyExpirationDatestring<date-time>nullablerequired

The date and time the survey ex

SurveyCreationDatestring<date-time>nullablerequired

The date and time the survey was created.

CreatorIDUser Id (string)required

The unique identifier for a specific user.

Possible values: Value must match regular expression ^UR_[a-zA-Z0-9]{11,15}$

LastModifiedstring<date-time>required

The date and time of the last survey modification.

LastAccessedstring<date-time>nullablerequired

The date and time the survey was last accessed.

LastActivatedstring<date-time>nullablerequired

Deletedstring<date-time>nullablerequired

Get metadata response

{
  "meta": {
    "httpStatus": "string",
    "requestId": "string",
    "notice": "string"
  },
  "result": {
    "SurveyID": "string",
    "SurveyName": "string",
    "SurveyDescription": "string",
    "SurveyOwnerID": "string",
    "SurveyBrandID": "string",
    "DivisionID": "string",
    "SurveyLanguage": "string",
    "SurveyActiveResponseSet": "string",
    "SurveyStatus": "Inactive",
    "SurveyStartDate": "2024-07-29T15:51:28.071Z",
    "SurveyExpirationDate": "2024-07-29T15:51:28.071Z",
    "SurveyCreationDate": "2024-07-29T15:51:28.071Z",
    "CreatorID": "string",
    "LastModified": "2024-07-29T15:51:28.071Z",
    "LastAccessed": "2024-07-29T15:51:28.071Z",
    "LastActivated": "2024-07-29T15:51:28.071Z",
    "Deleted": "2024-07-29T15:51:28.071Z"
  }
}