Skip to content

Scheduler Service v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Scheduler Microservice

Base URLs:

Authentication

  • HTTP Authentication, scheme: bearer

AttachmentController

AttachmentController.count

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attachments/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attachments/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /attachments/count

Permissions
ViewAttachment
15

Parameters

Name In Type Required Description
where query object false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Attachment model count loopback.Count

AttachmentController.replaceById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "fileUrl": "string",
  "iconLink": "string",
  "mimeType": "string",
  "title": "string",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attachments/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "fileUrl": "string",
  "iconLink": "string",
  "mimeType": "string",
  "title": "string",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attachments/{id}',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /attachments/{id}

Permissions
UpdateAttachment
17

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "fileUrl": "string",
  "iconLink": "string",
  "mimeType": "string",
  "title": "string",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
id path string true none
body body Attachment false none

Responses

Status Meaning Description Schema
204 No Content Attachment PUT success None

AttachmentController.updateById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "fileUrl": "string",
  "iconLink": "string",
  "mimeType": "string",
  "title": "string",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attachments/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "fileUrl": "string",
  "iconLink": "string",
  "mimeType": "string",
  "title": "string",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attachments/{id}',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /attachments/{id}

Permissions
UpdateAttachment
17

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "fileUrl": "string",
  "iconLink": "string",
  "mimeType": "string",
  "title": "string",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
id path string true none
body body AttachmentPartial false none

Responses

Status Meaning Description Schema
204 No Content Attachment PATCH success None

AttachmentController.findById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attachments/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attachments/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /attachments/{id}

Permissions
ViewAttachment
15

Parameters

Name In Type Required Description
id path string true none
filter query attachments.Filter false none

Example responses

200 Response

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "fileUrl": "string",
  "iconLink": "string",
  "mimeType": "string",
  "title": "string",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {},
  "event": {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "bgColor": "string",
    "description": "string",
    "endDateTime": "2019-08-24T14:15:22Z",
    "fgColor": "string",
    "iCalUid": "string",
    "isFullDayEvent": true,
    "isLocked": true,
    "link": "string",
    "location": "string",
    "meetingLink": "string",
    "identifier": "string",
    "startDateTime": "2019-08-24T14:15:22Z",
    "status": "confirmed",
    "summary": "string",
    "timezone": "string",
    "calendarId": "string",
    "parentEventId": "string",
    "extId": "string",
    "extMetadata": {},
    "calendar": {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "source": "string",
      "enableWorkingHours": true,
      "location": "string",
      "identifier": "string",
      "summary": "string",
      "timezone": "string",
      "extId": "string",
      "extMetadata": {},
      "events": [
        {}
      ],
      "workingHours": [
        {
          "deleted": true,
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "dayOfWeek": 0,
          "end": "string",
          "start": "string",
          "calendarId": "string",
          "extId": "string",
          "extMetadata": {},
          "calendar": {},
          "foreignKey": null
        }
      ],
      "subscriptions": [
        {
          "deleted": true,
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "accessRole": "freeBusyReader",
          "bgColor": "string",
          "fgColor": "string",
          "isHidden": true,
          "isPrimary": true,
          "identifier": "string",
          "defaultReminders": {},
          "notificationSettings": {},
          "calendarId": "string",
          "extId": "string",
          "extMetadata": {},
          "calendar": {},
          "foreignKey": null
        }
      ]
    },
    "foreignKey": null,
    "parentEvent": {},
    "attendees": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "identifier": "string",
        "isOptional": true,
        "isOrganizer": true,
        "messages": "string",
        "responseStatus": "needsAction",
        "eventId": "string",
        "extId": "string",
        "extMetadata": {},
        "event": {},
        "foreignKey": null
      }
    ],
    "attachments": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "fileUrl": "string",
        "iconLink": "string",
        "mimeType": "string",
        "title": "string",
        "eventId": "string",
        "extId": "string",
        "extMetadata": {},
        "event": {},
        "foreignKey": null
      }
    ]
  },
  "foreignKey": null
}

Responses

Status Meaning Description Schema
200 OK Attachment model instance AttachmentWithRelations

AttachmentController.deleteById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/attachments/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/attachments/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /attachments/{id}

Permissions
DeleteAttachment
18

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
204 No Content Attachment DELETE success None

AttachmentController.create

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "fileUrl": "string",
  "iconLink": "string",
  "mimeType": "string",
  "title": "string",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attachments',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "fileUrl": "string",
  "iconLink": "string",
  "mimeType": "string",
  "title": "string",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attachments',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /attachments

Permissions
CreateAttachment
16

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "fileUrl": "string",
  "iconLink": "string",
  "mimeType": "string",
  "title": "string",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
body body NewAttachment false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "fileUrl": "string",
  "iconLink": "string",
  "mimeType": "string",
  "title": "string",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
}

Responses

Status Meaning Description Schema
200 OK Attachment model instance Attachment

AttachmentController.updateAll

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "fileUrl": "string",
  "iconLink": "string",
  "mimeType": "string",
  "title": "string",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attachments',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "fileUrl": "string",
  "iconLink": "string",
  "mimeType": "string",
  "title": "string",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attachments',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /attachments

Permissions
UpdateAttachment
17

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "fileUrl": "string",
  "iconLink": "string",
  "mimeType": "string",
  "title": "string",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
where query object false none
body body AttachmentPartial false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Attachment PATCH success count loopback.Count

AttachmentController.find

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attachments',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attachments',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /attachments

Permissions
ViewAttachment
15

Parameters

Name In Type Required Description
filter query attachments.Filter1 false none

Example responses

200 Response

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
[
  {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "fileUrl": "string",
    "iconLink": "string",
    "mimeType": "string",
    "title": "string",
    "eventId": "string",
    "extId": "string",
    "extMetadata": {},
    "event": {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "bgColor": "string",
      "description": "string",
      "endDateTime": "2019-08-24T14:15:22Z",
      "fgColor": "string",
      "iCalUid": "string",
      "isFullDayEvent": true,
      "isLocked": true,
      "link": "string",
      "location": "string",
      "meetingLink": "string",
      "identifier": "string",
      "startDateTime": "2019-08-24T14:15:22Z",
      "status": "confirmed",
      "summary": "string",
      "timezone": "string",
      "calendarId": "string",
      "parentEventId": "string",
      "extId": "string",
      "extMetadata": {},
      "calendar": {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "source": "string",
        "enableWorkingHours": true,
        "location": "string",
        "identifier": "string",
        "summary": "string",
        "timezone": "string",
        "extId": "string",
        "extMetadata": {},
        "events": [
          {}
        ],
        "workingHours": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "dayOfWeek": 0,
            "end": "string",
            "start": "string",
            "calendarId": "string",
            "extId": "string",
            "extMetadata": {},
            "calendar": {},
            "foreignKey": null
          }
        ],
        "subscriptions": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "accessRole": "freeBusyReader",
            "bgColor": "string",
            "fgColor": "string",
            "isHidden": true,
            "isPrimary": true,
            "identifier": "string",
            "defaultReminders": {},
            "notificationSettings": {},
            "calendarId": "string",
            "extId": "string",
            "extMetadata": {},
            "calendar": {},
            "foreignKey": null
          }
        ]
      },
      "foreignKey": null,
      "parentEvent": {},
      "attendees": [
        {
          "deleted": true,
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "identifier": "string",
          "isOptional": true,
          "isOrganizer": true,
          "messages": "string",
          "responseStatus": "needsAction",
          "eventId": "string",
          "extId": "string",
          "extMetadata": {},
          "event": {},
          "foreignKey": null
        }
      ],
      "attachments": [
        {}
      ]
    },
    "foreignKey": null
  }
]

Responses

Status Meaning Description Schema
200 OK Array of Attachment model instances Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [AttachmentWithRelations] false none [(tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })]
» AttachmentWithRelations AttachmentWithRelations false none (tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })
»» deleted boolean false none none
»» deletedOn string(date-time)¦null false none none
»» deletedBy string¦null false none none
»» createdOn string(date-time) false none none
»» modifiedOn string(date-time) false none none
»» createdBy string false none none
»» modifiedBy string false none none
»» id string false none none
»» fileUrl string true none none
»» iconLink string false none none
»» mimeType string false none none
»» title string false none none
»» eventId string true none none
»» extId string false none none
»» extMetadata object false none none
»» event EventWithRelations false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
»»» deleted boolean false none none
»»» deletedOn string(date-time)¦null false none none
»»» deletedBy string¦null false none none
»»» createdOn string(date-time) false none none
»»» modifiedOn string(date-time) false none none
»»» createdBy string false none none
»»» modifiedBy string false none none
»»» id string false none none
»»» bgColor string false none none
»»» description string false none none
»»» endDateTime string(date-time) false none none
»»» fgColor string false none none
»»» iCalUid string false none none
»»» isFullDayEvent boolean false none none
»»» isLocked boolean false none none
»»» link string false none none
»»» location string false none none
»»» meetingLink string false none none
»»» identifier string false none none
»»» startDateTime string(date-time) false none none
»»» status string false none none
»»» summary string false none none
»»» timezone string false none none
»»» calendarId string true none none
»»» parentEventId string false none none
»»» extId string false none none
»»» extMetadata object false none none
»»» calendar CalendarWithRelations false none (tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })
»»»» deleted boolean false none none
»»»» deletedOn string(date-time)¦null false none none
»»»» deletedBy string¦null false none none
»»»» createdOn string(date-time) false none none
»»»» modifiedOn string(date-time) false none none
»»»» createdBy string false none none
»»»» modifiedBy string false none none
»»»» id string false none none
»»»» source string false none none
»»»» enableWorkingHours boolean false none none
»»»» location string false none none
»»»» identifier string true none none
»»»» summary string false none none
»»»» timezone string false none none
»»»» extId string false none none
»»»» extMetadata object false none none
»»»» events [EventWithRelations] false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
»»»»» EventWithRelations EventWithRelations false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
»»»» workingHours [WorkingHourWithRelations] false none (tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })
»»»»» WorkingHourWithRelations WorkingHourWithRelations false none (tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })
»»»»»» deleted boolean false none none
»»»»»» deletedOn string(date-time)¦null false none none
»»»»»» deletedBy string¦null false none none
»»»»»» createdOn string(date-time) false none none
»»»»»» modifiedOn string(date-time) false none none
»»»»»» createdBy string false none none
»»»»»» modifiedBy string false none none
»»»»»» id string false none none
»»»»»» dayOfWeek number false none none
»»»»»» end string false none none
»»»»»» start string false none none
»»»»»» calendarId string true none none
»»»»»» extId string false none none
»»»»»» extMetadata object false none none
»»»»»» calendar CalendarWithRelations false none (tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })
»»»»»» foreignKey any false none none
»»»» subscriptions [SubscriptionWithRelations] false none (tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })
»»»»» SubscriptionWithRelations SubscriptionWithRelations false none (tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })
»»»»»» deleted boolean false none none
»»»»»» deletedOn string(date-time)¦null false none none
»»»»»» deletedBy string¦null false none none
»»»»»» createdOn string(date-time) false none none
»»»»»» modifiedOn string(date-time) false none none
»»»»»» createdBy string false none none
»»»»»» modifiedBy string false none none
»»»»»» id string false none none
»»»»»» accessRole string false none none
»»»»»» bgColor string false none none
»»»»»» fgColor string false none none
»»»»»» isHidden boolean false none none
»»»»»» isPrimary boolean false none none
»»»»»» identifier string true none none
»»»»»» defaultReminders object false none none
»»»»»» notificationSettings object false none none
»»»»»» calendarId string true none none
»»»»»» extId string false none none
»»»»»» extMetadata object false none none
»»»»»» calendar CalendarWithRelations false none (tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })
»»»»»» foreignKey any false none none
»»» foreignKey any false none none
»»» parentEvent EventWithRelations false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
»»» attendees [AttendeeWithRelations] false none (tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })
»»»» AttendeeWithRelations AttendeeWithRelations false none (tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })
»»»»» deleted boolean false none none
»»»»» deletedOn string(date-time)¦null false none none
»»»»» deletedBy string¦null false none none
»»»»» createdOn string(date-time) false none none
»»»»» modifiedOn string(date-time) false none none
»»»»» createdBy string false none none
»»»»» modifiedBy string false none none
»»»»» id string false none none
»»»»» identifier string true none none
»»»»» isOptional boolean false none none
»»»»» isOrganizer boolean false none none
»»»»» messages string false none none
»»»»» responseStatus string false none none
»»»»» eventId string true none none
»»»»» extId string false none none
»»»»» extMetadata object false none none
»»»»» event EventWithRelations false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
»»»»» foreignKey any false none none
»»» attachments [AttachmentWithRelations] false none (tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })
»»»» AttachmentWithRelations AttachmentWithRelations false none (tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })
»» foreignKey any false none none

Enumerated Values

Property Value
status confirmed
status tentative
status cancelled
status completed
dayOfWeek 0
dayOfWeek 1
dayOfWeek 2
dayOfWeek 3
dayOfWeek 4
dayOfWeek 5
dayOfWeek 6
accessRole freeBusyReader
accessRole reader
accessRole writer
accessRole owner
responseStatus needsAction
responseStatus tentative
responseStatus accepted
responseStatus declined

AttendeeController

AttendeeController.count

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attendees/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attendees/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /attendees/count

Permissions
ViewAttendee
19

Parameters

Name In Type Required Description
where query object false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Attendee model count loopback.Count

AttendeeController.replaceById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "identifier": "string",
  "isOptional": true,
  "isOrganizer": true,
  "messages": "string",
  "responseStatus": "needsAction",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attendees/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "identifier": "string",
  "isOptional": true,
  "isOrganizer": true,
  "messages": "string",
  "responseStatus": "needsAction",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attendees/{id}',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /attendees/{id}

Permissions
UpdateAttendee
21

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "identifier": "string",
  "isOptional": true,
  "isOrganizer": true,
  "messages": "string",
  "responseStatus": "needsAction",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
id path string true none
body body Attendee false none

Responses

Status Meaning Description Schema
204 No Content Attendee PUT success None

AttendeeController.updateById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "identifier": "string",
  "isOptional": true,
  "isOrganizer": true,
  "messages": "string",
  "responseStatus": "needsAction",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attendees/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "identifier": "string",
  "isOptional": true,
  "isOrganizer": true,
  "messages": "string",
  "responseStatus": "needsAction",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attendees/{id}',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /attendees/{id}

Permissions
UpdateAttendee
21

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "identifier": "string",
  "isOptional": true,
  "isOrganizer": true,
  "messages": "string",
  "responseStatus": "needsAction",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
id path string true none
body body AttendeePartial false none

Responses

Status Meaning Description Schema
204 No Content Attendee PATCH success None

AttendeeController.findById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attendees/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attendees/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /attendees/{id}

Permissions
ViewAttendee
19

Parameters

Name In Type Required Description
id path string true none
filter query attendees.Filter false none

Example responses

200 Response

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "identifier": "string",
  "isOptional": true,
  "isOrganizer": true,
  "messages": "string",
  "responseStatus": "needsAction",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {},
  "event": {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "bgColor": "string",
    "description": "string",
    "endDateTime": "2019-08-24T14:15:22Z",
    "fgColor": "string",
    "iCalUid": "string",
    "isFullDayEvent": true,
    "isLocked": true,
    "link": "string",
    "location": "string",
    "meetingLink": "string",
    "identifier": "string",
    "startDateTime": "2019-08-24T14:15:22Z",
    "status": "confirmed",
    "summary": "string",
    "timezone": "string",
    "calendarId": "string",
    "parentEventId": "string",
    "extId": "string",
    "extMetadata": {},
    "calendar": {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "source": "string",
      "enableWorkingHours": true,
      "location": "string",
      "identifier": "string",
      "summary": "string",
      "timezone": "string",
      "extId": "string",
      "extMetadata": {},
      "events": [
        {}
      ],
      "workingHours": [
        {
          "deleted": true,
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "dayOfWeek": 0,
          "end": "string",
          "start": "string",
          "calendarId": "string",
          "extId": "string",
          "extMetadata": {},
          "calendar": {},
          "foreignKey": null
        }
      ],
      "subscriptions": [
        {
          "deleted": true,
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "accessRole": "freeBusyReader",
          "bgColor": "string",
          "fgColor": "string",
          "isHidden": true,
          "isPrimary": true,
          "identifier": "string",
          "defaultReminders": {},
          "notificationSettings": {},
          "calendarId": "string",
          "extId": "string",
          "extMetadata": {},
          "calendar": {},
          "foreignKey": null
        }
      ]
    },
    "foreignKey": null,
    "parentEvent": {},
    "attendees": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "identifier": "string",
        "isOptional": true,
        "isOrganizer": true,
        "messages": "string",
        "responseStatus": "needsAction",
        "eventId": "string",
        "extId": "string",
        "extMetadata": {},
        "event": {},
        "foreignKey": null
      }
    ],
    "attachments": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "fileUrl": "string",
        "iconLink": "string",
        "mimeType": "string",
        "title": "string",
        "eventId": "string",
        "extId": "string",
        "extMetadata": {},
        "event": {},
        "foreignKey": null
      }
    ]
  },
  "foreignKey": null
}

Responses

Status Meaning Description Schema
200 OK Attendee model instance AttendeeWithRelations

AttendeeController.deleteById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/attendees/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/attendees/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /attendees/{id}

Permissions
DeleteAttendee
22

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
204 No Content Attendee DELETE success None

AttendeeController.create

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "identifier": "string",
  "isOptional": true,
  "isOrganizer": true,
  "messages": "string",
  "responseStatus": "needsAction",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attendees',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "identifier": "string",
  "isOptional": true,
  "isOrganizer": true,
  "messages": "string",
  "responseStatus": "needsAction",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attendees',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /attendees

Permissions
CreateAttendee
20

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "identifier": "string",
  "isOptional": true,
  "isOrganizer": true,
  "messages": "string",
  "responseStatus": "needsAction",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
body body NewAttendee false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "identifier": "string",
  "isOptional": true,
  "isOrganizer": true,
  "messages": "string",
  "responseStatus": "needsAction",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
}

Responses

Status Meaning Description Schema
200 OK Attendee model instance Attendee

AttendeeController.updateAll

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "identifier": "string",
  "isOptional": true,
  "isOrganizer": true,
  "messages": "string",
  "responseStatus": "needsAction",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attendees',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "identifier": "string",
  "isOptional": true,
  "isOrganizer": true,
  "messages": "string",
  "responseStatus": "needsAction",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attendees',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /attendees

Permissions
UpdateAttendee
21

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "identifier": "string",
  "isOptional": true,
  "isOrganizer": true,
  "messages": "string",
  "responseStatus": "needsAction",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
where query object false none
body body AttendeePartial false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Attendee PATCH success count loopback.Count

AttendeeController.find

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attendees',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attendees',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /attendees

Permissions
ViewAttendee
19

Parameters

Name In Type Required Description
filter query attendees.Filter1 false none

Example responses

200 Response

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
[
  {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "identifier": "string",
    "isOptional": true,
    "isOrganizer": true,
    "messages": "string",
    "responseStatus": "needsAction",
    "eventId": "string",
    "extId": "string",
    "extMetadata": {},
    "event": {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "bgColor": "string",
      "description": "string",
      "endDateTime": "2019-08-24T14:15:22Z",
      "fgColor": "string",
      "iCalUid": "string",
      "isFullDayEvent": true,
      "isLocked": true,
      "link": "string",
      "location": "string",
      "meetingLink": "string",
      "identifier": "string",
      "startDateTime": "2019-08-24T14:15:22Z",
      "status": "confirmed",
      "summary": "string",
      "timezone": "string",
      "calendarId": "string",
      "parentEventId": "string",
      "extId": "string",
      "extMetadata": {},
      "calendar": {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "source": "string",
        "enableWorkingHours": true,
        "location": "string",
        "identifier": "string",
        "summary": "string",
        "timezone": "string",
        "extId": "string",
        "extMetadata": {},
        "events": [
          {}
        ],
        "workingHours": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "dayOfWeek": 0,
            "end": "string",
            "start": "string",
            "calendarId": "string",
            "extId": "string",
            "extMetadata": {},
            "calendar": {},
            "foreignKey": null
          }
        ],
        "subscriptions": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "accessRole": "freeBusyReader",
            "bgColor": "string",
            "fgColor": "string",
            "isHidden": true,
            "isPrimary": true,
            "identifier": "string",
            "defaultReminders": {},
            "notificationSettings": {},
            "calendarId": "string",
            "extId": "string",
            "extMetadata": {},
            "calendar": {},
            "foreignKey": null
          }
        ]
      },
      "foreignKey": null,
      "parentEvent": {},
      "attendees": [
        {}
      ],
      "attachments": [
        {
          "deleted": true,
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "fileUrl": "string",
          "iconLink": "string",
          "mimeType": "string",
          "title": "string",
          "eventId": "string",
          "extId": "string",
          "extMetadata": {},
          "event": {},
          "foreignKey": null
        }
      ]
    },
    "foreignKey": null
  }
]

Responses

Status Meaning Description Schema
200 OK Array of Attendee model instances Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [AttendeeWithRelations] false none [(tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })]
» AttendeeWithRelations AttendeeWithRelations false none (tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })
»» deleted boolean false none none
»» deletedOn string(date-time)¦null false none none
»» deletedBy string¦null false none none
»» createdOn string(date-time) false none none
»» modifiedOn string(date-time) false none none
»» createdBy string false none none
»» modifiedBy string false none none
»» id string false none none
»» identifier string true none none
»» isOptional boolean false none none
»» isOrganizer boolean false none none
»» messages string false none none
»» responseStatus string false none none
»» eventId string true none none
»» extId string false none none
»» extMetadata object false none none
»» event EventWithRelations false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
»»» deleted boolean false none none
»»» deletedOn string(date-time)¦null false none none
»»» deletedBy string¦null false none none
»»» createdOn string(date-time) false none none
»»» modifiedOn string(date-time) false none none
»»» createdBy string false none none
»»» modifiedBy string false none none
»»» id string false none none
»»» bgColor string false none none
»»» description string false none none
»»» endDateTime string(date-time) false none none
»»» fgColor string false none none
»»» iCalUid string false none none
»»» isFullDayEvent boolean false none none
»»» isLocked boolean false none none
»»» link string false none none
»»» location string false none none
»»» meetingLink string false none none
»»» identifier string false none none
»»» startDateTime string(date-time) false none none
»»» status string false none none
»»» summary string false none none
»»» timezone string false none none
»»» calendarId string true none none
»»» parentEventId string false none none
»»» extId string false none none
»»» extMetadata object false none none
»»» calendar CalendarWithRelations false none (tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })
»»»» deleted boolean false none none
»»»» deletedOn string(date-time)¦null false none none
»»»» deletedBy string¦null false none none
»»»» createdOn string(date-time) false none none
»»»» modifiedOn string(date-time) false none none
»»»» createdBy string false none none
»»»» modifiedBy string false none none
»»»» id string false none none
»»»» source string false none none
»»»» enableWorkingHours boolean false none none
»»»» location string false none none
»»»» identifier string true none none
»»»» summary string false none none
»»»» timezone string false none none
»»»» extId string false none none
»»»» extMetadata object false none none
»»»» events [EventWithRelations] false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
»»»»» EventWithRelations EventWithRelations false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
»»»» workingHours [WorkingHourWithRelations] false none (tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })
»»»»» WorkingHourWithRelations WorkingHourWithRelations false none (tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })
»»»»»» deleted boolean false none none
»»»»»» deletedOn string(date-time)¦null false none none
»»»»»» deletedBy string¦null false none none
»»»»»» createdOn string(date-time) false none none
»»»»»» modifiedOn string(date-time) false none none
»»»»»» createdBy string false none none
»»»»»» modifiedBy string false none none
»»»»»» id string false none none
»»»»»» dayOfWeek number false none none
»»»»»» end string false none none
»»»»»» start string false none none
»»»»»» calendarId string true none none
»»»»»» extId string false none none
»»»»»» extMetadata object false none none
»»»»»» calendar CalendarWithRelations false none (tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })
»»»»»» foreignKey any false none none
»»»» subscriptions [SubscriptionWithRelations] false none (tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })
»»»»» SubscriptionWithRelations SubscriptionWithRelations false none (tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })
»»»»»» deleted boolean false none none
»»»»»» deletedOn string(date-time)¦null false none none
»»»»»» deletedBy string¦null false none none
»»»»»» createdOn string(date-time) false none none
»»»»»» modifiedOn string(date-time) false none none
»»»»»» createdBy string false none none
»»»»»» modifiedBy string false none none
»»»»»» id string false none none
»»»»»» accessRole string false none none
»»»»»» bgColor string false none none
»»»»»» fgColor string false none none
»»»»»» isHidden boolean false none none
»»»»»» isPrimary boolean false none none
»»»»»» identifier string true none none
»»»»»» defaultReminders object false none none
»»»»»» notificationSettings object false none none
»»»»»» calendarId string true none none
»»»»»» extId string false none none
»»»»»» extMetadata object false none none
»»»»»» calendar CalendarWithRelations false none (tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })
»»»»»» foreignKey any false none none
»»» foreignKey any false none none
»»» parentEvent EventWithRelations false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
»»» attendees [AttendeeWithRelations] false none (tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })
»»»» AttendeeWithRelations AttendeeWithRelations false none (tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })
»»» attachments [AttachmentWithRelations] false none (tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })
»»»» AttachmentWithRelations AttachmentWithRelations false none (tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })
»»»»» deleted boolean false none none
»»»»» deletedOn string(date-time)¦null false none none
»»»»» deletedBy string¦null false none none
»»»»» createdOn string(date-time) false none none
»»»»» modifiedOn string(date-time) false none none
»»»»» createdBy string false none none
»»»»» modifiedBy string false none none
»»»»» id string false none none
»»»»» fileUrl string true none none
»»»»» iconLink string false none none
»»»»» mimeType string false none none
»»»»» title string false none none
»»»»» eventId string true none none
»»»»» extId string false none none
»»»»» extMetadata object false none none
»»»»» event EventWithRelations false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
»»»»» foreignKey any false none none
»» foreignKey any false none none

Enumerated Values

Property Value
responseStatus needsAction
responseStatus tentative
responseStatus accepted
responseStatus declined
status confirmed
status tentative
status cancelled
status completed
dayOfWeek 0
dayOfWeek 1
dayOfWeek 2
dayOfWeek 3
dayOfWeek 4
dayOfWeek 5
dayOfWeek 6
accessRole freeBusyReader
accessRole reader
accessRole writer
accessRole owner

CalendarController

CalendarController.createWithSubscription

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
const inputBody = '{
  "source": "string",
  "enableWorkingHours": true,
  "location": "string",
  "identifier": "string",
  "summary": "string",
  "timezone": "string",
  "extId": "string",
  "extMetadata": {},
  "workingHours": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "dayOfWeek": 0,
      "end": "string",
      "start": "string",
      "calendarId": "string",
      "extId": "string",
      "extMetadata": {}
    }
  ],
  "subscription": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/calendarSubscription',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
const fetch = require('node-fetch');
const inputBody = {
  "source": "string",
  "enableWorkingHours": true,
  "location": "string",
  "identifier": "string",
  "summary": "string",
  "timezone": "string",
  "extId": "string",
  "extMetadata": {},
  "workingHours": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "dayOfWeek": 0,
      "end": "string",
      "start": "string",
      "calendarId": "string",
      "extId": "string",
      "extMetadata": {}
    }
  ],
  "subscription": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/calendarSubscription',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /calendars/calendarSubscription

Permissions
CreateCalendar
12

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
{
  "source": "string",
  "enableWorkingHours": true,
  "location": "string",
  "identifier": "string",
  "summary": "string",
  "timezone": "string",
  "extId": "string",
  "extMetadata": {},
  "workingHours": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "dayOfWeek": 0,
      "end": "string",
      "start": "string",
      "calendarId": "string",
      "extId": "string",
      "extMetadata": {}
    }
  ],
  "subscription": {}
}

Parameters

