Bulk

Bulk Documentation

Bulk [BULK DELETE]

Bulk [BULK DELETE]

Request

Endpoint

DELETE /api/v2/appeals/appeal_contacts/bulk
Content-Type: application/vnd.api+json

Body

{
  "data": [
    {
      "data": {
        "type": "appeal_contacts",
        "id": "1ba210a0-b710-4d3c-b521-bb98a4ad8e43"
      }
    }
  ]
}

Response

Headers

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

Body

[
  {
    "data": {
      "id": "1ba210a0-b710-4d3c-b521-bb98a4ad8e43",
      "type": "appeal_contacts",
      "attributes": {
        "created_at": "2022-01-12T17:18:16Z",
        "updated_at": "2022-01-12T17:18:16Z",
        "updated_in_db_at": "2022-01-12T17:18:16Z"
      },
      "relationships": {
        "appeal": {
          "data": {
            "id": "b7dc0fc1-8613-4cf2-97f9-c27554762966",
            "type": "appeals"
          }
        },
        "contact": {
          "data": {
            "id": "e72a3271-8c8c-490e-96fe-e28fae240b37",
            "type": "contacts"
          }
        }
      }
    }
  }
]

Bulk [BULK POST]

Bulk [BULK POST]

Request

Endpoint

POST /api/v2/appeals/appeal_contacts/bulk
Content-Type: application/vnd.api+json

Body

{
  "data": [
    {
      "data": {
        "type": "appeal_contacts",
        "id": "cd8f3530-222c-44f0-927e-a681d58e3a10",
        "attributes": {
        },
        "relationships": {
          "appeal": {
            "data": {
              "type": "appeals",
              "id": "8c4b325f-84aa-42f8-a7b6-d5ddcba00961"
            }
          },
          "contact": {
            "data": {
              "type": "contacts",
              "id": "799b9a5c-f3a7-499c-8f3f-8068fe9f0de2"
            }
          }
        }
      }
    }
  ]
}

Response

Headers

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

Body

[
  {
    "data": {
      "id": "cd8f3530-222c-44f0-927e-a681d58e3a10",
      "type": "appeal_contacts",
      "attributes": {
        "created_at": "2022-01-12T17:18:16Z",
        "updated_at": "2022-01-12T17:18:16Z",
        "updated_in_db_at": "2022-01-12T17:18:16Z"
      },
      "relationships": {
        "appeal": {
          "data": {
            "id": "8c4b325f-84aa-42f8-a7b6-d5ddcba00961",
            "type": "appeals"
          }
        },
        "contact": {
          "data": {
            "id": "799b9a5c-f3a7-499c-8f3f-8068fe9f0de2",
            "type": "contacts"
          }
        }
      }
    }
  }
]

Fields

Attributes

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.