# /parent

This endpoint is used by devices which are used by a parent.

## see

- [auth API](./auth.md) for obtaining mail auth tokens which are needed at some APIs here

## POST /parent/get-status-by-mail-address

Use this to check the status of a mail auth token and the linked mail address.

### request

see [this JSON schema](../schema/mailauthtokenrequestbody.md)

### response

On a invalid request body: HTTP status code 400 Bad Request

If the mail auth token is invalid/ expired: HTTP status code 401 Unauthorized

On success: a object with the properties ``status`` (string), ``mail`` (string),
``canCreateFamily`` (boolean) and ``alwaysPro`` (boolean)

- ``status`` is ``with family`` or ``without family``
- ``mail`` is the mail address for which the auth token was created
- ``canCreateFamily`` is false if the sign up of new families was disabled and otherwise true
- ``alwaysPro`` is true if the premium version is always unlocked

## POST /parent/create-family

Use this to register a new family.

### request

see [this JSON schema](../schema/createfamilybymailtokenrequest.md)

### response

On a invalid request body: HTTP status code 400 Bad Request

If the mail auth token is invalid/ expired: HTTP status code 401 Unauthorized

If there is already a user with the mail address of the mail auth token: HTTP status code 409 Conflict

On success: object with ``deviceAuthToken`` (string) and ``ownDeviceId`` (string)

## POST /parent/sign-in-into-family

Use this to sign in into an existing family using a mail auth token.

### request

see [this JSON schema](../schema/signintofamilyrequest.md)

### response

On a invalid request body: HTTP status code 400 Bad Request

If there is no user with the mail address of the mail auth token: HTTP status code 409 Conflict

On success: object with ``deviceAuthToken`` (string) and ``ownDeviceId`` (string)

## POST /parent/can-recover-password

Use this to check if the parent password can be recovered. This checks that the
mail auth token matches the mail address of the parent user.

### request

see [this JSON schema](/schema/canrecoverpasswordrequest.md)

### response

On a invalid request body: HTTP status code 400 Bad Request

If the mail auth token is invalid/ expired: HTTP status code 401 Unauthorized

On success: object with the property ``canRecover`` (boolean)

## POST /parent/recover-parent-password

Use this to set the password for a user without knowing the old password.

### request

see [this JSON schema](../schema/recoverparentpasswordrequest.md)

### response

On a invalid request body: HTTP status code 400 Bad Request

If the mail auth token is invalid/ expired: HTTP status code 401 Unauthorized

On success: ``{"ok": true}``

## POST /parent/create-add-device-token

Use this to create a token which can be used by ``/child/add-device``.

### request

see [this JSON schema](../schema/createregisterdevicetokenrequest.md)

in case of a device used by a parent with disabled password checks, use ``device`` as ``secondPasswordHash``

### response

On a invalid request body: HTTP status code 400 Bad Request

If the device auth token is invalid: HTTP status code 401 Unauthorized

If the ``secondPasswordHash`` is invalid: HTTP status code 401 Unauthorized

On success: object with ``token`` and ``deviceId``

``token`` is the add device token

``deviceId`` is the device id which the new device will get if it uses the token

## POST /parent/link-mail-address

Use this to link a mail address to an existing parent user.

### request

see [this JSON schema](../schema/linkparentmailaddressrequest.md)

### response

On a invalid request body: HTTP status code 400 Bad Request

If the device auth token is invalid: HTTP status code 401 Unauthorized

If the mail auth token is invalid/ expired: HTTP status code 401 Unauthorized

If there is already a user with the mail address of the mail auth token: HTTP status code 409 Conflict

If there is no user with the specified ``parentId`` (user id): HTTP status code 409 Conflict

If there is already a mail address for the user: HTTP status code 409 Conflict

If the ``parentPasswordSecondHash`` is invalid: HTTP status code 409 Conflict

On success: ``{"ok": true}``

## POST /parent/remove-device

Use this to remove a device from a family.

### request

see [this JSON schema](../schema/removedevicerequest.md)

in case of a device used by a parent with disabled password checks, use ``device`` as ``secondPasswordHash``

### response

On a invalid request body: HTTP status code 400 Bad Request

If the device auth token is invalid: HTTP status code 401 Unauthorized

If there is no device with the specified ``deviceId``: HTTP status code 409 Conflict

If the ``secondPasswordHash`` is invalid: HTTP status code 401 Unauthorized

On success: ``{"ok": true}``