> For the complete documentation index, see [llms.txt](https://docs.venuzle.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.venuzle.com/manager-api/internal-endpoints/partner/operators.md).

# Operators

Endpoints to work with the operators of a partner.

{% hint style="info" %}
The response example for some endpoints is missing and will be added later.
{% endhint %}

## Get operators

<mark style="color:blue;">`GET`</mark> `/api/internal/v1/partners/:partner_id/operators`

Get the operators of a partner.\
\
An authenticated user with permission `operators.read` and partner access is required.

#### Path Parameters

| Name        | Type    | Description            |
| ----------- | ------- | ---------------------- |
| partner\_id | integer | The id of the partner. |

#### Query Parameters

| Name      | Type    | Description                                      |
| --------- | ------- | ------------------------------------------------ |
| page      | integer | The page to display.                             |
| per\_page | integer | How many operators to return per page.           |
| search    | string  | Filter operators by their name or email address. |

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

```
```

{% endtab %}
{% endtabs %}

## Get all operators simplified

<mark style="color:blue;">`GET`</mark> `/api/internal/v1/partners/:partner_id/operators/simplified`

#### Path Parameters

| Name        | Type    | Description            |
| ----------- | ------- | ---------------------- |
| partner\_id | integer | The ID of the partner. |

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

```
```

{% endtab %}
{% endtabs %}

## Get operator

<mark style="color:blue;">`GET`</mark> `/api/internal/v1/partners/:partner_id/operators/:operator_id`

Get operator by id.\
\
An authenticated user with permission `operators.read` and partner access is required.

#### Path Parameters

| Name         | Type    | Description                                      |
| ------------ | ------- | ------------------------------------------------ |
| operator\_id | integer | The id of the operator that should be retrieved. |
| partner\_id  | integer | The id of the partner.                           |

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

```
```

{% endtab %}
{% endtabs %}

## Create operator

<mark style="color:green;">`POST`</mark> `/api/internal/v1/partners/:partner_id/operators`

Create a new operator.\
\
An authenticated user with permission `operators.created` and partner access is required.

#### Path Parameters

| Name        | Type    | Description            |
| ----------- | ------- | ---------------------- |
| partner\_id | integer | The id of the partner. |

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

```
```

{% endtab %}
{% endtabs %}

## Update operator

<mark style="color:orange;">`PUT`</mark> `/api/internal/v1/partners/:partner_id/operators/:operator_id`

Update the given operator.\
\
An authenticated user with permission `operators.update` and partner access is required.

#### Path Parameters

| Name         | Type    | Description                                    |
| ------------ | ------- | ---------------------------------------------- |
| operator\_id | integer | The id of the operator that should be updated. |
| partner\_id  | integer | The id of the partner.                         |

#### Request Body

| Name                                 | Type    | Description                                                                                                                                                                                                            |
| ------------------------------------ | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| name                                 | string  | The name of the operator.                                                                                                                                                                                              |
| email                                | string  | The email address of the operator.                                                                                                                                                                                     |
| website                              | string  | The operator website address.                                                                                                                                                                                          |
| fiscal\_details.uid                  | string  | Operator UID.                                                                                                                                                                                                          |
| fiscal\_details.fn                   | string  | Operator FN.                                                                                                                                                                                                           |
| fiscal\_details.zvr                  | string  | Operator ZVR.                                                                                                                                                                                                          |
| fiscal\_details.dvr                  | string  | Operator DVR.                                                                                                                                                                                                          |
| phone\_number.prefix                 | number  | The prefix of the phone number. Required if the `phone_number.number` is present.                                                                                                                                      |
| phone\_number.number                 | number  | The number of the phone number. Required if the `phone_number.prefix` is present.                                                                                                                                      |
| fax\_number.prefix                   | number  | The prefix of the fax number. Required if `fax_number.number` if present.                                                                                                                                              |
| fax\_number.number                   | number  | The number of the fax number. Required if `fax_number.prefix` is present.                                                                                                                                              |
| contact\_person.first\_name          | string  | The first name of the contact person. Required if any of the following are present: `contact_person.last_name`, `contact_person.email`.                                                                                |
| contact\_person.last\_name           | string  | The last name of the contact person. Required if any of the following are present: `contact_person.first_name`, `contact_person.email`.                                                                                |
| contact\_person.email                | string  | The email address of the contact person. Required if any of the following are present: `contact_person.first_name`, `contact_person.last_name`.                                                                        |
| contact\_person.gender               | number  | The gender of the contact person. Allowed values: `0`, `1`, and `2`. For more info: <https://en.wikipedia.org/wiki/ISO/IEC\\_5218>                                                                                     |
| contact\_person.phone\_number.prefix | number  | The prefix of the contact person's phone number. Required if `contact_person.phone_number.number` is present.                                                                                                          |
| contact\_person.phone\_number.number | number  | The number of the contact person's phone number. Required if `contact_person.phone_number.prefix` is present.                                                                                                          |
| address.country\_id                  | integer | The id of the address country. Required if any of the following are present: `address.state_id`, `address.post_code`, `address.street_name`, `address.street_number`, `address.additional_information`                 |
| address.state\_id                    | integer | The id of the address state. Required if any of the following are present: `address.country_id`, `address.post_code`, `address.street_name`, `address.street_number`, `address.additional_information`                 |
| address.city                         | string  | The city of the address. Required if any of the following are present: `address.country_id`, `address.state_id`, `address.post_code`, `address.street_name`, `address.street_number`, `address.additional_information` |
| address.post\_code                   | string  | The post code of the address. Required if any of the following are present: `address.country_id`, `address.state_id`, `address.city`, `address.street_name`, `address.street_number`, `address.additional_information` |
| address.street\_name                 | string  | The street name of the address. Required if any of the following are present: `address.country_id`, `address.street_number`, `address.post_code`, `address.city`, `address.state_id`, `address.country_id`             |
| address.street\_number               | string  | The street number of the address.                                                                                                                                                                                      |
| address.additional\_information      | string  | String with additional information about the address location.                                                                                                                                                         |

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

```
```

{% endtab %}
{% endtabs %}

<mark style="color:orange;">`PUT`</mark> `/api/internal/v1/partners/:partner_id/operators/:operator_id`

#### Request Body

| Name                 | Type   | Description                                                                                                                  |
| -------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------- |
| address.street\_name | string | `address.country_id`, `address.street_number`, `address.post_code`, `address.city`, `address.state_id`, `address.country_id` |

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

```
```

{% endtab %}
{% endtabs %}

## Delete operator

<mark style="color:red;">`DELETE`</mark> `/api/internal/v1/partners/:partner_id/operators/:operator_id`

Delete the given operator.

#### Path Parameters

| Name         | Type    | Description                           |
| ------------ | ------- | ------------------------------------- |
| partner\_id  | integer | The ID of the partner.                |
| operator\_id | integer | The ID of the operator being deleted. |

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

```
```

{% endtab %}
{% endtabs %}