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

    Get Sharing

    Gets a list of participants who have permission to use the calendar.

    API Type

    Service API

    Request URL

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

    HTTP Method

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

    Request

    Parameter Type Required Description
    calendarId String Y Calendar ID to get participants of

    Request Example

    {
      "calendarId": "1868022"
    }
    

    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 String Y The list of result values returned by the "Get a Calendar" API call.
    Use the email, userId, and role (Permission Details map).
        calendarId String Y The calendar ID to get participants of.
        responseDate String Y Response date
        calendarName String Y The calendar name to get participants of
        invitationDate String Y Invitation date
         email String Y Participant's email address
         userId String Y Participant ID
         role Map Y Calendar roles
    ● master: Master who can add/modify/remove/view events, manage participants, close, and transfer calendars. It corresponds to Calendar master in the Calendar service.
    ● staff: Manager who can add/modify/remove/view events and manage participants. It corresponds to Manage calendar and events in the Calendar service.
    ● member: Member who can add/modify/remove/view events. It corresponds to Manage events in the Calendar service.
    ● half_member: Associate member who can view events. It corresponds to Inquire event details in the Calendar service.
    ● subscriber: Subscriber who can view events. No calendar role is displayed for subscribers in the Calendar service.
    ● delegater: Delegator who has the same permissions as the Master. It corresponds to Manage events on behalf of master in the Calendar service.
    ● timelookup_only_delegater: Those who can only view whether an event exists at a specific time. It corresponds to Show only the time of the event in the Calendar service.
             roleName String Y Permission name
             roleId Integer Y Role type
    ● 6: Delegator (delegater). It corresponds to Manage events on behalf of master in the Calendar service.
    ● 2: Admin (staff). It corresponds to Manage calendar and events in the Calendar service.
    ● 3: Member (member). It corresponds to Manage events in the Calendar service.
    ● 4: Associate member (half_member). It corresponds to Inquire event details in the Calendar service.
    ● 8: Delegation of time lookups (timelookup_only_delegater). It corresponds to Show only the time of the event in the Calendar service.

    Response Example

    {
        "result": "success",
        "returnValue": [{
            "responseState": 1,
            "calendarId": "3141",
            "responseDate": "",
            "calendarName": "",
            "invitationDate": "",
            "email": "admin@example.com",
            "userId": "14503002",
            "targetUserId": "14503002",
            "role": {
                "roleName": "master",
                "roleId": 1,
                "roleLabel2": "Master",
                "roleLabel": "Master"
            },
            "invitationSeq": "",
            "targetUserType": "0",
            "invitationMessageSeq": "",
            "emailUserName": "Admin"
        }, {
            "responseState": 1,
            "calendarId": "3141",
            "responseDate": "2014-12-08 14:57:02",
            "calendarName": null,
            "invitationDate": "2014-12-08 14:57:02",
            "email": "user01@example.com",
            "userId": "14503002",
            "targetUserId": "16937001",
            "role": {
                "roleName": "staff",
                "roleId": 2,
                "roleLabel2": "All Permissions",
                "roleLabel": "Manager"
            },
            "invitationSeq": 0,
            "targetUserType": "0",
            "invitationMessageSeq": 0,
            "emailUserName": "User1"
        }]
    }