Name In Type Required Description
body body NewCalendar false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
{
  "id": "string",
  "source": "string",
  "enableWorkingHours": true,
  "location": "string",
  "identifier": "string",
  "summary": "string",
  "timezone": "string",
  "extId": "string",
  "extMetadata": {},
  "workingHours": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "dayOfWeek": 0,
      "end": "string",
      "start": "string",
      "calendarId": "string",
      "extId": "string",
      "extMetadata": {}
    }
  ],
  "subscription": {}
}

Responses

Status Meaning Description Schema
200 OK Calendar model instance CalendarDTO

CalendarController.count

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /calendars/count

Permissions
ViewCalendar
11

Parameters

Name In Type Required Description
where query object false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Calendar model count loopback.Count

CalendarController.replaceById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
const inputBody = '{
  "id": "string",
  "source": "string",
  "enableWorkingHours": true,
  "location": "string",
  "identifier": "string",
  "summary": "string",
  "timezone": "string",
  "extId": "string",
  "extMetadata": {},
  "workingHours": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "dayOfWeek": 0,
      "end": "string",
      "start": "string",
      "calendarId": "string",
      "extId": "string",
      "extMetadata": {}
    }
  ],
  "subscription": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
const fetch = require('node-fetch');
const inputBody = {
  "id": "string",
  "source": "string",
  "enableWorkingHours": true,
  "location": "string",
  "identifier": "string",
  "summary": "string",
  "timezone": "string",
  "extId": "string",
  "extMetadata": {},
  "workingHours": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "dayOfWeek": 0,
      "end": "string",
      "start": "string",
      "calendarId": "string",
      "extId": "string",
      "extMetadata": {}
    }
  ],
  "subscription": {}
};
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/{id}',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /calendars/{id}

This api is to update the calendar by passing an id. This action will be allowed only to the owner of the calendar or the admin. To identify the ‘owner’ we will check for the email passed in the token and the corresponding access level, whereas to identify the admin we will check for the permission.

Permissions
UpdateCalendar
13

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
{
  "id": "string",
  "source": "string",
  "enableWorkingHours": true,
  "location": "string",
  "identifier": "string",
  "summary": "string",
  "timezone": "string",
  "extId": "string",
  "extMetadata": {},
  "workingHours": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "dayOfWeek": 0,
      "end": "string",
      "start": "string",
      "calendarId": "string",
      "extId": "string",
      "extMetadata": {}
    }
  ],
  "subscription": {}
}

Parameters

Name In Type Required Description
id path string true none
body body CalendarDTO false none

Responses

Status Meaning Description Schema
204 No Content Calendar PUT success None

CalendarController.updateById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "source": "string",
  "enableWorkingHours": true,
  "location": "string",
  "identifier": "string",
  "summary": "string",
  "timezone": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "source": "string",
  "enableWorkingHours": true,
  "location": "string",
  "identifier": "string",
  "summary": "string",
  "timezone": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/{id}',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /calendars/{id}

Permissions
UpdateCalendar
13

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "source": "string",
  "enableWorkingHours": true,
  "location": "string",
  "identifier": "string",
  "summary": "string",
  "timezone": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
id path string true none
body body CalendarPartial false none

Responses

Status Meaning Description Schema
204 No Content Calendar PATCH success None

CalendarController.findById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /calendars/{id}

These requests will be available to everyone in the event to look at.

Permissions
ViewCalendar
11

Parameters

Name In Type Required Description
id path string true none
filter query calendars.Filter false none

Example responses

200 Response

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "source": "string",
  "enableWorkingHours": true,
  "location": "string",
  "identifier": "string",
  "summary": "string",
  "timezone": "string",
  "extId": "string",
  "extMetadata": {},
  "events": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "bgColor": "string",
      "description": "string",
      "endDateTime": "2019-08-24T14:15:22Z",
      "fgColor": "string",
      "iCalUid": "string",
      "isFullDayEvent": true,
      "isLocked": true,
      "link": "string",
      "location": "string",
      "meetingLink": "string",
      "identifier": "string",
      "startDateTime": "2019-08-24T14:15:22Z",
      "status": "confirmed",
      "summary": "string",
      "timezone": "string",
      "calendarId": "string",
      "parentEventId": "string",
      "extId": "string",
      "extMetadata": {},
      "calendar": {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "source": "string",
        "enableWorkingHours": true,
        "location": "string",
        "identifier": "string",
        "summary": "string",
        "timezone": "string",
        "extId": "string",
        "extMetadata": {},
        "events": [],
        "workingHours": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "dayOfWeek": 0,
            "end": "string",
            "start": "string",
            "calendarId": "string",
            "extId": "string",
            "extMetadata": {},
            "calendar": {},
            "foreignKey": null
          }
        ],
        "subscriptions": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "accessRole": "freeBusyReader",
            "bgColor": "string",
            "fgColor": "string",
            "isHidden": true,
            "isPrimary": true,
            "identifier": "string",
            "defaultReminders": {},
            "notificationSettings": {},
            "calendarId": "string",
            "extId": "string",
            "extMetadata": {},
            "calendar": {},
            "foreignKey": null
          }
        ]
      },
      "foreignKey": null,
      "parentEvent": {},
      "attendees": [
        {
          "deleted": true,
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "identifier": "string",
          "isOptional": true,
          "isOrganizer": true,
          "messages": "string",
          "responseStatus": "needsAction",
          "eventId": "string",
          "extId": "string",
          "extMetadata": {},
          "event": {},
          "foreignKey": null
        }
      ],
      "attachments": [
        {
          "deleted": true,
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "fileUrl": "string",
          "iconLink": "string",
          "mimeType": "string",
          "title": "string",
          "eventId": "string",
          "extId": "string",
          "extMetadata": {},
          "event": {},
          "foreignKey": null
        }
      ]
    }
  ],
  "workingHours": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "dayOfWeek": 0,
      "end": "string",
      "start": "string",
      "calendarId": "string",
      "extId": "string",
      "extMetadata": {},
      "calendar": {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "source": "string",
        "enableWorkingHours": true,
        "location": "string",
        "identifier": "string",
        "summary": "string",
        "timezone": "string",
        "extId": "string",
        "extMetadata": {},
        "events": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "bgColor": "string",
            "description": "string",
            "endDateTime": "2019-08-24T14:15:22Z",
            "fgColor": "string",
            "iCalUid": "string",
            "isFullDayEvent": true,
            "isLocked": true,
            "link": "string",
            "location": "string",
            "meetingLink": "string",
            "identifier": "string",
            "startDateTime": "2019-08-24T14:15:22Z",
            "status": "confirmed",
            "summary": "string",
            "timezone": "string",
            "calendarId": "string",
            "parentEventId": "string",
            "extId": "string",
            "extMetadata": {},
            "calendar": {},
            "foreignKey": null,
            "parentEvent": {},
            "attendees": [
              {
                "deleted": true,
                "deletedOn": "2019-08-24T14:15:22Z",
                "deletedBy": "string",
                "createdOn": "2019-08-24T14:15:22Z",
                "modifiedOn": "2019-08-24T14:15:22Z",
                "createdBy": "string",
                "modifiedBy": "string",
                "id": "string",
                "identifier": "string",
                "isOptional": true,
                "isOrganizer": true,
                "messages": "string",
                "responseStatus": "needsAction",
                "eventId": "string",
                "extId": "string",
                "extMetadata": {},
                "event": {},
                "foreignKey": null
              }
            ],
            "attachments": [
              {
                "deleted": true,
                "deletedOn": "2019-08-24T14:15:22Z",
                "deletedBy": "string",
                "createdOn": "2019-08-24T14:15:22Z",
                "modifiedOn": "2019-08-24T14:15:22Z",
                "createdBy": "string",
                "modifiedBy": "string",
                "id": "string",
                "fileUrl": "string",
                "iconLink": "string",
                "mimeType": "string",
                "title": "string",
                "eventId": "string",
                "extId": "string",
                "extMetadata": {},
                "event": {},
                "foreignKey": null
              }
            ]
          }
        ],
        "workingHours": [],
        "subscriptions": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "accessRole": "freeBusyReader",
            "bgColor": "string",
            "fgColor": "string",
            "isHidden": true,
            "isPrimary": true,
            "identifier": "string",
            "defaultReminders": {},
            "notificationSettings": {},
            "calendarId": "string",
            "extId": "string",
            "extMetadata": {},
            "calendar": {},
            "foreignKey": null
          }
        ]
      },
      "foreignKey": null
    }
  ],
  "subscriptions": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "accessRole": "freeBusyReader",
      "bgColor": "string",
      "fgColor": "string",
      "isHidden": true,
      "isPrimary": true,
      "identifier": "string",
      "defaultReminders": {},
      "notificationSettings": {},
      "calendarId": "string",
      "extId": "string",
      "extMetadata": {},
      "calendar": {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "source": "string",
        "enableWorkingHours": true,
        "location": "string",
        "identifier": "string",
        "summary": "string",
        "timezone": "string",
        "extId": "string",
        "extMetadata": {},
        "events": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "bgColor": "string",
            "description": "string",
            "endDateTime": "2019-08-24T14:15:22Z",
            "fgColor": "string",
            "iCalUid": "string",
            "isFullDayEvent": true,
            "isLocked": true,
            "link": "string",
            "location": "string",
            "meetingLink": "string",
            "identifier": "string",
            "startDateTime": "2019-08-24T14:15:22Z",
            "status": "confirmed",
            "summary": "string",
            "timezone": "string",
            "calendarId": "string",
            "parentEventId": "string",
            "extId": "string",
            "extMetadata": {},
            "calendar": {},
            "foreignKey": null,
            "parentEvent": {},
            "attendees": [
              {
                "deleted": true,
                "deletedOn": "2019-08-24T14:15:22Z",
                "deletedBy": "string",
                "createdOn": "2019-08-24T14:15:22Z",
                "modifiedOn": "2019-08-24T14:15:22Z",
                "createdBy": "string",
                "modifiedBy": "string",
                "id": "string",
                "identifier": "string",
                "isOptional": true,
                "isOrganizer": true,
                "messages": "string",
                "responseStatus": "needsAction",
                "eventId": "string",
                "extId": "string",
                "extMetadata": {},
                "event": {},
                "foreignKey": null
              }
            ],
            "attachments": [
              {
                "deleted": true,
                "deletedOn": "2019-08-24T14:15:22Z",
                "deletedBy": "string",
                "createdOn": "2019-08-24T14:15:22Z",
                "modifiedOn": "2019-08-24T14:15:22Z",
                "createdBy": "string",
                "modifiedBy": "string",
                "id": "string",
                "fileUrl": "string",
                "iconLink": "string",
                "mimeType": "string",
                "title": "string",
                "eventId": "string",
                "extId": "string",
                "extMetadata": {},
                "event": {},
                "foreignKey": null
              }
            ]
          }
        ],
        "workingHours": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "dayOfWeek": 0,
            "end": "string",
            "start": "string",
            "calendarId": "string",
            "extId": "string",
            "extMetadata": {},
            "calendar": {},
            "foreignKey": null
          }
        ],
        "subscriptions": []
      },
      "foreignKey": null
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Calendar model instance CalendarWithRelations

CalendarController.deleteById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /calendars/{id}

This api is to update the calendar by passing an id. This action will be allowed only to the owner of the calendar or the admin. To identify the ‘owner’ we will check for the email passed in the token and the corresponding access level, whereas to identify the admin we will check for the permission.

Permissions
DeleteCalendar
14

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
204 No Content Calendar DELETE success None

CalendarController.create

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
const inputBody = '{
  "source": "string",
  "enableWorkingHours": true,
  "location": "string",
  "identifier": "string",
  "summary": "string",
  "timezone": "string",
  "extId": "string",
  "extMetadata": {},
  "workingHours": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "dayOfWeek": 0,
      "end": "string",
      "start": "string",
      "calendarId": "string",
      "extId": "string",
      "extMetadata": {}
    }
  ],
  "subscription": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
const fetch = require('node-fetch');
const inputBody = {
  "source": "string",
  "enableWorkingHours": true,
  "location": "string",
  "identifier": "string",
  "summary": "string",
  "timezone": "string",
  "extId": "string",
  "extMetadata": {},
  "workingHours": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "dayOfWeek": 0,
      "end": "string",
      "start": "string",
      "calendarId": "string",
      "extId": "string",
      "extMetadata": {}
    }
  ],
  "subscription": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /calendars

This is an api to create a calendar for any user. Recommendation: Use this while adding a user to the main application, in order to create a primary calendar for that particular user.

Permissions
CreateCalendar
12

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
{
  "source": "string",
  "enableWorkingHours": true,
  "location": "string",
  "identifier": "string",
  "summary": "string",
  "timezone": "string",
  "extId": "string",
  "extMetadata": {},
  "workingHours": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "dayOfWeek": 0,
      "end": "string",
      "start": "string",
      "calendarId": "string",
      "extId": "string",
      "extMetadata": {}
    }
  ],
  "subscription": {}
}

Parameters

Name In Type Required Description
body body NewCalendar false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "source": "string",
  "enableWorkingHours": true,
  "location": "string",
  "identifier": "string",
  "summary": "string",
  "timezone": "string",
  "extId": "string",
  "extMetadata": {}
}

Responses

Status Meaning Description Schema
200 OK Calendar model instance Calendar

CalendarController.updateAll

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "source": "string",
  "enableWorkingHours": true,
  "location": "string",
  "identifier": "string",
  "summary": "string",
  "timezone": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "source": "string",
  "enableWorkingHours": true,
  "location": "string",
  "identifier": "string",
  "summary": "string",
  "timezone": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /calendars

Permissions
UpdateCalendar
13

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "source": "string",
  "enableWorkingHours": true,
  "location": "string",
  "identifier": "string",
  "summary": "string",
  "timezone": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
where query object false none
body body CalendarPartial false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Calendar PATCH success count loopback.Count

CalendarController.find

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /calendars

These requests will be available to everyone in the event to look at.

Permissions
ViewCalendar
11

Parameters

Name In Type Required Description
filter query calendars.Filter1 false none

Example responses

200 Response

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
[
  {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "source": "string",
    "enableWorkingHours": true,
    "location": "string",
    "identifier": "string",
    "summary": "string",
    "timezone": "string",
    "extId": "string",
    "extMetadata": {},
    "events": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "bgColor": "string",
        "description": "string",
        "endDateTime": "2019-08-24T14:15:22Z",
        "fgColor": "string",
        "iCalUid": "string",
        "isFullDayEvent": true,
        "isLocked": true,
        "link": "string",
        "location": "string",
        "meetingLink": "string",
        "identifier": "string",
        "startDateTime": "2019-08-24T14:15:22Z",
        "status": "confirmed",
        "summary": "string",
        "timezone": "string",
        "calendarId": "string",
        "parentEventId": "string",
        "extId": "string",
        "extMetadata": {},
        "calendar": {},
        "foreignKey": null,
        "parentEvent": {},
        "attendees": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "identifier": "string",
            "isOptional": true,
            "isOrganizer": true,
            "messages": "string",
            "responseStatus": "needsAction",
            "eventId": "string",
            "extId": "string",
            "extMetadata": {},
            "event": {},
            "foreignKey": null
          }
        ],
        "attachments": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "fileUrl": "string",
            "iconLink": "string",
            "mimeType": "string",
            "title": "string",
            "eventId": "string",
            "extId": "string",
            "extMetadata": {},
            "event": {},
            "foreignKey": null
          }
        ]
      }
    ],
    "workingHours": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "dayOfWeek": 0,
        "end": "string",
        "start": "string",
        "calendarId": "string",
        "extId": "string",
        "extMetadata": {},
        "calendar": {},
        "foreignKey": null
      }
    ],
    "subscriptions": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "accessRole": "freeBusyReader",
        "bgColor": "string",
        "fgColor": "string",
        "isHidden": true,
        "isPrimary": true,
        "identifier": "string",
        "defaultReminders": {},
        "notificationSettings": {},
        "calendarId": "string",
        "extId": "string",
        "extMetadata": {},
        "calendar": {},
        "foreignKey": null
      }
    ]
  }
]

Responses

Status Meaning Description Schema
200 OK Array of Calendar model instances Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [CalendarWithRelations] false none [(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })]
» CalendarWithRelations CalendarWithRelations false none (tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })
»» deleted boolean false none none
»» deletedOn string(date-time)¦null false none none
»» deletedBy string¦null false none none
»» createdOn string(date-time) false none none
»» modifiedOn string(date-time) false none none
»» createdBy string false none none
»» modifiedBy string false none none
»» id string false none none
»» source string false none none
»» enableWorkingHours boolean false none none
»» location string false none none
»» identifier string true none none
»» summary string false none none
»» timezone string false none none
»» extId string false none none
»» extMetadata object false none none
»» events [EventWithRelations] false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
»»» EventWithRelations EventWithRelations false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
»»»» deleted boolean false none none
»»»» deletedOn string(date-time)¦null false none none
»»»» deletedBy string¦null false none none
»»»» createdOn string(date-time) false none none
»»»» modifiedOn string(date-time) false none none
»»»» createdBy string false none none
»»»» modifiedBy string false none none
»»»» id string false none none
»»»» bgColor string false none none
»»»» description string false none none
»»»» endDateTime string(date-time) false none none
»»»» fgColor string false none none
»»»» iCalUid string false none none
»»»» isFullDayEvent boolean false none none
»»»» isLocked boolean false none none
»»»» link string false none none
»»»» location string false none none
»»»» meetingLink string false none none
»»»» identifier string false none none
»»»» startDateTime string(date-time) false none none
»»»» status string false none none
»»»» summary string false none none
»»»» timezone string false none none
»»»» calendarId string true none none
»»»» parentEventId string false none none
»»»» extId string false none none
»»»» extMetadata object false none none
»»»» calendar CalendarWithRelations false none (tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })
»»»» foreignKey any false none none
»»»» parentEvent EventWithRelations false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
»»»» attendees [AttendeeWithRelations] false none (tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })
»»»»» AttendeeWithRelations AttendeeWithRelations false none (tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })
»»»»»» deleted boolean false none none
»»»»»» deletedOn string(date-time)¦null false none none
»»»»»» deletedBy string¦null false none none
»»»»»» createdOn string(date-time) false none none
»»»»»» modifiedOn string(date-time) false none none
»»»»»» createdBy string false none none
»»»»»» modifiedBy string false none none
»»»»»» id string false none none
»»»»»» identifier string true none none
»»»»»» isOptional boolean false none none
»»»»»» isOrganizer boolean false none none
»»»»»» messages string false none none
»»»»»» responseStatus string false none none
»»»»»» eventId string true none none
»»»»»» extId string false none none
»»»»»» extMetadata object false none none
»»»»»» event EventWithRelations false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
»»»»»» foreignKey any false none none
»»»» attachments [AttachmentWithRelations] false none (tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })
»»»»» AttachmentWithRelations AttachmentWithRelations false none (tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })
»»»»»» deleted boolean false none none
»»»»»» deletedOn string(date-time)¦null false none none
»»»»»» deletedBy string¦null false none none
»»»»»» createdOn string(date-time) false none none
»»»»»» modifiedOn string(date-time) false none none
»»»»»» createdBy string false none none
»»»»»» modifiedBy string false none none
»»»»»» id string false none none
»»»»»» fileUrl string true none none
»»»»»» iconLink string false none none
»»»»»» mimeType string false none none
»»»»»» title string false none none
»»»»»» eventId string true none none
»»»»»» extId string false none none
»»»»»» extMetadata object false none none
»»»»»» event EventWithRelations false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
»»»»»» foreignKey any false none none
»» workingHours [WorkingHourWithRelations] false none (tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })
»»» WorkingHourWithRelations WorkingHourWithRelations false none (tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })
»»»» deleted boolean false none none
»»»» deletedOn string(date-time)¦null false none none
»»»» deletedBy string¦null false none none
»»»» createdOn string(date-time) false none none
»»»» modifiedOn string(date-time) false none none
»»»» createdBy string false none none
»»»» modifiedBy string false none none
»»»» id string false none none
»»»» dayOfWeek number false none none
»»»» end string false none none
»»»» start string false none none
»»»» calendarId string true none none
»»»» extId string false none none
»»»» extMetadata object false none none
»»»» calendar CalendarWithRelations false none (tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })
»»»» foreignKey any false none none
»» subscriptions [SubscriptionWithRelations] false none (tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })
»»» SubscriptionWithRelations SubscriptionWithRelations false none (tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })
»»»» deleted boolean false none none
»»»» deletedOn string(date-time)¦null false none none
»»»» deletedBy string¦null false none none
»»»» createdOn string(date-time) false none none
»»»» modifiedOn string(date-time) false none none
»»»» createdBy string false none none
»»»» modifiedBy string false none none
»»»» id string false none none
»»»» accessRole string false none none
»»»» bgColor string false none none
»»»» fgColor string false none none
»»»» isHidden boolean false none none
»»»» isPrimary boolean false none none
»»»» identifier string true none none
»»»» defaultReminders object false none none
»»»» notificationSettings object false none none
»»»» calendarId string true none none
»»»» extId string false none none
»»»» extMetadata object false none none
»»»» calendar CalendarWithRelations false none (tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })
»»»» foreignKey any false none none

Enumerated Values

Property Value
status confirmed
status tentative
status cancelled
status completed
responseStatus needsAction
responseStatus tentative
responseStatus accepted
responseStatus declined
dayOfWeek 0
dayOfWeek 1
dayOfWeek 2
dayOfWeek 3
dayOfWeek 4
dayOfWeek 5
dayOfWeek 6
accessRole freeBusyReader
accessRole reader
accessRole writer
accessRole owner

SubscriptionController

SubscriptionController.findMe

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/subscriptions/me',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/subscriptions/me',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /calendars/subscriptions/me

Permissions
ViewSubscription
2

Parameters

Name In Type Required Description
filter query subscriptions.Filter false none

Example responses

200 Response

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
[
  {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "accessRole": "freeBusyReader",
    "bgColor": "string",
    "fgColor": "string",
    "isHidden": true,
    "isPrimary": true,
    "identifier": "string",
    "defaultReminders": {},
    "notificationSettings": {},
    "calendarId": "string",
    "extId": "string",
    "extMetadata": {},
    "calendar": {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "source": "string",
      "enableWorkingHours": true,
      "location": "string",
      "identifier": "string",
      "summary": "string",
      "timezone": "string",
      "extId": "string",
      "extMetadata": {},
      "events": [
        {
          "deleted": true,
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "bgColor": "string",
          "description": "string",
          "endDateTime": "2019-08-24T14:15:22Z",
          "fgColor": "string",
          "iCalUid": "string",
          "isFullDayEvent": true,
          "isLocked": true,
          "link": "string",
          "location": "string",
          "meetingLink": "string",
          "identifier": "string",
          "startDateTime": "2019-08-24T14:15:22Z",
          "status": "confirmed",
          "summary": "string",
          "timezone": "string",
          "calendarId": "string",
          "parentEventId": "string",
          "extId": "string",
          "extMetadata": {},
          "calendar": {},
          "foreignKey": null,
          "parentEvent": {},
          "attendees": [
            {
              "deleted": true,
              "deletedOn": "2019-08-24T14:15:22Z",
              "deletedBy": "string",
              "createdOn": "2019-08-24T14:15:22Z",
              "modifiedOn": "2019-08-24T14:15:22Z",
              "createdBy": "string",
              "modifiedBy": "string",
              "id": "string",
              "identifier": "string",
              "isOptional": true,
              "isOrganizer": true,
              "messages": "string",
              "responseStatus": "needsAction",
              "eventId": "string",
              "extId": "string",
              "extMetadata": {},
              "event": {},
              "foreignKey": null
            }
          ],
          "attachments": [
            {
              "deleted": true,
              "deletedOn": "2019-08-24T14:15:22Z",
              "deletedBy": "string",
              "createdOn": "2019-08-24T14:15:22Z",
              "modifiedOn": "2019-08-24T14:15:22Z",
              "createdBy": "string",
              "modifiedBy": "string",
              "id": "string",
              "fileUrl": "string",
              "iconLink": "string",
              "mimeType": "string",
              "title": "string",
              "eventId": "string",
              "extId": "string",
              "extMetadata": {},
              "event": {},
              "foreignKey": null
            }
          ]
        }
      ],
      "workingHours": [
        {
          "deleted": true,
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "dayOfWeek": 0,
          "end": "string",
          "start": "string",
          "calendarId": "string",
          "extId": "string",
          "extMetadata": {},
          "calendar": {},
          "foreignKey": null
        }
      ],
      "subscriptions": [
        {}
      ]
    },
    "foreignKey": null
  }
]

Responses

Status Meaning Description Schema
200 OK Array of Subscription model instances Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [SubscriptionWithRelations] false none [(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })]
» SubscriptionWithRelations SubscriptionWithRelations false none (tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })
»» deleted boolean false none none
»» deletedOn string(date-time)¦null false none none
»» deletedBy string¦null false none none
»» createdOn string(date-time) false none none
»» modifiedOn string(date-time) false none none
»» createdBy string false none none
»» modifiedBy string false none none
»» id string false none none
»» accessRole string false none none
»» bgColor string false none none
»» fgColor string false none none
»» isHidden boolean false none none
»» isPrimary boolean false none none
»» identifier string true none none
»» defaultReminders object false none none
»» notificationSettings object false none none
»» calendarId string true none none
»» extId string false none none
»» extMetadata object false none none
»» calendar CalendarWithRelations false none (tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })
»»» deleted boolean false none none
»»» deletedOn string(date-time)¦null false none none
»»» deletedBy string¦null false none none
»»» createdOn string(date-time) false none none
»»» modifiedOn string(date-time) false none none
»»» createdBy string false none none
»»» modifiedBy string false none none
»»» id string false none none
»»» source string false none none
»»» enableWorkingHours boolean false none none
»»» location string false none none
»»» identifier string true none none
»»» summary string false none none
»»» timezone string false none none
»»» extId string false none none
»»» extMetadata object false none none
»»» events [EventWithRelations] false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
»»»» EventWithRelations EventWithRelations false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
»»»»» deleted boolean false none none
»»»»» deletedOn string(date-time)¦null false none none
»»»»» deletedBy string¦null false none none
»»»»» createdOn string(date-time) false none none
»»»»» modifiedOn string(date-time) false none none
»»»»» createdBy string false none none
»»»»» modifiedBy string false none none
»»»»» id string false none none
»»»»» bgColor string false none none
»»»»» description string false none none
»»»»» endDateTime string(date-time) false none none
»»»»» fgColor string false none none
»»»»» iCalUid string false none none
»»»»» isFullDayEvent boolean false none none
»»»»» isLocked boolean false none none
»»»»» link string false none none
»»»»» location string false none none
»»»»» meetingLink string false none none
»»»»» identifier string false none none
»»»»» startDateTime string(date-time) false none none
»»»»» status string false none none
»»»»» summary string false none none
»»»»» timezone string false none none
»»»»» calendarId string true none none
»»»»» parentEventId string false none none
»»»»» extId string false none none
»»»»» extMetadata object false none none
»»»»» calendar CalendarWithRelations false none (tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })
»»»»» foreignKey any false none none
»»»»» parentEvent EventWithRelations false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
»»»»» attendees [AttendeeWithRelations] false none (tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })
»»»»»» AttendeeWithRelations AttendeeWithRelations false none (tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })
»»»»»»» deleted boolean false none none
»»»»»»» deletedOn string(date-time)¦null false none none
»»»»»»» deletedBy string¦null false none none
»»»»»»» createdOn string(date-time) false none none
»»»»»»» modifiedOn string(date-time) false none none
»»»»»»» createdBy string false none none
»»»»»»» modifiedBy string false none none
»»»»»»» id string false none none
»»»»»»» identifier string true none none
»»»»»»» isOptional boolean false none none
»»»»»»» isOrganizer boolean false none none
»»»»»»» messages string false none none
»»»»»»» responseStatus string false none none
»»»»»»» eventId string true none none
»»»»»»» extId string false none none
»»»»»»» extMetadata object false none none
»»»»»»» event EventWithRelations false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
»»»»»»» foreignKey any false none none
»»»»» attachments [AttachmentWithRelations] false none (tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })
»»»»»» AttachmentWithRelations AttachmentWithRelations false none (tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })
»»»»»»» deleted boolean false none none
»»»»»»» deletedOn string(date-time)¦null false none none
»»»»»»» deletedBy string¦null false none none
»»»»»»» createdOn string(date-time) false none none
»»»»»»» modifiedOn string(date-time) false none none
»»»»»»» createdBy string false none none
»»»»»»» modifiedBy string false none none
»»»»»»» id string false none none
»»»»»»» fileUrl string true none none
»»»»»»» iconLink string false none none
»»»»»»» mimeType string false none none
»»»»»»» title string false none none
»»»»»»» eventId string true none none
»»»»»»» extId string false none none
»»»»»»» extMetadata object false none none
»»»»»»» event EventWithRelations false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
»»»»»»» foreignKey any false none none
»»» workingHours [WorkingHourWithRelations] false none (tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })
»»»» WorkingHourWithRelations WorkingHourWithRelations false none (tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })
»»»»» deleted boolean false none none
»»»»» deletedOn string(date-time)¦null false none none
»»»»» deletedBy string¦null false none none
»»»»» createdOn string(date-time) false none none
»»»»» modifiedOn string(date-time) false none none
»»»»» createdBy string false none none
»»»»» modifiedBy string false none none
»»»»» id string false none none
»»»»» dayOfWeek number false none none
»»»»» end string false none none
»»»»» start string false none none
»»»»» calendarId string true none none
»»»»» extId string false none none
»»»»» extMetadata object false none none
»»»»» calendar CalendarWithRelations false none (tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })
»»»»» foreignKey any false none none
»»» subscriptions [SubscriptionWithRelations] false none (tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })
»»»» SubscriptionWithRelations SubscriptionWithRelations false none (tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })
»» foreignKey any false none none

