Skip to content

Notification 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.

notification microservice

Base URLs:

Authentication

  • HTTP Authentication, scheme: bearer

NotificationUserController

NotificationUserController.createAll

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
const inputBody = '[
  {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "notificationId": "string",
    "userId": "string",
    "isRead": true,
    "actionMeta": {},
    "isDraft": true
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/notification-users/bulk',
{
  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
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",
    "notificationId": "string",
    "userId": "string",
    "isRead": true,
    "actionMeta": {},
    "isDraft": true
  }
];
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

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

POST /notification-users/bulk

Permissions
ViewNotification
1

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
[
  {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "notificationId": "string",
    "userId": "string",
    "isRead": true,
    "actionMeta": {},
    "isDraft": true
  }
]

Parameters

Name In Type Required Description
body body NewNotificationUser false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": "string",
  "notificationId": "string",
  "userId": "string",
  "isRead": true,
  "actionMeta": {},
  "isDraft": true
}

Responses

Status Meaning Description Schema
200 OK Notification User model instance NotificationUser

NotificationUserController.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('/notification-users/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('/notification-users/count',
{
  method: 'GET',

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

GET /notification-users/count

Permissions
ViewNotification
1

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 NotificationUser model count loopback.Count

NotificationUserController.deleteAllHard

Code samples

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

fetch('/notification-users/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('/notification-users/hard',
{
  method: 'DELETE',

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

DELETE /notification-users/hard

Permissions
DeleteNotification
4

Parameters

Name In Type Required Description
where query object false none

Responses

Status Meaning Description Schema
204 No Content Notification DELETE success None

NotificationUserController.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
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": "string",
  "notificationId": "string",
  "userId": "string",
  "isRead": true,
  "actionMeta": {},
  "isDraft": true
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/notification-users/{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
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",
  "id": "string",
  "notificationId": "string",
  "userId": "string",
  "isRead": true,
  "actionMeta": {},
  "isDraft": true
};
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

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

PUT /notification-users/{id}

Permissions
ViewNotification
1

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": "string",
  "notificationId": "string",
  "userId": "string",
  "isRead": true,
  "actionMeta": {},
  "isDraft": true
}

Parameters

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

Responses

Status Meaning Description Schema
204 No Content NotificationUser PUT success None

NotificationUserController.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
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": "string",
  "notificationId": "string",
  "userId": "string",
  "isRead": true,
  "actionMeta": {},
  "isDraft": true
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/notification-users/{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
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",
  "id": "string",
  "notificationId": "string",
  "userId": "string",
  "isRead": true,
  "actionMeta": {},
  "isDraft": true
};
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

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

PATCH /notification-users/{id}

Permissions
ViewNotification
1

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": "string",
  "notificationId": "string",
  "userId": "string",
  "isRead": true,
  "actionMeta": {},
  "isDraft": true
}

Parameters

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

Responses

Status Meaning Description Schema
204 No Content NotificationUser PATCH success None

NotificationUserController.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('/notification-users/{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('/notification-users/{id}',
{
  method: 'GET',

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

GET /notification-users/{id}

Permissions
ViewNotification
1

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": "string",
  "notificationId": "string",
  "userId": "string",
  "isRead": true,
  "actionMeta": {},
  "isDraft": true
}

Responses

Status Meaning Description Schema
200 OK NotificationUser instance NotificationUser

NotificationUserController.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('/notification-users/{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('/notification-users/{id}',
{
  method: 'DELETE',

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

DELETE /notification-users/{id}

Permissions
DeleteNotification
4

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
204 No Content NotificationUser DELETE success None

NotificationUserController.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
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "notificationId": "string",
  "userId": "string",
  "isRead": true,
  "actionMeta": {},
  "isDraft": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/notification-users',
{
  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
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",
  "notificationId": "string",
  "userId": "string",
  "isRead": true,
  "actionMeta": {},
  "isDraft": true
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

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

POST /notification-users

Permissions
ViewNotification
1

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "notificationId": "string",
  "userId": "string",
  "isRead": true,
  "actionMeta": {},
  "isDraft": true
}

Parameters

Name In Type Required Description
body body NewNotificationUser false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": "string",
  "notificationId": "string",
  "userId": "string",
  "isRead": true,
  "actionMeta": {},
  "isDraft": true
}

Responses

Status Meaning Description Schema
200 OK NotificationUser model instance NotificationUser

NotificationUserController.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
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": "string",
  "notificationId": "string",
  "userId": "string",
  "isRead": true,
  "actionMeta": {},
  "isDraft": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/notification-users',
{
  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
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",
  "id": "string",
  "notificationId": "string",
  "userId": "string",
  "isRead": true,
  "actionMeta": {},
  "isDraft": true
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

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

PATCH /notification-users

Permissions
ViewNotification
1

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": "string",
  "notificationId": "string",
  "userId": "string",
  "isRead": true,
  "actionMeta": {},
  "isDraft": true
}

Parameters

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

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

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

NotificationUserController.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('/notification-users',
{
  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('/notification-users',
{
  method: 'GET',

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

GET /notification-users

Permissions
ViewNotification
1

Parameters

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

Example responses

200 Response

 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",
    "id": "string",
    "notificationId": "string",
    "userId": "string",
    "isRead": true,
    "actionMeta": {},
    "isDraft": true
  }
]

Responses

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

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [NotificationUser] false none none
» NotificationUser NotificationUser 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
»» id string false none none
»» notificationId string true none none
»» userId string true none none
»» isRead boolean false none none
»» actionMeta object false none none
»» isDraft boolean false none none

NotificationUserController.deleteAll

Code samples

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

fetch('/notification-users',
{
  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('/notification-users',
{
  method: 'DELETE',

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

DELETE /notification-users

Permissions
DeleteNotification
4

Parameters

Name In Type Required Description
where query object false none

Responses

Status Meaning Description Schema
204 No Content Notification DELETE success None

NotificationUserNotificationController

NotificationUserNotificationController.getNotification

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('/notification-users/{id}/notification',
{
  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('/notification-users/{id}/notification',
{
  method: 'GET',

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

GET /notification-users/{id}/notification

Permissions
ViewNotification
1

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
[
  {
    "id": "string",
    "subject": "string",
    "body": "string",
    "receiver": {},
    "type": 0,
    "sentDate": "2019-08-24T14:15:22Z",
    "options": {},
    "isDraft": true,
    "groupKey": "string",
    "isCritical": true
  }
]

Responses

Status Meaning Description Schema
200 OK Notification belonging to NotificationUser Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [Notification] false none none
» Notification Notification false none none
»» id string false none none
»» subject string¦null false none none
»» body string true none none
»» receiver object false none none
»» type number true none none
»» sentDate string(date-time) false none none
»» options object false none none
»» isDraft boolean false none none
»» groupKey string false none none
»» isCritical boolean false none none

PubnubNotificationController

PubnubNotificationController.grantAccess

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
const inputBody = '{
  "receiver": {},
  "type": 0,
  "options": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'string',
  'pubnubToken':'string'
};

fetch('/notifications/access/{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
const fetch = require('node-fetch');
const inputBody = {
  "receiver": {},
  "type": 0,
  "options": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'string',
  'pubnubToken':'string'
};

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

PATCH /notifications/access/{id}

Permissions
CanGetNotificationAccess
5

Body parameter

1
2
3
4
5
{
  "receiver": {},
  "type": 0,
  "options": {}
}

Parameters

Name In Type Required Description
id path string true none
Authorization header string false none
pubnubToken header string true none
body body NotificationAccess false none

Example responses

200 Response

1
2
3
4
{
  "ttl": 0,
  "cipherKey": "string"
}

Responses

Status Meaning Description Schema
200 OK Access response AccessResponseDto

PubnubNotificationController.revokeAccess

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
fetch('/notifications/access/{id}',
{
  method: 'DELETE'

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

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

fetch('/notifications/access/{id}',
{
  method: 'DELETE'

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

DELETE /notifications/access/{id}

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Object with success None

NotificationController

NotificationController.createBulkNotificaitions

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
const inputBody = '[
  {
    "subject": "string",
    "body": "string",
    "receiver": {},
    "type": 0,
    "sentDate": "2019-08-24T14:15:22Z",
    "options": {},
    "isDraft": true,
    "groupKey": "string",
    "isCritical": true
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/notifications/bulk',
{
  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
const fetch = require('node-fetch');
const inputBody = [
  {
    "subject": "string",
    "body": "string",
    "receiver": {},
    "type": 0,
    "sentDate": "2019-08-24T14:15:22Z",
    "options": {},
    "isDraft": true,
    "groupKey": "string",
    "isCritical": true
  }
];
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

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

POST /notifications/bulk

Permissions
CreateNotification
2

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
[
  {
    "subject": "string",
    "body": "string",
    "receiver": {},
    "type": 0,
    "sentDate": "2019-08-24T14:15:22Z",
    "options": {},
    "isDraft": true,
    "groupKey": "string",
    "isCritical": true
  }
]

Parameters

Name In Type Required Description
body body NotificationExcluding_id_ false none

Example responses

Responses

Status Meaning Description Schema
200 OK Array of Notifications, to send notifications as bulk. None

Response Schema

NotificationController.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('/notifications/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('/notifications/count',
{
  method: 'GET',

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

GET /notifications/count

Permissions
ViewNotification
1

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 Notification model count loopback.Count

NotificationController.draftNotification

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
const inputBody = '{
  "subject": "string",
  "body": "string",
  "receiver": {},
  "type": 0,
  "sentDate": "2019-08-24T14:15:22Z",
  "options": {},
  "groupKey": "string",
  "isCritical": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/notifications/drafts',
{
  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
const fetch = require('node-fetch');
const inputBody = {
  "subject": "string",
  "body": "string",
  "receiver": {},
  "type": 0,
  "sentDate": "2019-08-24T14:15:22Z",
  "options": {},
  "groupKey": "string",
  "isCritical": true
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

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

POST /notifications/drafts

Permissions
CreateNotification
2

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "subject": "string",
  "body": "string",
  "receiver": {},
  "type": 0,
  "sentDate": "2019-08-24T14:15:22Z",
  "options": {},
  "groupKey": "string",
  "isCritical": true
}

Parameters

Name In Type Required Description
body body NotificationExcluding_id-isDraft_ false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "subject": "string",
  "body": "string",
  "receiver": {},
  "type": 0,
  "sentDate": "2019-08-24T14:15:22Z",
  "options": {},
  "groupKey": "string",
  "isCritical": true
}

Responses

Status Meaning Description Schema
200 OK This API is used to draft notifications, here in case isDraft . NotificationExcluding_id-isDraft_

NotificationController.sendGroupedNotificationByGroupKey

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
const inputBody = '{
  "subject": "string",
  "body": "string",
  "receiver": {},
  "isCritical": true,
  "type": 0,
  "options": {},
  "sentDate": "2019-08-24T14:15:22Z"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/notifications/groups/{groupKey}',
{
  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
const fetch = require('node-fetch');
const inputBody = {
  "subject": "string",
  "body": "string",
  "receiver": {},
  "isCritical": true,
  "type": 0,
  "options": {},
  "sentDate": "2019-08-24T14:15:22Z"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

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

POST /notifications/groups/{groupKey}

Permissions
CreateNotification
2

Body parameter

1
2
3
4
5
6
7
8
9
{
  "subject": "string",
  "body": "string",
  "receiver": {},
  "isCritical": true,
  "type": 0,
  "options": {},
  "sentDate": "2019-08-24T14:15:22Z"
}

Parameters

Name In Type Required Description
groupKey path string true none
body body NotificationDtoExcluding_id-groupKey_ false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "subject": "string",
  "body": "string",
  "receiver": {},
  "isCritical": true,
  "type": 0,
  "groupKey": "string",
  "options": {},
  "sentDate": "2019-08-24T14:15:22Z"
}

Responses

Status Meaning Description Schema
200 OK This API is used to send notification by grouping by given key in the end point. NotificationDtoExcluding_id_

NotificationController.sendNotificationForSleepTimeUsers

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
const inputBody = '{
  "ids": [
    "string"
  ],
  "userId": [
    "string"
  ],
  "startTime": "2019-08-24T14:15:22Z",
  "endTime": "2019-08-24T14:15:22Z"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/notifications/send',
{
  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
const fetch = require('node-fetch');
const inputBody = {
  "ids": [
    "string"
  ],
  "userId": [
    "string"
  ],
  "startTime": "2019-08-24T14:15:22Z",
  "endTime": "2019-08-24T14:15:22Z"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

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

POST /notifications/send

Permissions
CreateNotification
2

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "ids": [
    "string"
  ],
  "userId": [
    "string"
  ],
  "startTime": "2019-08-24T14:15:22Z",
  "endTime": "2019-08-24T14:15:22Z"
}

Parameters

Name In Type Required Description
body body NotificationSettingsDto false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "ids": [
    "string"
  ],
  "userId": [
    "string"
  ],
  "startTime": "2019-08-24T14:15:22Z",
  "endTime": "2019-08-24T14:15:22Z"
}

Responses

Status Meaning Description Schema
200 OK This API is used to send notifications for given search criteria. NotificationSettingsDto

NotificationController.sendNotificationById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
const inputBody = '{
  "isCritical": true,
  "options": {},
  "sentDate": "2019-08-24T14:15:22Z"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/notifications/{id}/send',
{
  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
const fetch = require('node-fetch');
const inputBody = {
  "isCritical": true,
  "options": {},
  "sentDate": "2019-08-24T14:15:22Z"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

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

POST /notifications/{id}/send

Permissions
CreateNotification
2

Body parameter

1
2
3
4
5
{
  "isCritical": true,
  "options": {},
  "sentDate": "2019-08-24T14:15:22Z"
}

Parameters

Name In Type Required Description
id path string true none
body body NotificationDtoExcluding_id-groupKey-receiver-subject-body-type_ false none

Example responses

200 Response

1
2
3
4
5
{
  "isCritical": true,
  "options": {},
  "sentDate": "2019-08-24T14:15:22Z"
}

Responses

Status Meaning Description Schema
200 OK This API is used to send notifications for given Notification Id. NotificationDtoExcluding_id-groupKey-receiver-subject-body-type_

NotificationController.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
const inputBody = '{
  "id": "string",
  "subject": "string",
  "body": "string",
  "receiver": {},
  "type": 0,
  "sentDate": "2019-08-24T14:15:22Z",
  "options": {},
  "isDraft": true,
  "groupKey": "string",
  "isCritical": true
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/notifications/{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
const fetch = require('node-fetch');
const inputBody = {
  "id": "string",
  "subject": "string",
  "body": "string",
  "receiver": {},
  "type": 0,
  "sentDate": "2019-08-24T14:15:22Z",
  "options": {},
  "isDraft": true,
  "groupKey": "string",
  "isCritical": true
};
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

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

PATCH /notifications/{id}

Permissions
UpdateNotification
3

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "id": "string",
  "subject": "string",
  "body": "string",
  "receiver": {},
  "type": 0,
  "sentDate": "2019-08-24T14:15:22Z",
  "options": {},
  "isDraft": true,
  "groupKey": "string",
  "isCritical": true
}

Parameters

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

Responses

Status Meaning Description Schema
204 No Content Notification PATCH success None

NotificationController.findById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/notifications/{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
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

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

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

GET /notifications/{id}

Permissions
ViewNotification
1

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "id": "string",
  "subject": "string",
  "body": "string",
  "receiver": {},
  "type": 0,
  "sentDate": "2019-08-24T14:15:22Z",
  "options": {},
  "isDraft": true,
  "groupKey": "string",
  "isCritical": true
}

Responses

Status Meaning Description Schema
200 OK , to get the notification by ID Notification

NotificationController.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
const inputBody = '{
  "subject": "string",
  "body": "string",
  "receiver": {},
  "type": 0,
  "sentDate": "2019-08-24T14:15:22Z",
  "options": {},
  "groupKey": "string",
  "isCritical": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/notifications',
{
  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
const fetch = require('node-fetch');
const inputBody = {
  "subject": "string",
  "body": "string",
  "receiver": {},
  "type": 0,
  "sentDate": "2019-08-24T14:15:22Z",
  "options": {},
  "groupKey": "string",
  "isCritical": true
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

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

POST /notifications

Permissions
CreateNotification
2

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "subject": "string",
  "body": "string",
  "receiver": {},
  "type": 0,
  "sentDate": "2019-08-24T14:15:22Z",
  "options": {},
  "groupKey": "string",
  "isCritical": true
}

Parameters

Name In Type Required Description
body body NotificationExcluding_id-isDraft_ false This API is used to send notifications, the request body contains the object of notification model.

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "id": "string",
  "subject": "string",
  "body": "string",
  "receiver": {},
  "type": 0,
  "sentDate": "2019-08-24T14:15:22Z",
  "options": {},
  "isDraft": true,
  "groupKey": "string",
  "isCritical": true
}

Responses

Status Meaning Description Schema
200 OK Notification model instance, This API end point will be used to send the notification to the user. Notification

NotificationController.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
const inputBody = '{
  "id": "string",
  "subject": "string",
  "body": "string",
  "receiver": {},
  "type": 0,
  "sentDate": "2019-08-24T14:15:22Z",
  "options": {},
  "isDraft": true,
  "groupKey": "string",
  "isCritical": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/notifications',
{
  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
const fetch = require('node-fetch');
const inputBody = {
  "id": "string",
  "subject": "string",
  "body": "string",
  "receiver": {},
  "type": 0,
  "sentDate": "2019-08-24T14:15:22Z",
  "options": {},
  "isDraft": true,
  "groupKey": "string",
  "isCritical": true
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

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

PATCH /notifications

Permissions
UpdateNotification
3

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "id": "string",
  "subject": "string",
  "body": "string",
  "receiver": {},
  "type": 0,
  "sentDate": "2019-08-24T14:15:22Z",
  "options": {},
  "isDraft": true,
  "groupKey": "string",
  "isCritical": true
}

Parameters

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

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

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

NotificationController.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('/notifications',
{
  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('/notifications',
{
  method: 'GET',

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

GET /notifications

Parameters

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

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
[
  {
    "id": "string",
    "subject": "string",
    "body": "string",
    "receiver": {},
    "type": 0,
    "sentDate": "2019-08-24T14:15:22Z",
    "options": {},
    "isDraft": true,
    "groupKey": "string",
    "isCritical": true
  }
]

Responses

Status Meaning Description Schema
200 OK Array of Notification model instances, To get the notifications Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [Notification] false none none
» Notification Notification false none none
»» id string false none none
»» subject string¦null false none none
»» body string true none none
»» receiver object false none none
»» type number true none none
»» sentDate string(date-time) false none none
»» options object false none none
»» isDraft boolean false none none
»» groupKey string false none none
»» isCritical boolean false none none

NotificationController.deleteAll

Code samples

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

fetch('/notifications',
{
  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('/notifications',
{
  method: 'DELETE',

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

DELETE /notifications

Permissions
DeleteNotification
4

Parameters

Name In Type Required Description
where query object false none

Responses

Status Meaning Description Schema
204 No Content Notification DELETE success None

NotificationNotificationUserController

NotificationNotificationUserController.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
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "notificationId": "string",
  "userId": "string",
  "isRead": true,
  "actionMeta": {},
  "isDraft": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/notifications/{id}/notification-users',
{
  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
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",
  "notificationId": "string",
  "userId": "string",
  "isRead": true,
  "actionMeta": {},
  "isDraft": true
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

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

POST /notifications/{id}/notification-users

Permissions
CreateNotification
2

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "notificationId": "string",
  "userId": "string",
  "isRead": true,
  "actionMeta": {},
  "isDraft": true
}

Parameters

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

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": "string",
  "notificationId": "string",
  "userId": "string",
  "isRead": true,
  "actionMeta": {},
  "isDraft": true
}

Responses

Status Meaning Description Schema
200 OK Notification model instance NotificationUser

NotificationNotificationUserController.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
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": "string",
  "notificationId": "string",
  "userId": "string",
  "isRead": true,
  "actionMeta": {},
  "isDraft": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/notifications/{id}/notification-users',
{
  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
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",
  "id": "string",
  "notificationId": "string",
  "userId": "string",
  "isRead": true,
  "actionMeta": {},
  "isDraft": true
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

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

PATCH /notifications/{id}/notification-users

Permissions
UpdateNotification
3

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": "string",
  "notificationId": "string",
  "userId": "string",
  "isRead": true,
  "actionMeta": {},
  "isDraft": true
}

Parameters

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

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

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

NotificationNotificationUserController.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('/notifications/{id}/notification-users',
{
  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('/notifications/{id}/notification-users',
{
  method: 'GET',

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

GET /notifications/{id}/notification-users

Permissions
ViewNotification
1

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
[
  {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "id": "string",
    "notificationId": "string",
    "userId": "string",
    "isRead": true,
    "actionMeta": {},
    "isDraft": true
  }
]

Responses

Status Meaning Description Schema
200 OK Array of Notification has many NotificationUser Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [NotificationUser] false none none
» NotificationUser NotificationUser 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
»» id string false none none
»» notificationId string true none none
»» userId string true none none
»» isRead boolean false none none
»» actionMeta object false none none
»» isDraft boolean false none none

NotificationNotificationUserController.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('/notifications/{id}/notification-users',
{
  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('/notifications/{id}/notification-users',
{
  method: 'DELETE',

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

DELETE /notifications/{id}/notification-users

Permissions
DeleteNotification
4

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 Notification.NotificationUser DELETE success count loopback.Count

UserNotificationSettingsController

UserNotificationSettingsController.count

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/user-notification-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
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/user-notification-settings/count',
{
  method: 'GET',

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

GET /user-notification-settings/count

Permissions
ViewNotificationUserSettings

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 UserNotificationSettings model count loopback.Count

UserNotificationSettingsController.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
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": "string",
  "userId": "string",
  "sleepStartTime": "2019-08-24T14:15:22Z",
  "sleepEndTime": "2019-08-24T14:15:22Z",
  "type": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/user-notification-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
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",
  "id": "string",
  "userId": "string",
  "sleepStartTime": "2019-08-24T14:15:22Z",
  "sleepEndTime": "2019-08-24T14:15:22Z",
  "type": 0
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

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

PUT /user-notification-settings/{id}

Permissions
UpdateNotificationUserSettings

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": "string",
  "userId": "string",
  "sleepStartTime": "2019-08-24T14:15:22Z",
  "sleepEndTime": "2019-08-24T14:15:22Z",
  "type": 0
}

Parameters

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

Example responses

204 Response

1
null

Responses

Status Meaning Description Schema
200 OK Return value of UserNotificationSettingsController.replaceById None
204 No Content No Content Inline

Response Schema

Status Code 204

UserNotificationSettings PUT success

Name Type Required Restrictions Description

UserNotificationSettingsController.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
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": "string",
  "userId": "string",
  "sleepStartTime": "2019-08-24T14:15:22Z",
  "sleepEndTime": "2019-08-24T14:15:22Z",
  "type": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/user-notification-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
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",
  "id": "string",
  "userId": "string",
  "sleepStartTime": "2019-08-24T14:15:22Z",
  "sleepEndTime": "2019-08-24T14:15:22Z",
  "type": 0
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

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

PATCH /user-notification-settings/{id}

Permissions
UpdateNotificationUserSettings

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": "string",
  "userId": "string",
  "sleepStartTime": "2019-08-24T14:15:22Z",
  "sleepEndTime": "2019-08-24T14:15:22Z",
  "type": 0
}

Parameters

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

Example responses

204 Response

1
null

Responses

Status Meaning Description Schema
200 OK Return value of UserNotificationSettingsController.updateById None
204 No Content No Content Inline

Response Schema

Status Code 204

UserNotificationSettings PATCH success

Name Type Required Restrictions Description

UserNotificationSettingsController.findById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/user-notification-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
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

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

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

GET /user-notification-settings/{id}

Permissions
ViewNotificationUserSettings

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": "string",
  "userId": "string",
  "sleepStartTime": "2019-08-24T14:15:22Z",
  "sleepEndTime": "2019-08-24T14:15:22Z",
  "type": 0
}

Responses

Status Meaning Description Schema
200 OK UserNotificationSettings model instance UserNotificationSettingsWithRelations

UserNotificationSettingsController.deleteById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/user-notification-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 = {
  'Accept':'application/json'
};

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

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

DELETE /user-notification-settings/{id}

Permissions
DeleteNotificationUserSettings

Parameters

Name In Type Required Description
id path string true none

Example responses

204 Response

1
null

Responses

Status Meaning Description Schema
200 OK Return value of UserNotificationSettingsController.deleteById None
204 No Content No Content Inline

Response Schema

Status Code 204

UserNotificationSettings DELETE success

Name Type Required Restrictions Description

UserNotificationSettingsController.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
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "userId": "string",
  "sleepStartTime": "2019-08-24T14:15:22Z",
  "sleepEndTime": "2019-08-24T14:15:22Z",
  "type": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/user-notification-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
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",
  "userId": "string",
  "sleepStartTime": "2019-08-24T14:15:22Z",
  "sleepEndTime": "2019-08-24T14:15:22Z",
  "type": 0
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

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

POST /user-notification-settings

Permissions
CreateNotificationUserSettings

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "userId": "string",
  "sleepStartTime": "2019-08-24T14:15:22Z",
  "sleepEndTime": "2019-08-24T14:15:22Z",
  "type": 0
}

Parameters

Name In Type Required Description
body body NewUserNotificationSettings false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": "string",
  "userId": "string",
  "sleepStartTime": "2019-08-24T14:15:22Z",
  "sleepEndTime": "2019-08-24T14:15:22Z",
  "type": 0
}

Responses

Status Meaning Description Schema
200 OK UserNotificationSettings model instance UserNotificationSettings

UserNotificationSettingsController.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
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": "string",
  "userId": "string",
  "sleepStartTime": "2019-08-24T14:15:22Z",
  "sleepEndTime": "2019-08-24T14:15:22Z",
  "type": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/user-notification-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
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",
  "id": "string",
  "userId": "string",
  "sleepStartTime": "2019-08-24T14:15:22Z",
  "sleepEndTime": "2019-08-24T14:15:22Z",
  "type": 0
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

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

PATCH /user-notification-settings

Permissions
UpdateNotificationUserSettings

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": "string",
  "userId": "string",
  "sleepStartTime": "2019-08-24T14:15:22Z",
  "sleepEndTime": "2019-08-24T14:15:22Z",
  "type": 0
}

Parameters

Name In Type Required Description
body body UserNotificationSettingsPartial false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

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

UserNotificationSettingsController.find

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/user-notification-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
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/user-notification-settings',
{
  method: 'GET',

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

GET /user-notification-settings

Permissions
ViewNotificationUserSettings

Parameters

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

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
[
  {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "id": "string",
    "userId": "string",
    "sleepStartTime": "2019-08-24T14:15:22Z",
    "sleepEndTime": "2019-08-24T14:15:22Z",
    "type": 0
  }
]

Responses

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

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [UserNotificationSettingsWithRelations] false none [(tsType: UserNotificationSettingsWithRelations, schemaOptions: { includeRelations: true })]
» UserNotificationSettingsWithRelations UserNotificationSettingsWithRelations false none (tsType: UserNotificationSettingsWithRelations, 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
»» id string false none none
»» userId string true none none
»» sleepStartTime string(date-time) true none none
»» sleepEndTime string(date-time) true none none
»» type number true none none

Schemas

Notification

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "id": "string",
  "subject": "string",
  "body": "string",
  "receiver": {},
  "type": 0,
  "sentDate": "2019-08-24T14:15:22Z",
  "options": {},
  "isDraft": true,
  "groupKey": "string",
  "isCritical": true
}

Notification

Properties

Name Type Required Restrictions Description
id string false none none
subject string¦null false none none
body string true none none
receiver object false none none
type number true none none
sentDate string(date-time) false none none
options object false none none
isDraft boolean false none none
groupKey string false none none
isCritical boolean false none none

NotificationExcluding_id-isDraft_

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "subject": "string",
  "body": "string",
  "receiver": {},
  "type": 0,
  "sentDate": "2019-08-24T14:15:22Z",
  "options": {},
  "groupKey": "string",
  "isCritical": true
}

NotificationExcluding_id-isDraft_

Properties

Name Type Required Restrictions Description
subject string¦null false none none
body string true none none
receiver object false none none
type number true none none
sentDate string(date-time) false none none
options object false none none
groupKey string false none none
isCritical boolean false none none

NotificationDtoExcluding_id_

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "subject": "string",
  "body": "string",
  "receiver": {},
  "isCritical": true,
  "type": 0,
  "groupKey": "string",
  "options": {},
  "sentDate": "2019-08-24T14:15:22Z"
}

NotificationDtoExcluding_id_

Properties

Name Type Required Restrictions Description
subject string¦null false none none
body string false none none
receiver object false none none
isCritical boolean false none none
type number true none none
groupKey string false none none
options object false none none
sentDate string(date-time) false none none

NotificationDtoExcluding_id-groupKey_

1
2
3
4
5
6
7
8
9
{
  "subject": "string",
  "body": "string",
  "receiver": {},
  "isCritical": true,
  "type": 0,
  "options": {},
  "sentDate": "2019-08-24T14:15:22Z"
}

NotificationDtoExcluding_id-groupKey_

Properties

Name Type Required Restrictions Description
subject string¦null false none none
body string false none none
receiver object false none none
isCritical boolean false none none
type number true none none
options object false none none
sentDate string(date-time) false none none

NotificationDtoExcluding_id-groupKey-receiver-subject-body-type_

1
2
3
4
5
{
  "isCritical": true,
  "options": {},
  "sentDate": "2019-08-24T14:15:22Z"
}

NotificationDtoExcluding_id-groupKey-receiver-subject-body-type_

Properties

Name Type Required Restrictions Description
isCritical boolean false none none
options object false none none
sentDate string(date-time) false none none

NotificationDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "id": "string",
  "subject": "string",
  "body": "string",
  "receiver": {},
  "isCritical": true,
  "type": 0,
  "groupKey": "string",
  "options": {},
  "sentDate": "2019-08-24T14:15:22Z"
}

NotificationDto

Properties

Name Type Required Restrictions Description
id string false none none
subject string¦null false none none
body string false none none
receiver object false none none
isCritical boolean false none none
type number true none none
groupKey string false none none
options object false none none
sentDate string(date-time) false none none

NotificationSettingsDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "ids": [
    "string"
  ],
  "userId": [
    "string"
  ],
  "startTime": "2019-08-24T14:15:22Z",
  "endTime": "2019-08-24T14:15:22Z"
}

NotificationSettingsDto

Properties

Name Type Required Restrictions Description
ids [string] false none none
userId [string] false none none
startTime string(date-time) false none none
endTime string(date-time) false none none

NotificationExcluding_id_

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "subject": "string",
  "body": "string",
  "receiver": {},
  "type": 0,
  "sentDate": "2019-08-24T14:15:22Z",
  "options": {},
  "isDraft": true,
  "groupKey": "string",
  "isCritical": true
}

NotificationExcluding_id_

Properties

Name Type Required Restrictions Description
subject string¦null false none none
body string true none none
receiver object false none none
type number true none none
sentDate string(date-time) false none none
options object false none none
isDraft boolean false none none
groupKey string false none none
isCritical boolean false none none

NotificationPartial

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "id": "string",
  "subject": "string",
  "body": "string",
  "receiver": {},
  "type": 0,
  "sentDate": "2019-08-24T14:15:22Z",
  "options": {},
  "isDraft": true,
  "groupKey": "string",
  "isCritical": true
}

NotificationPartial

Properties

Name Type Required Restrictions Description
id string false none none
subject string¦null false none none
body string false none none
receiver object false none none
type number false none none
sentDate string(date-time) false none none
options object false none none
isDraft boolean false none none
groupKey string false none none
isCritical boolean false none none

NotificationUser

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": "string",
  "notificationId": "string",
  "userId": "string",
  "isRead": true,
  "actionMeta": {},
  "isDraft": true
}

NotificationUser

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
id string false none none
notificationId string true none none
userId string true none none
isRead boolean false none none
actionMeta object false none none
isDraft boolean false none none

NewNotificationUser

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "notificationId": "string",
  "userId": "string",
  "isRead": true,
  "actionMeta": {},
  "isDraft": true
}

NewNotificationUser

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
notificationId string true none none
userId string true none none
isRead boolean false none none
actionMeta object false none none
isDraft boolean false none none

NotificationUserPartial

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": "string",
  "notificationId": "string",
  "userId": "string",
  "isRead": true,
  "actionMeta": {},
  "isDraft": true
}

NotificationUserPartial

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
id string false none none
notificationId string false none none
userId string false none none
isRead boolean false none none
actionMeta object false none none
isDraft boolean false none none

AccessResponseDto

1
2
3
4
{
  "ttl": 0,
  "cipherKey": "string"
}

AccessResponseDto

Properties

Name Type Required Restrictions Description
ttl number false none none
cipherKey string false none none

NotificationAccess

1
2
3
4
5
{
  "receiver": {},
  "type": 0,
  "options": {}
}

NotificationAccess

Properties

Name Type Required Restrictions Description
receiver object true none this will contain the list of reciever to give access
type number true none none
options object false none this will contain the ttl property for now

NewNotificationUserInNotification

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "notificationId": "string",
  "userId": "string",
  "isRead": true,
  "actionMeta": {},
  "isDraft": true
}

NewNotificationUserInNotification

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
notificationId string false none none
userId string true none none
isRead boolean false none none
actionMeta object false none none
isDraft boolean false none none

UserNotificationSettings

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": "string",
  "userId": "string",
  "sleepStartTime": "2019-08-24T14:15:22Z",
  "sleepEndTime": "2019-08-24T14:15:22Z",
  "type": 0
}

UserNotificationSettings

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
id string false none none
userId string true none none
sleepStartTime string(date-time) true none none
sleepEndTime string(date-time) true none none
type number true none none

NewUserNotificationSettings

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "userId": "string",
  "sleepStartTime": "2019-08-24T14:15:22Z",
  "sleepEndTime": "2019-08-24T14:15:22Z",
  "type": 0
}

NewUserNotificationSettings

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
userId string true none none
sleepStartTime string(date-time) true none none
sleepEndTime string(date-time) true none none
type number true none none

UserNotificationSettingsWithRelations

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": "string",
  "userId": "string",
  "sleepStartTime": "2019-08-24T14:15:22Z",
  "sleepEndTime": "2019-08-24T14:15:22Z",
  "type": 0
}

UserNotificationSettingsWithRelations

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
id string false none none
userId string true none none
sleepStartTime string(date-time) true none none
sleepEndTime string(date-time) true none none
type number true none none

UserNotificationSettingsPartial

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "id": "string",
  "userId": "string",
  "sleepStartTime": "2019-08-24T14:15:22Z",
  "sleepEndTime": "2019-08-24T14:15:22Z",
  "type": 0
}

UserNotificationSettingsPartial

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
id string false none none
userId string false none none
sleepStartTime string(date-time) false none none
sleepEndTime string(date-time) false none none
type number false none none

loopback.Count

1
2
3
{
  "count": 0
}

loopback.Count

Properties

Name Type Required Restrictions Description
count number false none none

notification_users.ScopeFilter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {},
  "include": [
    {}
  ]
}

notification_users.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

notification_users.IncludeFilter.Items

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "relation": "notification",
  "scope": {
    "offset": 0,
    "limit": 100,
    "skip": 0,
    "order": "string",
    "where": {},
    "fields": {},
    "include": [
      {}
    ]
  }
}

notification_users.IncludeFilter.Items

Properties

Name Type Required Restrictions Description
relation string false none none
scope notification_users.ScopeFilter false none none

Enumerated Values

Property Value
relation notification

notification_users.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
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {
    "deleted": true,
    "deletedOn": true,
    "deletedBy": true,
    "createdOn": true,
    "modifiedOn": true,
    "id": true,
    "notificationId": true,
    "userId": true,
    "isRead": true,
    "actionMeta": true,
    "isDraft": true
  },
  "include": [
    {
      "relation": "notification",
      "scope": {
        "offset": 0,
        "limit": 100,
        "skip": 0,
        "order": "string",
        "where": {},
        "fields": {},
        "include": [
          {}
        ]
      }
    }
  ]
}

notification_users.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
»» id boolean false none none
»» notificationId boolean false none none
»» userId boolean false none none
»» isRead boolean false none none
»» actionMeta boolean false none none
»» isDraft 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 notification_users.IncludeFilter.Items false none none

or

Name Type Required Restrictions Description
» anonymous string false none none

notifications.ScopeFilter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {},
  "include": [
    {}
  ]
}

notifications.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

notifications.IncludeFilter.Items

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "relation": "notificationUsers",
  "scope": {
    "offset": 0,
    "limit": 100,
    "skip": 0,
    "order": "string",
    "where": {},
    "fields": {},
    "include": [
      {}
    ]
  }
}

notifications.IncludeFilter.Items

Properties

Name Type Required Restrictions Description
relation string false none none
scope notifications.ScopeFilter false none none

Enumerated Values

Property Value
relation notificationUsers

notifications.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
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {
    "id": true,
    "subject": true,
    "body": true,
    "receiver": true,
    "type": true,
    "sentDate": true,
    "options": true,
    "isDraft": true,
    "groupKey": true,
    "isCritical": true
  },
  "include": [
    {
      "relation": "notificationUsers",
      "scope": {
        "offset": 0,
        "limit": 100,
        "skip": 0,
        "order": "string",
        "where": {},
        "fields": {},
        "include": [
          {}
        ]
      }
    }
  ]
}

notifications.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
»» id boolean false none none
»» subject boolean false none none
»» body boolean false none none
»» receiver boolean false none none
»» type boolean false none none
»» sentDate boolean false none none
»» options boolean false none none
»» isDraft boolean false none none
»» groupKey boolean false none none
»» isCritical 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 notifications.IncludeFilter.Items false none none

or

Name Type Required Restrictions Description
» anonymous string false none none

user_notification_settings.Filter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {
    "deleted": true,
    "deletedOn": true,
    "deletedBy": true,
    "createdOn": true,
    "modifiedOn": true,
    "id": true,
    "userId": true,
    "sleepStartTime": true,
    "sleepEndTime": true,
    "type": true
  }
}

user_notification_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
»» id boolean false none none
»» userId boolean false none none
»» sleepStartTime boolean false none none
»» sleepEndTime boolean false none none
»» type boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none