Appeal Contacts

Appeal Contacts Documentation

Appeal Contact [LIST]

Appeal Contact [LIST]

Request

Endpoint

GET /api/v2/appeals/3bfe7279-12c1-429d-ad26-4c5787e13f96/appeal_contacts
Content-Type: application/vnd.api+json

Body

Parameters

Sorts

contact.name

Type Unknown

Description Sort by contact name

Required No

Filters

pledged_to_appeal

Type boolean

Description Filter if contact has pledged to appeal; Accepts value "true" or "false"'

Required No

Response

Headers

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

Body

{
  "data": [
    {
      "id": "7a7d4f82-a9a9-41ec-8ce3-4e75ec290b75",
      "type": "appeal_contacts",
      "attributes": {
        "created_at": "2022-01-12T17:18:58Z",
        "updated_at": "2022-01-12T17:18:58Z",
        "updated_in_db_at": "2022-01-12T17:18:58Z"
      },
      "relationships": {
        "appeal": {
          "data": {
            "id": "3bfe7279-12c1-429d-ad26-4c5787e13f96",
            "type": "appeals"
          }
        },
        "contact": {
          "data": {
            "id": "74187c2d-e523-49b5-9809-b2b7b899afc1",
            "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

Appeal Contact [POST]

Appeal Contact [POST]

Request

Endpoint

POST /api/v2/appeals/542220df-12bb-42cd-879d-9d1505f8a869/appeal_contacts
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "appeal_contacts",
    "attributes": {
    },
    "relationships": {
      "contact": {
        "data": {
          "type": "contacts",
          "id": "c42e6ed9-8c7a-4f41-bcb6-409625c9fb24"
        }
      }
    }
  }
}

Parameters

Attributes

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

appeal.data

Type Appeal

Description appeal relating to the contact

Required No

contact.data

Type Contact

Description contact relating to the appeal

Required No

Response

Headers

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

Body

{
  "data": {
    "id": "17ecb720-a527-458e-bb9c-6c3c6fc919bb",
    "type": "appeal_contacts",
    "attributes": {
      "created_at": "2022-01-12T17:18:58Z",
      "updated_at": "2022-01-12T17:18:58Z",
      "updated_in_db_at": "2022-01-12T17:18:58Z"
    },
    "relationships": {
      "appeal": {
        "data": {
          "id": "542220df-12bb-42cd-879d-9d1505f8a869",
          "type": "appeals"
        }
      },
      "contact": {
        "data": {
          "id": "c42e6ed9-8c7a-4f41-bcb6-409625c9fb24",
          "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.

Relationships

appeal.data

Type Appeal

Description appeal relating to the contact

contact.data

Type Contact

Description contact relating to the appeal

Appeal Contact [GET]

Appeal Contact [GET]

Request

Endpoint

GET /api/v2/appeals/c54e1928-6481-4c7b-9316-c6232e964e9e/appeal_contacts/b7d2e7ad-c5c3-45dc-a757-9d72c25298ea
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": {
    "id": "b7d2e7ad-c5c3-45dc-a757-9d72c25298ea",
    "type": "appeal_contacts",
    "attributes": {
      "created_at": "2022-01-12T17:18:58Z",
      "updated_at": "2022-01-12T17:18:58Z",
      "updated_in_db_at": "2022-01-12T17:18:58Z"
    },
    "relationships": {
      "appeal": {
        "data": {
          "id": "c54e1928-6481-4c7b-9316-c6232e964e9e",
          "type": "appeals"
        }
      },
      "contact": {
        "data": {
          "id": "f7b7d461-5673-4f1f-a8a7-93c1228eca79",
          "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.

Relationships

appeal.data

Type Appeal

Description appeal relating to the contact

contact.data

Type Contact

Description contact relating to the appeal

Appeal Contact [DELETE]

Appeal Contact [DELETE]

Request

Endpoint

DELETE /api/v2/appeals/37e027b3-e2c7-448c-9c5a-1e45f78c0598/appeal_contacts/11006a64-2515-4f8c-814b-0ed5e9ce18d5
Content-Type: application/vnd.api+json

Body

Response

Headers

204 No Content

Body