Enumerated Values

Property Value
accessRole freeBusyReader
accessRole reader
accessRole writer
accessRole owner
status confirmed
status tentative
status cancelled
status completed
responseStatus needsAction
responseStatus tentative
responseStatus accepted
responseStatus declined
dayOfWeek 0
dayOfWeek 1
dayOfWeek 2
dayOfWeek 3
dayOfWeek 4
dayOfWeek 5
dayOfWeek 6

SubscriptionController.count

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/subscriptions/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/subscriptions/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /subscriptions/count

Permissions
ViewSubscription
2

Parameters

Name In Type Required Description
where query object false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Subscription model count loopback.Count

SubscriptionController.replaceById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "accessRole": "freeBusyReader",
  "bgColor": "string",
  "fgColor": "string",
  "isHidden": true,
  "isPrimary": true,
  "identifier": "string",
  "defaultReminders": {},
  "notificationSettings": {},
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/subscriptions/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "accessRole": "freeBusyReader",
  "bgColor": "string",
  "fgColor": "string",
  "isHidden": true,
  "isPrimary": true,
  "identifier": "string",
  "defaultReminders": {},
  "notificationSettings": {},
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/subscriptions/{id}',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /subscriptions/{id}

Permissions
UpdateSubscription
4

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "accessRole": "freeBusyReader",
  "bgColor": "string",
  "fgColor": "string",
  "isHidden": true,
  "isPrimary": true,
  "identifier": "string",
  "defaultReminders": {},
  "notificationSettings": {},
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
id path string true none
body body Subscription false none

Responses

Status Meaning Description Schema
204 No Content Subscription PUT success None

SubscriptionController.updateById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "accessRole": "freeBusyReader",
  "bgColor": "string",
  "fgColor": "string",
  "isHidden": true,
  "isPrimary": true,
  "identifier": "string",
  "defaultReminders": {},
  "notificationSettings": {},
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/subscriptions/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "accessRole": "freeBusyReader",
  "bgColor": "string",
  "fgColor": "string",
  "isHidden": true,
  "isPrimary": true,
  "identifier": "string",
  "defaultReminders": {},
  "notificationSettings": {},
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/subscriptions/{id}',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /subscriptions/{id}

Permissions
UpdateSubscription
4

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "accessRole": "freeBusyReader",
  "bgColor": "string",
  "fgColor": "string",
  "isHidden": true,
  "isPrimary": true,
  "identifier": "string",
  "defaultReminders": {},
  "notificationSettings": {},
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
id path string true none
body body SubscriptionPartial false none

Responses

Status Meaning Description Schema
204 No Content Subscription PATCH success None

SubscriptionController.findById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/subscriptions/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/subscriptions/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /subscriptions/{id}

Permissions
ViewSubscription
2

Parameters

Name In Type Required Description
id path string true none
filter query subscriptions.Filter1 false none

Example responses

200 Response

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "accessRole": "freeBusyReader",
  "bgColor": "string",
  "fgColor": "string",
  "isHidden": true,
  "isPrimary": true,
  "identifier": "string",
  "defaultReminders": {},
  "notificationSettings": {},
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {},
  "calendar": {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "source": "string",
    "enableWorkingHours": true,
    "location": "string",
    "identifier": "string",
    "summary": "string",
    "timezone": "string",
    "extId": "string",
    "extMetadata": {},
    "events": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "bgColor": "string",
        "description": "string",
        "endDateTime": "2019-08-24T14:15:22Z",
        "fgColor": "string",
        "iCalUid": "string",
        "isFullDayEvent": true,
        "isLocked": true,
        "link": "string",
        "location": "string",
        "meetingLink": "string",
        "identifier": "string",
        "startDateTime": "2019-08-24T14:15:22Z",
        "status": "confirmed",
        "summary": "string",
        "timezone": "string",
        "calendarId": "string",
        "parentEventId": "string",
        "extId": "string",
        "extMetadata": {},
        "calendar": {},
        "foreignKey": null,
        "parentEvent": {},
        "attendees": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "identifier": "string",
            "isOptional": true,
            "isOrganizer": true,
            "messages": "string",
            "responseStatus": "needsAction",
            "eventId": "string",
            "extId": "string",
            "extMetadata": {},
            "event": {},
            "foreignKey": null
          }
        ],
        "attachments": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "fileUrl": "string",
            "iconLink": "string",
            "mimeType": "string",
            "title": "string",
            "eventId": "string",
            "extId": "string",
            "extMetadata": {},
            "event": {},
            "foreignKey": null
          }
        ]
      }
    ],
    "workingHours": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "dayOfWeek": 0,
        "end": "string",
        "start": "string",
        "calendarId": "string",
        "extId": "string",
        "extMetadata": {},
        "calendar": {},
        "foreignKey": null
      }
    ],
    "subscriptions": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "accessRole": "freeBusyReader",
        "bgColor": "string",
        "fgColor": "string",
        "isHidden": true,
        "isPrimary": true,
        "identifier": "string",
        "defaultReminders": {},
        "notificationSettings": {},
        "calendarId": "string",
        "extId": "string",
        "extMetadata": {},
        "calendar": {},
        "foreignKey": null
      }
    ]
  },
  "foreignKey": null
}

Responses

Status Meaning Description Schema
200 OK Subscription model instance SubscriptionWithRelations

SubscriptionController.deleteById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/subscriptions/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/subscriptions/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /subscriptions/{id}

Permissions
DeleteSubscription
5

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
204 No Content Subscription DELETE success None

SubscriptionController.create

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "accessRole": "freeBusyReader",
  "bgColor": "string",
  "fgColor": "string",
  "isHidden": true,
  "isPrimary": true,
  "identifier": "string",
  "defaultReminders": {},
  "notificationSettings": {},
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/subscriptions',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "accessRole": "freeBusyReader",
  "bgColor": "string",
  "fgColor": "string",
  "isHidden": true,
  "isPrimary": true,
  "identifier": "string",
  "defaultReminders": {},
  "notificationSettings": {},
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/subscriptions',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /subscriptions

Permissions
CreateSubscription
3

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "accessRole": "freeBusyReader",
  "bgColor": "string",
  "fgColor": "string",
  "isHidden": true,
  "isPrimary": true,
  "identifier": "string",
  "defaultReminders": {},
  "notificationSettings": {},
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
body body NewSubscription false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "accessRole": "freeBusyReader",
  "bgColor": "string",
  "fgColor": "string",
  "isHidden": true,
  "isPrimary": true,
  "identifier": "string",
  "defaultReminders": {},
  "notificationSettings": {},
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
}

Responses

Status Meaning Description Schema
200 OK Subscription model instance Subscription

SubscriptionController.updateAll

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "accessRole": "freeBusyReader",
  "bgColor": "string",
  "fgColor": "string",
  "isHidden": true,
  "isPrimary": true,
  "identifier": "string",
  "defaultReminders": {},
  "notificationSettings": {},
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/subscriptions',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "accessRole": "freeBusyReader",
  "bgColor": "string",
  "fgColor": "string",
  "isHidden": true,
  "isPrimary": true,
  "identifier": "string",
  "defaultReminders": {},
  "notificationSettings": {},
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/subscriptions',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /subscriptions

Permissions
UpdateSubscription
4

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "accessRole": "freeBusyReader",
  "bgColor": "string",
  "fgColor": "string",
  "isHidden": true,
  "isPrimary": true,
  "identifier": "string",
  "defaultReminders": {},
  "notificationSettings": {},
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
where query object false none
body body SubscriptionPartial false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Subscription PATCH success count loopback.Count

SubscriptionController.find

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/subscriptions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/subscriptions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /subscriptions

Permissions
ViewSubscription
2

Parameters

Name In Type Required Description
filter query subscriptions.Filter false none

Example responses

200 Response

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
[
  {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "accessRole": "freeBusyReader",
    "bgColor": "string",
    "fgColor": "string",
    "isHidden": true,
    "isPrimary": true,
    "identifier": "string",
    "defaultReminders": {},
    "notificationSettings": {},
    "calendarId": "string",
    "extId": "string",
    "extMetadata": {},
    "calendar": {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "source": "string",
      "enableWorkingHours": true,
      "location": "string",
      "identifier": "string",
      "summary": "string",
      "timezone": "string",
      "extId": "string",
      "extMetadata": {},
      "events": [
        {
          "deleted": true,
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "bgColor": "string",
          "description": "string",
          "endDateTime": "2019-08-24T14:15:22Z",
          "fgColor": "string",
          "iCalUid": "string",
          "isFullDayEvent": true,
          "isLocked": true,
          "link": "string",
          "location": "string",
          "meetingLink": "string",
          "identifier": "string",
          "startDateTime": "2019-08-24T14:15:22Z",
          "status": "confirmed",
          "summary": "string",
          "timezone": "string",
          "calendarId": "string",
          "parentEventId": "string",
          "extId": "string",
          "extMetadata": {},
          "calendar": {},
          "foreignKey": null,
          "parentEvent": {},
          "attendees": [
            {
              "deleted": true,
              "deletedOn": "2019-08-24T14:15:22Z",
              "deletedBy": "string",
              "createdOn": "2019-08-24T14:15:22Z",
              "modifiedOn": "2019-08-24T14:15:22Z",
              "createdBy": "string",
              "modifiedBy": "string",
              "id": "string",
              "identifier": "string",
              "isOptional": true,
              "isOrganizer": true,
              "messages": "string",
              "responseStatus": "needsAction",
              "eventId": "string",
              "extId": "string",
              "extMetadata": {},
              "event": {},
              "foreignKey": null
            }
          ],
          "attachments": [
            {
              "deleted": true,
              "deletedOn": "2019-08-24T14:15:22Z",
              "deletedBy": "string",
              "createdOn": "2019-08-24T14:15:22Z",
              "modifiedOn": "2019-08-24T14:15:22Z",
              "createdBy": "string",
              "modifiedBy": "string",
              "id": "string",
              "fileUrl": "string",
              "iconLink": "string",
              "mimeType": "string",
              "title": "string",
              "eventId": "string",
              "extId": "string",
              "extMetadata": {},
              "event": {},
              "foreignKey": null
            }
          ]
        }
      ],
      "workingHours": [
        {
          "deleted": true,
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "dayOfWeek": 0,
          "end": "string",
          "start": "string",
          "calendarId": "string",
          "extId": "string",
          "extMetadata": {},
          "calendar": {},
          "foreignKey": null
        }
      ],
      "subscriptions": [
        {}
      ]
    },
    "foreignKey": null
  }
]

Responses

Status Meaning Description Schema
200 OK Array of Subscription model instances Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [SubscriptionWithRelations] false none [(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })]
» SubscriptionWithRelations SubscriptionWithRelations false none (tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })
»» deleted boolean false none none
»» deletedOn string(date-time)¦null false none none
»» deletedBy string¦null false none none
»» createdOn string(date-time) false none none
»» modifiedOn string(date-time) false none none
»» createdBy string false none none
»» modifiedBy string false none none
»» id string false none none
»» accessRole string false none none
»» bgColor string false none none
»» fgColor string false none none
»» isHidden boolean false none none
»» isPrimary boolean false none none
»» identifier string true none none
»» defaultReminders object false none none
»» notificationSettings object false none none
»» calendarId string true none none
»» extId string false none none
»» extMetadata object false none none
»» calendar CalendarWithRelations false none (tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })
»»» deleted boolean false none none
»»» deletedOn string(date-time)¦null false none none
»»» deletedBy string¦null false none none
»»» createdOn string(date-time) false none none
»»» modifiedOn string(date-time) false none none
»»» createdBy string false none none
»»» modifiedBy string false none none
»»» id string false none none
»»» source string false none none
»»» enableWorkingHours boolean false none none
»»» location string false none none
»»» identifier string true none none
»»» summary string false none none
»»» timezone string false none none
»»» extId string false none none
»»» extMetadata object false none none
»»» events [EventWithRelations] false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
»»»» EventWithRelations EventWithRelations false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
»»»»» deleted boolean false none none
»»»»» deletedOn string(date-time)¦null false none none
»»»»» deletedBy string¦null false none none
»»»»» createdOn string(date-time) false none none
»»»»» modifiedOn string(date-time) false none none
»»»»» createdBy string false none none
»»»»» modifiedBy string false none none
»»»»» id string false none none
»»»»» bgColor string false none none
»»»»» description string false none none
»»»»» endDateTime string(date-time) false none none
»»»»» fgColor string false none none
»»»»» iCalUid string false none none
»»»»» isFullDayEvent boolean false none none
»»»»» isLocked boolean false none none
»»»»» link string false none none
»»»»» location string false none none
»»»»» meetingLink string false none none
»»»»» identifier string false none none
»»»»» startDateTime string(date-time) false none none
»»»»» status string false none none
»»»»» summary string false none none
»»»»» timezone string false none none
»»»»» calendarId string true none none
»»»»» parentEventId string false none none
»»»»» extId string false none none
»»»»» extMetadata object false none none
»»»»» calendar CalendarWithRelations false none (tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })
»»»»» foreignKey any false none none
»»»»» parentEvent EventWithRelations false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
»»»»» attendees [AttendeeWithRelations] false none (tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })
»»»»»» AttendeeWithRelations AttendeeWithRelations false none (tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })
»»»»»»» deleted boolean false none none
»»»»»»» deletedOn string(date-time)¦null false none none
»»»»»»» deletedBy string¦null false none none
»»»»»»» createdOn string(date-time) false none none
»»»»»»» modifiedOn string(date-time) false none none
»»»»»»» createdBy string false none none
»»»»»»» modifiedBy string false none none
»»»»»»» id string false none none
»»»»»»» identifier string true none none
»»»»»»» isOptional boolean false none none
»»»»»»» isOrganizer boolean false none none
»»»»»»» messages string false none none
»»»»»»» responseStatus string false none none
»»»»»»» eventId string true none none
»»»»»»» extId string false none none
»»»»»»» extMetadata object false none none
»»»»»»» event EventWithRelations false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
»»»»»»» foreignKey any false none none
»»»»» attachments [AttachmentWithRelations] false none (tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })
»»»»»» AttachmentWithRelations AttachmentWithRelations false none (tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })
»»»»»»» deleted boolean false none none
»»»»»»» deletedOn string(date-time)¦null false none none
»»»»»»» deletedBy string¦null false none none
»»»»»»» createdOn string(date-time) false none none
»»»»»»» modifiedOn string(date-time) false none none
»»»»»»» createdBy string false none none
»»»»»»» modifiedBy string false none none
»»»»»»» id string false none none
»»»»»»» fileUrl string true none none
»»»»»»» iconLink string false none none
»»»»»»» mimeType string false none none
»»»»»»» title string false none none
»»»»»»» eventId string true none none
»»»»»»» extId string false none none
»»»»»»» extMetadata object false none none
»»»»»»» event EventWithRelations false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
»»»»»»» foreignKey any false none none
»»» workingHours [WorkingHourWithRelations] false none (tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })
»»»» WorkingHourWithRelations WorkingHourWithRelations false none (tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })
»»»»» deleted boolean false none none
»»»»» deletedOn string(date-time)¦null false none none
»»»»» deletedBy string¦null false none none
»»»»» createdOn string(date-time) false none none
»»»»» modifiedOn string(date-time) false none none
»»»»» createdBy string false none none
»»»»» modifiedBy string false none none
»»»»» id string false none none
»»»»» dayOfWeek number false none none
»»»»» end string false none none
»»»»» start string false none none
»»»»» calendarId string true none none
»»»»» extId string false none none
»»»»» extMetadata object false none none
»»»»» calendar CalendarWithRelations false none (tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })
»»»»» foreignKey any false none none
»»» subscriptions [SubscriptionWithRelations] false none (tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })
»»»» SubscriptionWithRelations SubscriptionWithRelations false none (tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })
»» foreignKey any false none none

Enumerated Values

Property Value
accessRole freeBusyReader
accessRole reader
accessRole writer
accessRole owner
status confirmed
status tentative
status cancelled
status completed
responseStatus needsAction
responseStatus tentative
responseStatus accepted
responseStatus declined
dayOfWeek 0
dayOfWeek 1
dayOfWeek 2
dayOfWeek 3
dayOfWeek 4
dayOfWeek 5
dayOfWeek 6

CalendarEventController

CalendarEventController.create

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "bgColor": "string",
  "description": "string",
  "endDateTime": "2019-08-24T14:15:22Z",
  "fgColor": "string",
  "iCalUid": "string",
  "isFullDayEvent": true,
  "isLocked": true,
  "link": "string",
  "location": "string",
  "meetingLink": "string",
  "identifier": "string",
  "startDateTime": "2019-08-24T14:15:22Z",
  "status": "confirmed",
  "summary": "string",
  "timezone": "string",
  "calendarId": "string",
  "parentEventId": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/{id}/events',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "bgColor": "string",
  "description": "string",
  "endDateTime": "2019-08-24T14:15:22Z",
  "fgColor": "string",
  "iCalUid": "string",
  "isFullDayEvent": true,
  "isLocked": true,
  "link": "string",
  "location": "string",
  "meetingLink": "string",
  "identifier": "string",
  "startDateTime": "2019-08-24T14:15:22Z",
  "status": "confirmed",
  "summary": "string",
  "timezone": "string",
  "calendarId": "string",
  "parentEventId": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/{id}/events',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /calendars/{id}/events

Permissions
CreateEvent
7

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "bgColor": "string",
  "description": "string",
  "endDateTime": "2019-08-24T14:15:22Z",
  "fgColor": "string",
  "iCalUid": "string",
  "isFullDayEvent": true,
  "isLocked": true,
  "link": "string",
  "location": "string",
  "meetingLink": "string",
  "identifier": "string",
  "startDateTime": "2019-08-24T14:15:22Z",
  "status": "confirmed",
  "summary": "string",
  "timezone": "string",
  "calendarId": "string",
  "parentEventId": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
id path string true none
body body NewEventInCalendar false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "bgColor": "string",
  "description": "string",
  "endDateTime": "2019-08-24T14:15:22Z",
  "fgColor": "string",
  "iCalUid": "string",
  "isFullDayEvent": true,
  "isLocked": true,
  "link": "string",
  "location": "string",
  "meetingLink": "string",
  "identifier": "string",
  "startDateTime": "2019-08-24T14:15:22Z",
  "status": "confirmed",
  "summary": "string",
  "timezone": "string",
  "calendarId": "string",
  "parentEventId": "string",
  "extId": "string",
  "extMetadata": {}
}

Responses

Status Meaning Description Schema
200 OK Calendar model instance Event

CalendarEventController.patch

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "bgColor": "string",
  "description": "string",
  "endDateTime": "2019-08-24T14:15:22Z",
  "fgColor": "string",
  "iCalUid": "string",
  "isFullDayEvent": true,
  "isLocked": true,
  "link": "string",
  "location": "string",
  "meetingLink": "string",
  "identifier": "string",
  "startDateTime": "2019-08-24T14:15:22Z",
  "status": "confirmed",
  "summary": "string",
  "timezone": "string",
  "calendarId": "string",
  "parentEventId": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/{id}/events',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "bgColor": "string",
  "description": "string",
  "endDateTime": "2019-08-24T14:15:22Z",
  "fgColor": "string",
  "iCalUid": "string",
  "isFullDayEvent": true,
  "isLocked": true,
  "link": "string",
  "location": "string",
  "meetingLink": "string",
  "identifier": "string",
  "startDateTime": "2019-08-24T14:15:22Z",
  "status": "confirmed",
  "summary": "string",
  "timezone": "string",
  "calendarId": "string",
  "parentEventId": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/{id}/events',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /calendars/{id}/events

Permissions
UpdateEvent
8

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "bgColor": "string",
  "description": "string",
  "endDateTime": "2019-08-24T14:15:22Z",
  "fgColor": "string",
  "iCalUid": "string",
  "isFullDayEvent": true,
  "isLocked": true,
  "link": "string",
  "location": "string",
  "meetingLink": "string",
  "identifier": "string",
  "startDateTime": "2019-08-24T14:15:22Z",
  "status": "confirmed",
  "summary": "string",
  "timezone": "string",
  "calendarId": "string",
  "parentEventId": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
id path string true none
where query object false none
body body EventPartial false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Calendar.Event PATCH success count loopback.Count

CalendarEventController.find

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/{id}/events',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/{id}/events',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /calendars/{id}/events

Permissions
ViewEvent
6

Parameters

Name In Type Required Description
id path string true none
filter query object false none
timeMax query string(date-time) false none
timeMin query string(date-time) false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
[
  {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "bgColor": "string",
    "description": "string",
    "endDateTime": "2019-08-24T14:15:22Z",
    "fgColor": "string",
    "iCalUid": "string",
    "isFullDayEvent": true,
    "isLocked": true,
    "link": "string",
    "location": "string",
    "meetingLink": "string",
    "identifier": "string",
    "startDateTime": "2019-08-24T14:15:22Z",
    "status": "confirmed",
    "summary": "string",
    "timezone": "string",
    "calendarId": "string",
    "parentEventId": "string",
    "extId": "string",
    "extMetadata": {}
  }
]

Responses

Status Meaning Description Schema
200 OK Array of Calendar has many Event Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [Event] false none none
» Event Event false none none
»» deleted boolean false none none
»» deletedOn string(date-time)¦null false none none
»» deletedBy string¦null false none none
»» createdOn string(date-time) false none none
»» modifiedOn string(date-time) false none none
»» createdBy string false none none
»» modifiedBy string false none none
»» id string false none none
»» bgColor string false none none
»» description string false none none
»» endDateTime string(date-time) false none none
»» fgColor string false none none
»» iCalUid string false none none
»» isFullDayEvent boolean false none none
»» isLocked boolean false none none
»» link string false none none
»» location string false none none
»» meetingLink string false none none
»» identifier string false none none
»» startDateTime string(date-time) false none none
»» status string false none none
»» summary string false none none
»» timezone string false none none
»» calendarId string true none none
»» parentEventId string false none none
»» extId string false none none
»» extMetadata object false none none

Enumerated Values

Property Value
status confirmed
status tentative
status cancelled
status completed

CalendarEventController.delete

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/{id}/events',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/{id}/events',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /calendars/{id}/events

Permissions
DeleteEvent
9

Parameters

Name In Type Required Description
id path string true none
where query object false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Calendar.Event DELETE success count loopback.Count

CalendarSubscriptionController

CalendarSubscriptionController.create

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "accessRole": "freeBusyReader",
  "bgColor": "string",
  "fgColor": "string",
  "isHidden": true,
  "isPrimary": true,
  "identifier": "string",
  "defaultReminders": {},
  "notificationSettings": {},
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/{id}/subscriptions',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "accessRole": "freeBusyReader",
  "bgColor": "string",
  "fgColor": "string",
  "isHidden": true,
  "isPrimary": true,
  "identifier": "string",
  "defaultReminders": {},
  "notificationSettings": {},
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/{id}/subscriptions',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /calendars/{id}/subscriptions

This is an api to create a calendar subscription for any calendar.

Permissions
CreateSubscription
3

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "accessRole": "freeBusyReader",
  "bgColor": "string",
  "fgColor": "string",
  "isHidden": true,
  "isPrimary": true,
  "identifier": "string",
  "defaultReminders": {},
  "notificationSettings": {},
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
id path string true none
body body NewSubscriptionInCalendar false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "accessRole": "freeBusyReader",
  "bgColor": "string",
  "fgColor": "string",
  "isHidden": true,
  "isPrimary": true,
  "identifier": "string",
  "defaultReminders": {},
  "notificationSettings": {},
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
}

Responses

Status Meaning Description Schema
200 OK Calendar model instance Subscription

CalendarSubscriptionController.patch

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "accessRole": "freeBusyReader",
  "bgColor": "string",
  "fgColor": "string",
  "isHidden": true,
  "isPrimary": true,
  "identifier": "string",
  "defaultReminders": {},
  "notificationSettings": {},
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/{id}/subscriptions',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "accessRole": "freeBusyReader",
  "bgColor": "string",
  "fgColor": "string",
  "isHidden": true,
  "isPrimary": true,
  "identifier": "string",
  "defaultReminders": {},
  "notificationSettings": {},
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/{id}/subscriptions',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /calendars/{id}/subscriptions

This api is to update the calendar subscription by passing an id. This action will be allowed only to the owner of the calendar or the admin. To identify the owner we will check for the email passed in the token and the corresponding access level, whereas to identify the admin we will check for the permission.

Permissions
UpdateSubscription
4

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "accessRole": "freeBusyReader",
  "bgColor": "string",
  "fgColor": "string",
  "isHidden": true,
  "isPrimary": true,
  "identifier": "string",
  "defaultReminders": {},
  "notificationSettings": {},
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
id path string true none
where query object false none
body body SubscriptionPartial false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Calendar.Subscription PATCH success count loopback.Count

CalendarSubscriptionController.find

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/{id}/subscriptions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/{id}/subscriptions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /calendars/{id}/subscriptions

These requests will be available to the owner of the subscription.

Permissions
ViewSubscription
2

Parameters

Name In Type Required Description
id path string true none
filter query object false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
[
  {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "accessRole": "freeBusyReader",
    "bgColor": "string",
    "fgColor": "string",
    "isHidden": true,
    "isPrimary": true,
    "identifier": "string",
    "defaultReminders": {},
    "notificationSettings": {},
    "calendarId": "string",
    "extId": "string",
    "extMetadata": {}
  }
]

Responses

Status Meaning Description Schema
200 OK Array of Calendar has many Subscriptions Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [Subscription] false none none
» Subscription Subscription false none none
»» deleted boolean false none none
»» deletedOn string(date-time)¦null false none none
»» deletedBy string¦null false none none
»» createdOn string(date-time) false none none
»» modifiedOn string(date-time) false none none
»» createdBy string false none none
»» modifiedBy string false none none
»» id string false none none
»» accessRole string false none none
»» bgColor string false none none
»» fgColor string false none none
»» isHidden boolean false none none
»» isPrimary boolean false none none
»» identifier string true none none
»» defaultReminders object false none none
»» notificationSettings object false none none
»» calendarId string true none none
»» extId string false none none
»» extMetadata object false none none

