cancel
Showing results for 
Search instead for 
Did you mean: 
cancel
1638
Views
0
Helpful
1
Replies

How to get list of TimeZones, Country/region, locale, language .

Need following information.

1) Is filter supported in LstsummaryUser?

2) If the user is modified, does any attribute gets updated with timestamp (last modification time)

3) How to get list of TimeZones, Country/region, locale, language .

1 Accepted Solution

Accepted Solutions

ryanhunt
Level 5
Level 5

Hi Sandeep,

1. Yes, you can filter LstsummaryUser to some degree. Let me know what type of filtering you’re looking for or see Figure 3-20 • Schema diagram for lstsummaryUserhttps://developer.cisco.com/site/webex-developer/develop-test/xml-api/xml-api-reference/#lstsummaryuser

Example:

<?xml version="1.0" encoding="UTF-8"?>

<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

    <header>

        <securityContext>

            <webExID>USERNAME</webExID>

            <password>PASSWORD</password>

            <siteName>SITENAME</siteName>

            <returnAdditionalInfo>true</returnAdditionalInfo>

        </securityContext>

    </header>

    <body>

        <bodyContent

            xsi:type="java:com.webex.service.binding.user.LstsummaryUser">

            <listControl>

                <serv:startFrom>1</serv:startFrom>

                <serv:maximumNum>1</serv:maximumNum>

                <serv:listMethod>AND</serv:listMethod>

            </listControl>

            <order>

                <orderBy>UID</orderBy>

                <orderAD>ASC</orderAD>

            </order>

            <dataScope>

                <regDateStart>06/23/2015 01:00:00</regDateStart>

                <regDateEnd>06/23/2016 10:00:00</regDateEnd>

            </dataScope>

        </bodyContent>

    </body>

</serv:message>

Example response:

<?xml version="1.0" encoding="UTF-8"?>

<serv:message>

  <serv:header>

    <serv:response>

      <serv:result>SUCCESS</serv:result>

      <serv:gsbStatus>PRIMARY</serv:gsbStatus>

      <serv:respTime>218</serv:respTime>

      <serv:caseID>xtatc001.webex.com 20160624183853</serv:caseID>

    </serv:response>

  </serv:header>

  <serv:body>

    <serv:bodyContent xsi:type="use:lstsummaryUserResponse">

      <use:user>

        <use:webExId>WEBEXID</use:webExId>

        <use:firstName>FNAME</use:firstName>

        <use:lastName>LNAME</use:lastName>

        <use:email>email@domain.com</use:email>

        <use:registrationDate>08/17/2015 16:15:04</use:registrationDate>

        <use:active>ACTIVATED</use:active>

        <use:timeZoneID>6</use:timeZoneID>

      </use:user>

      <use:matchingRecords>

        <serv:total>106</serv:total>

        <serv:returned>1</serv:returned>

        <serv:startFrom>1</serv:startFrom>

      </use:matchingRecords>

    </serv:bodyContent>

  </serv:body>

</serv:message>

2. No, there are no incremental update timestamps.

3. A. A list of time zones can be obtained with LstTimeZone: https://developer.cisco.com/site/webex-developer/develop-test/xml-api/xml-api-reference/#lsttimezone

    B. Country list isn’t available via API at this time, but I’ve attached a CSV file that lists all of our country codes and the friendly names. Please note that there is currently a defect awaiting a production fix  in which the country code returned may be incomplete (depending on whether country was set via XML API CreateUser/SetUser or via page UI, countries with sub codes, ie. 1_13 for Jamaica may return as just 1, which would normally be United States of America). We should see a fix to this in the next month or two.

    C. Locale/Language can be accessed on the site level using GetSite (returns site default) and on the user level via GetUser (returns values for a specific user, may differ from site default).

GetSite:

<?xml version="1.0" encoding="UTF-8"?>

<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

    <header>

        <securityContext>

            <webExID>USERNAME</webExID>

            <password>PASSWORD</password>

            <siteName>SITENAME</siteName>

            <returnAdditionalInfo>true</returnAdditionalInfo>

        </securityContext>

    </header>

    <body>

        <bodyContent

            xsi:type="java:com.webex.service.binding.site.GetSite">

        </bodyContent>

    </body>

