Get List of Calendars with Summary

HTTPS Method

POST

URI

https://<server>/adminapi/calendar?detail=brief

Example URI

https://uccx-server/adminapi/calendar?detail=brief

Content Type

Application/XML, Application/JSON

HTTPS Success Code

200

HTTPS Failure Codes

401,403,406,500

Error Codes

—

Success Response


<calendars>
    <calendar>
        <self>https://uccx-server/adminapi/calendar/1</self>
        <calId>1</calId>
        <name>Calendar1</name>
        <timeZone>Asia/Kolkata</timeZone>
        <description>description</description>
        <calendarType>FLEXIBLEHOURS</calendarType>
        <applications>
            <application name="TestApplication">
                <refURL>https://uccx-server/adminapi/application/TestApplication</refURL>
            </application>
            <application name="TestApp2">
                <refURL>https://uccx-server/adminapi/application/TestApp2</refURL>
            </application>
        </applications>
        <holidaysConfigured>true</holidaysConfigured>
        <customBusinessDaysConfigured>false</customBusinessDaysConfigured>
    </calendar>
    <calendar>
        ........
        ........
    </calendar>
</calendars>

Error Response


<apiErrors>
	<apiError>
		<errorData>{id}</errorData>
		<errorMessage>{error message}</errorMessage>
		<errorType>{error type}</errorType>
		<i18n>
			<key>{error key}</key>
			<args>
				<arg>{value-1}</arg>
				<arg>{value-2}</arg>
			</args>
		</i18n>
	</apiError>
</apiErrors>