Enumerated Values

Property Value
accessRole freeBusyReader
accessRole reader
accessRole writer
accessRole owner

CalendarSubscriptionController.delete

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/{id}/subscriptions',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/{id}/subscriptions',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /calendars/{id}/subscriptions

This api is to update the calendar subscription by passing an id. This action will be allowed only to the owner of the calendar or the admin. To identify the ‘owner’ we will check for the email passed in the token and the corresponding access level, whereas to identify the admin we will check for the permission.

Permissions
DeleteSubscription
5

Parameters

Name In Type Required Description
id path string true none
where query object false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Calendar.Subscription DELETE success count loopback.Count

CalendarWorkingHourController

CalendarWorkingHourController.create

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "dayOfWeek": 0,
  "end": "string",
  "start": "string",
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/{id}/working-hours',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "dayOfWeek": 0,
  "end": "string",
  "start": "string",
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/{id}/working-hours',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /calendars/{id}/working-hours

This is an api to create a calendar for any user.

Permissions
CreateWorkingHour
32

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "dayOfWeek": 0,
  "end": "string",
  "start": "string",
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
id path string true none
body body NewWorkingHourInCalendar false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "dayOfWeek": 0,
  "end": "string",
  "start": "string",
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
}

Responses

Status Meaning Description Schema
200 OK Calendar model instance WorkingHour

CalendarWorkingHourController.patch

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "dayOfWeek": 0,
  "end": "string",
  "start": "string",
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/{id}/working-hours',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "dayOfWeek": 0,
  "end": "string",
  "start": "string",
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/{id}/working-hours',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /calendars/{id}/working-hours

Permissions
UpdateWorkingHour
33

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "dayOfWeek": 0,
  "end": "string",
  "start": "string",
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
id path string true none
where query object false none
body body WorkingHourPartial false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Calendar.WorkingHour PATCH success count loopback.Count

CalendarWorkingHourController.find

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/{id}/working-hours',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/{id}/working-hours',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /calendars/{id}/working-hours

Permissions
ViewWorkingHour
31

Parameters

Name In Type Required Description
id path string true none
filter query object false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
[
  {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "dayOfWeek": 0,
    "end": "string",
    "start": "string",
    "calendarId": "string",
    "extId": "string",
    "extMetadata": {}
  }
]

Responses

Status Meaning Description Schema
200 OK Array of Calendar has many WorkingHour Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [WorkingHour] false none none
» WorkingHour WorkingHour false none none
»» deleted boolean false none none
»» deletedOn string(date-time)¦null false none none
»» deletedBy string¦null false none none
»» createdOn string(date-time) false none none
»» modifiedOn string(date-time) false none none
»» createdBy string false none none
»» modifiedBy string false none none
»» id string false none none
»» dayOfWeek number false none none
»» end string false none none
»» start string false none none
»» calendarId string true none none
»» extId string false none none
»» extMetadata object false none none

Enumerated Values

Property Value
dayOfWeek 0
dayOfWeek 1
dayOfWeek 2
dayOfWeek 3
dayOfWeek 4
dayOfWeek 5
dayOfWeek 6

CalendarWorkingHourController.delete

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/{id}/working-hours',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/calendars/{id}/working-hours',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /calendars/{id}/working-hours

Permissions
DeleteWorkingHour
34

Parameters

Name In Type Required Description
id path string true none
where query object false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Calendar.WorkingHour DELETE success count loopback.Count

EventController

EventController.count

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /events/count

Permissions
ViewEvent
6

Parameters

Name In Type Required Description
where query object false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Event model count loopback.Count

EventController.getFeeBusyStatus

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
const inputBody = '{
  "timeMax": "2019-08-24T14:15:22Z",
  "timeMin": "2019-08-24T14:15:22Z",
  "items": [
    {
      "id": "string",
      "bgColor": "string",
      "description": "string",
      "endDateTime": "2019-08-24T14:15:22Z",
      "extId": "string",
      "extMetadata": {},
      "fgColor": "string",
      "iCalUid": "string",
      "isFullDayEvent": true,
      "isLocked": true,
      "link": "string",
      "location": "string",
      "meetingLink": "string",
      "identifier": "string",
      "startDateTime": "2019-08-24T14:15:22Z",
      "status": "confirmed",
      "summary": "string",
      "timezone": "string",
      "attendeeId": "string",
      "isOptional": true,
      "attendeeIdentifier": "string",
      "isOrganizer": true,
      "messages": "string",
      "eventId": "string"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events/freeBusy',
{
  method: 'GET',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
const fetch = require('node-fetch');
const inputBody = {
  "timeMax": "2019-08-24T14:15:22Z",
  "timeMin": "2019-08-24T14:15:22Z",
  "items": [
    {
      "id": "string",
      "bgColor": "string",
      "description": "string",
      "endDateTime": "2019-08-24T14:15:22Z",
      "extId": "string",
      "extMetadata": {},
      "fgColor": "string",
      "iCalUid": "string",
      "isFullDayEvent": true,
      "isLocked": true,
      "link": "string",
      "location": "string",
      "meetingLink": "string",
      "identifier": "string",
      "startDateTime": "2019-08-24T14:15:22Z",
      "status": "confirmed",
      "summary": "string",
      "timezone": "string",
      "attendeeId": "string",
      "isOptional": true,
      "attendeeIdentifier": "string",
      "isOrganizer": true,
      "messages": "string",
      "eventId": "string"
    }
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events/freeBusy',
{
  method: 'GET',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /events/freeBusy

Permissions
ViewEvent
ViewAttendee
6
19

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
  "timeMax": "2019-08-24T14:15:22Z",
  "timeMin": "2019-08-24T14:15:22Z",
  "items": [
    {
      "id": "string",
      "bgColor": "string",
      "description": "string",
      "endDateTime": "2019-08-24T14:15:22Z",
      "extId": "string",
      "extMetadata": {},
      "fgColor": "string",
      "iCalUid": "string",
      "isFullDayEvent": true,
      "isLocked": true,
      "link": "string",
      "location": "string",
      "meetingLink": "string",
      "identifier": "string",
      "startDateTime": "2019-08-24T14:15:22Z",
      "status": "confirmed",
      "summary": "string",
      "timezone": "string",
      "attendeeId": "string",
      "isOptional": true,
      "attendeeIdentifier": "string",
      "isOrganizer": true,
      "messages": "string",
      "eventId": "string"
    }
  ]
}

Parameters

Name In Type Required Description
body body FreeBusyRequest false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "bgColor": "string",
  "description": "string",
  "endDateTime": "2019-08-24T14:15:22Z",
  "fgColor": "string",
  "iCalUid": "string",
  "isFullDayEvent": true,
  "isLocked": true,
  "link": "string",
  "location": "string",
  "meetingLink": "string",
  "identifier": "string",
  "startDateTime": "2019-08-24T14:15:22Z",
  "status": "confirmed",
  "summary": "string",
  "timezone": "string",
  "calendarId": "string",
  "parentEventId": "string",
  "extId": "string",
  "extMetadata": {}
}

Responses

Status Meaning Description Schema
200 OK Event model freeBusy Event

EventController.hardDeleteById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/events/{id}/hard',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/events/{id}/hard',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /events/{id}/hard

Permissions
HardDeleteEvent
10

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
204 No Content Event HARD DELETE success None

EventController.replaceById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "bgColor": "string",
  "description": "string",
  "endDateTime": "2019-08-24T14:15:22Z",
  "fgColor": "string",
  "iCalUid": "string",
  "isFullDayEvent": true,
  "isLocked": true,
  "link": "string",
  "location": "string",
  "meetingLink": "string",
  "identifier": "string",
  "startDateTime": "2019-08-24T14:15:22Z",
  "status": "confirmed",
  "summary": "string",
  "timezone": "string",
  "calendarId": "string",
  "parentEventId": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "bgColor": "string",
  "description": "string",
  "endDateTime": "2019-08-24T14:15:22Z",
  "fgColor": "string",
  "iCalUid": "string",
  "isFullDayEvent": true,
  "isLocked": true,
  "link": "string",
  "location": "string",
  "meetingLink": "string",
  "identifier": "string",
  "startDateTime": "2019-08-24T14:15:22Z",
  "status": "confirmed",
  "summary": "string",
  "timezone": "string",
  "calendarId": "string",
  "parentEventId": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events/{id}',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /events/{id}

This api will be responsible for making any updates on an event. This action is only allowed to the organizer or the admin(based on permission).

Permissions
UpdateEvent
8

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "bgColor": "string",
  "description": "string",
  "endDateTime": "2019-08-24T14:15:22Z",
  "fgColor": "string",
  "iCalUid": "string",
  "isFullDayEvent": true,
  "isLocked": true,
  "link": "string",
  "location": "string",
  "meetingLink": "string",
  "identifier": "string",
  "startDateTime": "2019-08-24T14:15:22Z",
  "status": "confirmed",
  "summary": "string",
  "timezone": "string",
  "calendarId": "string",
  "parentEventId": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
id path string true none
body body Event false none

Responses

Status Meaning Description Schema
204 No Content Event PUT success None

EventController.updateById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "bgColor": "string",
  "description": "string",
  "endDateTime": "2019-08-24T14:15:22Z",
  "fgColor": "string",
  "iCalUid": "string",
  "isFullDayEvent": true,
  "isLocked": true,
  "link": "string",
  "location": "string",
  "meetingLink": "string",
  "identifier": "string",
  "startDateTime": "2019-08-24T14:15:22Z",
  "status": "confirmed",
  "summary": "string",
  "timezone": "string",
  "calendarId": "string",
  "parentEventId": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "bgColor": "string",
  "description": "string",
  "endDateTime": "2019-08-24T14:15:22Z",
  "fgColor": "string",
  "iCalUid": "string",
  "isFullDayEvent": true,
  "isLocked": true,
  "link": "string",
  "location": "string",
  "meetingLink": "string",
  "identifier": "string",
  "startDateTime": "2019-08-24T14:15:22Z",
  "status": "confirmed",
  "summary": "string",
  "timezone": "string",
  "calendarId": "string",
  "parentEventId": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events/{id}',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /events/{id}

This api will be responsible for making any updates on an event. This action is only allowed to the organizer or the admin(based on permission).

Permissions
UpdateEvent
8

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "bgColor": "string",
  "description": "string",
  "endDateTime": "2019-08-24T14:15:22Z",
  "fgColor": "string",
  "iCalUid": "string",
  "isFullDayEvent": true,
  "isLocked": true,
  "link": "string",
  "location": "string",
  "meetingLink": "string",
  "identifier": "string",
  "startDateTime": "2019-08-24T14:15:22Z",
  "status": "confirmed",
  "summary": "string",
  "timezone": "string",
  "calendarId": "string",
  "parentEventId": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
id path string true none
body body EventPartial false none

Responses

Status Meaning Description Schema
204 No Content Event PATCH success None

EventController.findById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /events/{id}

This api will return events data based on the id. Sending the data of participants will be optional and will depend on the query.

Permissions
ViewEvent
6

Parameters

Name In Type Required Description
id path string true none
filter query events.Filter false none

Example responses

200 Response

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "bgColor": "string",
  "description": "string",
  "endDateTime": "2019-08-24T14:15:22Z",
  "fgColor": "string",
  "iCalUid": "string",
  "isFullDayEvent": true,
  "isLocked": true,
  "link": "string",
  "location": "string",
  "meetingLink": "string",
  "identifier": "string",
  "startDateTime": "2019-08-24T14:15:22Z",
  "status": "confirmed",
  "summary": "string",
  "timezone": "string",
  "calendarId": "string",
  "parentEventId": "string",
  "extId": "string",
  "extMetadata": {},
  "calendar": {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "source": "string",
    "enableWorkingHours": true,
    "location": "string",
    "identifier": "string",
    "summary": "string",
    "timezone": "string",
    "extId": "string",
    "extMetadata": {},
    "events": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "bgColor": "string",
        "description": "string",
        "endDateTime": "2019-08-24T14:15:22Z",
        "fgColor": "string",
        "iCalUid": "string",
        "isFullDayEvent": true,
        "isLocked": true,
        "link": "string",
        "location": "string",
        "meetingLink": "string",
        "identifier": "string",
        "startDateTime": "2019-08-24T14:15:22Z",
        "status": "confirmed",
        "summary": "string",
        "timezone": "string",
        "calendarId": "string",
        "parentEventId": "string",
        "extId": "string",
        "extMetadata": {},
        "calendar": {},
        "foreignKey": null,
        "parentEvent": {},
        "attendees": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "identifier": "string",
            "isOptional": true,
            "isOrganizer": true,
            "messages": "string",
            "responseStatus": "needsAction",
            "eventId": "string",
            "extId": "string",
            "extMetadata": {},
            "event": {},
            "foreignKey": null
          }
        ],
        "attachments": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "fileUrl": "string",
            "iconLink": "string",
            "mimeType": "string",
            "title": "string",
            "eventId": "string",
            "extId": "string",
            "extMetadata": {},
            "event": {},
            "foreignKey": null
          }
        ]
      }
    ],
    "workingHours": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "dayOfWeek": 0,
        "end": "string",
        "start": "string",
        "calendarId": "string",
        "extId": "string",
        "extMetadata": {},
        "calendar": {},
        "foreignKey": null
      }
    ],
    "subscriptions": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "accessRole": "freeBusyReader",
        "bgColor": "string",
        "fgColor": "string",
        "isHidden": true,
        "isPrimary": true,
        "identifier": "string",
        "defaultReminders": {},
        "notificationSettings": {},
        "calendarId": "string",
        "extId": "string",
        "extMetadata": {},
        "calendar": {},
        "foreignKey": null
      }
    ]
  },
  "foreignKey": null,
  "parentEvent": {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "bgColor": "string",
    "description": "string",
    "endDateTime": "2019-08-24T14:15:22Z",
    "fgColor": "string",
    "iCalUid": "string",
    "isFullDayEvent": true,
    "isLocked": true,
    "link": "string",
    "location": "string",
    "meetingLink": "string",
    "identifier": "string",
    "startDateTime": "2019-08-24T14:15:22Z",
    "status": "confirmed",
    "summary": "string",
    "timezone": "string",
    "calendarId": "string",
    "parentEventId": "string",
    "extId": "string",
    "extMetadata": {},
    "calendar": {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "source": "string",
      "enableWorkingHours": true,
      "location": "string",
      "identifier": "string",
      "summary": "string",
      "timezone": "string",
      "extId": "string",
      "extMetadata": {},
      "events": [
        {}
      ],
      "workingHours": [
        {
          "deleted": true,
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "dayOfWeek": 0,
          "end": "string",
          "start": "string",
          "calendarId": "string",
          "extId": "string",
          "extMetadata": {},
          "calendar": {},
          "foreignKey": null
        }
      ],
      "subscriptions": [
        {
          "deleted": true,
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "accessRole": "freeBusyReader",
          "bgColor": "string",
          "fgColor": "string",
          "isHidden": true,
          "isPrimary": true,
          "identifier": "string",
          "defaultReminders": {},
          "notificationSettings": {},
          "calendarId": "string",
          "extId": "string",
          "extMetadata": {},
          "calendar": {},
          "foreignKey": null
        }
      ]
    },
    "foreignKey": null,
    "parentEvent": {},
    "attendees": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "identifier": "string",
        "isOptional": true,
        "isOrganizer": true,
        "messages": "string",
        "responseStatus": "needsAction",
        "eventId": "string",
        "extId": "string",
        "extMetadata": {},
        "event": {},
        "foreignKey": null
      }
    ],
    "attachments": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "fileUrl": "string",
        "iconLink": "string",
        "mimeType": "string",
        "title": "string",
        "eventId": "string",
        "extId": "string",
        "extMetadata": {},
        "event": {},
        "foreignKey": null
      }
    ]
  },
  "attendees": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "identifier": "string",
      "isOptional": true,
      "isOrganizer": true,
      "messages": "string",
      "responseStatus": "needsAction",
      "eventId": "string",
      "extId": "string",
      "extMetadata": {},
      "event": {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "bgColor": "string",
        "description": "string",
        "endDateTime": "2019-08-24T14:15:22Z",
        "fgColor": "string",
        "iCalUid": "string",
        "isFullDayEvent": true,
        "isLocked": true,
        "link": "string",
        "location": "string",
        "meetingLink": "string",
        "identifier": "string",
        "startDateTime": "2019-08-24T14:15:22Z",
        "status": "confirmed",
        "summary": "string",
        "timezone": "string",
        "calendarId": "string",
        "parentEventId": "string",
        "extId": "string",
        "extMetadata": {},
        "calendar": {
          "deleted": true,
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "source": "string",
          "enableWorkingHours": true,
          "location": "string",
          "identifier": "string",
          "summary": "string",
          "timezone": "string",
          "extId": "string",
          "extMetadata": {},
          "events": [
            {}
          ],
          "workingHours": [
            {
              "deleted": true,
              "deletedOn": "2019-08-24T14:15:22Z",
              "deletedBy": "string",
              "createdOn": "2019-08-24T14:15:22Z",
              "modifiedOn": "2019-08-24T14:15:22Z",
              "createdBy": "string",
              "modifiedBy": "string",
              "id": "string",
              "dayOfWeek": 0,
              "end": "string",
              "start": "string",
              "calendarId": "string",
              "extId": "string",
              "extMetadata": {},
              "calendar": {},
              "foreignKey": null
            }
          ],
          "subscriptions": [
            {
              "deleted": true,
              "deletedOn": "2019-08-24T14:15:22Z",
              "deletedBy": "string",
              "createdOn": "2019-08-24T14:15:22Z",
              "modifiedOn": "2019-08-24T14:15:22Z",
              "createdBy": "string",
              "modifiedBy": "string",
              "id": "string",
              "accessRole": "freeBusyReader",
              "bgColor": "string",
              "fgColor": "string",
              "isHidden": true,
              "isPrimary": true,
              "identifier": "string",
              "defaultReminders": {},
              "notificationSettings": {},
              "calendarId": "string",
              "extId": "string",
              "extMetadata": {},
              "calendar": {},
              "foreignKey": null
            }
          ]
        },
        "foreignKey": null,
        "parentEvent": {},
        "attendees": [],
        "attachments": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "fileUrl": "string",
            "iconLink": "string",
            "mimeType": "string",
            "title": "string",
            "eventId": "string",
            "extId": "string",
            "extMetadata": {},
            "event": {},
            "foreignKey": null
          }
        ]
      },
      "foreignKey": null
    }
  ],
  "attachments": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "fileUrl": "string",
      "iconLink": "string",
      "mimeType": "string",
      "title": "string",
      "eventId": "string",
      "extId": "string",
      "extMetadata": {},
      "event": {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "bgColor": "string",
        "description": "string",
        "endDateTime": "2019-08-24T14:15:22Z",
        "fgColor": "string",
        "iCalUid": "string",
        "isFullDayEvent": true,
        "isLocked": true,
        "link": "string",
        "location": "string",
        "meetingLink": "string",
        "identifier": "string",
        "startDateTime": "2019-08-24T14:15:22Z",
        "status": "confirmed",
        "summary": "string",
        "timezone": "string",
        "calendarId": "string",
        "parentEventId": "string",
        "extId": "string",
        "extMetadata": {},
        "calendar": {
          "deleted": true,
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "source": "string",
          "enableWorkingHours": true,
          "location": "string",
          "identifier": "string",
          "summary": "string",
          "timezone": "string",
          "extId": "string",
          "extMetadata": {},
          "events": [
            {}
          ],
          "workingHours": [
            {
              "deleted": true,
              "deletedOn": "2019-08-24T14:15:22Z",
              "deletedBy": "string",
              "createdOn": "2019-08-24T14:15:22Z",
              "modifiedOn": "2019-08-24T14:15:22Z",
              "createdBy": "string",
              "modifiedBy": "string",
              "id": "string",
              "dayOfWeek": 0,
              "end": "string",
              "start": "string",
              "calendarId": "string",
              "extId": "string",
              "extMetadata": {},
              "calendar": {},
              "foreignKey": null
            }
          ],
          "subscriptions": [
            {
              "deleted": true,
              "deletedOn": "2019-08-24T14:15:22Z",
              "deletedBy": "string",
              "createdOn": "2019-08-24T14:15:22Z",
              "modifiedOn": "2019-08-24T14:15:22Z",
              "createdBy": "string",
              "modifiedBy": "string",
              "id": "string",
              "accessRole": "freeBusyReader",
              "bgColor": "string",
              "fgColor": "string",
              "isHidden": true,
              "isPrimary": true,
              "identifier": "string",
              "defaultReminders": {},
              "notificationSettings": {},
              "calendarId": "string",
              "extId": "string",
              "extMetadata": {},
              "calendar": {},
              "foreignKey": null
            }
          ]
        },
        "foreignKey": null,
        "parentEvent": {},
        "attendees": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "identifier": "string",
            "isOptional": true,
            "isOrganizer": true,
            "messages": "string",
            "responseStatus": "needsAction",
            "eventId": "string",
            "extId": "string",
            "extMetadata": {},
            "event": {},
            "foreignKey": null
          }
        ],
        "attachments": []
      },
      "foreignKey": null
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Event model instance EventWithRelations

EventController.deleteById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/events/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/events/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /events/{id}

Api to delete the event based on id. The action is only allowed to the organiser or the admin(based on permission).

Permissions
DeleteEvent
9

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
204 No Content Event DELETE success None

EventController.create

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
const inputBody = '{
  "bgColor": "string",
  "description": "string",
  "endDateTime": "2019-08-24T14:15:22Z",
  "fgColor": "string",
  "iCalUid": "string",
  "isFullDayEvent": true,
  "isLocked": true,
  "link": "string",
  "location": "string",
  "meetingLink": "string",
  "identifier": "string",
  "startDateTime": "2019-08-24T14:15:22Z",
  "status": "confirmed",
  "summary": "string",
  "timezone": "string",
  "calendarId": "string",
  "parentEventId": "string",
  "attachments": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "fileUrl": "string",
      "iconLink": "string",
      "mimeType": "string",
      "title": "string",
      "eventId": "string",
      "extId": "string",
      "extMetadata": {}
    }
  ],
  "attendees": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "identifier": "string",
      "isOptional": true,
      "isOrganizer": true,
      "messages": "string",
      "responseStatus": "needsAction",
      "eventId": "string",
      "extId": "string",
      "extMetadata": {}
    }
  ],
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
const fetch = require('node-fetch');
const inputBody = {
  "bgColor": "string",
  "description": "string",
  "endDateTime": "2019-08-24T14:15:22Z",
  "fgColor": "string",
  "iCalUid": "string",
  "isFullDayEvent": true,
  "isLocked": true,
  "link": "string",
  "location": "string",
  "meetingLink": "string",
  "identifier": "string",
  "startDateTime": "2019-08-24T14:15:22Z",
  "status": "confirmed",
  "summary": "string",
  "timezone": "string",
  "calendarId": "string",
  "parentEventId": "string",
  "attachments": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "fileUrl": "string",
      "iconLink": "string",
      "mimeType": "string",
      "title": "string",
      "eventId": "string",
      "extId": "string",
      "extMetadata": {}
    }
  ],
  "attendees": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "identifier": "string",
      "isOptional": true,
      "isOrganizer": true,
      "messages": "string",
      "responseStatus": "needsAction",
      "eventId": "string",
      "extId": "string",
      "extMetadata": {}
    }
  ],
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /events

While an organizer creates an event, we get participants details along with it. This api will check for slot availability of all the participants in that particular time slot. If the slot is free the event will be created. Events can be scheduled on behalf of someone else, In this case we will be saving the creator details (generally the organiser is the creator themselves, so we will be keeping the organiser and created_by the same).

Permissions
CreateEvent
7

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
{
  "bgColor": "string",
  "description": "string",
  "endDateTime": "2019-08-24T14:15:22Z",
  "fgColor": "string",
  "iCalUid": "string",
  "isFullDayEvent": true,
  "isLocked": true,
  "link": "string",
  "location": "string",
  "meetingLink": "string",
  "identifier": "string",
  "startDateTime": "2019-08-24T14:15:22Z",
  "status": "confirmed",
  "summary": "string",
  "timezone": "string",
  "calendarId": "string",
  "parentEventId": "string",
  "attachments": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "fileUrl": "string",
      "iconLink": "string",
      "mimeType": "string",
      "title": "string",
      "eventId": "string",
      "extId": "string",
      "extMetadata": {}
    }
  ],
  "attendees": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "identifier": "string",
      "isOptional": true,
      "isOrganizer": true,
      "messages": "string",
      "responseStatus": "needsAction",
      "eventId": "string",
      "extId": "string",
      "extMetadata": {}
    }
  ],
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
body body NewEvent false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "bgColor": "string",
  "description": "string",
  "endDateTime": "2019-08-24T14:15:22Z",
  "fgColor": "string",
  "iCalUid": "string",
  "isFullDayEvent": true,
  "isLocked": true,
  "link": "string",
  "location": "string",
  "meetingLink": "string",
  "identifier": "string",
  "startDateTime": "2019-08-24T14:15:22Z",
  "status": "confirmed",
  "summary": "string",
  "timezone": "string",
  "calendarId": "string",
  "parentEventId": "string",
  "extId": "string",
  "extMetadata": {}
}

Responses

Status Meaning Description Schema
200 OK Event model instance Event

EventController.updateAll

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "bgColor": "string",
  "description": "string",
  "endDateTime": "2019-08-24T14:15:22Z",
  "fgColor": "string",
  "iCalUid": "string",
  "isFullDayEvent": true,
  "isLocked": true,
  "link": "string",
  "location": "string",
  "meetingLink": "string",
  "identifier": "string",
  "startDateTime": "2019-08-24T14:15:22Z",
  "status": "confirmed",
  "summary": "string",
  "timezone": "string",
  "calendarId": "string",
  "parentEventId": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "bgColor": "string",
  "description": "string",
  "endDateTime": "2019-08-24T14:15:22Z",
  "fgColor": "string",
  "iCalUid": "string",
  "isFullDayEvent": true,
  "isLocked": true,
  "link": "string",
  "location": "string",
  "meetingLink": "string",
  "identifier": "string",
  "startDateTime": "2019-08-24T14:15:22Z",
  "status": "confirmed",
  "summary": "string",
  "timezone": "string",
  "calendarId": "string",
  "parentEventId": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /events

Permissions
UpdateEvent
8

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "bgColor": "string",
  "description": "string",
  "endDateTime": "2019-08-24T14:15:22Z",
  "fgColor": "string",
  "iCalUid": "string",
  "isFullDayEvent": true,
  "isLocked": true,
  "link": "string",
  "location": "string",
  "meetingLink": "string",
  "identifier": "string",
  "startDateTime": "2019-08-24T14:15:22Z",
  "status": "confirmed",
  "summary": "string",
  "timezone": "string",
  "calendarId": "string",
  "parentEventId": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
where query object false none
body body EventPartial false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Event PATCH success count loopback.Count

EventController.find

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /events

This api will return the events data, based on the filter provided. Sending the data of participants will be optional and will depend on the query.

Permissions
ViewEvent
6

Parameters

Name In Type Required Description
filter query events_attendees_view.Filter false none

Example responses