</serv:message>

Example response (truncated to just the relevant data):

<?xml version="1.0" encoding="UTF-8"?>

<serv:message>

  <serv:header>

    <serv:response>

      <serv:result>SUCCESS</serv:result>

      <serv:gsbStatus>PRIMARY</serv:gsbStatus>

      <serv:respTime>180</serv:respTime>

      <serv:caseID>xtatc011.webex.com 20160624184537</serv:caseID>

    </serv:response>

  </serv:header>

  <serv:body>

    <serv:bodyContent xsi:type="ns1:getSiteResponse">

      <ns1:siteInstance>

        <ns1:metaData>

          <ns1:region>U.S.</ns1:region>

          <ns1:currency>US Dollars</ns1:currency>

          <ns1:timeZoneID>4</ns1:timeZoneID>

          <ns1:timeZone>GMT-08:00, Pacific (San Jose)</ns1:timeZone>

          <ns1:parterID>241ac</ns1:parterID>

          <ns1:webDomain>djwd</ns1:webDomain>

          <ns1:meetingDomain>ed1vamd</ns1:meetingDomain>

          <ns1:telephonyDomain>acme_tsp_hybrid_djwd</ns1:telephonyDomain>

          <ns1:pageVersion>T31L</ns1:pageVersion>

          <ns1:clientVersion>T31L</ns1:clientVersion>

         <ns1:pageLanguage>ENGLISH</ns1:pageLanguage>

          <ns1:activateStatus>true</ns1:activateStatus>

          <ns1:webPageType>J2EE</ns1:webPageType>

          <ns1:iCalendar>true</ns1:iCalendar>

          <ns1:myWebExDefaultPage>My Meetings</ns1:myWebExDefaultPage>

          <ns1:componentVersion>cmp3100</ns1:componentVersion>

          <ns1:displayMeetingActualTime>false</ns1:displayMeetingActualTime>

          <ns1:displayOffset>true</ns1:displayOffset>

          <ns1:supportWebEx11>false</ns1:supportWebEx11>

        </ns1:metaData>

        ...

    </serv:bodyContent>

  </serv:body>

</serv:message>

GetUser:

<?xml version="1.0" encoding="UTF-8"?>

<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

    <header>

        <securityContext>

            <webExID>USERNAME</webExID>

            <password>PASSWORD</password>

            <siteName>SITENAME</siteName>

            <returnAdditionalInfo>true</returnAdditionalInfo>

        </securityContext>

    </header>

    <body>

        <bodyContent

            xsi:type="java:com.webex.service.binding.user.GetUser">

           <webExId>USERNAME</webExId>

        </bodyContent>

    </body>

</serv:message>

Example response (truncated to relevant data):

<?xml version="1.0" encoding="UTF-8"?>

<serv:message>

  <serv:header>

    <serv:response>

      <serv:result>SUCCESS</serv:result>

      <serv:gsbStatus>PRIMARY</serv:gsbStatus>

      <serv:respTime>193</serv:respTime>

      <serv:caseID>xtatc006.webex.com 20160624185103</serv:caseID>

    </serv:response>

  </serv:header>

  <serv:body>

    <serv:bodyContent xsi:type="use:getUserResponse">

      <use:firstName>FNAME</use:firstName>

      <use:lastName>LNAME</use:lastName>

      ...

      <use:webExId>WEBEXID</use:webExId>

      <use:address>

        <com:addressType>PERSONAL</com:addressType>

        <com:address1>Test</com:address1>

        <com:address2>Test2</com:address2>

        <com:city>CITY</com:city>

        <com:state>CA</com:state>

        <com:zipCode>#####</com:zipCode>

       <com:country>39_1</com:country>

      </use:address>

      ...

      <use:email>email@domain.com</use:email>

      <use:password>******</use:password>

      <use:personalUrl>PMRROOMNAME</use:personalUrl>

      <use:expirationDate>12/31/2049 15:59:59</use:expirationDate>

      ...

      <use:timeZoneID>4</use:timeZoneID>

      <use:timeZone>GMT-08:00, Pacific (San Jose)</use:timeZone>

      <use:timeZoneWithDST>San Francisco (Pacific Daylight Time, GMT-07:00)</use:timeZoneWithDST>

      ...

      <use:language>ENGLISH</use:language>

      <use:locale>U.S.</use:locale>

      ...

    </serv:bodyContent>

  </serv:body>

