This API will soon be deprecated. Please use another API.

    Get Details for a Schedule

    Gets details for a specific schedule.

    API Type

    Service API

    Request URL

    https://apis.worksmobile.com/{API ID}/calendar/getScheduleDetail

    HTTP Method

    POST (Content-Type: application/json; charset=UTF-8)

    Request

    Parameter Type Required Description
    calendarId String Y Calendar ID
    scheduleUID String Y Schedule UID

    Request Example

    {
        "calendarId": "1304314",
        "scheduleUID": "20140609T102246Z"
    }
    

    Response

    It returns the value of the "returnValue" property which contains the results when the API call succeeds.

    Property Type Required Description
    result String Y API call success
    returnValue List Y The list of iCalendar data for schedules. It contains single iCalendar data (refer to iCalendar Data Format in the "Schedule" section).

    Response Example

    {
        "result": "success",
    
        "returnValue": ["BEGIN:VCAL....",
                        "BEGIN:VCAL....",
                        "BEGIN:VCAL...."
                        }
    }