200 Response

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
[
  {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "bgColor": "string",
    "description": "string",
    "endDateTime": "2019-08-24T14:15:22Z",
    "fgColor": "string",
    "iCalUid": "string",
    "isFullDayEvent": true,
    "isLocked": true,
    "link": "string",
    "location": "string",
    "meetingLink": "string",
    "identifier": "string",
    "startDateTime": "2019-08-24T14:15:22Z",
    "status": "confirmed",
    "summary": "string",
    "timezone": "string",
    "calendarId": "string",
    "parentEventId": "string",
    "extId": "string",
    "extMetadata": {},
    "calendar": {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "source": "string",
      "enableWorkingHours": true,
      "location": "string",
      "identifier": "string",
      "summary": "string",
      "timezone": "string",
      "extId": "string",
      "extMetadata": {},
      "events": [
        {}
      ],
      "workingHours": [
        {
          "deleted": true,
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "dayOfWeek": 0,
          "end": "string",
          "start": "string",
          "calendarId": "string",
          "extId": "string",
          "extMetadata": {},
          "calendar": {},
          "foreignKey": null
        }
      ],
      "subscriptions": [
        {
          "deleted": true,
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "accessRole": "freeBusyReader",
          "bgColor": "string",
          "fgColor": "string",
          "isHidden": true,
          "isPrimary": true,
          "identifier": "string",
          "defaultReminders": {},
          "notificationSettings": {},
          "calendarId": "string",
          "extId": "string",
          "extMetadata": {},
          "calendar": {},
          "foreignKey": null
        }
      ]
    },
    "foreignKey": null,
    "parentEvent": {},
    "attendees": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "identifier": "string",
        "isOptional": true,
        "isOrganizer": true,
        "messages": "string",
        "responseStatus": "needsAction",
        "eventId": "string",
        "extId": "string",
        "extMetadata": {},
        "event": {},
        "foreignKey": null
      }
    ],
    "attachments": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "fileUrl": "string",
        "iconLink": "string",
        "mimeType": "string",
        "title": "string",
        "eventId": "string",
        "extId": "string",
        "extMetadata": {},
        "event": {},
        "foreignKey": null
      }
    ]
  }
]

Responses

Status Meaning Description Schema
200 OK Array of Event model instances Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [EventWithRelations] false none [(tsType: EventWithRelations, schemaOptions: { includeRelations: true })]
» EventWithRelations EventWithRelations false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
»» deleted boolean false none none
»» deletedOn string(date-time)¦null false none none
»» deletedBy string¦null false none none
»» createdOn string(date-time) false none none
»» modifiedOn string(date-time) false none none
»» createdBy string false none none
»» modifiedBy string false none none
»» id string false none none
»» bgColor string false none none
»» description string false none none
»» endDateTime string(date-time) false none none
»» fgColor string false none none
»» iCalUid string false none none
»» isFullDayEvent boolean false none none
»» isLocked boolean false none none
»» link string false none none
»» location string false none none
»» meetingLink string false none none
»» identifier string false none none
»» startDateTime string(date-time) false none none
»» status string false none none
»» summary string false none none
»» timezone string false none none
»» calendarId string true none none
»» parentEventId string false none none
»» extId string false none none
»» extMetadata object false none none
»» calendar CalendarWithRelations false none (tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })
»»» deleted boolean false none none
»»» deletedOn string(date-time)¦null false none none
»»» deletedBy string¦null false none none
»»» createdOn string(date-time) false none none
»»» modifiedOn string(date-time) false none none
»»» createdBy string false none none
»»» modifiedBy string false none none
»»» id string false none none
»»» source string false none none
»»» enableWorkingHours boolean false none none
»»» location string false none none
»»» identifier string true none none
»»» summary string false none none
»»» timezone string false none none
»»» extId string false none none
»»» extMetadata object false none none
»»» events [EventWithRelations] false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
»»»» EventWithRelations EventWithRelations false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
»»» workingHours [WorkingHourWithRelations] false none (tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })
»»»» WorkingHourWithRelations WorkingHourWithRelations false none (tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })
»»»»» deleted boolean false none none
»»»»» deletedOn string(date-time)¦null false none none
»»»»» deletedBy string¦null false none none
»»»»» createdOn string(date-time) false none none
»»»»» modifiedOn string(date-time) false none none
»»»»» createdBy string false none none
»»»»» modifiedBy string false none none
»»»»» id string false none none
»»»»» dayOfWeek number false none none
»»»»» end string false none none
»»»»» start string false none none
»»»»» calendarId string true none none
»»»»» extId string false none none
»»»»» extMetadata object false none none
»»»»» calendar CalendarWithRelations false none (tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })
»»»»» foreignKey any false none none
»»» subscriptions [SubscriptionWithRelations] false none (tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })
»»»» SubscriptionWithRelations SubscriptionWithRelations false none (tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })
»»»»» deleted boolean false none none
»»»»» deletedOn string(date-time)¦null false none none
»»»»» deletedBy string¦null false none none
»»»»» createdOn string(date-time) false none none
»»»»» modifiedOn string(date-time) false none none
»»»»» createdBy string false none none
»»»»» modifiedBy string false none none
»»»»» id string false none none
»»»»» accessRole string false none none
»»»»» bgColor string false none none
»»»»» fgColor string false none none
»»»»» isHidden boolean false none none
»»»»» isPrimary boolean false none none
»»»»» identifier string true none none
»»»»» defaultReminders object false none none
»»»»» notificationSettings object false none none
»»»»» calendarId string true none none
»»»»» extId string false none none
»»»»» extMetadata object false none none
»»»»» calendar CalendarWithRelations false none (tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })
»»»»» foreignKey any false none none
»» foreignKey any false none none
»» parentEvent EventWithRelations false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
»» attendees [AttendeeWithRelations] false none (tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })
»»» AttendeeWithRelations AttendeeWithRelations false none (tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })
»»»» deleted boolean false none none
»»»» deletedOn string(date-time)¦null false none none
»»»» deletedBy string¦null false none none
»»»» createdOn string(date-time) false none none
»»»» modifiedOn string(date-time) false none none
»»»» createdBy string false none none
»»»» modifiedBy string false none none
»»»» id string false none none
»»»» identifier string true none none
»»»» isOptional boolean false none none
»»»» isOrganizer boolean false none none
»»»» messages string false none none
»»»» responseStatus string false none none
»»»» eventId string true none none
»»»» extId string false none none
»»»» extMetadata object false none none
»»»» event EventWithRelations false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
»»»» foreignKey any false none none
»» attachments [AttachmentWithRelations] false none (tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })
»»» AttachmentWithRelations AttachmentWithRelations false none (tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })
»»»» deleted boolean false none none
»»»» deletedOn string(date-time)¦null false none none
»»»» deletedBy string¦null false none none
»»»» createdOn string(date-time) false none none
»»»» modifiedOn string(date-time) false none none
»»»» createdBy string false none none
»»»» modifiedBy string false none none
»»»» id string false none none
»»»» fileUrl string true none none
»»»» iconLink string false none none
»»»» mimeType string false none none
»»»» title string false none none
»»»» eventId string true none none
»»»» extId string false none none
»»»» extMetadata object false none none
»»»» event EventWithRelations false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
»»»» foreignKey any false none none

Enumerated Values

Property Value
status confirmed
status tentative
status cancelled
status completed
dayOfWeek 0
dayOfWeek 1
dayOfWeek 2
dayOfWeek 3
dayOfWeek 4
dayOfWeek 5
dayOfWeek 6
accessRole freeBusyReader
accessRole reader
accessRole writer
accessRole owner
responseStatus needsAction
responseStatus tentative
responseStatus accepted
responseStatus declined

EventAttachmentController

EventAttachmentController.create

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "fileUrl": "string",
  "iconLink": "string",
  "mimeType": "string",
  "title": "string",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events/{id}/attachments',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "fileUrl": "string",
  "iconLink": "string",
  "mimeType": "string",
  "title": "string",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events/{id}/attachments',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /events/{id}/attachments

Organizer can add attachments to the event (if it was missed while creating event).

Permissions
CreateAttachment
16

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "fileUrl": "string",
  "iconLink": "string",
  "mimeType": "string",
  "title": "string",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
id path string true none
body body NewAttachmentInEvent false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "fileUrl": "string",
  "iconLink": "string",
  "mimeType": "string",
  "title": "string",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
}

Responses

Status Meaning Description Schema
200 OK Event model instance Attachment

EventAttachmentController.patch

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "fileUrl": "string",
  "iconLink": "string",
  "mimeType": "string",
  "title": "string",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events/{id}/attachments',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "fileUrl": "string",
  "iconLink": "string",
  "mimeType": "string",
  "title": "string",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events/{id}/attachments',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /events/{id}/attachments

Organizer can update details of the attachment.

Permissions
UpdateAttachment
17

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "fileUrl": "string",
  "iconLink": "string",
  "mimeType": "string",
  "title": "string",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
id path string true none
where query object false none
body body AttachmentPartial false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Event.Attachment PATCH success count loopback.Count

EventAttachmentController.find

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events/{id}/attachments',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events/{id}/attachments',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /events/{id}/attachments

These requests will be available to everyone in the event to look at.

Permissions
ViewAttachment
15

Parameters

Name In Type Required Description
id path string true none
filter query object false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
[
  {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "fileUrl": "string",
    "iconLink": "string",
    "mimeType": "string",
    "title": "string",
    "eventId": "string",
    "extId": "string",
    "extMetadata": {}
  }
]

Responses

Status Meaning Description Schema
200 OK Array of Event has many Attachment Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [Attachment] false none none
» Attachment Attachment false none none
»» deleted boolean false none none
»» deletedOn string(date-time)¦null false none none
»» deletedBy string¦null false none none
»» createdOn string(date-time) false none none
»» modifiedOn string(date-time) false none none
»» createdBy string false none none
»» modifiedBy string false none none
»» id string false none none
»» fileUrl string true none none
»» iconLink string false none none
»» mimeType string false none none
»» title string false none none
»» eventId string true none none
»» extId string false none none
»» extMetadata object false none none

EventAttachmentController.delete

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events/{id}/attachments',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events/{id}/attachments',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /events/{id}/attachments

Organizer can delete the attachment.

Permissions
DeleteAttachment
18

Parameters

Name In Type Required Description
id path string true none
where query object false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Event.Attachment DELETE success count loopback.Count

EventAttendeeController

EventAttendeeController.create

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "identifier": "string",
  "isOptional": true,
  "isOrganizer": true,
  "messages": "string",
  "responseStatus": "needsAction",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events/{id}/attendees',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "identifier": "string",
  "isOptional": true,
  "isOrganizer": true,
  "messages": "string",
  "responseStatus": "needsAction",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events/{id}/attendees',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /events/{id}/attendees

Attendees could be added to the event. This action could only be performed by the organizer

Permissions
CreateAttendee
20

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "identifier": "string",
  "isOptional": true,
  "isOrganizer": true,
  "messages": "string",
  "responseStatus": "needsAction",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
id path string true none
body body NewAttendeeInEvent false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "identifier": "string",
  "isOptional": true,
  "isOrganizer": true,
  "messages": "string",
  "responseStatus": "needsAction",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
}

Responses

Status Meaning Description Schema
200 OK Event model instance Attendee

EventAttendeeController.patch

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "identifier": "string",
  "isOptional": true,
  "isOrganizer": true,
  "messages": "string",
  "responseStatus": "needsAction",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events/{id}/attendees',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "identifier": "string",
  "isOptional": true,
  "isOrganizer": true,
  "messages": "string",
  "responseStatus": "needsAction",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events/{id}/attendees',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /events/{id}/attendees

Attendees can update details here. (Mainly accept or reject the invitation)

Permissions
UpdateAttendee
21

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "identifier": "string",
  "isOptional": true,
  "isOrganizer": true,
  "messages": "string",
  "responseStatus": "needsAction",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
id path string true none
where query object false none
body body AttendeePartial false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Event.Attendee PATCH success count loopback.Count

EventAttendeeController.find

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events/{id}/attendees',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events/{id}/attendees',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /events/{id}/attendees

Attendees are visible to everyone according to the access permissions provided to them.

Permissions
ViewAttendee
19

Parameters

Name In Type Required Description
id path string true none
filter query object false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
[
  {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "identifier": "string",
    "isOptional": true,
    "isOrganizer": true,
    "messages": "string",
    "responseStatus": "needsAction",
    "eventId": "string",
    "extId": "string",
    "extMetadata": {}
  }
]

Responses

Status Meaning Description Schema
200 OK Array of Event has many Attendee Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [Attendee] false none none
» Attendee Attendee false none none
»» deleted boolean false none none
»» deletedOn string(date-time)¦null false none none
»» deletedBy string¦null false none none
»» createdOn string(date-time) false none none
»» modifiedOn string(date-time) false none none
»» createdBy string false none none
»» modifiedBy string false none none
»» id string false none none
»» identifier string true none none
»» isOptional boolean false none none
»» isOrganizer boolean false none none
»» messages string false none none
»» responseStatus string false none none
»» eventId string true none none
»» extId string false none none
»» extMetadata object false none none

Enumerated Values

Property Value
responseStatus needsAction
responseStatus tentative
responseStatus accepted
responseStatus declined

EventAttendeeController.delete

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events/{id}/attendees',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/events/{id}/attendees',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /events/{id}/attendees

Organiser is allowed to delete an attendee of an event. Event participants details from the past could not be created or updated.

Permissions
DeleteAttendee
22

Parameters

Name In Type Required Description
id path string true none
where query object false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Event.Attendee DELETE success count loopback.Count

SettingsController

SettingsController.count

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/settings/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/settings/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /settings/count

Permissions
ViewSettings
23

Parameters

Name In Type Required Description
where query object false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Settings model count loopback.Count

SettingsController.replaceById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "ownerId": "string",
  "ownerType": "global",
  "settingName": "string",
  "settingValue": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/settings/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "ownerId": "string",
  "ownerType": "global",
  "settingName": "string",
  "settingValue": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/settings/{id}',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /settings/{id}

Update setting.

Permissions
UpdateSettings
25

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "ownerId": "string",
  "ownerType": "global",
  "settingName": "string",
  "settingValue": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
id path string true none
body body Settings false none

Responses

Status Meaning Description Schema
204 No Content Settings PUT success None

SettingsController.updateById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "ownerId": "string",
  "ownerType": "global",
  "settingName": "string",
  "settingValue": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/settings/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "ownerId": "string",
  "ownerType": "global",
  "settingName": "string",
  "settingValue": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/settings/{id}',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /settings/{id}

Permissions
UpdateSettings
25

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "ownerId": "string",
  "ownerType": "global",
  "settingName": "string",
  "settingValue": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
id path string true none
body body SettingsPartial false none

Responses

Status Meaning Description Schema
204 No Content Settings PATCH success None

SettingsController.findById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/settings/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/settings/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /settings/{id}

These requests will be available to everyone in the setting to look at.

Permissions
ViewSettings
23

Parameters

Name In Type Required Description
id path string true none
filter query settings.Filter false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "ownerId": "string",
  "ownerType": "global",
  "settingName": "string",
  "settingValue": "string",
  "extId": "string",
  "extMetadata": {}
}

Responses

Status Meaning Description Schema
200 OK Settings model instance SettingsWithRelations

SettingsController.deleteById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/settings/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/settings/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /settings/{id}

Delete setting.

Permissions
DeleteSettings
26

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
204 No Content Settings DELETE success None

SettingsController.create

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "ownerId": "string",
  "ownerType": "global",
  "settingName": "string",
  "settingValue": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/settings',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "ownerId": "string",
  "ownerType": "global",
  "settingName": "string",
  "settingValue": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/settings',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /settings

Create any new settings

Permissions
CreateSettings
24

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "ownerId": "string",
  "ownerType": "global",
  "settingName": "string",
  "settingValue": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
body body NewSettings false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "ownerId": "string",
  "ownerType": "global",
  "settingName": "string",
  "settingValue": "string",
  "extId": "string",
  "extMetadata": {}
}

Responses

Status Meaning Description Schema
200 OK Settings model instance Settings

SettingsController.updateAll

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "ownerId": "string",
  "ownerType": "global",
  "settingName": "string",
  "settingValue": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/settings',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "ownerId": "string",
  "ownerType": "global",
  "settingName": "string",
  "settingValue": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/settings',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /settings

Permissions
UpdateSettings
25

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "ownerId": "string",
  "ownerType": "global",
  "settingName": "string",
  "settingValue": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
where query object false none
body body SettingsPartial false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Settings PATCH success count loopback.Count

SettingsController.find

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/settings',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/settings',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /settings

Permissions
ViewSettings
23

Parameters

Name In Type Required Description
filter query settings.Filter1 false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
[
  {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "ownerId": "string",
    "ownerType": "global",
    "settingName": "string",
    "settingValue": "string",
    "extId": "string",
    "extMetadata": {}
  }
]

Responses

Status Meaning Description Schema
200 OK Array of Settings model instances Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [SettingsWithRelations] false none [(tsType: SettingsWithRelations, schemaOptions: { includeRelations: true })]
» SettingsWithRelations SettingsWithRelations false none (tsType: SettingsWithRelations, schemaOptions: { includeRelations: true })
»» deleted boolean false none none
»» deletedOn string(date-time)¦null false none none
»» deletedBy string¦null false none none
»» createdOn string(date-time) false none none
»» modifiedOn string(date-time) false none none
»» createdBy string false none none
»» modifiedBy string false none none
»» id string false none none
»» ownerId string true none none
»» ownerType string false none none
»» settingName string false none none
»» settingValue string false none none
»» extId string false none none
»» extMetadata object false none none

Enumerated Values

Property Value
ownerType global
ownerType user
ownerType calendar
ownerType event

ThemeController

ThemeController.count

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/themes/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/themes/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /themes/count

Permissions
ViewTheme
27

Parameters

Name In Type Required Description
where query object false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Theme model count loopback.Count

ThemeController.replaceById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "calBg": "string",
  "calFg": "string",
  "eventBg": "string",
  "eventFg": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/themes/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "calBg": "string",
  "calFg": "string",
  "eventBg": "string",
  "eventFg": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/themes/{id}',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /themes/{id}

Permissions
UpdateTheme

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "calBg": "string",
  "calFg": "string",
  "eventBg": "string",
  "eventFg": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
id path string true none
body body Theme false none

Responses

Status Meaning Description Schema
204 No Content Theme PUT success None

ThemeController.updateById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "calBg": "string",
  "calFg": "string",
  "eventBg": "string",
  "eventFg": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/themes/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "calBg": "string",
  "calFg": "string",
  "eventBg": "string",
  "eventFg": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/themes/{id}',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /themes/{id}

Permissions
UpdateTheme

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "calBg": "string",
  "calFg": "string",
  "eventBg": "string",
  "eventFg": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
id path string true none
body body ThemePartial false none

Responses

Status Meaning Description Schema
204 No Content Theme PATCH success None

ThemeController.findById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/themes/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/themes/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /themes/{id}

Permissions
ViewTheme
27

Parameters

Name In Type Required Description
id path string true none
filter query themes.Filter false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "calBg": "string",
  "calFg": "string",
  "eventBg": "string",
  "eventFg": "string",
  "extId": "string",
  "extMetadata": {}
}

Responses

Status Meaning Description Schema
200 OK Theme model instance ThemeWithRelations

ThemeController.deleteById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/themes/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/themes/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /themes/{id}

Permissions
DeleteTheme

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
204 No Content Theme DELETE success None

ThemeController.create

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "calBg": "string",
  "calFg": "string",
  "eventBg": "string",
  "eventFg": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/themes',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "calBg": "string",
  "calFg": "string",
  "eventBg": "string",
  "eventFg": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/themes',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /themes

Permissions
CreateTheme
28

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "calBg": "string",
  "calFg": "string",
  "eventBg": "string",
  "eventFg": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
body body NewTheme false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "calBg": "string",
  "calFg": "string",
  "eventBg": "string",
  "eventFg": "string",
  "extId": "string",
  "extMetadata": {}
}

Responses

Status Meaning Description Schema
200 OK Theme model instance Theme

ThemeController.updateAll

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "calBg": "string",
  "calFg": "string",
  "eventBg": "string",
  "eventFg": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/themes',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "calBg": "string",
  "calFg": "string",
  "eventBg": "string",
  "eventFg": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/themes',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /themes

Permissions
UpdateTheme
29

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "calBg": "string",
  "calFg": "string",
  "eventBg": "string",
  "eventFg": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
where query object false none
body body ThemePartial false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Theme PATCH success count loopback.Count

ThemeController.find

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/themes',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/themes',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /themes

Permissions
ViewTheme
27

Parameters

Name In Type Required Description
filter query themes.Filter1 false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
[
  {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "calBg": "string",
    "calFg": "string",
    "eventBg": "string",
    "eventFg": "string",
    "extId": "string",
    "extMetadata": {}
  }
]

Responses

Status Meaning Description Schema
200 OK Array of Theme model instances Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [ThemeWithRelations] false none [(tsType: ThemeWithRelations, schemaOptions: { includeRelations: true })]
» ThemeWithRelations ThemeWithRelations false none (tsType: ThemeWithRelations, schemaOptions: { includeRelations: true })
»» deleted boolean false none none
»» deletedOn string(date-time)¦null false none none
»» deletedBy string¦null false none none
»» createdOn string(date-time) false none none
»» modifiedOn string(date-time) false none none
»» createdBy string false none none
»» modifiedBy string false none none
»» id string false none none
»» calBg string false none none
»» calFg string false none none
»» eventBg string false none none
»» eventFg string false none none
»» extId string false none none
»» extMetadata object false none none

WorkingHourController

WorkingHourController.count

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/working-hours/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/working-hours/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /working-hours/count

Permissions
ViewWorkingHour
31

Parameters

Name In Type Required Description
where query object false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK WorkingHour model count loopback.Count

WorkingHourController.replaceById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "dayOfWeek": 0,
  "end": "string",
  "start": "string",
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/working-hours/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "dayOfWeek": 0,
  "end": "string",
  "start": "string",
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/working-hours/{id}',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /working-hours/{id}

This api is to update the calendar by passing an id. This action will be allowed only to the owner of the calendar or the admin. To identify the owner we will check for the email passed in the token and the corresponding access level,whereas to identify the admin we will check for the permission.

Permissions
UpdateWorkingHour
33

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "dayOfWeek": 0,
  "end": "string",
  "start": "string",
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
id path string true none
body body WorkingHour false none

Responses

Status Meaning Description Schema
204 No Content WorkingHour PUT success None

WorkingHourController.updateById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "dayOfWeek": 0,
  "end": "string",
  "start": "string",
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/working-hours/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "dayOfWeek": 0,
  "end": "string",
  "start": "string",
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/working-hours/{id}',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /working-hours/{id}

Permissions
UpdateWorkingHour
33

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "dayOfWeek": 0,
  "end": "string",
  "start": "string",
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
id path string true none
body body WorkingHourPartial false none

Responses

Status Meaning Description Schema
204 No Content WorkingHour PATCH success None

WorkingHourController.findById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/working-hours/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/working-hours/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /working-hours/{id}

These requests will be available to everyone to look at. This will be represent the work timings for the owner of the calendar.

Permissions
ViewWorkingHour
31

Parameters

Name In Type Required Description
id path string true none
filter query working_hours.Filter false none

Example responses

200 Response

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "dayOfWeek": 0,
  "end": "string",
  "start": "string",
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {},
  "calendar": {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "source": "string",
    "enableWorkingHours": true,
    "location": "string",
    "identifier": "string",
    "summary": "string",
    "timezone": "string",
    "extId": "string",
    "extMetadata": {},
    "events": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "bgColor": "string",
        "description": "string",
        "endDateTime": "2019-08-24T14:15:22Z",
        "fgColor": "string",
        "iCalUid": "string",
        "isFullDayEvent": true,
        "isLocked": true,
        "link": "string",
        "location": "string",
        "meetingLink": "string",
        "identifier": "string",
        "startDateTime": "2019-08-24T14:15:22Z",
        "status": "confirmed",
        "summary": "string",
        "timezone": "string",
        "calendarId": "string",
        "parentEventId": "string",
        "extId": "string",
        "extMetadata": {},
        "calendar": {},
        "foreignKey": null,
        "parentEvent": {},
        "attendees": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "identifier": "string",
            "isOptional": true,
            "isOrganizer": true,
            "messages": "string",
            "responseStatus": "needsAction",
            "eventId": "string",
            "extId": "string",
            "extMetadata": {},
            "event": {},
            "foreignKey": null
          }
        ],
        "attachments": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "fileUrl": "string",
            "iconLink": "string",
            "mimeType": "string",
            "title": "string",
            "eventId": "string",
            "extId": "string",
            "extMetadata": {},
            "event": {},
            "foreignKey": null
          }
        ]
      }
    ],
    "workingHours": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "dayOfWeek": 0,
        "end": "string",
        "start": "string",
        "calendarId": "string",
        "extId": "string",
        "extMetadata": {},
        "calendar": {},
        "foreignKey": null
      }
    ],
    "subscriptions": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "accessRole": "freeBusyReader",
        "bgColor": "string",
        "fgColor": "string",
        "isHidden": true,
        "isPrimary": true,
        "identifier": "string",
        "defaultReminders": {},
        "notificationSettings": {},
        "calendarId": "string",
        "extId": "string",
        "extMetadata": {},
        "calendar": {},
        "foreignKey": null
      }
    ]
  },
  "foreignKey": null
}

Responses

Status Meaning Description Schema
200 OK WorkingHour model instance WorkingHourWithRelations

WorkingHourController.deleteById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/working-hours/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/working-hours/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /working-hours/{id}

This api is to update the calendar by passing an id. This action will be allowed only to the owner of the calendar or the admin. To identify the ‘owner’ we will check for the email passed in the token and the corresponding access level, whereas to identify the admin we will check for the permission.

Permissions
DeleteWorkingHour
34

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
204 No Content WorkingHour DELETE success None

WorkingHourController.create

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "dayOfWeek": 0,
  "end": "string",
  "start": "string",
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/working-hours',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "dayOfWeek": 0,
  "end": "string",
  "start": "string",
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/working-hours',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /working-hours

Permissions
CreateWorkingHour
32

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "dayOfWeek": 0,
  "end": "string",
  "start": "string",
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
body body NewWorkingHour false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "dayOfWeek": 0,
  "end": "string",
  "start": "string",
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
}

Responses

Status Meaning Description Schema
200 OK WorkingHour model instance WorkingHour

WorkingHourController.updateAll

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "dayOfWeek": 0,
  "end": "string",
  "start": "string",
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/working-hours',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "dayOfWeek": 0,
  "end": "string",
  "start": "string",
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/working-hours',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /working-hours

Permissions
UpdateWorkingHour
33

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "dayOfWeek": 0,
  "end": "string",
  "start": "string",
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
where query object false none
body body WorkingHourPartial false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK WorkingHour PATCH success count loopback.Count

WorkingHourController.find

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/working-hours',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/working-hours',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /working-hours

Permissions
ViewWorkingHour
31

Parameters

Name In Type Required Description
filter query working_hours.Filter1 false none

Example responses

200 Response

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
[
  {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "dayOfWeek": 0,
    "end": "string",
    "start": "string",
    "calendarId": "string",
    "extId": "string",
    "extMetadata": {},
    "calendar": {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "source": "string",
      "enableWorkingHours": true,
      "location": "string",
      "identifier": "string",
      "summary": "string",
      "timezone": "string",
      "extId": "string",
      "extMetadata": {},
      "events": [
        {
          "deleted": true,
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "bgColor": "string",
          "description": "string",
          "endDateTime": "2019-08-24T14:15:22Z",
          "fgColor": "string",
          "iCalUid": "string",
          "isFullDayEvent": true,
          "isLocked": true,
          "link": "string",
          "location": "string",
          "meetingLink": "string",
          "identifier": "string",
          "startDateTime": "2019-08-24T14:15:22Z",
          "status": "confirmed",
          "summary": "string",
          "timezone": "string",
          "calendarId": "string",
          "parentEventId": "string",
          "extId": "string",
          "extMetadata": {},
          "calendar": {},
          "foreignKey": null,
          "parentEvent": {},
          "attendees": [
            {
              "deleted": true,
              "deletedOn": "2019-08-24T14:15:22Z",
              "deletedBy": "string",
              "createdOn": "2019-08-24T14:15:22Z",
              "modifiedOn": "2019-08-24T14:15:22Z",
              "createdBy": "string",
              "modifiedBy": "string",
              "id": "string",
              "identifier": "string",
              "isOptional": true,
              "isOrganizer": true,
              "messages": "string",
              "responseStatus": "needsAction",
              "eventId": "string",
              "extId": "string",
              "extMetadata": {},
              "event": {},
              "foreignKey": null
            }
          ],
          "attachments": [
            {
              "deleted": true,
              "deletedOn": "2019-08-24T14:15:22Z",
              "deletedBy": "string",
              "createdOn": "2019-08-24T14:15:22Z",
              "modifiedOn": "2019-08-24T14:15:22Z",
              "createdBy": "string",
              "modifiedBy": "string",
              "id": "string",
              "fileUrl": "string",
              "iconLink": "string",
              "mimeType": "string",
              "title": "string",
              "eventId": "string",
              "extId": "string",
              "extMetadata": {},
              "event": {},
              "foreignKey": null
            }
          ]
        }
      ],
      "workingHours": [
        {}
      ],
      "subscriptions": [
        {
          "deleted": true,
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "accessRole": "freeBusyReader",
          "bgColor": "string",
          "fgColor": "string",
          "isHidden": true,
          "isPrimary": true,
          "identifier": "string",
          "defaultReminders": {},
          "notificationSettings": {},
          "calendarId": "string",
          "extId": "string",
          "extMetadata": {},
          "calendar": {},
          "foreignKey": null
        }
      ]
    },
    "foreignKey": null
  }
]

