Answers
Answers Documentation
Answer [LIST]
Answer [LIST]
Request
Endpoint
GET /api/v2/coaching/answers
Content-Type: application/vnd.api+jsonBody
Response
Headers
Content-Type: application/vnd.api+json; charset=utf-8
200 OKBody
{
"data": [
{
"id": "f6c63f80-c3e0-47b4-a7f1-c6c46f6c11ef",
"type": "coaching_answers",
"attributes": {
"created_at": "2021-11-23T14:38:06Z",
"response": null,
"updated_at": "2021-11-23T14:38:06Z",
"updated_in_db_at": "2021-11-23T14:38:06Z"
},
"relationships": {
"question": {
"data": {
"id": "ecceae2c-3843-4eff-9921-de4e0924c5a9",
"type": "coaching_questions"
}
},
"answer_set": {
"data": {
"id": "67711e79-a691-48b8-b866-58727dbac0ef",
"type": "coaching_answer_sets"
}
},
"submitted_by_user": {
"data": {
"id": "8512d8b9-79b2-461b-aae5-cc6d5213280a",
"type": "users"
}
}
}
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 1,
"total_pages": 1
},
"sort": null,
"filter": {
}
}
}Fields
data
Type
[Answer]
Description An array of Answer Objects
Answer [POST]
Answer [POST]
Request
Endpoint
Body
Parameters
Attributes
created_at
Type
date
Description The timestamp of when this resource was created
Required No
response
Type
string
Description The answer itself
Required No
updated_at
Type
date
Description The timestamp of when this resource was last updated
Required No
updated_in_db_at
Type
date
Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.
Required No
Relationships
answer_set.data
Type
Answer Set
Description The Answer Set that the answer belongs to
Required No
question.data
Type
Question
Description The Question that the answer belongs to
Required No
submitted_by_user.data
Type
User
Description The User that submitted the answer (filled in automatically)
Required No
Response
Headers
Body
Fields
Attributes
created_at
Type
date
Description The timestamp of when this resource was created
response
Type
string
Description The answer itself
updated_at
Type
date
Description The timestamp of when this resource was last updated
updated_in_db_at
Type
date
Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.
Relationships
answer_set.data
Type
Answer Set
Description The Answer Set that the answer belongs to
question.data
Type
Question
Description The Question that the answer belongs to
submitted_by_user.data
Type
User
Description The User that submitted the answer (filled in automatically)
Answer [GET]
Answer [GET]
Request
Endpoint
Body
Response
Headers
Body
Fields
Attributes
created_at
Type
date
Description The timestamp of when this resource was created
response
Type
string
Description The answer itself
updated_at
Type
date
Description The timestamp of when this resource was last updated
updated_in_db_at
Type
date
Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.
Relationships
answer_set.data
Type
Answer Set
Description The Answer Set that the answer belongs to
question.data
Type
Question
Description The Question that the answer belongs to
submitted_by_user.data
Type
User
Description The User that submitted the answer (filled in automatically)
Answer [PUT]
Answer [PUT]
Request
Endpoint
Body
Parameters
Attributes
created_at
Type
date
Description The timestamp of when this resource was created
Required No
overwrite
Type
boolean
Description
Only used for updating a record where you want to ignore the server's ' 'updated_in_db_at value and force overwrite the values for the record. ' 'Must be true to work.
Required No
response
Type
string
Description The answer itself
Required No
updated_at
Type
date
Description The timestamp of when this resource was last updated
Required No
updated_in_db_at
Type
date
Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.
Required No
Relationships
answer_set.data
Type
Answer Set
Description The Answer Set that the answer belongs to
Required No
question.data
Type
Question
Description The Question that the answer belongs to
Required No
submitted_by_user.data
Type
User
Description The User that submitted the answer (filled in automatically)
Required No
Response
Headers
Body
Fields
Attributes
created_at
Type
date
Description The timestamp of when this resource was created
response
Type
string
Description The answer itself
updated_at
Type
date
Description The timestamp of when this resource was last updated
updated_in_db_at
Type
date
Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.
Relationships
answer_set.data
Type
Answer Set
Description The Answer Set that the answer belongs to
question.data
Type
Question
Description The Question that the answer belongs to
submitted_by_user.data
Type
User
Description The User that submitted the answer (filled in automatically)
Last updated