Response Structure - Rep Data Documentation

All endpoints return JSON. POST and PUT requests must send Content-Type: application/json.

Success Responses

Successful responses are wrapped in a standard envelope. A Status of 0 indicates success, and Data contains the endpoint-specific payload — either an object or an array of objects.

{
    "Status": 0,
    "Message": "Success",
    "Data": { }
}

Field	Description
`Status`	`0` indicates success.
`Message`	Human-readable status message (e.g. `"Success"`).
`Data`	The endpoint-specific payload — an object or an array of objects.

Payload Shapes

Object
Array

Single-resource endpoints return an object in Data — for example, Get Survey or Create Links.

{
  "Status": 0,
  "Message": "Success",
  "Data": {
    "LiveLinkUD": "d026d369-b370-4ffa-8177-c75cf46026f7",
    "LiveLinkURL": "https://www-staging.researchdesk.com/landing2?fttsn=d026d369-b370-4ffa-8177-c75cf46026f7&rid=[%RID%]"
  }
}

List endpoints return an array in Data — for example, List Surveys & Streams or Get Stream Quotas.

{
  "Status": 0,
  "Message": "Success",
  "Data": [
    { "SurveyName": "US Gen Pop Survey - Short", "SurveyNumber": 2634, "SurveyStatus": "Live" }
  ]
}

The supplier-facing disposition of a respondent is communicated separately via the isc status code appended to your redirect links — not in this API envelope. See Respondent Status Codes.