Responses

Status Meaning Description Schema
200 OK Array of WorkingHour model instances Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [WorkingHourWithRelations] false none [(tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })]
» WorkingHourWithRelations WorkingHourWithRelations false none (tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })
»» deleted boolean false none none
»» deletedOn string(date-time)¦null false none none
»» deletedBy string¦null false none none
»» createdOn string(date-time) false none none
»» modifiedOn string(date-time) false none none
»» createdBy string false none none
»» modifiedBy string false none none
»» id string false none none
»» dayOfWeek number false none none
»» end string false none none
»» start string false none none
»» calendarId string true none none
»» extId string false none none
»» extMetadata object false none none
»» calendar CalendarWithRelations false none (tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })
»»» deleted boolean false none none
»»» deletedOn string(date-time)¦null false none none
»»» deletedBy string¦null false none none
»»» createdOn string(date-time) false none none
»»» modifiedOn string(date-time) false none none
»»» createdBy string false none none
»»» modifiedBy string false none none
»»» id string false none none
»»» source string false none none
»»» enableWorkingHours boolean false none none
»»» location string false none none
»»» identifier string true none none
»»» summary string false none none
»»» timezone string false none none
»»» extId string false none none
»»» extMetadata object false none none
»»» events [EventWithRelations] false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
»»»» EventWithRelations EventWithRelations false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
»»»»» deleted boolean false none none
»»»»» deletedOn string(date-time)¦null false none none
»»»»» deletedBy string¦null false none none
»»»»» createdOn string(date-time) false none none
»»»»» modifiedOn string(date-time) false none none
»»»»» createdBy string false none none
»»»»» modifiedBy string false none none
»»»»» id string false none none
»»»»» bgColor string false none none
»»»»» description string false none none
»»»»» endDateTime string(date-time) false none none
»»»»» fgColor string false none none
»»»»» iCalUid string false none none
»»»»» isFullDayEvent boolean false none none
»»»»» isLocked boolean false none none
»»»»» link string false none none
»»»»» location string false none none
»»»»» meetingLink string false none none
»»»»» identifier string false none none
»»»»» startDateTime string(date-time) false none none
»»»»» status string false none none
»»»»» summary string false none none
»»»»» timezone string false none none
»»»»» calendarId string true none none
»»»»» parentEventId string false none none
»»»»» extId string false none none
»»»»» extMetadata object false none none
»»»»» calendar CalendarWithRelations false none (tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })
»»»»» foreignKey any false none none
»»»»» parentEvent EventWithRelations false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
»»»»» attendees [AttendeeWithRelations] false none (tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })
»»»»»» AttendeeWithRelations AttendeeWithRelations false none (tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })
»»»»»»» deleted boolean false none none
»»»»»»» deletedOn string(date-time)¦null false none none
»»»»»»» deletedBy string¦null false none none
»»»»»»» createdOn string(date-time) false none none
»»»»»»» modifiedOn string(date-time) false none none
»»»»»»» createdBy string false none none
»»»»»»» modifiedBy string false none none
»»»»»»» id string false none none
»»»»»»» identifier string true none none
»»»»»»» isOptional boolean false none none
»»»»»»» isOrganizer boolean false none none
»»»»»»» messages string false none none
»»»»»»» responseStatus string false none none
»»»»»»» eventId string true none none
»»»»»»» extId string false none none
»»»»»»» extMetadata object false none none
»»»»»»» event EventWithRelations false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
»»»»»»» foreignKey any false none none
»»»»» attachments [AttachmentWithRelations] false none (tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })
»»»»»» AttachmentWithRelations AttachmentWithRelations false none (tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })
»»»»»»» deleted boolean false none none
»»»»»»» deletedOn string(date-time)¦null false none none
»»»»»»» deletedBy string¦null false none none
»»»»»»» createdOn string(date-time) false none none
»»»»»»» modifiedOn string(date-time) false none none
»»»»»»» createdBy string false none none
»»»»»»» modifiedBy string false none none
»»»»»»» id string false none none
»»»»»»» fileUrl string true none none
»»»»»»» iconLink string false none none
»»»»»»» mimeType string false none none
»»»»»»» title string false none none
»»»»»»» eventId string true none none
»»»»»»» extId string false none none
»»»»»»» extMetadata object false none none
»»»»»»» event EventWithRelations false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
»»»»»»» foreignKey any false none none
»»» workingHours [WorkingHourWithRelations] false none (tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })
»»»» WorkingHourWithRelations WorkingHourWithRelations false none (tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })
»»» subscriptions [SubscriptionWithRelations] false none (tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })
»»»» SubscriptionWithRelations SubscriptionWithRelations false none (tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })
»»»»» deleted boolean false none none
»»»»» deletedOn string(date-time)¦null false none none
»»»»» deletedBy string¦null false none none
»»»»» createdOn string(date-time) false none none
»»»»» modifiedOn string(date-time) false none none
»»»»» createdBy string false none none
»»»»» modifiedBy string false none none
»»»»» id string false none none
»»»»» accessRole string false none none
»»»»» bgColor string false none none
»»»»» fgColor string false none none
»»»»» isHidden boolean false none none
»»»»» isPrimary boolean false none none
»»»»» identifier string true none none
»»»»» defaultReminders object false none none
»»»»» notificationSettings object false none none
»»»»» calendarId string true none none
»»»»» extId string false none none
»»»»» extMetadata object false none none
»»»»» calendar CalendarWithRelations false none (tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })
»»»»» foreignKey any false none none
»» foreignKey any false none none

Enumerated Values

Property Value
dayOfWeek 0
dayOfWeek 1
dayOfWeek 2
dayOfWeek 3
dayOfWeek 4
dayOfWeek 5
dayOfWeek 6
status confirmed
status tentative
status cancelled
status completed
responseStatus needsAction
responseStatus tentative
responseStatus accepted
responseStatus declined
accessRole freeBusyReader
accessRole reader
accessRole writer
accessRole owner

Schemas

Attachment

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "fileUrl": "string",
  "iconLink": "string",
  "mimeType": "string",
  "title": "string",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
}

Attachment

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
fileUrl string true none none
iconLink string false none none
mimeType string false none none
title string false none none
eventId string true none none
extId string false none none
extMetadata object false none none

NewAttachment

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "fileUrl": "string",
  "iconLink": "string",
  "mimeType": "string",
  "title": "string",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
}

NewAttachment

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
fileUrl string true none none
iconLink string false none none
mimeType string false none none
title string false none none
eventId string true none none
extId string false none none
extMetadata object false none none

AttendeeWithRelations

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "identifier": "string",
  "isOptional": true,
  "isOrganizer": true,
  "messages": "string",
  "responseStatus": "needsAction",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {},
  "event": {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "bgColor": "string",
    "description": "string",
    "endDateTime": "2019-08-24T14:15:22Z",
    "fgColor": "string",
    "iCalUid": "string",
    "isFullDayEvent": true,
    "isLocked": true,
    "link": "string",
    "location": "string",
    "meetingLink": "string",
    "identifier": "string",
    "startDateTime": "2019-08-24T14:15:22Z",
    "status": "confirmed",
    "summary": "string",
    "timezone": "string",
    "calendarId": "string",
    "parentEventId": "string",
    "extId": "string",
    "extMetadata": {},
    "calendar": {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "source": "string",
      "enableWorkingHours": true,
      "location": "string",
      "identifier": "string",
      "summary": "string",
      "timezone": "string",
      "extId": "string",
      "extMetadata": {},
      "events": [
        {}
      ],
      "workingHours": [
        {
          "deleted": true,
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "dayOfWeek": 0,
          "end": "string",
          "start": "string",
          "calendarId": "string",
          "extId": "string",
          "extMetadata": {},
          "calendar": {},
          "foreignKey": null
        }
      ],
      "subscriptions": [
        {
          "deleted": true,
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "accessRole": "freeBusyReader",
          "bgColor": "string",
          "fgColor": "string",
          "isHidden": true,
          "isPrimary": true,
          "identifier": "string",
          "defaultReminders": {},
          "notificationSettings": {},
          "calendarId": "string",
          "extId": "string",
          "extMetadata": {},
          "calendar": {},
          "foreignKey": null
        }
      ]
    },
    "foreignKey": null,
    "parentEvent": {},
    "attendees": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "identifier": "string",
        "isOptional": true,
        "isOrganizer": true,
        "messages": "string",
        "responseStatus": "needsAction",
        "eventId": "string",
        "extId": "string",
        "extMetadata": {},
        "event": {},
        "foreignKey": null
      }
    ],
    "attachments": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "fileUrl": "string",
        "iconLink": "string",
        "mimeType": "string",
        "title": "string",
        "eventId": "string",
        "extId": "string",
        "extMetadata": {},
        "event": {},
        "foreignKey": null
      }
    ]
  },
  "foreignKey": null
}

AttendeeWithRelations

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
identifier string true none none
isOptional boolean false none none
isOrganizer boolean false none none
messages string false none none
responseStatus string false none none
eventId string true none none
extId string false none none
extMetadata object false none none
event EventWithRelations false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
foreignKey any false none none

Enumerated Values

Property Value
responseStatus needsAction
responseStatus tentative
responseStatus accepted
responseStatus declined

EventWithRelations

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "bgColor": "string",
  "description": "string",
  "endDateTime": "2019-08-24T14:15:22Z",
  "fgColor": "string",
  "iCalUid": "string",
  "isFullDayEvent": true,
  "isLocked": true,
  "link": "string",
  "location": "string",
  "meetingLink": "string",
  "identifier": "string",
  "startDateTime": "2019-08-24T14:15:22Z",
  "status": "confirmed",
  "summary": "string",
  "timezone": "string",
  "calendarId": "string",
  "parentEventId": "string",
  "extId": "string",
  "extMetadata": {},
  "calendar": {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "source": "string",
    "enableWorkingHours": true,
    "location": "string",
    "identifier": "string",
    "summary": "string",
    "timezone": "string",
    "extId": "string",
    "extMetadata": {},
    "events": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "bgColor": "string",
        "description": "string",
        "endDateTime": "2019-08-24T14:15:22Z",
        "fgColor": "string",
        "iCalUid": "string",
        "isFullDayEvent": true,
        "isLocked": true,
        "link": "string",
        "location": "string",
        "meetingLink": "string",
        "identifier": "string",
        "startDateTime": "2019-08-24T14:15:22Z",
        "status": "confirmed",
        "summary": "string",
        "timezone": "string",
        "calendarId": "string",
        "parentEventId": "string",
        "extId": "string",
        "extMetadata": {},
        "calendar": {},
        "foreignKey": null,
        "parentEvent": {},
        "attendees": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "identifier": "string",
            "isOptional": true,
            "isOrganizer": true,
            "messages": "string",
            "responseStatus": "needsAction",
            "eventId": "string",
            "extId": "string",
            "extMetadata": {},
            "event": {},
            "foreignKey": null
          }
        ],
        "attachments": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "fileUrl": "string",
            "iconLink": "string",
            "mimeType": "string",
            "title": "string",
            "eventId": "string",
            "extId": "string",
            "extMetadata": {},
            "event": {},
            "foreignKey": null
          }
        ]
      }
    ],
    "workingHours": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "dayOfWeek": 0,
        "end": "string",
        "start": "string",
        "calendarId": "string",
        "extId": "string",
        "extMetadata": {},
        "calendar": {},
        "foreignKey": null
      }
    ],
    "subscriptions": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "accessRole": "freeBusyReader",
        "bgColor": "string",
        "fgColor": "string",
        "isHidden": true,
        "isPrimary": true,
        "identifier": "string",
        "defaultReminders": {},
        "notificationSettings": {},
        "calendarId": "string",
        "extId": "string",
        "extMetadata": {},
        "calendar": {},
        "foreignKey": null
      }
    ]
  },
  "foreignKey": null,
  "parentEvent": {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "bgColor": "string",
    "description": "string",
    "endDateTime": "2019-08-24T14:15:22Z",
    "fgColor": "string",
    "iCalUid": "string",
    "isFullDayEvent": true,
    "isLocked": true,
    "link": "string",
    "location": "string",
    "meetingLink": "string",
    "identifier": "string",
    "startDateTime": "2019-08-24T14:15:22Z",
    "status": "confirmed",
    "summary": "string",
    "timezone": "string",
    "calendarId": "string",
    "parentEventId": "string",
    "extId": "string",
    "extMetadata": {},
    "calendar": {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "source": "string",
      "enableWorkingHours": true,
      "location": "string",
      "identifier": "string",
      "summary": "string",
      "timezone": "string",
      "extId": "string",
      "extMetadata": {},
      "events": [
        {}
      ],
      "workingHours": [
        {
          "deleted": true,
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "dayOfWeek": 0,
          "end": "string",
          "start": "string",
          "calendarId": "string",
          "extId": "string",
          "extMetadata": {},
          "calendar": {},
          "foreignKey": null
        }
      ],
      "subscriptions": [
        {
          "deleted": true,
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "accessRole": "freeBusyReader",
          "bgColor": "string",
          "fgColor": "string",
          "isHidden": true,
          "isPrimary": true,
          "identifier": "string",
          "defaultReminders": {},
          "notificationSettings": {},
          "calendarId": "string",
          "extId": "string",
          "extMetadata": {},
          "calendar": {},
          "foreignKey": null
        }
      ]
    },
    "foreignKey": null,
    "parentEvent": {},
    "attendees": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "identifier": "string",
        "isOptional": true,
        "isOrganizer": true,
        "messages": "string",
        "responseStatus": "needsAction",
        "eventId": "string",
        "extId": "string",
        "extMetadata": {},
        "event": {},
        "foreignKey": null
      }
    ],
    "attachments": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "fileUrl": "string",
        "iconLink": "string",
        "mimeType": "string",
        "title": "string",
        "eventId": "string",
        "extId": "string",
        "extMetadata": {},
        "event": {},
        "foreignKey": null
      }
    ]
  },
  "attendees": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "identifier": "string",
      "isOptional": true,
      "isOrganizer": true,
      "messages": "string",
      "responseStatus": "needsAction",
      "eventId": "string",
      "extId": "string",
      "extMetadata": {},
      "event": {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "bgColor": "string",
        "description": "string",
        "endDateTime": "2019-08-24T14:15:22Z",
        "fgColor": "string",
        "iCalUid": "string",
        "isFullDayEvent": true,
        "isLocked": true,
        "link": "string",
        "location": "string",
        "meetingLink": "string",
        "identifier": "string",
        "startDateTime": "2019-08-24T14:15:22Z",
        "status": "confirmed",
        "summary": "string",
        "timezone": "string",
        "calendarId": "string",
        "parentEventId": "string",
        "extId": "string",
        "extMetadata": {},
        "calendar": {
          "deleted": true,
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "source": "string",
          "enableWorkingHours": true,
          "location": "string",
          "identifier": "string",
          "summary": "string",
          "timezone": "string",
          "extId": "string",
          "extMetadata": {},
          "events": [
            {}
          ],
          "workingHours": [
            {
              "deleted": true,
              "deletedOn": "2019-08-24T14:15:22Z",
              "deletedBy": "string",
              "createdOn": "2019-08-24T14:15:22Z",
              "modifiedOn": "2019-08-24T14:15:22Z",
              "createdBy": "string",
              "modifiedBy": "string",
              "id": "string",
              "dayOfWeek": 0,
              "end": "string",
              "start": "string",
              "calendarId": "string",
              "extId": "string",
              "extMetadata": {},
              "calendar": {},
              "foreignKey": null
            }
          ],
          "subscriptions": [
            {
              "deleted": true,
              "deletedOn": "2019-08-24T14:15:22Z",
              "deletedBy": "string",
              "createdOn": "2019-08-24T14:15:22Z",
              "modifiedOn": "2019-08-24T14:15:22Z",
              "createdBy": "string",
              "modifiedBy": "string",
              "id": "string",
              "accessRole": "freeBusyReader",
              "bgColor": "string",
              "fgColor": "string",
              "isHidden": true,
              "isPrimary": true,
              "identifier": "string",
              "defaultReminders": {},
              "notificationSettings": {},
              "calendarId": "string",
              "extId": "string",
              "extMetadata": {},
              "calendar": {},
              "foreignKey": null
            }
          ]
        },
        "foreignKey": null,
        "parentEvent": {},
        "attendees": [],
        "attachments": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "fileUrl": "string",
            "iconLink": "string",
            "mimeType": "string",
            "title": "string",
            "eventId": "string",
            "extId": "string",
            "extMetadata": {},
            "event": {},
            "foreignKey": null
          }
        ]
      },
      "foreignKey": null
    }
  ],
  "attachments": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "fileUrl": "string",
      "iconLink": "string",
      "mimeType": "string",
      "title": "string",
      "eventId": "string",
      "extId": "string",
      "extMetadata": {},
      "event": {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "bgColor": "string",
        "description": "string",
        "endDateTime": "2019-08-24T14:15:22Z",
        "fgColor": "string",
        "iCalUid": "string",
        "isFullDayEvent": true,
        "isLocked": true,
        "link": "string",
        "location": "string",
        "meetingLink": "string",
        "identifier": "string",
        "startDateTime": "2019-08-24T14:15:22Z",
        "status": "confirmed",
        "summary": "string",
        "timezone": "string",
        "calendarId": "string",
        "parentEventId": "string",
        "extId": "string",
        "extMetadata": {},
        "calendar": {
          "deleted": true,
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "source": "string",
          "enableWorkingHours": true,
          "location": "string",
          "identifier": "string",
          "summary": "string",
          "timezone": "string",
          "extId": "string",
          "extMetadata": {},
          "events": [
            {}
          ],
          "workingHours": [
            {
              "deleted": true,
              "deletedOn": "2019-08-24T14:15:22Z",
              "deletedBy": "string",
              "createdOn": "2019-08-24T14:15:22Z",
              "modifiedOn": "2019-08-24T14:15:22Z",
              "createdBy": "string",
              "modifiedBy": "string",
              "id": "string",
              "dayOfWeek": 0,
              "end": "string",
              "start": "string",
              "calendarId": "string",
              "extId": "string",
              "extMetadata": {},
              "calendar": {},
              "foreignKey": null
            }
          ],
          "subscriptions": [
            {
              "deleted": true,
              "deletedOn": "2019-08-24T14:15:22Z",
              "deletedBy": "string",
              "createdOn": "2019-08-24T14:15:22Z",
              "modifiedOn": "2019-08-24T14:15:22Z",
              "createdBy": "string",
              "modifiedBy": "string",
              "id": "string",
              "accessRole": "freeBusyReader",
              "bgColor": "string",
              "fgColor": "string",
              "isHidden": true,
              "isPrimary": true,
              "identifier": "string",
              "defaultReminders": {},
              "notificationSettings": {},
              "calendarId": "string",
              "extId": "string",
              "extMetadata": {},
              "calendar": {},
              "foreignKey": null
            }
          ]
        },
        "foreignKey": null,
        "parentEvent": {},
        "attendees": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "identifier": "string",
            "isOptional": true,
            "isOrganizer": true,
            "messages": "string",
            "responseStatus": "needsAction",
            "eventId": "string",
            "extId": "string",
            "extMetadata": {},
            "event": {},
            "foreignKey": null
          }
        ],
        "attachments": []
      },
      "foreignKey": null
    }
  ]
}

EventWithRelations

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
bgColor string false none none
description string false none none
endDateTime string(date-time) false none none
fgColor string false none none
iCalUid string false none none
isFullDayEvent boolean false none none
isLocked boolean false none none
link string false none none
location string false none none
meetingLink string false none none
identifier string false none none
startDateTime string(date-time) false none none
status string false none none
summary string false none none
timezone string false none none
calendarId string true none none
parentEventId string false none none
extId string false none none
extMetadata object false none none
calendar CalendarWithRelations false none (tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })
foreignKey any false none none
parentEvent EventWithRelations false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
attendees [AttendeeWithRelations] false none [(tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })]
attachments [AttachmentWithRelations] false none [(tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })]

Enumerated Values

Property Value
status confirmed
status tentative
status cancelled
status completed

AttachmentWithRelations

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "fileUrl": "string",
  "iconLink": "string",
  "mimeType": "string",
  "title": "string",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {},
  "event": {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "bgColor": "string",
    "description": "string",
    "endDateTime": "2019-08-24T14:15:22Z",
    "fgColor": "string",
    "iCalUid": "string",
    "isFullDayEvent": true,
    "isLocked": true,
    "link": "string",
    "location": "string",
    "meetingLink": "string",
    "identifier": "string",
    "startDateTime": "2019-08-24T14:15:22Z",
    "status": "confirmed",
    "summary": "string",
    "timezone": "string",
    "calendarId": "string",
    "parentEventId": "string",
    "extId": "string",
    "extMetadata": {},
    "calendar": {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "source": "string",
      "enableWorkingHours": true,
      "location": "string",
      "identifier": "string",
      "summary": "string",
      "timezone": "string",
      "extId": "string",
      "extMetadata": {},
      "events": [
        {}
      ],
      "workingHours": [
        {
          "deleted": true,
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "dayOfWeek": 0,
          "end": "string",
          "start": "string",
          "calendarId": "string",
          "extId": "string",
          "extMetadata": {},
          "calendar": {},
          "foreignKey": null
        }
      ],
      "subscriptions": [
        {
          "deleted": true,
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "accessRole": "freeBusyReader",
          "bgColor": "string",
          "fgColor": "string",
          "isHidden": true,
          "isPrimary": true,
          "identifier": "string",
          "defaultReminders": {},
          "notificationSettings": {},
          "calendarId": "string",
          "extId": "string",
          "extMetadata": {},
          "calendar": {},
          "foreignKey": null
        }
      ]
    },
    "foreignKey": null,
    "parentEvent": {},
    "attendees": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "identifier": "string",
        "isOptional": true,
        "isOrganizer": true,
        "messages": "string",
        "responseStatus": "needsAction",
        "eventId": "string",
        "extId": "string",
        "extMetadata": {},
        "event": {},
        "foreignKey": null
      }
    ],
    "attachments": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "fileUrl": "string",
        "iconLink": "string",
        "mimeType": "string",
        "title": "string",
        "eventId": "string",
        "extId": "string",
        "extMetadata": {},
        "event": {},
        "foreignKey": null
      }
    ]
  },
  "foreignKey": null
}

AttachmentWithRelations

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
fileUrl string true none none
iconLink string false none none
mimeType string false none none
title string false none none
eventId string true none none
extId string false none none
extMetadata object false none none
event EventWithRelations false none (tsType: EventWithRelations, schemaOptions: { includeRelations: true })
foreignKey any false none none

AttachmentPartial

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "fileUrl": "string",
  "iconLink": "string",
  "mimeType": "string",
  "title": "string",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
}

AttachmentPartial

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
fileUrl string false none none
iconLink string false none none
mimeType string false none none
title string false none none
eventId string false none none
extId string false none none
extMetadata object false none none

Attendee

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "identifier": "string",
  "isOptional": true,
  "isOrganizer": true,
  "messages": "string",
  "responseStatus": "needsAction",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
}

Attendee

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
identifier string true none none
isOptional boolean false none none
isOrganizer boolean false none none
messages string false none none
responseStatus string false none none
eventId string true none none
extId string false none none
extMetadata object false none none

Enumerated Values

Property Value
responseStatus needsAction
responseStatus tentative
responseStatus accepted
responseStatus declined

NewAttendee

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "identifier": "string",
  "isOptional": true,
  "isOrganizer": true,
  "messages": "string",
  "responseStatus": "needsAction",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
}

NewAttendee

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
identifier string true none none
isOptional boolean false none none
isOrganizer boolean false none none
messages string false none none
responseStatus string false none none
eventId string true none none
extId string false none none
extMetadata object false none none

Enumerated Values

Property Value
responseStatus needsAction
responseStatus tentative
responseStatus accepted
responseStatus declined

AttendeePartial

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "identifier": "string",
  "isOptional": true,
  "isOrganizer": true,
  "messages": "string",
  "responseStatus": "needsAction",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
}

AttendeePartial

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
identifier string false none none
isOptional boolean false none none
isOrganizer boolean false none none
messages string false none none
responseStatus string false none none
eventId string false none none
extId string false none none
extMetadata object false none none

Enumerated Values

Property Value
responseStatus needsAction
responseStatus tentative
responseStatus accepted
responseStatus declined

Calendar

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "source": "string",
  "enableWorkingHours": true,
  "location": "string",
  "identifier": "string",
  "summary": "string",
  "timezone": "string",
  "extId": "string",
  "extMetadata": {}
}

Calendar

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
source string false none none
enableWorkingHours boolean false none none
location string false none none
identifier string true none none
summary string false none none
timezone string false none none
extId string false none none
extMetadata object false none none

WorkingHour

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "dayOfWeek": 0,
  "end": "string",
  "start": "string",
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
}

WorkingHour

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
dayOfWeek number false none none
end string false none none
start string false none none
calendarId string true none none
extId string false none none
extMetadata object false none none

Enumerated Values

Property Value
dayOfWeek 0
dayOfWeek 1
dayOfWeek 2
dayOfWeek 3
dayOfWeek 4
dayOfWeek 5
dayOfWeek 6

NewCalendar

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
{
  "source": "string",
  "enableWorkingHours": true,
  "location": "string",
  "identifier": "string",
  "summary": "string",
  "timezone": "string",
  "extId": "string",
  "extMetadata": {},
  "workingHours": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "dayOfWeek": 0,
      "end": "string",
      "start": "string",
      "calendarId": "string",
      "extId": "string",
      "extMetadata": {}
    }
  ],
  "subscription": {}
}

NewCalendar

Properties

Name Type Required Restrictions Description
source string false none none
enableWorkingHours boolean false none none
location string false none none
identifier string true none none
summary string false none none
timezone string false none none
extId string false none none
extMetadata object false none none
workingHours [WorkingHour] false none none
subscription object false none none

CalendarDTO

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
{
  "id": "string",
  "source": "string",
  "enableWorkingHours": true,
  "location": "string",
  "identifier": "string",
  "summary": "string",
  "timezone": "string",
  "extId": "string",
  "extMetadata": {},
  "workingHours": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "dayOfWeek": 0,
      "end": "string",
      "start": "string",
      "calendarId": "string",
      "extId": "string",
      "extMetadata": {}
    }
  ],
  "subscription": {}
}

CalendarDTO

Properties

Name Type Required Restrictions Description
id string false none none
source string false none none
enableWorkingHours boolean false none none
location string false none none
identifier string true none none
summary string false none none
timezone string false none none
extId string false none none
extMetadata object false none none
workingHours [WorkingHour] false none none
subscription object false none none

