Relationships

Relationships Documentation

Relationship [LIST]

Relationship [LIST]

Request

Endpoint

GET /api/v2/contacts/a06f3ae7-49c8-4430-9b29-4e07fcfaadba/people/eea57f86-ce68-40e8-8e59-bd604480300d/relationships
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": [
    {
      "id": "9a40b34e-b6b3-408b-a418-d07dc94b6f7a",
      "type": "family_relationships",
      "attributes": {
        "created_at": "2022-01-12T17:18:06Z",
        "relationship": "MyString",
        "updated_at": "2022-01-12T17:18:06Z",
        "updated_in_db_at": "2022-01-12T17:18:06Z"
      },
      "relationships": {
        "related_person": {
          "data": {
            "id": "abadcd55-37b5-45e2-9893-d5d5a2e4ea99",
            "type": "people"
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total_count": 1,
      "total_pages": 1
    },
    "sort": null,
    "filter": {
    }
  }
}

Fields

data

Type [Family Relationship]

Description An array of Family Relationships

Relationship [POST]

Relationship [POST]

Request

Endpoint

POST /api/v2/contacts/2910ded2-bfd5-4d5a-b7fe-304fbfe954ab/people/4f601125-64ba-4f06-9340-f5f6c35ecdd4/relationships
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "family_relationships",
    "attributes": {
      "relationship": "MyString",
      "updated_in_db_at": "2022-01-12 17:18:07 UTC"
    },
    "relationships": {
      "related_person": {
        "data": {
          "type": "people",
          "id": "02951ce9-d6c1-4594-b261-783b986ebc2e"
        }
      }
    }
  }
}

Parameters

Attributes

created_at

Type date

Description The timestamp of when this resource was created

Required No

relationship

Type string

Description The description of how these two people are related

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

related_person.data

Type Person

Description The person this person is related to

Required No

Response

Headers

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

Body

{
  "data": {
    "id": "435eacfc-a1ee-44b9-bb15-f709af3713f2",
    "type": "family_relationships",
    "attributes": {
      "created_at": "2022-01-12T17:18:07Z",
      "relationship": "MyString",
      "updated_at": "2022-01-12T17:18:07Z",
      "updated_in_db_at": "2022-01-12T17:18:07Z"
    },
    "relationships": {
      "related_person": {
        "data": {
          "id": "02951ce9-d6c1-4594-b261-783b986ebc2e",
          "type": "people"
        }
      }
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

relationship

Type string

Description The description of how these two people are related

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

related_person.data

Type Person

Description The person this person is related to

Relationship [GET]

Relationship [GET]

Request

Endpoint

GET /api/v2/contacts/f7dcafa2-1504-4ad3-8416-0f82378644c5/people/29fede67-9dbf-49ec-832e-8693a9b7edbe/relationships/73192e55-b596-4f63-868c-bd0047e0d66b
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": {
    "id": "73192e55-b596-4f63-868c-bd0047e0d66b",
    "type": "family_relationships",
    "attributes": {
      "created_at": "2022-01-12T17:18:06Z",
      "relationship": "MyString",
      "updated_at": "2022-01-12T17:18:06Z",
      "updated_in_db_at": "2022-01-12T17:18:06Z"
    },
    "relationships": {
      "related_person": {
        "data": {
          "id": "d198a56b-1688-4e84-9d50-f1c51b355699",
          "type": "people"
        }
      }
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

relationship

Type string

Description The description of how these two people are related

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

related_person.data

Type Person

Description The person this person is related to

Relationship [PUT]

Relationship [PUT]

Request

Endpoint

PUT /api/v2/contacts/087cf18e-7a11-4653-a630-fabbc6efc91b/people/a9e67a22-b170-4cfe-b1b9-951b70b9db4d/relationships/78987534-e9ef-4a95-be9a-a449ae6641f7
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "family_relationships",
    "attributes": {
      "relationship": "MyString",
      "updated_in_db_at": "2022-01-12 17:18:06 UTC"
    },
    "relationships": {
      "related_person": {
        "data": {
          "type": "people",
          "id": "fb2f67b0-1ccf-4960-8955-070f0908c6eb"
        }
      }
    }
  }
}

Parameters

Attributes

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

relationship

Type string

Description The description of how these two people are related

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

related_person.data

Type Person

Description The person this person is related to

Required No

Response

Headers

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

Body

{
  "data": {
    "id": "78987534-e9ef-4a95-be9a-a449ae6641f7",
    "type": "family_relationships",
    "attributes": {
      "created_at": "2022-01-12T17:18:06Z",
      "relationship": "MyString",
      "updated_at": "2022-01-12T17:18:06Z",
      "updated_in_db_at": "2022-01-12T17:18:06Z"
    },
    "relationships": {
      "related_person": {
        "data": {
          "id": "fb2f67b0-1ccf-4960-8955-070f0908c6eb",
          "type": "people"
        }
      }
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

relationship

Type string

Description The description of how these two people are related

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

related_person.data

Type Person

Description The person this person is related to

Relationship [DELETE]

Relationship [DELETE]

Request

Endpoint

DELETE /api/v2/contacts/3eb07f07-195a-41a0-bc71-561699b46d7f/people/e4e1a92c-88f9-4bd0-82fa-b1152d5f0e6c/relationships/6fbd94a3-54cf-4c6b-a226-2de79d117877
Content-Type: application/vnd.api+json

Body

Response

Headers

204 No Content

Body