Relationships

A relationship defines the kind of association between a student and a parent

List of parent-children relationships

get

https://api.managebac.comhttps://api.managebac.cnhttps://api.us.managebac.comhttps://api.managebac.ushttps://api.managebactest.comhttps://{Host}

/v2p0/parents/{parent_id}/children

This endpoint retrieves all children relationships of parent

Authorizations

authTokenQueryauthTokenHeader

auth_tokenstringRequired

Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.

Path parameters

parent_idstringRequired

An integer of child's Parent ID

Query parameters

pagestringOptional

An integer defining which page to display.

per_pagestringOptional

An integer defining the number of records to display per page.

Responses

200

Success

application/json

get

/v2p0/parents/{parent_id}/children

HTTPcURLJavaScriptPython

GET /v2p0/parents/{parent_id}/children HTTP/1.1
Host: api.managebac.com
Accept: */*

200

Success

{
  "children": [
    {
      "id": 1,
      "relationship": "Mother"
    }
  ],
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "per_page": 100
  }
}

Create a parent-child relationship

post

https://api.managebac.comhttps://api.managebac.cnhttps://api.us.managebac.comhttps://api.managebac.ushttps://api.managebactest.comhttps://{Host}

/v2p0/parents/{parent_id}/children

This endpoint creates parent-child relationship

Authorizations

authTokenQueryauthTokenHeader

auth_tokenstringRequired

Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.

Path parameters

parent_idstringRequired

An integer of child's Parent ID

Body

application/json

Responses

201

Created

application/json

422

Unprocessable entity

application/json

post

/v2p0/parents/{parent_id}/children

HTTPcURLJavaScriptPython

POST /v2p0/parents/{parent_id}/children HTTP/1.1
Host: api.managebac.com
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "child": {
    "id": 1,
    "relationship": "Mother"
  }
}

{
  "child": {
    "id": 1,
    "relationship": "Mother"
  }
}

Bulk update a parent-children relationships

put

https://api.managebac.comhttps://api.managebac.cnhttps://api.us.managebac.comhttps://api.managebac.ushttps://api.managebactest.comhttps://{Host}

/v2p0/parents/{parent_id}/children

This endpoint updates all parent-children relationships

Authorizations

authTokenQueryauthTokenHeader

auth_tokenstringRequired

Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.

Path parameters

parent_idstringRequired

An integer of child's Parent ID

Body

application/json

Responses

200

Success

application/json

422

Unprocessable entity

application/json

put

/v2p0/parents/{parent_id}/children

HTTPcURLJavaScriptPython

PUT /v2p0/parents/{parent_id}/children HTTP/1.1
Host: api.managebac.com
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "children": [
    {
      "id": 1,
      "relationship": "Mother"
    }
  ]
}

{
  "children": [
    {
      "id": 1,
      "relationship": "Mother"
    },
    {
      "id": 2,
      "relationship": "Brother"
    }
  ]
}

Get parent-child relationship

get

https://api.managebac.comhttps://api.managebac.cnhttps://api.us.managebac.comhttps://api.managebac.ushttps://api.managebactest.comhttps://{Host}

/v2p0/parents/{parent_id}/children/{id}

This endpoint retrieves all information about child relationship to parent

Authorizations

authTokenQueryauthTokenHeader

auth_tokenstringRequired

Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.

Path parameters

parent_idstringRequired

An integer of child's Parent ID

idstringRequired

An integer of child ID

Responses

200

Success

application/json

404

Not found

application/json

get

/v2p0/parents/{parent_id}/children/{id}

HTTPcURLJavaScriptPython

GET /v2p0/parents/{parent_id}/children/{id} HTTP/1.1
Host: api.managebac.com
Accept: */*

{
  "child": {
    "id": 1,
    "relationship": "Mother"
  }
}

Update parent-child relationship

put

https://api.managebac.comhttps://api.managebac.cnhttps://api.us.managebac.comhttps://api.managebac.ushttps://api.managebactest.comhttps://{Host}

/v2p0/parents/{parent_id}/children/{id}

This endpoint updates parent-child relationship

Authorizations

authTokenQueryauthTokenHeader

auth_tokenstringRequired

Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.

Path parameters

parent_idstringRequired

An integer of child's Parent ID

idstringRequired

An integer of child ID

Body

application/json

Responses

200

Success

application/json

404

Not found

application/json

422

Unprocessable entity

application/json

put

/v2p0/parents/{parent_id}/children/{id}

HTTPcURLJavaScriptPython

PUT /v2p0/parents/{parent_id}/children/{id} HTTP/1.1
Host: api.managebac.com
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "child": {
    "relationship": "Mother"
  }
}

{
  "child": {
    "id": 1,
    "relationship": "Mother"
  }
}

Remove parent-child relationship

delete

https://api.managebac.comhttps://api.managebac.cnhttps://api.us.managebac.comhttps://api.managebac.ushttps://api.managebactest.comhttps://{Host}

/v2p0/parents/{parent_id}/children/{id}

This endpoint removes child relationship to parent

Authorizations

authTokenQueryauthTokenHeader

auth_tokenstringRequired

Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.

Path parameters

parent_idstringRequired

An integer of child's Parent ID

idstringRequired

An integer of child ID

Responses

204

No content

404

Not found

application/json

delete

/v2p0/parents/{parent_id}/children/{id}

HTTPcURLJavaScriptPython

DELETE /v2p0/parents/{parent_id}/children/{id} HTTP/1.1
Host: api.managebac.com
Accept: */*

No content