# Domain Management

## Domain Management

To use the Domain Management APIs, the calling Domain must be part the Partner Management Group of 3Q. Contact the Support, if this is needed.

## /domains/clonefornetwork

<mark style="color:green;">`POST`</mark> `https://api.nexx.cloud/v3.1/manage/domains/clonefornetwork`

#### Request Body

| Name                                          | Type   | Description                                                                          |
| --------------------------------------------- | ------ | ------------------------------------------------------------------------------------ |
| title<mark style="color:red;">\*</mark>       | string | the Title of the new registered Domain                                               |
| url<mark style="color:red;">\*</mark>         | string | the URL of the new registered Domain                                                 |
| networkmode<mark style="color:red;">\*</mark> | string | \[mixed, master, own, all] defines the Rights on Network Contents for the new Domain |
| refnr                                         | string | an internal Reference Number of the Client                                           |

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

```
```

{% endtab %}
{% endtabs %}

## /domains/:domainid/markfordeletion

<mark style="color:red;">`DELETE`</mark> `https://api.nexx.cloud/v3.1/manage/domains/:domainid/markfordeletion`

will mark the given Domain for Deletion. The given Domain cannot be the calling Domain and must be part of the same Network. Contents of the target Domain will not be deleted.

#### Path Parameters

| Name                                       | Type    | Description                                            |
| ------------------------------------------ | ------- | ------------------------------------------------------ |
| domainid<mark style="color:red;">\*</mark> | integer | a valid Domain ID of the Network of the calling Domain |

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

```
```

{% endtab %}
{% endtabs %}

## Domain References

Domain References handles Objects and Structures, that are not considered as "Media", but belong to the Domain and serve as References.

## /channels/add

<mark style="color:green;">`POST`</mark> `https://api.nexx.cloud/v3.1/manage/channels/add`

all Parameters of the **/channels/update** Methods are supported.

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

```
```

{% endtab %}
{% endtabs %}

## /channels/:channelid/update

<mark style="color:orange;">`PUT`</mark> `https://api.nexx.cloud/v3.1/manage/channels/:channelid/update`

#### Path Parameters

| Name                                        | Type    | Description                               |
| ------------------------------------------- | ------- | ----------------------------------------- |
| channelid<mark style="color:red;">\*</mark> | integer | the ID of a Channel of the calling Domain |

#### Request Body

| Name                                    | Type    | Description                                                                               |
| --------------------------------------- | ------- | ----------------------------------------------------------------------------------------- |
| title<mark style="color:red;">\*</mark> | string  |                                                                                           |
| subtitle                                | string  |                                                                                           |
| refnr                                   | string  |                                                                                           |
| teaser                                  | string  |                                                                                           |
| description                             | string  |                                                                                           |
| parent                                  | integer | if the Channel shall be a Sub Channel of a parent Channel, add the parent Channel ID here |
| pos                                     | integer | an optional Sorting Parameter for publically visible Channels                             |
| color                                   | string  |                                                                                           |

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

```
```

{% endtab %}
{% endtabs %}

## /channels/:channelid/cover

<mark style="color:green;">`POST`</mark> `https://api.nexx.cloud/v3.1/manage/channels/:channelid/cover`

&#x20;&#x20;

#### Path Parameters

| Name                                        | Type    | Description                               |
| ------------------------------------------- | ------- | ----------------------------------------- |
| channelid<mark style="color:red;">\*</mark> | integer | the ID of a Channel of the calling Domain |

#### Query Parameters

| Name                                  | Type    | Description                                                                                                                                    |
| ------------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| url<mark style="color:red;">\*</mark> | String  | the URL to the Image, that should be used as Cover                                                                                             |
| description                           | String  | an optional Description of the Cover                                                                                                           |
| assetLanguage                         | string  | if the Domain supports MultiLanguage Assets, this Cover will be used only in Contexts with this given Language and not override the main Cover |
| copyright                             | String  | an optional Copyright for the Cover                                                                                                            |
| isAIGenerated                         | \[0, 1] | if set to 1, the System will assume, that this Asset has been created by an AI.                                                                |

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

{% endtab %}
{% endtabs %}

## /channels/:channelid/actionshot

<mark style="color:green;">`POST`</mark> `https://api.nexx.cloud/v3.1/manage/channels/actionshot`

&#x20;&#x20;

#### Path Parameters

| Name                                        | Type    | Description                               |
| ------------------------------------------- | ------- | ----------------------------------------- |
| channelid<mark style="color:red;">\*</mark> | integer | the ID of a Channel of the calling Domain |

#### Query Parameters

