Citrix Virtual Apps and Desktops REST APIs

How to get all the timezones supported by the Citrix Virtual Apps and Desktops site

Use REST APIs to get all timezones supported by your Citrix Virtual Apps and Desktops site.

Follow the prerequisites and examples to get started with this API.

You can make API requests using the PowerShell code, C# code, Python, or any tool that supports invoking the REST API.

Prerequisites to get all the supported timezones

Get all the timezones supported in your site using any REST API tool

Learn from the following example to get all the timezones supported in your current Citrix Virtual Apps and Desktops site using any REST API tool.

You can get list the timezones supported by the site as options. Timezone names are represented in the caller’s locale.

Request

GET https://[DdcServerAddress]/cvad/manage/TimeZones/All HTTP/1.1
Accept: application/json
Content-Type: application/json; charset=utf-8
Authorization: CWSAuth bearer=<token-from-prerequisites>
Citrix-CustomerId: loy6oujtu6a4
Citrix-InstanceId: 22ded57c-0306-47e4-b6e8-fed6252759e1
<!--NeedCopy-->

Response

HTTP/1.1 200 OK
citrix-transactionid: 3fcf9f31-8dd9-44c6-bbb0-75daa77f17f4
content-Length: 319
content-Type: application/json; charset=utf-8
date: "Tue, 08 Dec 2020 01:53:08 GMT"
Server: Citrix Systems, Inc.

{
  "Items": [
    {
        "Name": "(UTC+05:30) India Standard Time",
        "FullName": "(UTC+05:30) India Standard Time",
        "Primary": "Asia/Calcutta",
        "Canonical": "Asia/Kolkata",
        "WindowsId": "India Standard Time",
        "UtcOffsetSeconds": 19800,
        "UtcOffset": "+05:30",
        "TzdbIds": [
            "Asia/Calcutta",
            "Asia/Colombo",
            "Asia/Kolkata"
        ]
    },
    ...
  ]
}
<!--NeedCopy-->

Get all the timezones supported in your site using PowerShell

Learn from the following example to get all the timezones supported in your current Citrix Virtual Apps and Desktops site using any PowerShell code.

function GetAllTimeZones {
    param (
        [Parameter(Mandatory=$true)]
        [string] $customerid,
        [Parameter(Mandatory=$true)]
        [string] $siteid,
        [Parameter(Mandatory=$true)]
        [string] $bearerToken
    )
    $requestUri = "https://[DdcServerAddress]/cvad/manage/TimeZones/All"
    $headers = @{
        "Accept" = "application/json";
        "Authorization" = "CWSAuth Bearer $bearerToken";
        "Citrix-CustomerId" = $customerid;
        "Citrix-InstanceId" = $siteid;
    }

    $response = Invoke-RestMethod -Uri $requestUri -Method GET -Headers $headers 
    return $response
}

$customerid = "n2ypkklgy6cv"
$siteid = "12f7438-bf8e-42ba-b1b3-2eb75d098f57"
$bearerToken = "eyJ..."
$response = GetAllTimeZones $customerid $siteid $bearerToken 
<!--NeedCopy-->

Get all the timezones supported in your site using C# code

Learn from the following example to get all the timezones supported in your current Citrix Virtual Apps and Desktops site using any C# code.

public static async Task<string> GetAllTimeZones(
    string customerid,
    string siteid,
    string bearerToken)
{
    var requestUri = "https://[DdcServerAddress]/cvad/manage/TimeZones/All";
    using (var client = new HttpClient())
    {
        client.DefaultRequestHeaders.Accept.ParseAdd("application/json");
        client.DefaultRequestHeaders.Add("Citrix-CustomerId", customerid);
        client.DefaultRequestHeaders.Add("Citrix-InstanceId", siteid);
        client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("CWSAuth Bearer" + bearerToken);

        var response = await client.GetAsync(requestUri);

        if (response != null)
        {
            var content = await response.Content.ReadAsStringAsync();
            return content;
        }

        return null;
    }
}
<!--NeedCopy-->

Get all the timezones supported in your site using Python

Learn from the following example to get all the timezones supported in your current Citrix Virtual Apps and Desktops site using Python.

import requests 

def get_all_time_zones(bearerToken, customerid, siteid):
    request_uri = "https://[DdcServerAddress]/cvad/manage/TimeZones/All"
    headers = {
                'Authorization': 'CWSAuth Bearer %s' % bearerToken,
                'Citrix-CustomerId': customerid,
                'Citrix-InstanceId': siteid,
                'Content-Type': 'application/json',
                'Accept': 'application/json'
              }

    response = requests.get(request_uri, headers = headers)

    return response.json()
<!--NeedCopy-->
Resources
Citrix Virtual Apps and Desktops REST APIs OpenAPI Specification
Copy Download
How to get all the timezones supported by the Citrix Virtual Apps and Desktops site