</serv:message>

View solution in original post

1 Reply 1

ryanhunt
Level 5
Level 5

Hi Sandeep,

1. Yes, you can filter LstsummaryUser to some degree. Let me know what type of filtering you’re looking for or see Figure 3-20 • Schema diagram for lstsummaryUserhttps://developer.cisco.com/site/webex-developer/develop-test/xml-api/xml-api-reference/#lstsummaryuser

Example:

<?xml version="1.0" encoding="UTF-8"?>

<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

    <header>

        <securityContext>

            <webExID>USERNAME</webExID>

            <password>PASSWORD</password>

            <siteName>SITENAME</siteName>

            <returnAdditionalInfo>true</returnAdditionalInfo>

        </securityContext>

    </header>

    <body>

        <bodyContent

            xsi:type="java:com.webex.service.binding.user.LstsummaryUser">

            <listControl>

                <serv:startFrom>1</serv:startFrom>

                <serv:maximumNum>1</serv:maximumNum>

                <serv:listMethod>AND</serv:listMethod>

            </listControl>

            <order>

                <orderBy>UID</orderBy>

                <orderAD>ASC</orderAD>

            </order>

            <dataScope>

                <regDateStart>06/23/2015 01:00:00</regDateStart>

                <regDateEnd>06/23/2016 10:00:00</regDateEnd>

            </dataScope>

        </bodyContent>

    </body>

</serv:message>

Example response:

<?xml version="1.0" encoding="UTF-8"?>

<serv:message>

  <serv:header>

    <serv:response>

      <serv:result>SUCCESS</serv:result>

      <serv:gsbStatus>PRIMARY</serv:gsbStatus>

      <serv:respTime>218</serv:respTime>

      <serv:caseID>xtatc001.webex.com 20160624183853</serv:caseID>

    </serv:response>

  </serv:header>

  <serv:body>

    <serv:bodyContent xsi:type="use:lstsummaryUserResponse">

      <use:user>

        <use:webExId>WEBEXID</use:webExId>

        <use:firstName>FNAME</use:firstName>

        <use:lastName>LNAME</use:lastName>

        <use:email>email@domain.com</use:email>

        <use:registrationDate>08/17/2015 16:15:04</use:registrationDate>

        <use:active>ACTIVATED</use:active>

        <use:timeZoneID>6</use:timeZoneID>

      </use:user>

      <use:matchingRecords>

        <serv:total>106</serv:total>

        <serv:returned>1</serv:returned>

        <serv:startFrom>1</serv:startFrom>

      </use:matchingRecords>

    </serv:bodyContent>

  </serv:body>

</serv:message>

2. No, there are no incremental update timestamps.

3. A. A list of time zones can be obtained with LstTimeZone: https://developer.cisco.com/site/webex-developer/develop-test/xml-api/xml-api-reference/#lsttimezone

    B. Country list isn’t available via API at this time, but I’ve attached a CSV file that lists all of our country codes and the friendly names. Please note that there is currently a defect awaiting a production fix  in which the country code returned may be incomplete (depending on whether country was set via XML API CreateUser/SetUser or via page UI, countries with sub codes, ie. 1_13 for Jamaica may return as just 1, which would normally be United States of America). We should see a fix to this in the next month or two.

    C. Locale/Language can be accessed on the site level using GetSite (returns site default) and on the user level via GetUser (returns values for a specific user, may differ from site default).

GetSite:

<?xml version="1.0" encoding="UTF-8"?>

<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

    <header>

        <securityContext>

            <webExID>USERNAME</webExID>

            <password>PASSWORD</password>

            <siteName>SITENAME</siteName>

            <returnAdditionalInfo>true</returnAdditionalInfo>

        </securityContext>

    </header>

    <body>

        <bodyContent

            xsi:type="java:com.webex.service.binding.site.GetSite">

        </bodyContent>

    </body>

</serv:message>

Example response (truncated to just the relevant data):

<?xml version="1.0" encoding="UTF-8"?>

