Answer Sets

Answer Sets Documentation

Answer Set [LIST]

Answer Set [LIST]

Request

Endpoint

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

Body

Parameters

Sorts

completed_at

Type Unknown

Description Sort by completed_at date

Required No

Filters

account_list_id

Type ID string

Description Filter by Account List; accepts an Account List id

Required No

completed

Type boolean

Description Filter by Completed; Accepts values "true", or "false"

Required No

Response

Headers

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

Body

{
  "data": [
    {
      "id": "036320fa-bcf8-49c2-a127-d6396ff20cf7",
      "type": "coaching_answer_sets",
      "attributes": {
        "account_list_id": "017954e1-4cdd-4c14-b401-9a8a82f2d878",
        "completed_at": "2022-01-11T17:18:05Z",
        "created_at": "2022-01-12T17:18:05Z",
        "updated_at": "2022-01-12T17:18:05Z",
        "updated_in_db_at": "2022-01-12T17:18:05Z"
      },
      "relationships": {
        "organization": {
          "data": {
            "id": "89fcaa19-d405-45c8-95fb-6cea1e1ae588",
            "type": "organizations"
          }
        },
        "answers": {
          "data": [

          ]
        },
        "questions": {
          "data": [

          ]
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total_count": 1,
      "total_pages": 1
    },
    "sort": null,
    "filter": {
    }
  }
}

Fields

data

Type [AnswerSet]

Description An array of Answer Set Objects

Answer Set [POST]

Answer Set [POST]

Request

Endpoint

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

Body

{
  "data": {
    "type": "coaching_answer_sets",
    "attributes": {
      "updated_in_db_at": "2022-01-12 17:18:05 UTC"
    },
    "relationships": {
      "account_list": {
        "data": {
          "type": "account_lists",
          "id": "3ffdb694-00d5-49fd-8dd5-6bc18b9365cf"
        }
      },
      "organization": {
        "data": {
          "type": "organizations",
          "id": "5f51b4c2-068b-4c9d-b834-eb3b0119db9e"
        }
      }
    }
  }
}

Parameters

Attributes

account_list_id

Type ID string

Description Id of account list this answer set is on

Required No

completed_at

Type datetime

Description When the answer set was marked completed at

Required No

created_at

Type date

Description The timestamp of when this resource was created

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

account_list.data

Type Account List

Description The Account List that the answer set belongs to

Required No

answers.data

Type Coaching Answer

Description The answers that have been submitted to this set

Required No

organization.data

Type Organization

Description The Organization that the answer belongs to

Required No

questions.data

Type Coaching Question

Description The questions to be asked in this set (fetched through organization)

Required No

Response

Headers

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

Body

{
  "data": {
    "id": "0571aea8-0323-4526-9d01-5e559094a0ce",
    "type": "coaching_answer_sets",
    "attributes": {
      "account_list_id": "3ffdb694-00d5-49fd-8dd5-6bc18b9365cf",
      "completed_at": null,
      "created_at": "2022-01-12T17:18:05Z",
      "updated_at": "2022-01-12T17:18:05Z",
      "updated_in_db_at": "2022-01-12T17:18:05Z"
    },
    "relationships": {
      "organization": {
        "data": {
          "id": "5f51b4c2-068b-4c9d-b834-eb3b0119db9e",
          "type": "organizations"
        }
      },
      "answers": {
        "data": [

        ]
      },
      "questions": {
        "data": [

        ]
      }
    }
  }
}

Fields

Attributes

account_list_id

Type ID string

Description Id of account list this answer set is on

completed_at

Type datetime

Description When the answer set was marked completed at

created_at

Type date

Description The timestamp of when this resource was created

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

answers.data

Type Coaching Answer

Description The answers that have been submitted to this set

organization.data

Type Organization

Description The Organization that the answer belongs to

questions.data

Type Coaching Question

Description The questions to be asked in this set (fetched through organization)

Answer Set [GET]

Answer Set [GET]

Request

Endpoint

GET /api/v2/coaching/answer_sets/7d1d60eb-bbf0-4f1f-8bfb-3f34c552d793
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": {
    "id": "7d1d60eb-bbf0-4f1f-8bfb-3f34c552d793",
    "type": "coaching_answer_sets",
    "attributes": {
      "account_list_id": "3ee29b10-95bc-4d01-a1c1-2989377d3230",
      "completed_at": "2022-01-11T17:18:04Z",
      "created_at": "2022-01-12T17:18:04Z",
      "updated_at": "2022-01-12T17:18:04Z",
      "updated_in_db_at": "2022-01-12T17:18:04Z"
    },
    "relationships": {
      "organization": {
        "data": {
          "id": "76c68d6d-766e-4044-a561-a4bfb5b97f0d",
          "type": "organizations"
        }
      },
      "answers": {
        "data": [

        ]
      },
      "questions": {
        "data": [

        ]
      }
    }
  }
}

