Skip to content

Answer specific survey

POST
/v1/Survey/Recipients/{id}/Respond
curl --request POST \
  --url https://rms.dev.caspeco.net/api/booking/v1/Survey/Recipients/example/Respond \
  --header 'Content-Type: application/json' \
  --data '{ "title": "example", "description": "example", "pages": [ { "title": "example", "description": "example", "sections": [ { "title": "example", "description": "example", "questions": [ { "id": 1, "ref": "example", "title": "example", "description": "example", "required": true, "questionType": 0, "questionScale": { "min": 1, "max": 1, "minLabel": "example", "maxLabel": "example", "value": 1 }, "questionText": { "multiLine": true, "value": "example" } } ] } ] } ], "confirmationText": "example" }'

Answer specific survey. If content question Ids do not match the original, answer will not be accepted

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Id of given recipient

Request Bodyrequired

Section titled “Request Bodyrequired”

The survey containing the answers

Media typeapplication/json
object
title
required
string
>= 1 characters
description
string
nullable
pages
required
Array<object>
object
title
string
nullable
description
string
nullable
sections
required
Array<object>
object
title
string
nullable
description
string
nullable
questions
required
Array<object>
object
id
integer format: int64
ref
string
nullable
title
required
string
>= 1 characters
description
string
nullable
required
boolean
questionType
integer
Allowed values: 0 1 2
questionScale
One of:
object
min
required
integer format: int32
max
required
integer format: int32
minLabel
string
nullable
maxLabel
string
nullable
value
integer format: int64
nullable
questionText
One of:
object
multiLine
boolean
value
string
nullable
confirmationText
string
nullable

Responses

Section titled “Responses”

200

Section titled “200”

The specified SurveyRecipient structures

Media typeapplication/json
object
id
string format: guid
rev
integer format: int64
surveyId
string format: guid
ref
string
nullable
referenceTime
string format: date-time
nullable
name
string
nullable
emailAddress
string
nullable
mobilePhone
string
nullable
invitationMethod
integer
Allowed values: 0 1 2
sendTime
string format: date-time
nullable
remindTime
string format: date-time
nullable
callbackUri
string
nullable
sentTime
string format: date-time
nullable
remindedTime
string format: date-time
nullable
openedTime
string format: date-time
nullable
respondedTime
string format: date-time
nullable
callbackCallCount
integer format: int32
callbackCallSuccess
boolean
callbackCalledTime
string format: date-time
nullable
status
integer
Allowed values: 0 1 2 3 4 5 6 999
replaceParams
object
key
additional properties
string
Example
{
  "application/json": {
    "id": "aa2af7b1-c640-4d4b-a9b2-8eaf68b446b7",
    "rev": 0,
    "surveyId": "ff07bf69-8453-4c1b-b407-1a3467a4109a",
    "referenceTime": "2025-12-01T07:50:09.6519551+00:00",
    "name": "Lennart Lennartsbesökare",
    "emailAddress": "lennart@lennart.se",
    "mobilePhone": "0701234567",
    "invitationMethod": 0,
    "sendTime": "2025-12-01T12:50:09.6519526+00:00",
    "remindTime": "2025-12-01T17:50:09.6519549+00:00",
    "callbackCallCount": 0,
    "callbackCallSuccess": false,
    "status": 1,
    "replaceParams": {
      "name": "Lennart",
      "personalMsg": "Glöm inte att sälja din freestyle Lennart!"
    }
  }
}