CalendarWithRelations

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "source": "string",
  "enableWorkingHours": true,
  "location": "string",
  "identifier": "string",
  "summary": "string",
  "timezone": "string",
  "extId": "string",
  "extMetadata": {},
  "events": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "bgColor": "string",
      "description": "string",
      "endDateTime": "2019-08-24T14:15:22Z",
      "fgColor": "string",
      "iCalUid": "string",
      "isFullDayEvent": true,
      "isLocked": true,
      "link": "string",
      "location": "string",
      "meetingLink": "string",
      "identifier": "string",
      "startDateTime": "2019-08-24T14:15:22Z",
      "status": "confirmed",
      "summary": "string",
      "timezone": "string",
      "calendarId": "string",
      "parentEventId": "string",
      "extId": "string",
      "extMetadata": {},
      "calendar": {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "source": "string",
        "enableWorkingHours": true,
        "location": "string",
        "identifier": "string",
        "summary": "string",
        "timezone": "string",
        "extId": "string",
        "extMetadata": {},
        "events": [],
        "workingHours": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "dayOfWeek": 0,
            "end": "string",
            "start": "string",
            "calendarId": "string",
            "extId": "string",
            "extMetadata": {},
            "calendar": {},
            "foreignKey": null
          }
        ],
        "subscriptions": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "accessRole": "freeBusyReader",
            "bgColor": "string",
            "fgColor": "string",
            "isHidden": true,
            "isPrimary": true,
            "identifier": "string",
            "defaultReminders": {},
            "notificationSettings": {},
            "calendarId": "string",
            "extId": "string",
            "extMetadata": {},
            "calendar": {},
            "foreignKey": null
          }
        ]
      },
      "foreignKey": null,
      "parentEvent": {},
      "attendees": [
        {
          "deleted": true,
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "identifier": "string",
          "isOptional": true,
          "isOrganizer": true,
          "messages": "string",
          "responseStatus": "needsAction",
          "eventId": "string",
          "extId": "string",
          "extMetadata": {},
          "event": {},
          "foreignKey": null
        }
      ],
      "attachments": [
        {
          "deleted": true,
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "fileUrl": "string",
          "iconLink": "string",
          "mimeType": "string",
          "title": "string",
          "eventId": "string",
          "extId": "string",
          "extMetadata": {},
          "event": {},
          "foreignKey": null
        }
      ]
    }
  ],
  "workingHours": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "dayOfWeek": 0,
      "end": "string",
      "start": "string",
      "calendarId": "string",
      "extId": "string",
      "extMetadata": {},
      "calendar": {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "source": "string",
        "enableWorkingHours": true,
        "location": "string",
        "identifier": "string",
        "summary": "string",
        "timezone": "string",
        "extId": "string",
        "extMetadata": {},
        "events": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "bgColor": "string",
            "description": "string",
            "endDateTime": "2019-08-24T14:15:22Z",
            "fgColor": "string",
            "iCalUid": "string",
            "isFullDayEvent": true,
            "isLocked": true,
            "link": "string",
            "location": "string",
            "meetingLink": "string",
            "identifier": "string",
            "startDateTime": "2019-08-24T14:15:22Z",
            "status": "confirmed",
            "summary": "string",
            "timezone": "string",
            "calendarId": "string",
            "parentEventId": "string",
            "extId": "string",
            "extMetadata": {},
            "calendar": {},
            "foreignKey": null,
            "parentEvent": {},
            "attendees": [
              {
                "deleted": true,
                "deletedOn": "2019-08-24T14:15:22Z",
                "deletedBy": "string",
                "createdOn": "2019-08-24T14:15:22Z",
                "modifiedOn": "2019-08-24T14:15:22Z",
                "createdBy": "string",
                "modifiedBy": "string",
                "id": "string",
                "identifier": "string",
                "isOptional": true,
                "isOrganizer": true,
                "messages": "string",
                "responseStatus": "needsAction",
                "eventId": "string",
                "extId": "string",
                "extMetadata": {},
                "event": {},
                "foreignKey": null
              }
            ],
            "attachments": [
              {
                "deleted": true,
                "deletedOn": "2019-08-24T14:15:22Z",
                "deletedBy": "string",
                "createdOn": "2019-08-24T14:15:22Z",
                "modifiedOn": "2019-08-24T14:15:22Z",
                "createdBy": "string",
                "modifiedBy": "string",
                "id": "string",
                "fileUrl": "string",
                "iconLink": "string",
                "mimeType": "string",
                "title": "string",
                "eventId": "string",
                "extId": "string",
                "extMetadata": {},
                "event": {},
                "foreignKey": null
              }
            ]
          }
        ],
        "workingHours": [],
        "subscriptions": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "accessRole": "freeBusyReader",
            "bgColor": "string",
            "fgColor": "string",
            "isHidden": true,
            "isPrimary": true,
            "identifier": "string",
            "defaultReminders": {},
            "notificationSettings": {},
            "calendarId": "string",
            "extId": "string",
            "extMetadata": {},
            "calendar": {},
            "foreignKey": null
          }
        ]
      },
      "foreignKey": null
    }
  ],
  "subscriptions": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "accessRole": "freeBusyReader",
      "bgColor": "string",
      "fgColor": "string",
      "isHidden": true,
      "isPrimary": true,
      "identifier": "string",
      "defaultReminders": {},
      "notificationSettings": {},
      "calendarId": "string",
      "extId": "string",
      "extMetadata": {},
      "calendar": {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "source": "string",
        "enableWorkingHours": true,
        "location": "string",
        "identifier": "string",
        "summary": "string",
        "timezone": "string",
        "extId": "string",
        "extMetadata": {},
        "events": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "bgColor": "string",
            "description": "string",
            "endDateTime": "2019-08-24T14:15:22Z",
            "fgColor": "string",
            "iCalUid": "string",
            "isFullDayEvent": true,
            "isLocked": true,
            "link": "string",
            "location": "string",
            "meetingLink": "string",
            "identifier": "string",
            "startDateTime": "2019-08-24T14:15:22Z",
            "status": "confirmed",
            "summary": "string",
            "timezone": "string",
            "calendarId": "string",
            "parentEventId": "string",
            "extId": "string",
            "extMetadata": {},
            "calendar": {},
            "foreignKey": null,
            "parentEvent": {},
            "attendees": [
              {
                "deleted": true,
                "deletedOn": "2019-08-24T14:15:22Z",
                "deletedBy": "string",
                "createdOn": "2019-08-24T14:15:22Z",
                "modifiedOn": "2019-08-24T14:15:22Z",
                "createdBy": "string",
                "modifiedBy": "string",
                "id": "string",
                "identifier": "string",
                "isOptional": true,
                "isOrganizer": true,
                "messages": "string",
                "responseStatus": "needsAction",
                "eventId": "string",
                "extId": "string",
                "extMetadata": {},
                "event": {},
                "foreignKey": null
              }
            ],
            "attachments": [
              {
                "deleted": true,
                "deletedOn": "2019-08-24T14:15:22Z",
                "deletedBy": "string",
                "createdOn": "2019-08-24T14:15:22Z",
                "modifiedOn": "2019-08-24T14:15:22Z",
                "createdBy": "string",
                "modifiedBy": "string",
                "id": "string",
                "fileUrl": "string",
                "iconLink": "string",
                "mimeType": "string",
                "title": "string",
                "eventId": "string",
                "extId": "string",
                "extMetadata": {},
                "event": {},
                "foreignKey": null
              }
            ]
          }
        ],
        "workingHours": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "dayOfWeek": 0,
            "end": "string",
            "start": "string",
            "calendarId": "string",
            "extId": "string",
            "extMetadata": {},
            "calendar": {},
            "foreignKey": null
          }
        ],
        "subscriptions": []
      },
      "foreignKey": null
    }
  ]
}

CalendarWithRelations

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
source string false none none
enableWorkingHours boolean false none none
location string false none none
identifier string true none none
summary string false none none
timezone string false none none
extId string false none none
extMetadata object false none none
events [EventWithRelations] false none [(tsType: EventWithRelations, schemaOptions: { includeRelations: true })]
workingHours [WorkingHourWithRelations] false none [(tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })]
subscriptions [SubscriptionWithRelations] false none [(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })]

CalendarPartial

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "source": "string",
  "enableWorkingHours": true,
  "location": "string",
  "identifier": "string",
  "summary": "string",
  "timezone": "string",
  "extId": "string",
  "extMetadata": {}
}

CalendarPartial

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
source string false none none
enableWorkingHours boolean false none none
location string false none none
identifier string false none none
summary string false none none
timezone string false none none
extId string false none none
extMetadata object false none none

Event

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "bgColor": "string",
  "description": "string",
  "endDateTime": "2019-08-24T14:15:22Z",
  "fgColor": "string",
  "iCalUid": "string",
  "isFullDayEvent": true,
  "isLocked": true,
  "link": "string",
  "location": "string",
  "meetingLink": "string",
  "identifier": "string",
  "startDateTime": "2019-08-24T14:15:22Z",
  "status": "confirmed",
  "summary": "string",
  "timezone": "string",
  "calendarId": "string",
  "parentEventId": "string",
  "extId": "string",
  "extMetadata": {}
}

Event

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
bgColor string false none none
description string false none none
endDateTime string(date-time) false none none
fgColor string false none none
iCalUid string false none none
isFullDayEvent boolean false none none
isLocked boolean false none none
link string false none none
location string false none none
meetingLink string false none none
identifier string false none none
startDateTime string(date-time) false none none
status string false none none
summary string false none none
timezone string false none none
calendarId string true none none
parentEventId string false none none
extId string false none none
extMetadata object false none none

Enumerated Values

Property Value
status confirmed
status tentative
status cancelled
status completed

NewEvent

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
{
  "bgColor": "string",
  "description": "string",
  "endDateTime": "2019-08-24T14:15:22Z",
  "fgColor": "string",
  "iCalUid": "string",
  "isFullDayEvent": true,
  "isLocked": true,
  "link": "string",
  "location": "string",
  "meetingLink": "string",
  "identifier": "string",
  "startDateTime": "2019-08-24T14:15:22Z",
  "status": "confirmed",
  "summary": "string",
  "timezone": "string",
  "calendarId": "string",
  "parentEventId": "string",
  "attachments": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "fileUrl": "string",
      "iconLink": "string",
      "mimeType": "string",
      "title": "string",
      "eventId": "string",
      "extId": "string",
      "extMetadata": {}
    }
  ],
  "attendees": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "identifier": "string",
      "isOptional": true,
      "isOrganizer": true,
      "messages": "string",
      "responseStatus": "needsAction",
      "eventId": "string",
      "extId": "string",
      "extMetadata": {}
    }
  ],
  "extId": "string",
  "extMetadata": {}
}

NewEvent

Properties

Name Type Required Restrictions Description
bgColor string false none none
description string false none none
endDateTime string(date-time) false none none
fgColor string false none none
iCalUid string false none none
isFullDayEvent boolean false none none
isLocked boolean false none none
link string false none none
location string false none none
meetingLink string false none none
identifier string false none none
startDateTime string(date-time) false none none
status string false none none
summary string false none none
timezone string false none none
calendarId string true none none
parentEventId string false none none
attachments [Attachment] false none none
attendees [Attendee] false none none
extId string false none none
extMetadata object false none none

Enumerated Values

Property Value
status confirmed
status tentative
status cancelled
status completed

EventAttendeeViewItemDTO

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
{
  "id": "string",
  "bgColor": "string",
  "description": "string",
  "endDateTime": "2019-08-24T14:15:22Z",
  "extId": "string",
  "extMetadata": {},
  "fgColor": "string",
  "iCalUid": "string",
  "isFullDayEvent": true,
  "isLocked": true,
  "link": "string",
  "location": "string",
  "meetingLink": "string",
  "identifier": "string",
  "startDateTime": "2019-08-24T14:15:22Z",
  "status": "confirmed",
  "summary": "string",
  "timezone": "string",
  "attendeeId": "string",
  "isOptional": true,
  "attendeeIdentifier": "string",
  "isOrganizer": true,
  "messages": "string",
  "eventId": "string"
}

EventAttendeeViewItemDTO

Properties

Name Type Required Restrictions Description
id string false none none
bgColor string false none none
description string false none none
endDateTime string(date-time) false none none
extId string false none none
extMetadata object false none none
fgColor string false none none
iCalUid string false none none
isFullDayEvent boolean false none none
isLocked boolean false none none
link string false none none
location string false none none
meetingLink string false none none
identifier string false none none
startDateTime string(date-time) false none none
status string false none none
summary string false none none
timezone string false none none
attendeeId string false none none
isOptional boolean false none none
attendeeIdentifier string false none none
isOrganizer boolean false none none
messages string false none none
eventId string false none none

Enumerated Values

Property Value
status confirmed
status tentative
status cancelled
status completed

FreeBusyRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
  "timeMax": "2019-08-24T14:15:22Z",
  "timeMin": "2019-08-24T14:15:22Z",
  "items": [
    {
      "id": "string",
      "bgColor": "string",
      "description": "string",
      "endDateTime": "2019-08-24T14:15:22Z",
      "extId": "string",
      "extMetadata": {},
      "fgColor": "string",
      "iCalUid": "string",
      "isFullDayEvent": true,
      "isLocked": true,
      "link": "string",
      "location": "string",
      "meetingLink": "string",
      "identifier": "string",
      "startDateTime": "2019-08-24T14:15:22Z",
      "status": "confirmed",
      "summary": "string",
      "timezone": "string",
      "attendeeId": "string",
      "isOptional": true,
      "attendeeIdentifier": "string",
      "isOrganizer": true,
      "messages": "string",
      "eventId": "string"
    }
  ]
}

FreeBusyRequest

Properties

Name Type Required Restrictions Description
timeMax string(date-time) true none none
timeMin string(date-time) true none none
items [EventAttendeeViewItemDTO] false none none

FreeBusyDTO

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
  "timeMax": "2019-08-24T14:15:22Z",
  "timeMin": "2019-08-24T14:15:22Z",
  "items": [
    {
      "id": "string",
      "bgColor": "string",
      "description": "string",
      "endDateTime": "2019-08-24T14:15:22Z",
      "extId": "string",
      "extMetadata": {},
      "fgColor": "string",
      "iCalUid": "string",
      "isFullDayEvent": true,
      "isLocked": true,
      "link": "string",
      "location": "string",
      "meetingLink": "string",
      "identifier": "string",
      "startDateTime": "2019-08-24T14:15:22Z",
      "status": "confirmed",
      "summary": "string",
      "timezone": "string",
      "attendeeId": "string",
      "isOptional": true,
      "attendeeIdentifier": "string",
      "isOrganizer": true,
      "messages": "string",
      "eventId": "string"
    }
  ]
}

FreeBusyDTO

Properties

Name Type Required Restrictions Description
timeMax string(date-time) true none none
timeMin string(date-time) true none none
items [EventAttendeeViewItemDTO] false none none

EventPartial

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "bgColor": "string",
  "description": "string",
  "endDateTime": "2019-08-24T14:15:22Z",
  "fgColor": "string",
  "iCalUid": "string",
  "isFullDayEvent": true,
  "isLocked": true,
  "link": "string",
  "location": "string",
  "meetingLink": "string",
  "identifier": "string",
  "startDateTime": "2019-08-24T14:15:22Z",
  "status": "confirmed",
  "summary": "string",
  "timezone": "string",
  "calendarId": "string",
  "parentEventId": "string",
  "extId": "string",
  "extMetadata": {}
}

EventPartial

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
bgColor string false none none
description string false none none
endDateTime string(date-time) false none none
fgColor string false none none
iCalUid string false none none
isFullDayEvent boolean false none none
isLocked boolean false none none
link string false none none
location string false none none
meetingLink string false none none
identifier string false none none
startDateTime string(date-time) false none none
status string false none none
summary string false none none
timezone string false none none
calendarId string false none none
parentEventId string false none none
extId string false none none
extMetadata object false none none

Enumerated Values

Property Value
status confirmed
status tentative
status cancelled
status completed

Settings

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "ownerId": "string",
  "ownerType": "global",
  "settingName": "string",
  "settingValue": "string",
  "extId": "string",
  "extMetadata": {}
}

Settings

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
ownerId string true none none
ownerType string false none none
settingName string false none none
settingValue string false none none
extId string false none none
extMetadata object false none none

Enumerated Values

Property Value
ownerType global
ownerType user
ownerType calendar
ownerType event

NewSettings

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "ownerId": "string",
  "ownerType": "global",
  "settingName": "string",
  "settingValue": "string",
  "extId": "string",
  "extMetadata": {}
}

NewSettings

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
ownerId string true none none
ownerType string false none none
settingName string false none none
settingValue string false none none
extId string false none none
extMetadata object false none none

Enumerated Values

Property Value
ownerType global
ownerType user
ownerType calendar
ownerType event

SettingsWithRelations

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "ownerId": "string",
  "ownerType": "global",
  "settingName": "string",
  "settingValue": "string",
  "extId": "string",
  "extMetadata": {}
}

SettingsWithRelations

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
ownerId string true none none
ownerType string false none none
settingName string false none none
settingValue string false none none
extId string false none none
extMetadata object false none none

Enumerated Values

Property Value
ownerType global
ownerType user
ownerType calendar
ownerType event

SettingsPartial

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "ownerId": "string",
  "ownerType": "global",
  "settingName": "string",
  "settingValue": "string",
  "extId": "string",
  "extMetadata": {}
}

SettingsPartial

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
ownerId string false none none
ownerType string false none none
settingName string false none none
settingValue string false none none
extId string false none none
extMetadata object false none none

Enumerated Values

Property Value
ownerType global
ownerType user
ownerType calendar
ownerType event

Subscription

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "accessRole": "freeBusyReader",
  "bgColor": "string",
  "fgColor": "string",
  "isHidden": true,
  "isPrimary": true,
  "identifier": "string",
  "defaultReminders": {},
  "notificationSettings": {},
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
}

Subscription

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
accessRole string false none none
bgColor string false none none
fgColor string false none none
isHidden boolean false none none
isPrimary boolean false none none
identifier string true none none
defaultReminders object false none none
notificationSettings object false none none
calendarId string true none none
extId string false none none
extMetadata object false none none

Enumerated Values

Property Value
accessRole freeBusyReader
accessRole reader
accessRole writer
accessRole owner

NewSubscription

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "accessRole": "freeBusyReader",
  "bgColor": "string",
  "fgColor": "string",
  "isHidden": true,
  "isPrimary": true,
  "identifier": "string",
  "defaultReminders": {},
  "notificationSettings": {},
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
}

NewSubscription

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
accessRole string false none none
bgColor string false none none
fgColor string false none none
isHidden boolean false none none
isPrimary boolean false none none
identifier string true none none
defaultReminders object false none none
notificationSettings object false none none
calendarId string true none none
extId string false none none
extMetadata object false none none

Enumerated Values

Property Value
accessRole freeBusyReader
accessRole reader
accessRole writer
accessRole owner

SubscriptionWithRelations

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "accessRole": "freeBusyReader",
  "bgColor": "string",
  "fgColor": "string",
  "isHidden": true,
  "isPrimary": true,
  "identifier": "string",
  "defaultReminders": {},
  "notificationSettings": {},
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {},
  "calendar": {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "source": "string",
    "enableWorkingHours": true,
    "location": "string",
    "identifier": "string",
    "summary": "string",
    "timezone": "string",
    "extId": "string",
    "extMetadata": {},
    "events": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "bgColor": "string",
        "description": "string",
        "endDateTime": "2019-08-24T14:15:22Z",
        "fgColor": "string",
        "iCalUid": "string",
        "isFullDayEvent": true,
        "isLocked": true,
        "link": "string",
        "location": "string",
        "meetingLink": "string",
        "identifier": "string",
        "startDateTime": "2019-08-24T14:15:22Z",
        "status": "confirmed",
        "summary": "string",
        "timezone": "string",
        "calendarId": "string",
        "parentEventId": "string",
        "extId": "string",
        "extMetadata": {},
        "calendar": {},
        "foreignKey": null,
        "parentEvent": {},
        "attendees": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "identifier": "string",
            "isOptional": true,
            "isOrganizer": true,
            "messages": "string",
            "responseStatus": "needsAction",
            "eventId": "string",
            "extId": "string",
            "extMetadata": {},
            "event": {},
            "foreignKey": null
          }
        ],
        "attachments": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "fileUrl": "string",
            "iconLink": "string",
            "mimeType": "string",
            "title": "string",
            "eventId": "string",
            "extId": "string",
            "extMetadata": {},
            "event": {},
            "foreignKey": null
          }
        ]
      }
    ],
    "workingHours": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "dayOfWeek": 0,
        "end": "string",
        "start": "string",
        "calendarId": "string",
        "extId": "string",
        "extMetadata": {},
        "calendar": {},
        "foreignKey": null
      }
    ],
    "subscriptions": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "accessRole": "freeBusyReader",
        "bgColor": "string",
        "fgColor": "string",
        "isHidden": true,
        "isPrimary": true,
        "identifier": "string",
        "defaultReminders": {},
        "notificationSettings": {},
        "calendarId": "string",
        "extId": "string",
        "extMetadata": {},
        "calendar": {},
        "foreignKey": null
      }
    ]
  },
  "foreignKey": null
}

SubscriptionWithRelations

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
accessRole string false none none
bgColor string false none none
fgColor string false none none
isHidden boolean false none none
isPrimary boolean false none none
identifier string true none none
defaultReminders object false none none
notificationSettings object false none none
calendarId string true none none
extId string false none none
extMetadata object false none none
calendar CalendarWithRelations false none (tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })
foreignKey any false none none

Enumerated Values

Property Value
accessRole freeBusyReader
accessRole reader
accessRole writer
accessRole owner

SubscriptionPartial

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "accessRole": "freeBusyReader",
  "bgColor": "string",
  "fgColor": "string",
  "isHidden": true,
  "isPrimary": true,
  "identifier": "string",
  "defaultReminders": {},
  "notificationSettings": {},
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
}

SubscriptionPartial

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
accessRole string false none none
bgColor string false none none
fgColor string false none none
isHidden boolean false none none
isPrimary boolean false none none
identifier string false none none
defaultReminders object false none none
notificationSettings object false none none
calendarId string false none none
extId string false none none
extMetadata object false none none

Enumerated Values

Property Value
accessRole freeBusyReader
accessRole reader
accessRole writer
accessRole owner

Theme

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "calBg": "string",
  "calFg": "string",
  "eventBg": "string",
  "eventFg": "string",
  "extId": "string",
  "extMetadata": {}
}

Theme

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
calBg string false none none
calFg string false none none
eventBg string false none none
eventFg string false none none
extId string false none none
extMetadata object false none none

NewTheme

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "calBg": "string",
  "calFg": "string",
  "eventBg": "string",
  "eventFg": "string",
  "extId": "string",
  "extMetadata": {}
}

NewTheme

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
calBg string false none none
calFg string false none none
eventBg string false none none
eventFg string false none none
extId string false none none
extMetadata object false none none

ThemeWithRelations

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "calBg": "string",
  "calFg": "string",
  "eventBg": "string",
  "eventFg": "string",
  "extId": "string",
  "extMetadata": {}
}

ThemeWithRelations

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
calBg string false none none
calFg string false none none
eventBg string false none none
eventFg string false none none
extId string false none none
extMetadata object false none none

ThemePartial

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "calBg": "string",
  "calFg": "string",
  "eventBg": "string",
  "eventFg": "string",
  "extId": "string",
  "extMetadata": {}
}

ThemePartial

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
calBg string false none none
calFg string false none none
eventBg string false none none
eventFg string false none none
extId string false none none
extMetadata object false none none

NewWorkingHour

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "dayOfWeek": 0,
  "end": "string",
  "start": "string",
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
}

NewWorkingHour

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
dayOfWeek number false none none
end string false none none
start string false none none
calendarId string true none none
extId string false none none
extMetadata object false none none

Enumerated Values

Property Value
dayOfWeek 0
dayOfWeek 1
dayOfWeek 2
dayOfWeek 3
dayOfWeek 4
dayOfWeek 5
dayOfWeek 6

WorkingHourWithRelations

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "dayOfWeek": 0,
  "end": "string",
  "start": "string",
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {},
  "calendar": {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "source": "string",
    "enableWorkingHours": true,
    "location": "string",
    "identifier": "string",
    "summary": "string",
    "timezone": "string",
    "extId": "string",
    "extMetadata": {},
    "events": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "bgColor": "string",
        "description": "string",
        "endDateTime": "2019-08-24T14:15:22Z",
        "fgColor": "string",
        "iCalUid": "string",
        "isFullDayEvent": true,
        "isLocked": true,
        "link": "string",
        "location": "string",
        "meetingLink": "string",
        "identifier": "string",
        "startDateTime": "2019-08-24T14:15:22Z",
        "status": "confirmed",
        "summary": "string",
        "timezone": "string",
        "calendarId": "string",
        "parentEventId": "string",
        "extId": "string",
        "extMetadata": {},
        "calendar": {},
        "foreignKey": null,
        "parentEvent": {},
        "attendees": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "identifier": "string",
            "isOptional": true,
            "isOrganizer": true,
            "messages": "string",
            "responseStatus": "needsAction",
            "eventId": "string",
            "extId": "string",
            "extMetadata": {},
            "event": {},
            "foreignKey": null
          }
        ],
        "attachments": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "fileUrl": "string",
            "iconLink": "string",
            "mimeType": "string",
            "title": "string",
            "eventId": "string",
            "extId": "string",
            "extMetadata": {},
            "event": {},
            "foreignKey": null
          }
        ]
      }
    ],
    "workingHours": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "dayOfWeek": 0,
        "end": "string",
        "start": "string",
        "calendarId": "string",
        "extId": "string",
        "extMetadata": {},
        "calendar": {},
        "foreignKey": null
      }
    ],
    "subscriptions": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "accessRole": "freeBusyReader",
        "bgColor": "string",
        "fgColor": "string",
        "isHidden": true,
        "isPrimary": true,
        "identifier": "string",
        "defaultReminders": {},
        "notificationSettings": {},
        "calendarId": "string",
        "extId": "string",
        "extMetadata": {},
        "calendar": {},
        "foreignKey": null
      }
    ]
  },
  "foreignKey": null
}

WorkingHourWithRelations

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
dayOfWeek number false none none
end string false none none
start string false none none
calendarId string true none none
extId string false none none
extMetadata object false none none
calendar CalendarWithRelations false none (tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })
foreignKey any false none none

Enumerated Values

Property Value
dayOfWeek 0
dayOfWeek 1
dayOfWeek 2
dayOfWeek 3
dayOfWeek 4
dayOfWeek 5
dayOfWeek 6

WorkingHourPartial

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "dayOfWeek": 0,
  "end": "string",
  "start": "string",
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
}

WorkingHourPartial

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
dayOfWeek number false none none
end string false none none
start string false none none
calendarId string false none none
extId string false none none
extMetadata object false none none

Enumerated Values

Property Value
dayOfWeek 0
dayOfWeek 1
dayOfWeek 2
dayOfWeek 3
dayOfWeek 4
dayOfWeek 5
dayOfWeek 6

Date

1
null

Properties

None

NewEventInCalendar

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "bgColor": "string",
  "description": "string",
  "endDateTime": "2019-08-24T14:15:22Z",
  "fgColor": "string",
  "iCalUid": "string",
  "isFullDayEvent": true,
  "isLocked": true,
  "link": "string",
  "location": "string",
  "meetingLink": "string",
  "identifier": "string",
  "startDateTime": "2019-08-24T14:15:22Z",
  "status": "confirmed",
  "summary": "string",
  "timezone": "string",
  "calendarId": "string",
  "parentEventId": "string",
  "extId": "string",
  "extMetadata": {}
}

NewEventInCalendar

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
bgColor string false none none
description string false none none
endDateTime string(date-time) false none none
fgColor string false none none
iCalUid string false none none
isFullDayEvent boolean false none none
isLocked boolean false none none
link string false none none
location string false none none
meetingLink string false none none
identifier string false none none
startDateTime string(date-time) false none none
status string false none none
summary string false none none
timezone string false none none
calendarId string false none none
parentEventId string false none none
extId string false none none
extMetadata object false none none

Enumerated Values

Property Value
status confirmed
status tentative
status cancelled
status completed

