DOCS

Appearance

Regions ​

Get Regions ​

This fetching all the available regions for the Konnect platform

Method ​

GET

Request Path Authorized ​

/api/Regions/GetRegions

Headers ​

http
tenantId: <tenant-id>
<applicationId: <application-id>

Response ​

Note that not all fields are included in the sample response, only those relevant to these docs

json
[
    {
        "regionId": "<region-id>",
        "fullName": "Name of region",
        "abbreviation": "Abbreviation",
        "uris": [            
            {
                "uriDescriptorId": "<identifier>",
                "name": null,
                "regionId": "<region-id>",
                "isDefault": true,
                "uri": "https://<base-domain-url>/",
                "backupUri": null,
                "type": 3
            }
            ...
        ]
    },
    ...
]

Get Regions For Channel ​

This fetching all the available regions for a specific Channel (Event)

Method ​

GET

Request Path Authorized ​

/api/Regions/GetRegionsForChannel

Headers ​

http
tenantId: <tenant-id>
<applicationId: <application-id>

Query String Parameters ​

http
channelId: <channel-id>

Response ​

Note that not all fields are included in the sample response, only those relevant to these docs

json
[
    {
        "regionId": "<region-id>",
        "fullName": "Name of region",
        "abbreviation": "Abbreviation",
        "uris": [            
            {
                "uriDescriptorId": "<identifier>",
                "name": null,
                "regionId": "<region-id>",
                "isDefault": true,
                "uri": "https://<base-domain-url>/",
                "backupUri": null,
                "type": 3
            }
            ...
        ]
    },
    ...
]