| Name                                  | Type    | Description                                                                                                                                    |
| ------------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| url<mark style="color:red;">\*</mark> | String  | the URL to the Image, that should be used as ActionShot                                                                                        |
| description                           | String  | an optional Description of the Cover                                                                                                           |
| assetLanguage                         | String  | if the Domain supports MultiLanguage Assets, this Cover will be used only in Contexts with this given Language and not override the main Cover |
| copyright                             | String  | an optional Copyright for the Cover.                                                                                                           |
| isAIGenerated                         | \[0, 1] | if set to 1, the System will assume, that this Asset has been created by an AI.                                                                |

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

{% endtab %}
{% endtabs %}

## /channels/:channelid/remove

<mark style="color:red;">`DELETE`</mark> `https://api.nexx.cloud/v3.1/manage/channels/:channelid/remove`

#### Path Parameters

| Name                                        | Type    | Description                               |
| ------------------------------------------- | ------- | ----------------------------------------- |
| channelid<mark style="color:red;">\*</mark> | integer | the ID of a Channel of the calling Domain |

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

```
```

{% endtab %}
{% endtabs %}

## /formats/add

<mark style="color:green;">`POST`</mark> `https://api.nexx.cloud/v3.1/manage/formats/add`

all Parameters of the **/formats/update** Methods are supported.

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

```
```

{% endtab %}
{% endtabs %}

## /formats/:formatid/update

<mark style="color:orange;">`PUT`</mark> `https://api.nexx.cloud/v3.1/manage/formats/:formatid/update`

#### Path Parameters

| Name     | Type    | Description                               |
| -------- | ------- | ----------------------------------------- |
| formatid | integer | the ID of a Channel of the calling Domain |

#### Request Body

| Name                                    | Type   | Description |
| --------------------------------------- | ------ | ----------- |
| title<mark style="color:red;">\*</mark> | string |             |
| subtitle                                | string |             |
| refnr                                   | string |             |
| teaser                                  | string |             |
| description                             | string |             |

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

```
```

{% endtab %}
{% endtabs %}

## /formats/:formatid/cover

<mark style="color:green;">`POST`</mark> `https://api.nexx.cloud/v3.1/manage/formats/:formatid/cover`

&#x20;&#x20;

#### Path Parameters

| Name                                       | Type    | Description                              |
| ------------------------------------------ | ------- | ---------------------------------------- |
| formatid<mark style="color:red;">\*</mark> | integer | the ID of a Format of the calling Domain |

#### Query Parameters

| Name                                  | Type    | Description                                                                                                                                    |
| ------------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| url<mark style="color:red;">\*</mark> | String  | the URL to the Image, that should be used as Cover                                                                                             |
| description                           | String  | an optional Description of the Cover                                                                                                           |
| assetLanguage                         | String  | if the Domain supports MultiLanguage Assets, this Cover will be used only in Contexts with this given Language and not override the main Cover |
| copyright                             | String  | an optional Copyright for the Cover.                                                                                                           |
| isAIGenerated                         | \[0, 1] | if set to 1, the System will assume, that this Asset has been created by an AI.                                                                |

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

{% endtab %}
{% endtabs %}

## /formats/:formatid/actionshot

<mark style="color:green;">`POST`</mark> `https://api.nexx.cloud/v3.1/manage/formats/:formatid/actionshot`

&#x20;&#x20;

#### Path Parameters

| Name                                       | Type    | Description                              |
| ------------------------------------------ | ------- | ---------------------------------------- |
| formatid<mark style="color:red;">\*</mark> | integer | the ID of a Format of the calling Domain |

#### Query Parameters

| Name                                  | Type    | Description                                                                                                                                    |
| ------------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| url<mark style="color:red;">\*</mark> | String  | the URL to the Image, that should be used as Cover                                                                                             |
| description                           | String  | an optional Description of the Cover                                                                                                           |
| assetLanguage                         | String  | if the Domain supports MultiLanguage Assets, this Cover will be used only in Contexts with this given Language and not override the main Cover |
| copyright                             | String  | an optional Copyright for the Cover                                                                                                            |
| isAIGenerated                         | \[0, 1] | if set to 1, the System will assume, that this Asset has been created by an AI.                                                                |

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

{% endtab %}
{% endtabs %}

## /formats/:formatid/remove

<mark style="color:red;">`DELETE`</mark> `https://api.nexx.cloud/v3.1/manage/formats/:formatid/remove`

#### Path Parameters

| Name      | Type    | Description                               |
| --------- | ------- | ----------------------------------------- |
| channelid | integer | the ID of a Channel of the calling Domain |

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

```
```

{% endtab %}
{% endtabs %}

## /:streamtypecategories/add

<mark style="color:green;">`POST`</mark> `https://api.nexx.cloud/v3.1/manage/:streamtypecategories/add`

all Parameters of the **/channels/update** Methods are supported.

#### Path Parameters

| Name                                                   | Type   | Description                                                                                                                                  |
| ------------------------------------------------------ | ------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
| streamtypecategories<mark style="color:red;">\*</mark> | string | \[videocategories, audiocategories, imagecategories, filecategories, articlecategories, eventcategories, placecategories, productcategories] |

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