Fields

Attributes

account_list_id

Type ID string

Description Id of account list this answer set is on

completed_at

Type datetime

Description When the answer set was marked completed at

created_at

Type date

Description The timestamp of when this resource was created

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

answers.data

Type Coaching Answer

Description The answers that have been submitted to this set

organization.data

Type Organization

Description The Organization that the answer belongs to

questions.data

Type Coaching Question

Description The questions to be asked in this set (fetched through organization)

Answer Set [PUT]

Answer Set [PUT]

Request

Endpoint

PUT /api/v2/coaching/answer_sets/57b1302e-bb00-466b-83af-4a96b207df6e
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "coaching_answer_sets",
    "attributes": {
      "updated_in_db_at": "2022-01-12 17:18:05 UTC"
    },
    "relationships": {
      "account_list": {
        "data": {
          "type": "account_lists",
          "id": "764e42b5-b12b-45e5-be67-5f4ece4b75d3"
        }
      },
      "organization": {
        "data": {
          "type": "organizations",
          "id": "c60f2098-bd9e-447a-8c41-1fce761a7d05"
        }
      }
    }
  }
}

Parameters

Attributes

account_list_id

Type ID string

Description Id of account list this answer set is on

Required No

completed_at

Type datetime

Description When the answer set was marked completed at

Required No

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

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

account_list.data

Type Account List

Description The Account List that the answer set belongs to

Required No

answers.data

Type Coaching Answer

Description The answers that have been submitted to this set

Required No

organization.data

Type Organization

Description The Organization that the answer belongs to

Required No

questions.data

Type Coaching Question

Description The questions to be asked in this set (fetched through organization)

Required No

Response

Headers

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

Body

{
  "data": {
    "id": "57b1302e-bb00-466b-83af-4a96b207df6e",
    "type": "coaching_answer_sets",
    "attributes": {
      "account_list_id": "764e42b5-b12b-45e5-be67-5f4ece4b75d3",
      "completed_at": "2022-01-11T17:18:05Z",
      "created_at": "2022-01-12T17:18:05Z",
      "updated_at": "2022-01-12T17:18:05Z",
      "updated_in_db_at": "2022-01-12T17:18:05Z"
    },
    "relationships": {
      "organization": {
        "data": {
          "id": "c60f2098-bd9e-447a-8c41-1fce761a7d05",
          "type": "organizations"
        }
      },
      "answers": {
        "data": [

        ]
      },
      "questions": {
        "data": [

        ]
      }
    }
  }
}

Fields

Attributes

account_list_id

Type ID string

Description Id of account list this answer set is on

completed_at

Type datetime

Description When the answer set was marked completed at

created_at

Type date

Description The timestamp of when this resource was created

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

answers.data

Type Coaching Answer

Description The answers that have been submitted to this set

organization.data

Type Organization

Description The Organization that the answer belongs to

questions.data

Type Coaching Question

Description The questions to be asked in this set (fetched through organization)