Excluded Appeal Contacts

Excluded Appeal Contacts Documentation

Excluded Appeal Contact [LIST]

Excluded Appeal Contact [LIST]

Request

Endpoint

GET /api/v2/appeals/be7e023d-e6db-421a-8795-85cc830518cb/excluded_appeal_contacts
Content-Type: application/vnd.api+json

Body

Parameters

Sorts

contact.name

Type Unknown

Description Sort by contact name

Required No

Response

Headers

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

Body

{
  "data": [
    {
      "id": "29ab5c04-4090-4062-b4fd-c986dc14b581",
      "type": "excluded_appeal_contacts",
      "attributes": {
        "created_at": "2022-01-12T17:18:19Z",
        "reasons": null,
        "updated_at": "2022-01-12T17:18:19Z",
        "updated_in_db_at": "2022-01-12T17:18:19Z"
      },
      "relationships": {
        "appeal": {
          "data": {
            "id": "be7e023d-e6db-421a-8795-85cc830518cb",
            "type": "appeals"
          }
        },
        "contact": {
          "data": {
            "id": "a4ebebe9-be81-484e-a52e-3041c7568a0c",
            "type": "contacts"
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total_count": 1,
      "total_pages": 1
    },
    "sort": null,
    "filter": {
    }
  }
}

Fields

data

Type [Object]

Description An array of Objects

Excluded Appeal Contact [GET]

Excluded Appeal Contact [GET]

Request

Endpoint

GET /api/v2/appeals/9812e542-c5f6-47d1-b849-b64ced5d89f1/excluded_appeal_contacts/364d7dd5-2f35-46bf-a594-f71b0d221c8d
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": {
    "id": "364d7dd5-2f35-46bf-a594-f71b0d221c8d",
    "type": "excluded_appeal_contacts",
    "attributes": {
      "created_at": "2022-01-12T17:18:19Z",
      "reasons": null,
      "updated_at": "2022-01-12T17:18:19Z",
      "updated_in_db_at": "2022-01-12T17:18:19Z"
    },
    "relationships": {
      "appeal": {
        "data": {
          "id": "9812e542-c5f6-47d1-b849-b64ced5d89f1",
          "type": "appeals"
        }
      },
      "contact": {
        "data": {
          "id": "639b6b3c-49b3-4a7b-9432-0077c6853f34",
          "type": "contacts"
        }
      }
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

reasons

Type string

Description A list of reasons the contact was automatically excluded

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

appeal.data

Type Appeal

Description appeal relating to the contact

contact.data

Type Contact

Description contact relating to the appeal

Excluded Appeal Contact [DELETE]

Excluded Appeal Contact [DELETE]

Request

Endpoint

DELETE /api/v2/appeals/3e71f80f-5b06-405f-ad78-2f59c399cc3c/excluded_appeal_contacts/163a8b09-85a2-4e42-9038-37a0ace610a4
Content-Type: application/vnd.api+json

Body

Response

Headers

204 No Content

Body