Relationships
A relationship defines the kind of association between a student and a parent
This endpoint retrieves all children relationships of parent
An integer of child's Parent ID
An integer defining which page to display.
An integer defining the number of records to display per page.
Success
GET /v2/parents/{parent_id}/children HTTP/1.1
Host: api.managebac.com
auth-token: YOUR_API_KEY
Accept: */*
Success
{
"children": [
{
"id": 1,
"relationship": "Mother"
}
],
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"per_page": 100
}
}This endpoint creates parent-child relationship
An integer of child's Parent ID
Created
Unprocessable entity
POST /v2/parents/{parent_id}/children HTTP/1.1
Host: api.managebac.com
auth-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 42
{
"child": {
"id": 1,
"relationship": "Mother"
}
}{
"child": {
"id": 1,
"relationship": "Mother"
}
}This endpoint completely defines the parent-children relationships.
An integer of child's Parent ID
Success
Unprocessable entity
PUT /v2/parents/{parent_id}/children HTTP/1.1
Host: api.managebac.com
auth-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 47
{
"children": [
{
"id": 1,
"relationship": "Mother"
}
]
}{
"children": [
{
"id": 1,
"relationship": "Mother"
},
{
"id": 2,
"relationship": "Brother"
}
]
}This endpoint retrieves all information about child relationship to parent
An integer of child's Parent ID
An integer of child ID
Success
Not found
GET /v2/parents/{parent_id}/children/{id} HTTP/1.1
Host: api.managebac.com
auth-token: YOUR_API_KEY
Accept: */*
{
"child": {
"id": 1,
"relationship": "Mother"
}
}This endpoint updates parent-child relationship
An integer of child's Parent ID
An integer of child ID
Success
Not found
Unprocessable entity
PUT /v2/parents/{parent_id}/children/{id} HTTP/1.1
Host: api.managebac.com
auth-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 35
{
"child": {
"relationship": "Mother"
}
}{
"child": {
"id": 1,
"relationship": "Mother"
}
}This endpoint removes child relationship to parent
An integer of child's Parent ID
An integer of child ID
No content
No content
Not found
DELETE /v2/parents/{parent_id}/children/{id} HTTP/1.1
Host: api.managebac.com
auth-token: YOUR_API_KEY
Accept: */*
No content
Was this helpful?