NewSubscriptionInCalendar

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "accessRole": "freeBusyReader",
  "bgColor": "string",
  "fgColor": "string",
  "isHidden": true,
  "isPrimary": true,
  "identifier": "string",
  "defaultReminders": {},
  "notificationSettings": {},
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
}

NewSubscriptionInCalendar

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
accessRole string false none none
bgColor string false none none
fgColor string false none none
isHidden boolean false none none
isPrimary boolean false none none
identifier string true none none
defaultReminders object false none none
notificationSettings object false none none
calendarId string false none none
extId string false none none
extMetadata object false none none

Enumerated Values

Property Value
accessRole freeBusyReader
accessRole reader
accessRole writer
accessRole owner

NewWorkingHourInCalendar

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "dayOfWeek": 0,
  "end": "string",
  "start": "string",
  "calendarId": "string",
  "extId": "string",
  "extMetadata": {}
}

NewWorkingHourInCalendar

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
dayOfWeek number false none none
end string false none none
start string false none none
calendarId string false none none
extId string false none none
extMetadata object false none none

Enumerated Values

Property Value
dayOfWeek 0
dayOfWeek 1
dayOfWeek 2
dayOfWeek 3
dayOfWeek 4
dayOfWeek 5
dayOfWeek 6

NewAttachmentInEvent

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "fileUrl": "string",
  "iconLink": "string",
  "mimeType": "string",
  "title": "string",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
}

NewAttachmentInEvent

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
fileUrl string true none none
iconLink string false none none
mimeType string false none none
title string false none none
eventId string false none none
extId string false none none
extMetadata object false none none

NewAttendeeInEvent

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "identifier": "string",
  "isOptional": true,
  "isOrganizer": true,
  "messages": "string",
  "responseStatus": "needsAction",
  "eventId": "string",
  "extId": "string",
  "extMetadata": {}
}

NewAttendeeInEvent

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
identifier string true none none
isOptional boolean false none none
isOrganizer boolean false none none
messages string false none none
responseStatus string false none none
eventId string false none none
extId string false none none
extMetadata object false none none

Enumerated Values

Property Value
responseStatus needsAction
responseStatus tentative
responseStatus accepted
responseStatus declined

loopback.Count

1
2
3
{
  "count": 0
}

loopback.Count

Properties

Name Type Required Restrictions Description
count number false none none

attachments.ScopeFilter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {},
  "include": [
    {}
  ]
}

attachments.ScopeFilter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
where object false none none
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
include [object] false none none

attachments.IncludeFilter.Items

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "relation": "event",
  "scope": {
    "offset": 0,
    "limit": 100,
    "skip": 0,
    "order": "string",
    "where": {},
    "fields": {},
    "include": [
      {}
    ]
  }
}

attachments.IncludeFilter.Items

Properties

Name Type Required Restrictions Description
relation string false none none
scope attachments.ScopeFilter false none none

Enumerated Values

Property Value
relation event

attachments.Filter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "fields": {
    "deleted": true,
    "deletedOn": true,
    "deletedBy": true,
    "createdOn": true,
    "modifiedOn": true,
    "createdBy": true,
    "modifiedBy": true,
    "id": true,
    "fileUrl": true,
    "iconLink": true,
    "mimeType": true,
    "title": true,
    "eventId": true,
    "extId": true,
    "extMetadata": true
  },
  "include": [
    {
      "relation": "event",
      "scope": {
        "offset": 0,
        "limit": 100,
        "skip": 0,
        "order": "string",
        "where": {},
        "fields": {},
        "include": [
          {}
        ]
      }
    }
  ]
}

attachments.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» deleted boolean false none none
»» deletedOn boolean false none none
»» deletedBy boolean false none none
»» createdOn boolean false none none
»» modifiedOn boolean false none none
»» createdBy boolean false none none
»» modifiedBy boolean false none none
»» id boolean false none none
»» fileUrl boolean false none none
»» iconLink boolean false none none
»» mimeType boolean false none none
»» title boolean false none none
»» eventId boolean false none none
»» extId boolean false none none
»» extMetadata boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
include [anyOf] false none none

anyOf

Name Type Required Restrictions Description
» anonymous attachments.IncludeFilter.Items false none none

or

Name Type Required Restrictions Description
» anonymous string false none none

attachments.Filter1

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {
    "deleted": true,
    "deletedOn": true,
    "deletedBy": true,
    "createdOn": true,
    "modifiedOn": true,
    "createdBy": true,
    "modifiedBy": true,
    "id": true,
    "fileUrl": true,
    "iconLink": true,
    "mimeType": true,
    "title": true,
    "eventId": true,
    "extId": true,
    "extMetadata": true
  },
  "include": [
    {
      "relation": "event",
      "scope": {
        "offset": 0,
        "limit": 100,
        "skip": 0,
        "order": "string",
        "where": {},
        "fields": {},
        "include": [
          {}
        ]
      }
    }
  ]
}

attachments.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
where object false none none
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» deleted boolean false none none
»» deletedOn boolean false none none
»» deletedBy boolean false none none
»» createdOn boolean false none none
»» modifiedOn boolean false none none
»» createdBy boolean false none none
»» modifiedBy boolean false none none
»» id boolean false none none
»» fileUrl boolean false none none
»» iconLink boolean false none none
»» mimeType boolean false none none
»» title boolean false none none
»» eventId boolean false none none
»» extId boolean false none none
»» extMetadata boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
include [anyOf] false none none

anyOf

Name Type Required Restrictions Description
» anonymous attachments.IncludeFilter.Items false none none

or

Name Type Required Restrictions Description
» anonymous string false none none

attendees.ScopeFilter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {},
  "include": [
    {}
  ]
}

attendees.ScopeFilter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
where object false none none
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
include [object] false none none

attendees.IncludeFilter.Items

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "relation": "event",
  "scope": {
    "offset": 0,
    "limit": 100,
    "skip": 0,
    "order": "string",
    "where": {},
    "fields": {},
    "include": [
      {}
    ]
  }
}

attendees.IncludeFilter.Items

Properties

Name Type Required Restrictions Description
relation string false none none
scope attendees.ScopeFilter false none none

Enumerated Values

Property Value
relation event

attendees.Filter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "fields": {
    "deleted": true,
    "deletedOn": true,
    "deletedBy": true,
    "createdOn": true,
    "modifiedOn": true,
    "createdBy": true,
    "modifiedBy": true,
    "id": true,
    "identifier": true,
    "isOptional": true,
    "isOrganizer": true,
    "messages": true,
    "responseStatus": true,
    "eventId": true,
    "extId": true,
    "extMetadata": true
  },
  "include": [
    {
      "relation": "event",
      "scope": {
        "offset": 0,
        "limit": 100,
        "skip": 0,
        "order": "string",
        "where": {},
        "fields": {},
        "include": [
          {}
        ]
      }
    }
  ]
}

attendees.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» deleted boolean false none none
»» deletedOn boolean false none none
»» deletedBy boolean false none none
»» createdOn boolean false none none
»» modifiedOn boolean false none none
»» createdBy boolean false none none
»» modifiedBy boolean false none none
»» id boolean false none none
»» identifier boolean false none none
»» isOptional boolean false none none
»» isOrganizer boolean false none none
»» messages boolean false none none
»» responseStatus boolean false none none
»» eventId boolean false none none
»» extId boolean false none none
»» extMetadata boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
include [anyOf] false none none

anyOf

Name Type Required Restrictions Description
» anonymous attendees.IncludeFilter.Items false none none

or

Name Type Required Restrictions Description
» anonymous string false none none

attendees.Filter1

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {
    "deleted": true,
    "deletedOn": true,
    "deletedBy": true,
    "createdOn": true,
    "modifiedOn": true,
    "createdBy": true,
    "modifiedBy": true,
    "id": true,
    "identifier": true,
    "isOptional": true,
    "isOrganizer": true,
    "messages": true,
    "responseStatus": true,
    "eventId": true,
    "extId": true,
    "extMetadata": true
  },
  "include": [
    {
      "relation": "event",
      "scope": {
        "offset": 0,
        "limit": 100,
        "skip": 0,
        "order": "string",
        "where": {},
        "fields": {},
        "include": [
          {}
        ]
      }
    }
  ]
}

attendees.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
where object false none none
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» deleted boolean false none none
»» deletedOn boolean false none none
»» deletedBy boolean false none none
»» createdOn boolean false none none
»» modifiedOn boolean false none none
»» createdBy boolean false none none
»» modifiedBy boolean false none none
»» id boolean false none none
»» identifier boolean false none none
»» isOptional boolean false none none
»» isOrganizer boolean false none none
»» messages boolean false none none
»» responseStatus boolean false none none
»» eventId boolean false none none
»» extId boolean false none none
»» extMetadata boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
include [anyOf] false none none

anyOf

Name Type Required Restrictions Description
» anonymous attendees.IncludeFilter.Items false none none

or

Name Type Required Restrictions Description
» anonymous string false none none

subscriptions.ScopeFilter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {},
  "include": [
    {}
  ]
}

subscriptions.ScopeFilter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
where object false none none
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
include [object] false none none

subscriptions.IncludeFilter.Items

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "relation": "calendar",
  "scope": {
    "offset": 0,
    "limit": 100,
    "skip": 0,
    "order": "string",
    "where": {},
    "fields": {},
    "include": [
      {}
    ]
  }
}

subscriptions.IncludeFilter.Items

Properties

Name Type Required Restrictions Description
relation string false none none
scope subscriptions.ScopeFilter false none none

Enumerated Values

Property Value
relation calendar

subscriptions.Filter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {
    "deleted": true,
    "deletedOn": true,
    "deletedBy": true,
    "createdOn": true,
    "modifiedOn": true,
    "createdBy": true,
    "modifiedBy": true,
    "id": true,
    "accessRole": true,
    "bgColor": true,
    "fgColor": true,
    "isHidden": true,
    "isPrimary": true,
    "identifier": true,
    "defaultReminders": true,
    "notificationSettings": true,
    "calendarId": true,
    "extId": true,
    "extMetadata": true
  },
  "include": [
    {
      "relation": "calendar",
      "scope": {
        "offset": 0,
        "limit": 100,
        "skip": 0,
        "order": "string",
        "where": {},
        "fields": {},
        "include": [
          {}
        ]
      }
    }
  ]
}

subscriptions.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
where object false none none
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» deleted boolean false none none
»» deletedOn boolean false none none
»» deletedBy boolean false none none
»» createdOn boolean false none none
»» modifiedOn boolean false none none
»» createdBy boolean false none none
»» modifiedBy boolean false none none
»» id boolean false none none
»» accessRole boolean false none none
»» bgColor boolean false none none
»» fgColor boolean false none none
»» isHidden boolean false none none
»» isPrimary boolean false none none
»» identifier boolean false none none
»» defaultReminders boolean false none none
»» notificationSettings boolean false none none
»» calendarId boolean false none none
»» extId boolean false none none
»» extMetadata boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
include [anyOf] false none none

anyOf

Name Type Required Restrictions Description
» anonymous subscriptions.IncludeFilter.Items false none none

or

Name Type Required Restrictions Description
» anonymous string false none none

calendars.ScopeFilter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {},
  "include": [
    {}
  ]
}

calendars.ScopeFilter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
where object false none none
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
include [object] false none none

calendars.IncludeFilter.Items

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "relation": "events",
  "scope": {
    "offset": 0,
    "limit": 100,
    "skip": 0,
    "order": "string",
    "where": {},
    "fields": {},
    "include": [
      {}
    ]
  }
}

calendars.IncludeFilter.Items

Properties

Name Type Required Restrictions Description
relation string false none none
scope calendars.ScopeFilter false none none

Enumerated Values

Property Value
relation events
relation workingHours
relation subscriptions

calendars.Filter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "fields": {
    "deleted": true,
    "deletedOn": true,
    "deletedBy": true,
    "createdOn": true,
    "modifiedOn": true,
    "createdBy": true,
    "modifiedBy": true,
    "id": true,
    "source": true,
    "enableWorkingHours": true,
    "location": true,
    "identifier": true,
    "summary": true,
    "timezone": true,
    "extId": true,
    "extMetadata": true
  },
  "include": [
    {
      "relation": "events",
      "scope": {
        "offset": 0,
        "limit": 100,
        "skip": 0,
        "order": "string",
        "where": {},
        "fields": {},
        "include": [
          {}
        ]
      }
    }
  ]
}

calendars.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» deleted boolean false none none
»» deletedOn boolean false none none
»» deletedBy boolean false none none
»» createdOn boolean false none none
»» modifiedOn boolean false none none
»» createdBy boolean false none none
»» modifiedBy boolean false none none
»» id boolean false none none
»» source boolean false none none
»» enableWorkingHours boolean false none none
»» location boolean false none none
»» identifier boolean false none none
»» summary boolean false none none
»» timezone boolean false none none
»» extId boolean false none none
»» extMetadata boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
include [anyOf] false none none

anyOf

Name Type Required Restrictions Description
» anonymous calendars.IncludeFilter.Items false none none

or

Name Type Required Restrictions Description
» anonymous string false none none

calendars.Filter1

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {
    "deleted": true,
    "deletedOn": true,
    "deletedBy": true,
    "createdOn": true,
    "modifiedOn": true,
    "createdBy": true,
    "modifiedBy": true,
    "id": true,
    "source": true,
    "enableWorkingHours": true,
    "location": true,
    "identifier": true,
    "summary": true,
    "timezone": true,
    "extId": true,
    "extMetadata": true
  },
  "include": [
    {
      "relation": "events",
      "scope": {
        "offset": 0,
        "limit": 100,
        "skip": 0,
        "order": "string",
        "where": {},
        "fields": {},
        "include": [
          {}
        ]
      }
    }
  ]
}

calendars.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
where object false none none
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» deleted boolean false none none
»» deletedOn boolean false none none
»» deletedBy boolean false none none
»» createdOn boolean false none none
»» modifiedOn boolean false none none
»» createdBy boolean false none none
»» modifiedBy boolean false none none
»» id boolean false none none
»» source boolean false none none
»» enableWorkingHours boolean false none none
»» location boolean false none none
»» identifier boolean false none none
»» summary boolean false none none
»» timezone boolean false none none
»» extId boolean false none none
»» extMetadata boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
include [anyOf] false none none

anyOf

Name Type Required Restrictions Description
» anonymous calendars.IncludeFilter.Items false none none

or

Name Type Required Restrictions Description
» anonymous string false none none

events.ScopeFilter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {},
  "include": [
    {}
  ]
}

events.ScopeFilter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
where object false none none
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
include [object] false none none

events.IncludeFilter.Items

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "relation": "calendar",
  "scope": {
    "offset": 0,
    "limit": 100,
    "skip": 0,
    "order": "string",
    "where": {},
    "fields": {},
    "include": [
      {}
    ]
  }
}

events.IncludeFilter.Items

Properties

Name Type Required Restrictions Description
relation string false none none
scope events.ScopeFilter false none none

Enumerated Values

Property Value
relation calendar
relation parentEvent
relation attendees
relation attachments

events.Filter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "fields": {
    "deleted": true,
    "deletedOn": true,
    "deletedBy": true,
    "createdOn": true,
    "modifiedOn": true,
    "createdBy": true,
    "modifiedBy": true,
    "id": true,
    "bgColor": true,
    "description": true,
    "endDateTime": true,
    "fgColor": true,
    "iCalUid": true,
    "isFullDayEvent": true,
    "isLocked": true,
    "link": true,
    "location": true,
    "meetingLink": true,
    "identifier": true,
    "startDateTime": true,
    "status": true,
    "summary": true,
    "timezone": true,
    "calendarId": true,
    "parentEventId": true,
    "extId": true,
    "extMetadata": true
  },
  "include": [
    {
      "relation": "calendar",
      "scope": {
        "offset": 0,
        "limit": 100,
        "skip": 0,
        "order": "string",
        "where": {},
        "fields": {},
        "include": [
          {}
        ]
      }
    }
  ]
}

events.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» deleted boolean false none none
»» deletedOn boolean false none none
»» deletedBy boolean false none none
»» createdOn boolean false none none
»» modifiedOn boolean false none none
»» createdBy boolean false none none
»» modifiedBy boolean false none none
»» id boolean false none none
»» bgColor boolean false none none
»» description boolean false none none
»» endDateTime boolean false none none
»» fgColor boolean false none none
»» iCalUid boolean false none none
»» isFullDayEvent boolean false none none
»» isLocked boolean false none none
»» link boolean false none none
»» location boolean false none none
»» meetingLink boolean false none none
»» identifier boolean false none none
»» startDateTime boolean false none none
»» status boolean false none none
»» summary boolean false none none
»» timezone boolean false none none
»» calendarId boolean false none none
»» parentEventId boolean false none none
»» extId boolean false none none
»» extMetadata boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
include [anyOf] false none none

anyOf

Name Type Required Restrictions Description
» anonymous events.IncludeFilter.Items false none none

or

Name Type Required Restrictions Description
» anonymous string false none none

events_attendees_view.ScopeFilter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {},
  "include": [
    {}
  ]
}

events_attendees_view.ScopeFilter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
where object false none none
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
include [object] false none none

events_attendees_view.IncludeFilter.Items

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "relation": "calendar",
  "scope": {
    "offset": 0,
    "limit": 100,
    "skip": 0,
    "order": "string",
    "where": {},
    "fields": {},
    "include": [
      {}
    ]
  }
}

events_attendees_view.IncludeFilter.Items

Properties

Name Type Required Restrictions Description
relation string false none none
scope events_attendees_view.ScopeFilter false none none

Enumerated Values

Property Value
relation calendar
relation parentEvent
relation attendees
relation attachments

events_attendees_view.Filter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {
    "deleted": true,
    "deletedOn": true,
    "deletedBy": true,
    "createdOn": true,
    "modifiedOn": true,
    "createdBy": true,
    "modifiedBy": true,
    "id": true,
    "bgColor": true,
    "description": true,
    "endDateTime": true,
    "fgColor": true,
    "iCalUid": true,
    "isFullDayEvent": true,
    "isLocked": true,
    "link": true,
    "location": true,
    "meetingLink": true,
    "identifier": true,
    "startDateTime": true,
    "status": true,
    "summary": true,
    "timezone": true,
    "calendarId": true,
    "parentEventId": true,
    "extId": true,
    "extMetadata": true,
    "attendeeId": true,
    "isOptional": true,
    "attendeeIdentifier": true,
    "isOrganizer": true,
    "messages": true,
    "responseStatus": true,
    "eventId": true
  },
  "include": [
    {
      "relation": "calendar",
      "scope": {
        "offset": 0,
        "limit": 100,
        "skip": 0,
        "order": "string",
        "where": {},
        "fields": {},
        "include": [
          {}
        ]
      }
    }
  ]
}

events_attendees_view.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
where object false none none
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» deleted boolean false none none
»» deletedOn boolean false none none
»» deletedBy boolean false none none
»» createdOn boolean false none none
»» modifiedOn boolean false none none
»» createdBy boolean false none none
»» modifiedBy boolean false none none
»» id boolean false none none
»» bgColor boolean false none none
»» description boolean false none none
»» endDateTime boolean false none none
»» fgColor boolean false none none
»» iCalUid boolean false none none
»» isFullDayEvent boolean false none none
»» isLocked boolean false none none
»» link boolean false none none
»» location boolean false none none
»» meetingLink boolean false none none
»» identifier boolean false none none
»» startDateTime boolean false none none
»» status boolean false none none
»» summary boolean false none none
»» timezone boolean false none none
»» calendarId boolean false none none
»» parentEventId boolean false none none
»» extId boolean false none none
»» extMetadata boolean false none none
»» attendeeId boolean false none none
»» isOptional boolean false none none
»» attendeeIdentifier boolean false none none
»» isOrganizer boolean false none none
»» messages boolean false none none
»» responseStatus boolean false none none
»» eventId boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
include [anyOf] false none none

anyOf

Name Type Required Restrictions Description
» anonymous events_attendees_view.IncludeFilter.Items false none none

or

Name Type Required Restrictions Description
» anonymous string false none none

settings.Filter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "fields": {
    "deleted": true,
    "deletedOn": true,
    "deletedBy": true,
    "createdOn": true,
    "modifiedOn": true,
    "createdBy": true,
    "modifiedBy": true,
    "id": true,
    "ownerId": true,
    "ownerType": true,
    "settingName": true,
    "settingValue": true,
    "extId": true,
    "extMetadata": true
  }
}

settings.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» deleted boolean false none none
»» deletedOn boolean false none none
»» deletedBy boolean false none none
»» createdOn boolean false none none
»» modifiedOn boolean false none none
»» createdBy boolean false none none
»» modifiedBy boolean false none none
»» id boolean false none none
»» ownerId boolean false none none
»» ownerType boolean false none none
»» settingName boolean false none none
»» settingValue boolean false none none
»» extId boolean false none none
»» extMetadata boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

settings.Filter1

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {
    "deleted": true,
    "deletedOn": true,
    "deletedBy": true,
    "createdOn": true,
    "modifiedOn": true,
    "createdBy": true,
    "modifiedBy": true,
    "id": true,
    "ownerId": true,
    "ownerType": true,
    "settingName": true,
    "settingValue": true,
    "extId": true,
    "extMetadata": true
  }
}

settings.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
where object false none none
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» deleted boolean false none none
»» deletedOn boolean false none none
»» deletedBy boolean false none none
»» createdOn boolean false none none
»» modifiedOn boolean false none none
»» createdBy boolean false none none
»» modifiedBy boolean false none none
»» id boolean false none none
»» ownerId boolean false none none
»» ownerType boolean false none none
»» settingName boolean false none none
»» settingValue boolean false none none
»» extId boolean false none none
»» extMetadata boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

subscriptions.Filter1

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "fields": {
    "deleted": true,
    "deletedOn": true,
    "deletedBy": true,
    "createdOn": true,
    "modifiedOn": true,
    "createdBy": true,
    "modifiedBy": true,
    "id": true,
    "accessRole": true,
    "bgColor": true,
    "fgColor": true,
    "isHidden": true,
    "isPrimary": true,
    "identifier": true,
    "defaultReminders": true,
    "notificationSettings": true,
    "calendarId": true,
    "extId": true,
    "extMetadata": true
  },
  "include": [
    {
      "relation": "calendar",
      "scope": {
        "offset": 0,
        "limit": 100,
        "skip": 0,
        "order": "string",
        "where": {},
        "fields": {},
        "include": [
          {}
        ]
      }
    }
  ]
}

subscriptions.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» deleted boolean false none none
»» deletedOn boolean false none none
»» deletedBy boolean false none none
»» createdOn boolean false none none
»» modifiedOn boolean false none none
»» createdBy boolean false none none
»» modifiedBy boolean false none none
»» id boolean false none none
»» accessRole boolean false none none
»» bgColor boolean false none none
»» fgColor boolean false none none
»» isHidden boolean false none none
»» isPrimary boolean false none none
»» identifier boolean false none none
»» defaultReminders boolean false none none
»» notificationSettings boolean false none none
»» calendarId boolean false none none
»» extId boolean false none none
»» extMetadata boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
include [anyOf] false none none

anyOf

Name Type Required Restrictions Description
» anonymous subscriptions.IncludeFilter.Items false none none

or

Name Type Required Restrictions Description
» anonymous string false none none

themes.Filter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "fields": {
    "deleted": true,
    "deletedOn": true,
    "deletedBy": true,
    "createdOn": true,
    "modifiedOn": true,
    "createdBy": true,
    "modifiedBy": true,
    "id": true,
    "calBg": true,
    "calFg": true,
    "eventBg": true,
    "eventFg": true,
    "extId": true,
    "extMetadata": true
  }
}

themes.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» deleted boolean false none none
»» deletedOn boolean false none none
»» deletedBy boolean false none none
»» createdOn boolean false none none
»» modifiedOn boolean false none none
»» createdBy boolean false none none
»» modifiedBy boolean false none none
»» id boolean false none none
»» calBg boolean false none none
»» calFg boolean false none none
»» eventBg boolean false none none
»» eventFg boolean false none none
»» extId boolean false none none
»» extMetadata boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

themes.Filter1

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {
    "deleted": true,
    "deletedOn": true,
    "deletedBy": true,
    "createdOn": true,
    "modifiedOn": true,
    "createdBy": true,
    "modifiedBy": true,
    "id": true,
    "calBg": true,
    "calFg": true,
    "eventBg": true,
    "eventFg": true,
    "extId": true,
    "extMetadata": true
  }
}

themes.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
where object false none none
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» deleted boolean false none none
»» deletedOn boolean false none none
»» deletedBy boolean false none none
»» createdOn boolean false none none
»» modifiedOn boolean false none none
»» createdBy boolean false none none
»» modifiedBy boolean false none none
»» id boolean false none none
»» calBg boolean false none none
»» calFg boolean false none none
»» eventBg boolean false none none
»» eventFg boolean false none none
»» extId boolean false none none
»» extMetadata boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

working_hours.ScopeFilter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {},
  "include": [
    {}
  ]
}

working_hours.ScopeFilter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
where object false none none
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
include [object] false none none

working_hours.IncludeFilter.Items

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "relation": "calendar",
  "scope": {
    "offset": 0,
    "limit": 100,
    "skip": 0,
    "order": "string",
    "where": {},
    "fields": {},
    "include": [
      {}
    ]
  }
}

working_hours.IncludeFilter.Items

Properties

Name Type Required Restrictions Description
relation string false none none
scope working_hours.ScopeFilter false none none

Enumerated Values

Property Value
relation calendar

working_hours.Filter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "fields": {
    "deleted": true,
    "deletedOn": true,
    "deletedBy": true,
    "createdOn": true,
    "modifiedOn": true,
    "createdBy": true,
    "modifiedBy": true,
    "id": true,
    "dayOfWeek": true,
    "end": true,
    "start": true,
    "calendarId": true,
    "extId": true,
    "extMetadata": true
  },
  "include": [
    {
      "relation": "calendar",
      "scope": {
        "offset": 0,
        "limit": 100,
        "skip": 0,
        "order": "string",
        "where": {},
        "fields": {},
        "include": [
          {}
        ]
      }
    }
  ]
}

working_hours.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» deleted boolean false none none
»» deletedOn boolean false none none
»» deletedBy boolean false none none
»» createdOn boolean false none none
»» modifiedOn boolean false none none
»» createdBy boolean false none none
»» modifiedBy boolean false none none
»» id boolean false none none
»» dayOfWeek boolean false none none
»» end boolean false none none
»» start boolean false none none
»» calendarId boolean false none none
»» extId boolean false none none
»» extMetadata boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
include [anyOf] false none none

anyOf

Name Type Required Restrictions Description
» anonymous working_hours.IncludeFilter.Items false none none

or

Name Type Required Restrictions Description
» anonymous string false none none

working_hours.Filter1

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {
    "deleted": true,
    "deletedOn": true,
    "deletedBy": true,
    "createdOn": true,
    "modifiedOn": true,
    "createdBy": true,
    "modifiedBy": true,
    "id": true,
    "dayOfWeek": true,
    "end": true,
    "start": true,
    "calendarId": true,
    "extId": true,
    "extMetadata": true
  },
  "include": [
    {
      "relation": "calendar",
      "scope": {
        "offset": 0,
        "limit": 100,
        "skip": 0,
        "order": "string",
        "where": {},
        "fields": {},
        "include": [
          {}
        ]
      }
    }
  ]
}

working_hours.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
where object false none none
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» deleted boolean false none none
»» deletedOn boolean false none none
»» deletedBy boolean false none none
»» createdOn boolean false none none
»» modifiedOn boolean false none none
»» createdBy boolean false none none
»» modifiedBy boolean false none none
»» id boolean false none none
»» dayOfWeek boolean false none none
»» end boolean false none none
»» start boolean false none none
»» calendarId boolean false none none
»» extId boolean false none none
»» extMetadata boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
include [anyOf] false none none

anyOf

Name Type Required Restrictions Description
» anonymous working_hours.IncludeFilter.Items false none none

or

Name Type Required Restrictions Description
» anonymous string false none none