# Users and Seals

## Show Open Seals

<mark style="color:blue;">`GET`</mark> `https://sandbox.nlp-institutes.net/api/v0/institutes/seals/{orga}/open`

Show all seals from specific orga that are open, i.e. seals that you have ordered, payed, and not used for&#x20;

#### Path Parameters

| Name   | Type   | Description                                             |
| ------ | ------ | ------------------------------------------------------- |
| {orga} | string | Possible balues are IN, ICI, WHO, In-Me, WSCO or PosPsy |

#### Headers

| Name           | Type   | Description               |
| -------------- | ------ | ------------------------- |
| Authentication | string | Bearer \*\*your-token\*\* |

{% tabs %}
{% tab title="200 " %}

```
[
    {
        "to": 500,
        "from": 311
    },
    {
        "to": 309,
        "from": 300
    }
]
```

{% endtab %}
{% endtabs %}

## Show Qualifications

<mark style="color:blue;">`GET`</mark> `https://sandbox.nlp-institutes.net/api/v0/institutes/qualifications`

This endpoint allows you to see all possible qualifcations

#### Headers

| Name           | Type   | Description                 |
| -------------- | ------ | --------------------------- |
| Accept         | string | <p>application/json<br></p> |
| Authentication | string | Bearer \*\*Your Token\*\*   |

{% tabs %}
{% tab title="200 Cake successfully retrieved." %}

```
[
    {
        "id": 1,
        "name": "'Qualification Name'",
        "alias": "ICI"
    },
    {
        "id": 2,
        "name": "'Other Qualification Name'",
        "alias": "IN"
    },
]
```

{% endtab %}

{% tab title="401 Token not valid" %}

```
{
    "message": "Unauthenticated."
}
```

{% endtab %}
{% endtabs %}

## Add User

<mark style="color:green;">`POST`</mark> `https://sandbox.nlp-institutes.net/api/v0/institutes/users`

This will add a user on our back-end. The user will receive an email soon. Once he confirmes, the user will be visible on our page.

#### Headers

| Name           | Type   | Description               |
| -------------- | ------ | ------------------------- |
| Authentication | string | Bearer \*\*Your Token\*\* |

#### Request Body

| Name            | Type   | Description                                                                                       |
| --------------- | ------ | ------------------------------------------------------------------------------------------------- |
| city            | string | Full name of city.                                                                                |
| gender          | string | Has to be value **f** for female or value **m** for male.                                         |
| qualificationId | number | Id of qualifcation. Has to match an existing qualification See /api/v0/institutes/qualifications. |
| sealNumber      | number | Sealnumber of the user. Has to be bought, unused, and match orga of qualification.                |
| email           | string | Email of user.                                                                                    |
| title           | string | Title like Dr., MSc. etc.                                                                         |
| firstname       | string | Forename of user.                                                                                 |
| lastname        | string | Lastname of user.                                                                                 |
| lang            | string | Language as ISO 639-1, otherwise default language of group upload will be used.                   |
| country         | string | <p>Country in ISO 3166-1 alpha-2<br><br><br><br><br><br></p>                                      |

{% tabs %}
{% tab title="200 Example response if everything goes well" %}

```
{
    "message": "User has been successfully added and will be notified."
}
```

{% endtab %}

{% tab title="422 Example response if required fields are missing or if type is invalid. Note, that there is always a message key, but not always a details key." %}

```
{
    "message": "Invalid data send",
    "details": {
        "gender": [
            "The selected gender is invalid."
        ],
        "firstname": [
            "The firstname field is required."
        ],
        "lastname": [
            "The lastname field is required."
        ],
        "email": [
            "The email field is required."
        ],
        "country": [
            "The country field is required."
        ],
        "sealNumber": [
            "The seal number field is required."
        ],
        "qualificationId": [
            "qualificationId is not a valid qualification id"
        ]
    }
}
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.nlp-institutes.net/master.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.