ADAM

Family Relationships

Use these endpoints to find the families linked to a pupil, or the current pupils linked to a family, with the relationship of each parent, and to change those relationships.

All endpoints on this page are under /api/familyrelationships/.

See Authentication for how to send your API token.

FamilyRelationships/family:get

Gets a list of current pupils linked to a family with their relationships descriptors for primary and secondary parents.

Request

GET /api/familyrelationships/family[/<family_id>]

Parameters

  • <family_id>: The internal identifier for the family. If omitted, all families are returned.

Response

The data attribute contains an array of 0 or more objects.

  • The index of each array object is the identifier of the pupil.
  • A primary and secondary key contain the relationship between the primary or secondary family member and the pupil. Note that a relationship will be returned even in instances where there may not be a secondary family member. Other logic must determine whether to discard this value or not.

Possible values include:

  • biological
  • adoptive parent
  • stepparent
  • foster parent
  • guardian
  • sponsor
  • relative
  • Other
GET /api/familyrelationships/family/123

{
  "data": [
    {
      "111": {
        "primary": "biological",
        "secondary": "step parent"
      },
      "321": {
        "primary": "step parent",
        "secondary": "biological"
      }
    }
  ],
  "message": "",
  "response": {
    "error": "OK",
    "code": 200
  }
}

FamilyRelationships/family:patch

Changes how the primary or secondary parent of a family is related to a pupil.

Request

PATCH /api/familyrelationships/family/<family_id>/<pupil_id>

Parameters

  • <family_id>: The internal identifier for the family (required).
  • <pupil_id>: The internal identifier for the pupil (required). The pupil must already be linked to the family.

The body of the request is a JSON object containing one or both of these fields:

  • primary: the relationship between the primary parent and the pupil.
  • secondary: the relationship between the secondary parent and the pupil.
{
  "primary": "biological",
  "secondary": "step parent"
}

Each value must be one of the following, written exactly as shown, in lower case:

  • biological
  • adoptive parent
  • step parent
  • foster parent
  • guardian
  • sponsor
  • relative
  • other

A field that is left out, or set to null, is not changed. Any other field in the body is rejected.

Response

On success, the data attribute contains the relationship as it now stands. primary or secondary is null if that relationship has never been set.

{
  "data": {
    "family_id": 111,
    "pupil_id": 123,
    "primary": "biological",
    "secondary": "step parent"
  },
  "message": "",
  "response": {
    "error": "OK",
    "code": 200
  }
}
  • Code 200: The relationship was updated.
  • Code 400: The body is empty, is not valid JSON, contains a field other than primary or secondary, or contains a value that is not in the list above. The response.error property describes the problem.
  • Code 404: The pupil is not linked to the family, or neither field has a value.

FamilyRelationships/pupil:get

Gets a list of families linked to a pupil with their relationships descriptors for primary and secondary parents.

Request

GET /api/familyrelationships/pupil[/<pupil_id>]

Parameters

  • <pupil_id>: The internal identifier for the pupil. If omitted, all pupils are returned

Response

GET /api/familyrelationships/pupil/123

{
  "data": {
    "111": {
      "primary": "biological",
      "secondary": "step parent"
    },
    "321": {
      "primary": "step parent",
      "secondary": "biological"
    }
  },
  "message": "",
  "response": {
    "error": "OK",
    "code": 200
  }
}

The data attribute contains an array of 0 or more objects.

  • The index of each array object is the identifier of the family.
  • A primary and secondary key contain the relationship between the primary or secondary family member and the pupil. Note that a relationship will be returned even in instances where there may not be a secondary family member. Other logic must determine whether to discard this value or not.

Possible values include:

  • biological
  • adoptive parent
  • step parent
  • foster parent
  • guardian
  • sponsor
  • relative
  • Other
GET /api/familyrelationships/pupil

{
  "data": {
    "123": {
      "111": {
        "primary": "biological",
        "secondary": "step parent"
      },
      "321": {
        "primary": "step parent",
        "secondary": "biological"
      }
    },
    "456": {
      "111": {
        "primary": "step parent",
        "secondary": "biological"
      }
    }
  },
  "message": "",
  "response": {
    "error": "OK",
    "code": 200
  }
}