<serv:message>

  <serv:header>

    <serv:response>

      <serv:result>SUCCESS</serv:result>

      <serv:gsbStatus>PRIMARY</serv:gsbStatus>

      <serv:respTime>180</serv:respTime>

      <serv:caseID>xtatc011.webex.com 20160624184537</serv:caseID>

    </serv:response>

  </serv:header>

  <serv:body>

    <serv:bodyContent xsi:type="ns1:getSiteResponse">

      <ns1:siteInstance>

        <ns1:metaData>

          <ns1:region>U.S.</ns1:region>

          <ns1:currency>US Dollars</ns1:currency>

          <ns1:timeZoneID>4</ns1:timeZoneID>

          <ns1:timeZone>GMT-08:00, Pacific (San Jose)</ns1:timeZone>

          <ns1:parterID>241ac</ns1:parterID>

          <ns1:webDomain>djwd</ns1:webDomain>

          <ns1:meetingDomain>ed1vamd</ns1:meetingDomain>

          <ns1:telephonyDomain>acme_tsp_hybrid_djwd</ns1:telephonyDomain>

          <ns1:pageVersion>T31L</ns1:pageVersion>

          <ns1:clientVersion>T31L</ns1:clientVersion>

         <ns1:pageLanguage>ENGLISH</ns1:pageLanguage>

          <ns1:activateStatus>true</ns1:activateStatus>

          <ns1:webPageType>J2EE</ns1:webPageType>

          <ns1:iCalendar>true</ns1:iCalendar>

          <ns1:myWebExDefaultPage>My Meetings</ns1:myWebExDefaultPage>

          <ns1:componentVersion>cmp3100</ns1:componentVersion>

          <ns1:displayMeetingActualTime>false</ns1:displayMeetingActualTime>

          <ns1:displayOffset>true</ns1:displayOffset>

          <ns1:supportWebEx11>false</ns1:supportWebEx11>

        </ns1:metaData>

        ...

    </serv:bodyContent>

  </serv:body>

</serv:message>

GetUser:

<?xml version="1.0" encoding="UTF-8"?>

<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

    <header>

        <securityContext>

            <webExID>USERNAME</webExID>

            <password>PASSWORD</password>

            <siteName>SITENAME</siteName>

            <returnAdditionalInfo>true</returnAdditionalInfo>

        </securityContext>

    </header>

    <body>

        <bodyContent

            xsi:type="java:com.webex.service.binding.user.GetUser">

           <webExId>USERNAME</webExId>

        </bodyContent>

    </body>

</serv:message>

Example response (truncated to relevant data):

<?xml version="1.0" encoding="UTF-8"?>

<serv:message>

  <serv:header>

    <serv:response>

      <serv:result>SUCCESS</serv:result>

      <serv:gsbStatus>PRIMARY</serv:gsbStatus>

      <serv:respTime>193</serv:respTime>

      <serv:caseID>xtatc006.webex.com 20160624185103</serv:caseID>

    </serv:response>

  </serv:header>

  <serv:body>

    <serv:bodyContent xsi:type="use:getUserResponse">

      <use:firstName>FNAME</use:firstName>

      <use:lastName>LNAME</use:lastName>

      ...

      <use:webExId>WEBEXID</use:webExId>

      <use:address>

        <com:addressType>PERSONAL</com:addressType>

        <com:address1>Test</com:address1>

        <com:address2>Test2</com:address2>

        <com:city>CITY</com:city>

        <com:state>CA</com:state>

        <com:zipCode>#####</com:zipCode>

       <com:country>39_1</com:country>

      </use:address>

      ...

      <use:email>email@domain.com</use:email>

      <use:password>******</use:password>

      <use:personalUrl>PMRROOMNAME</use:personalUrl>

      <use:expirationDate>12/31/2049 15:59:59</use:expirationDate>

      ...

      <use:timeZoneID>4</use:timeZoneID>

      <use:timeZone>GMT-08:00, Pacific (San Jose)</use:timeZone>

      <use:timeZoneWithDST>San Francisco (Pacific Daylight Time, GMT-07:00)</use:timeZoneWithDST>

      ...

      <use:language>ENGLISH</use:language>

      <use:locale>U.S.</use:locale>

      ...

    </serv:bodyContent>

  </serv:body>

</serv:message>