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": "5cb2413f-66bd-4fbe-ae78-d365f6da3f8e"
      }
    }
  ]
}

Response

Headers

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

Body

[
  {
    "data": {
      "id": "5cb2413f-66bd-4fbe-ae78-d365f6da3f8e",
      "type": "appeal_contacts",
      "attributes": {
        "created_at": "2021-11-23T14:37:43Z",
        "updated_at": "2021-11-23T14:37:43Z",
        "updated_in_db_at": "2021-11-23T14:37:43Z"
      },
      "relationships": {
        "appeal": {
          "data": {
            "id": "83714f1c-2e1c-48f4-b1b0-7d60c081d1fa",
            "type": "appeals"
          }
        },
        "contact": {
          "data": {
            "id": "39a207b6-037a-41f3-affb-353dd4090288",
            "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": "30f71ec9-0229-4b8e-9c5a-04b9785ecf33",
        "attributes": {
        },
        "relationships": {
          "appeal": {
            "data": {
              "type": "appeals",
              "id": "c76a5017-163b-4922-ba63-97ef0fcac1e6"
            }
          },
          "contact": {
            "data": {
              "type": "contacts",
              "id": "a31d83ee-2474-47b8-beb1-e442f202074d"
            }
          }
        }
      }
    }
  ]
}

Response

Headers

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

Body

[
  {
    "data": {
      "id": "30f71ec9-0229-4b8e-9c5a-04b9785ecf33",
      "type": "appeal_contacts",
      "attributes": {
        "created_at": "2021-11-23T14:37:43Z",
        "updated_at": "2021-11-23T14:37:43Z",
        "updated_in_db_at": "2021-11-23T14:37:43Z"
      },
      "relationships": {
        "appeal": {
          "data": {
            "id": "c76a5017-163b-4922-ba63-97ef0fcac1e6",
            "type": "appeals"
          }
        },
        "contact": {
          "data": {
            "id": "a31d83ee-2474-47b8-beb1-e442f202074d",
            "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.