```
```

{% endtab %}
{% endtabs %}

## /:streamtypecategories/:categoryid/update

<mark style="color:orange;">`PUT`</mark> `https://api.nexx.cloud/v3.1/manage/:streamtypecategories/:categoryid/update`

#### Path Parameters

| Name                                                   | Type    | Description                                                                                                                                  |
| ------------------------------------------------------ | ------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| streamtypecategories<mark style="color:red;">\*</mark> | string  | \[videocategories, audiocategories, imagecategories, filecategories, articlecategories, eventcategories, placecategories, productcategories] |
| categoryid<mark style="color:red;">\*</mark>           | integer | the ID of a Category of the given Type of the calling Domain                                                                                 |

#### Request Body

| Name                                    | Type   | Description                     |
| --------------------------------------- | ------ | ------------------------------- |
| title<mark style="color:red;">\*</mark> | string |                                 |
| subtitle                                | string |                                 |
| color                                   | string | only valid for Event Categories |

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

```
```

{% endtab %}
{% endtabs %}

## /:streamtypecategories/:categoryid/cover

<mark style="color:green;">`POST`</mark> `https://api.nexx.cloud/v3.1/manage/:streamtypecategories/:categoryid/cover`

&#x20;&#x20;

#### Path Parameters

| Name                                                   | Type    | Description                                                                                                                                  |
| ------------------------------------------------------ | ------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| categoryid<mark style="color:red;">\*</mark>           | integer | the ID of a Category of the given Type of the calling Domain                                                                                 |
| streamtypecategories<mark style="color:red;">\*</mark> | String  | \[videocategories, audiocategories, imagecategories, filecategories, articlecategories, eventcategories, placecategories, productcategories] |

#### Query Parameters

| Name                                  | Type   | Description                                                                                                                                    |
| ------------------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| url<mark style="color:red;">\*</mark> | String | the URL to the Image, that should be used as Cover                                                                                             |
| description                           | String | an optional Description of the Cover                                                                                                           |
| assetLanguage                         | String | if the Domain supports MultiLanguage Assets, this Cover will be used only in Contexts with this given Language and not override the main Cover |
| copyright                             | String | an optional Copyright of the Cover                                                                                                             |

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

{% endtab %}
{% endtabs %}

## /:streamtypecategories/:categoryid/remove

<mark style="color:red;">`DELETE`</mark> `https://api.nexx.cloud/v3.1/manage/:streamtypecategories/:categoryid/remove`

#### Path Parameters

| Name                                                   | Type    | Description                                                                                                                                  |
| ------------------------------------------------------ | ------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| streamtypecategories<mark style="color:red;">\*</mark> | string  | \[videocategories, audiocategories, imagecategories, filecategories, articlecategories, eventcategories, placecategories, productcategories] |
| categoryid<mark style="color:red;">\*</mark>           | integer | the ID of a Category of the given Type of the calling Domain                                                                                 |

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

```
```

{% endtab %}
{% endtabs %}

## UploadLinks

UploadsLinks are dynamic URLs, that allow external Users to upload Files to a specific nexxOMNIA Account.

## /uploadlinks/add

<mark style="color:green;">`POST`</mark> `https://api.nexx.cloud/v3.1/manage/uploadlinks/add`

#### Request Body

| Name                                                  | Type    | Description                                                                                                         |
| ----------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------- |
| title<mark style="color:red;">\*</mark>               | string  | a Title for the new UploadLink                                                                                      |
| selectedStreamtypes<mark style="color:red;">\*</mark> | string  | a comma-seperated List of Streamtypes, that can be uploaded via this Link. Possible is \[video, audio, image, file] |
| language<mark style="color:red;">\*</mark>            | string  | a 2-Letter coded Language for the Frontend. Currently supported is \[de, en, es, fr]                                |
| maxUsages                                             | integer | if the UploadLink shall be restricted in Usage, use this Parameter for the maximal Number of Usages.                |
| code                                                  | string  | if desired, an optional code for further Protection of the Link.                                                    |
| useDomainStyle                                        | boolean | if set to 1, the UploadLink UI will use the target Domain Colors and Icons.                                         |
| askForNotes                                           | boolean | if set to 1, the UploadLink will force the User to add some "Notes" as addiitonal Info for this Upload              |

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

```
```

{% endtab %}
{% endtabs %}

## /uploadlinks/:uploadlinkid/remove

<mark style="color:red;">`DELETE`</mark> `https://api.nexx.cloud/v3.1/manage/uploadlinks/:uploadlinkid/remove`

#### Path Parameters

| Name         | Type    | Description                                   |
| ------------ | ------- | --------------------------------------------- |
| uploadlinkid | integer | the ID of an UploadLink of the calling Domain |

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

```
```

{% endtab %}
{% endtabs %}