GET/users/{userId}/calendar-personals

ユーザーがアクセスできるカレンダーリストを取得する。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

calendar.read
calendar

HTTP Request

GEThttps://www.worksapis.com/v1.0/users/{userId}/calendar-personals

Path Parameters

ParameterTypeDescription
userId string 

ユーザーを特定する ID (URL エンコードする)

  • ユーザーID (userId)
  • ログインID (email)
  • 自身 ("me")

required
example : userf7da-f82c-4284-13e7-030f3b4c756x 

Query Parameters

ParameterTypeDescription
count integer 

取得するカレンダー数


default : 50
minimum : 1
maximum : 50
example : 50
format : int32 
cursor string 

次のリスト取得時に使用するカーソル値 (URL エンコードする)


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
calendarPersonals array (CalendarPersonal) 

ユーザーカレンダーリスト

 
responseMetaData object (responseMetaData) 

レスポンスのメタデータ

 

CalendarPersonal

PropertyTypeDescription
calendarId string 

カレンダー ID


required 
calendarName string 

カレンダー名


required
maxLength : 50 
isShowOnLNBList boolean 

Left Navigation Bar カレンダーリストへの表示フラグ


required 
displayOrder integer 

表示順位


required
minimum : 0
maximum : 9999
format : int32 
resourceLocation integer 

リソースロケーションコード


required 

responseMetaData

PropertyTypeDescription
nextCursor string 

次のリストが存在する場合のカーソル値


required 

Response Example

example

1{2  "calendarPersonals": [3    {4      "displayOrder": 9999,5      "calendarId": "calendar-96b8-4c74-8277-7953e0b4604a",6      "calendarName": "nameOf_99517579704",7      "isShowOnLNBList": true,8      "resourceLocation": 141019    },10    {11      "displayOrder": 1,12      "calendarId": "021aca65-c92c-4523-b2cf-f7afe8d46ca8",13      "calendarName": "nameOf_33617579704",14      "isShowOnLNBList": true,15      "resourceLocation": 1410116    }17  ],18  "responseMetaData": {19    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="20  }21}

HTTP 403

Forbidden

HTTP 404

Not Found