Parental-control API documentation version v1

https://client-api.magine.com/api/parental-control/{version}

  • version: required(v1)

/asset

post

post

Current youth-protection state for asset

Current youth-protection state for asset

Headers

  • Magine-AccessToken: required(string)

    A token that identifies a specific partner

    Example:

    25b70ae1-d2bd-4ae7-85f4-62026580c866
  • Authorization: required(string)

    Bearer {login token}

    Example:

    Bearer 4b6fbf80..

Body

Media type: application/json

Type: object

Properties
  • userId: required(string)
  • assetId: required(string)
  • iso8601Time: (string)

    Example:

    2017-06-12T09:37:45+01:00

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • pinCodeRequired: required(boolean)

HTTP status code 400

Bad request

HTTP status code 401

Unauthorized userId

/parental-control/{userId}

get patch

get

Returns current parental-control

patch

Modify parental-control

Returns current parental-control

URI Parameters

  • userId: required(string)

Headers

  • Magine-AccessToken: required(string)

    A token that identifies a specific partner

    Example:

    25b70ae1-d2bd-4ae7-85f4-62026580c866
  • Authorization: required(string)

    Bearer {login token}

    Example:

    Bearer 4b6fbf80..

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • active: required(boolean)

    If parental control is active (true) or inactive (false)

  • hasPinCode: required(boolean)

    If the user has a pincode set.

HTTP status code 401

Unauthorized userId

Modify parental-control

URI Parameters

  • userId: required(string)

Headers

  • Magine-AccessToken: required(string)

    A token that identifies a specific partner

    Example:

    25b70ae1-d2bd-4ae7-85f4-62026580c866
  • Authorization: required(string)

    Bearer {login token}

    Example:

    Bearer 4b6fbf80..

Body

Media type: application/json

Type: object

Properties
  • newCode: (string)

    Desired new code, if any

  • active: (boolean - default: true)

    Desired state for parental control (true for active, false for inactive)

  • oldCode: (string)

    The current parental-control code if the user has one.

HTTP status code 202

Accepted

HTTP status code 401

Unauthorized userId

HTTP status code 403

Invalid oldCode in request content

head get

head

Verify parental-control code

get

Verify parental-control code

Verify parental-control code

URI Parameters

  • userId: required(string)
  • code: required(string)

    The code to verify

Headers

  • Magine-AccessToken: required(string)

    A token that identifies a specific partner

    Example:

    25b70ae1-d2bd-4ae7-85f4-62026580c866
  • Authorization: required(string)

    Bearer {login token}

    Example:

    Bearer 4b6fbf80..

HTTP status code 204

The code is correct

HTTP status code 401

Unauthorized userId

HTTP status code 403

Could not verify pincode

Verify parental-control code

URI Parameters

  • userId: required(string)
  • code: required(string)

    The code to verify

Headers

  • Magine-AccessToken: required(string)

    A token that identifies a specific partner

    Example:

    25b70ae1-d2bd-4ae7-85f4-62026580c866
  • Authorization: required(string)

    Bearer {login token}

    Example:

    Bearer 4b6fbf80..

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "message": "OK",
  "code": 200
}

HTTP status code 401

Unauthorized userId

HTTP status code 403

Could not verify pincode

post

post

Reset parental control

Reset parental control

URI Parameters

  • userId: required(string)

HTTP status code 202

A new code will be genereated and e-mailed to the user, and parental control will be active.

HTTP status code 401

Unauthorized userId