Relationships
A relationship defines the kind of association between a student and a parent
Retrieves all children linked to a specific parent, along with the relationship type (e.g. Mother, Father, Guardian). Results are paginated.
OAuth 2.0 Bearer token obtained via client credentials grant. Pass the token in the Authorization header as Bearer <token>.
The unique numeric identifier of the parent record.
An integer defining which page to display. Defaults to 1.
An integer defining the number of records to display per page. Defaults to 100.
Success
Unauthorized
GET /v2p3/parents/{parent_id}/children HTTP/1.1
Host: api.managebac.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"children": [
{
"id": 1,
"relationship": "Mother"
}
],
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"per_page": 100
}
}Creates a new relationship between a parent and a child (student). The relationship type (e.g. Mother, Father, Guardian) must be provided.
If the child already has a relationship with this parent, a 422 error is returned. If the relationship was previously deleted, it is restored instead of creating a duplicate.
OAuth 2.0 Bearer token obtained via client credentials grant. Pass the token in the Authorization header as Bearer <token>.
The unique numeric identifier of the parent record.
Created
Unauthorized
Unprocessable entity
POST /v2p3/parents/{parent_id}/children HTTP/1.1
Host: api.managebac.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 42
{
"child": {
"id": 1,
"relationship": "Mother"
}
}{
"child": {
"id": 1,
"relationship": "Mother"
}
}Replaces all parent-children relationships for a given parent. The provided list of children and relationships becomes the complete set -- any existing relationships not included in the payload are removed.
OAuth 2.0 Bearer token obtained via client credentials grant. Pass the token in the Authorization header as Bearer <token>.
The unique numeric identifier of the parent record.
Success
Unauthorized
Unprocessable entity
PUT /v2p3/parents/{parent_id}/children HTTP/1.1
Host: api.managebac.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 47
{
"children": [
{
"id": 1,
"relationship": "Mother"
}
]
}{
"children": [
{
"id": 1,
"relationship": "Mother"
},
{
"id": 2,
"relationship": "Brother"
}
]
}Retrieves the relationship details between a specific parent and child, including the relationship type (e.g. Mother, Father, Guardian).
OAuth 2.0 Bearer token obtained via client credentials grant. Pass the token in the Authorization header as Bearer <token>.
The unique numeric identifier of the parent record.
The unique numeric identifier of the child (student) record.
Success
Unauthorized
Not found
GET /v2p3/parents/{parent_id}/children/{id} HTTP/1.1
Host: api.managebac.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"child": {
"id": 1,
"relationship": "Mother"
}
}Updates the relationship type between a specific parent and child. The relationship must already exist; if it does not, a 404 error is returned.
OAuth 2.0 Bearer token obtained via client credentials grant. Pass the token in the Authorization header as Bearer <token>.
The unique numeric identifier of the parent record.
The unique numeric identifier of the child (student) record.
Success
Unauthorized
Not found
Unprocessable entity
PUT /v2p3/parents/{parent_id}/children/{id} HTTP/1.1
Host: api.managebac.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35
{
"child": {
"relationship": "Mother"
}
}{
"child": {
"id": 1,
"relationship": "Mother"
}
}Removes the relationship between a specific parent and child. The relationship record is soft-deleted and can be restored by creating the same relationship again via POST.
OAuth 2.0 Bearer token obtained via client credentials grant. Pass the token in the Authorization header as Bearer <token>.
The unique numeric identifier of the parent record.
The unique numeric identifier of the child (student) record.
No content
No content
Unauthorized
Not found
DELETE /v2p3/parents/{parent_id}/children/{id} HTTP/1.1
Host: api.managebac.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Last updated