Answers

Answers Documentation

Answer [LIST]

Answer [LIST]

Request

Endpoint

GET /api/v2/coaching/answers
Content-Type: application/vnd.api+json

Body

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": [
    {
      "id": "ae52073e-0e24-450b-8708-b635a6acd591",
      "type": "coaching_answers",
      "attributes": {
        "created_at": "2022-01-12T17:18:44Z",
        "response": null,
        "updated_at": "2022-01-12T17:18:44Z",
        "updated_in_db_at": "2022-01-12T17:18:44Z"
      },
      "relationships": {
        "question": {
          "data": {
            "id": "643c8e01-cc7c-4aed-a7ab-62d061b64f75",
            "type": "coaching_questions"
          }
        },
        "answer_set": {
          "data": {
            "id": "0d1cfc4a-3c88-4ae5-9ac1-0835c9246824",
            "type": "coaching_answer_sets"
          }
        },
        "submitted_by_user": {
          "data": {
            "id": "a3b7780f-2479-447f-aa34-596b91ecf0cb",
            "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

POST /api/v2/coaching/answers
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "coaching_answers",
    "attributes": {
      "response": "test",
      "updated_in_db_at": "2022-01-12 17:18:44 UTC"
    },
    "relationships": {
      "question": {
        "data": {
          "type": "coaching_questions",
          "id": "1543c195-94aa-4995-92a2-29a1ebbe6190"
        }
      },
      "answer_set": {
        "data": {
          "type": "coaching_answer_sets",
          "id": "85d09426-bef3-4df8-81c1-951fd118840c"
        }
      }
    }
  }
}

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

Content-Type: application/vnd.api+json; charset=utf-8
201 Created

Body

{
  "data": {
    "id": "76ff4755-8971-4331-a6ef-fe784c6718fa",
    "type": "coaching_answers",
    "attributes": {
      "created_at": "2022-01-12T17:18:44Z",
      "response": "test",
      "updated_at": "2022-01-12T17:18:44Z",
      "updated_in_db_at": "2022-01-12T17:18:44Z"
    },
    "relationships": {
      "question": {
        "data": {
          "id": "1543c195-94aa-4995-92a2-29a1ebbe6190",
          "type": "coaching_questions"
        }
      },
      "answer_set": {
        "data": {
          "id": "85d09426-bef3-4df8-81c1-951fd118840c",
          "type": "coaching_answer_sets"
        }
      },
      "submitted_by_user": {
        "data": {
          "id": "65cd82d9-0ac7-4259-af0b-09742a8f19d8",
          "type": "users"
        }
      }
    }
  }
}

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

GET /api/v2/coaching/answers/4f82746c-b0e0-416e-afb8-e0a06517728c
Content-Type: application/vnd.api+json

Body

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": {
    "id": "4f82746c-b0e0-416e-afb8-e0a06517728c",
    "type": "coaching_answers",
    "attributes": {
      "created_at": "2022-01-12T17:18:44Z",
      "response": null,
      "updated_at": "2022-01-12T17:18:44Z",
      "updated_in_db_at": "2022-01-12T17:18:44Z"
    },
    "relationships": {
      "question": {
        "data": {
          "id": "ad61b72e-407c-42be-b425-2ecf5ed369dd",
          "type": "coaching_questions"
        }
      },
      "answer_set": {
        "data": {
          "id": "481eb74c-ea73-41f0-b30f-3ddc80881509",
          "type": "coaching_answer_sets"
        }
      },
      "submitted_by_user": {
        "data": {
          "id": "362890a4-d5b3-425a-a128-87b4c43b8efd",
          "type": "users"
        }
      }
    }
  }
}

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

PUT /api/v2/coaching/answers/b4c50ce9-4b5c-4dad-8b4c-2b034e02f61d
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "coaching_answers",
    "attributes": {
      "response": "test",
      "updated_in_db_at": "2022-01-12 17:18:44 UTC"
    },
    "relationships": {
      "question": {
        "data": {
          "type": "coaching_questions",
          "id": "9ee20e3f-5313-43c9-ac05-5dfe01a99172"
        }
      },
      "answer_set": {
        "data": {
          "type": "coaching_answer_sets",
          "id": "6fb5cbb9-6ee7-4abc-8383-584bd1348c3f"
        }
      }
    }
  }
}

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

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": {
    "id": "b4c50ce9-4b5c-4dad-8b4c-2b034e02f61d",
    "type": "coaching_answers",
    "attributes": {
      "created_at": "2022-01-12T17:18:44Z",
      "response": "test",
      "updated_at": "2022-01-12T17:18:44Z",
      "updated_in_db_at": "2022-01-12T17:18:44Z"
    },
    "relationships": {
      "question": {
        "data": {
          "id": "9ee20e3f-5313-43c9-ac05-5dfe01a99172",
          "type": "coaching_questions"
        }
      },
      "answer_set": {
        "data": {
          "id": "6fb5cbb9-6ee7-4abc-8383-584bd1348c3f",
          "type": "coaching_answer_sets"
        }
      },
      "submitted_by_user": {
        "data": {
          "id": "93c65d88-b58c-44e9-b84d-fbdb4c316410",
          "type": "users"
        }
      }
    }
  }
}

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)