title | language_tabs | language_clients | toc_footers | includes | search | highlight_theme | headingLevel | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Notification Service v1.0.0 |
|
|
true |
darkula |
2 |
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:
- HTTP Authentication, scheme: bearer
Code samples
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);
});
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
[
{
"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
}
]
Name | In | Type | Required | Description |
---|---|---|---|---|
body | body | NewNotificationUser | false | none |
Example responses
200 Response
{
"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
}
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Notification User model instance | NotificationUser |
Code samples
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);
});
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 |
Name | In | Type | Required | Description |
---|---|---|---|---|
where | query | object | false | none |
Example responses
200 Response
{
"count": 0
}
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | NotificationUser model count | loopback.Count |
Code samples
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);
});
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 |
Name | In | Type | Required | Description |
---|---|---|---|---|
where | query | object | false | none |
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Notification DELETE success | None |
Code samples
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);
});
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
{
"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
}
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | none |
body | body | NotificationUser | false | none |
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | NotificationUser PUT success | None |
Code samples
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);
});
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
{
"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
}
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | none |
body | body | NotificationUserPartial | false | none |
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | NotificationUser PATCH success | None |
Code samples
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);
});
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 |
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | none |
Example responses
200 Response
{
"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
}
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | NotificationUser instance | NotificationUser |
Code samples
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);
});
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 |
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | none |
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | NotificationUser DELETE success | None |
Code samples
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);
});
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
{
"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
}
Name | In | Type | Required | Description |
---|---|---|---|---|
body | body | NewNotificationUser | false | none |
Example responses
200 Response
{
"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
}
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | NotificationUser model instance | NotificationUser |
Code samples
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);
});
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
{
"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
}
Name | In | Type | Required | Description |
---|---|---|---|---|
where | query | object | false | none |
body | body | NotificationUserPartial | false | none |
Example responses
200 Response
{
"count": 0
}
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | NotificationUser PATCH success count | loopback.Count |
Code samples
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);
});
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 |
Name | In | Type | Required | Description |
---|---|---|---|---|
filter | query | notification_users.Filter | false | none |
Example responses
200 Response
[
{
"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
}
]
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Array of NotificationUser model instances | Inline |
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 |
Code samples
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);
});
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 |
Name | In | Type | Required | Description |
---|---|---|---|---|
where | query | object | false | none |
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Notification DELETE success | None |
Code samples
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);
});
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 |
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | none |
Example responses
200 Response
[
{
"id": "string",
"subject": "string",
"body": "string",
"receiver": {},
"type": 0,
"sentDate": "2019-08-24T14:15:22Z",
"options": {},
"isDraft": true,
"groupKey": "string",
"isCritical": true
}
]
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Notification belonging to NotificationUser | Inline |
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 |
Code samples
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);
});
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
{
"receiver": {},
"type": 0,
"options": {}
}
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
{
"ttl": 0,
"cipherKey": "string"
}
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Access response | AccessResponseDto |
Code samples
fetch('/notifications/access/{id}',
{
method: 'DELETE'
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
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}
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | none |
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Object with success | None |
Code samples
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);
});
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
[
{
"subject": "string",
"body": "string",
"receiver": {},
"type": 0,
"sentDate": "2019-08-24T14:15:22Z",
"options": {},
"isDraft": true,
"groupKey": "string",
"isCritical": true
}
]
Name | In | Type | Required | Description |
---|---|---|---|---|
body | body | NotificationExcluding_id_ | false | none |
Example responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Array of Notifications, to send notifications as bulk. | None |
Code samples
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);
});
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 |
Name | In | Type | Required | Description |
---|---|---|---|---|
where | query | object | false | none |
Example responses
200 Response
{
"count": 0
}
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Notification model count | loopback.Count |
Code samples
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);
});
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
{
"subject": "string",
"body": "string",
"receiver": {},
"type": 0,
"sentDate": "2019-08-24T14:15:22Z",
"options": {},
"groupKey": "string",
"isCritical": true
}
Name | In | Type | Required | Description |
---|---|---|---|---|
body | body | NotificationExcluding_id-isDraft_ | false | none |
Example responses
200 Response
{
"subject": "string",
"body": "string",
"receiver": {},
"type": 0,
"sentDate": "2019-08-24T14:15:22Z",
"options": {},
"groupKey": "string",
"isCritical": true
}
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | This API is used to draft notifications, here in case isDraft . | NotificationExcluding_id-isDraft_ |
Code samples
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);
});
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
{
"subject": "string",
"body": "string",
"receiver": {},
"isCritical": true,
"type": 0,
"options": {},
"sentDate": "2019-08-24T14:15:22Z"
}
Name | In | Type | Required | Description |
---|---|---|---|---|
groupKey | path | string | true | none |
body | body | NotificationDtoExcluding_id-groupKey_ | false | none |
Example responses
200 Response
{
"subject": "string",
"body": "string",
"receiver": {},
"isCritical": true,
"type": 0,
"groupKey": "string",
"options": {},
"sentDate": "2019-08-24T14:15:22Z"
}
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | This API is used to send notification by grouping by given key in the end point. | NotificationDtoExcluding_id_ |
Code samples
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);
});
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
{
"ids": [
"string"
],
"userId": [
"string"
],
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z"
}
Name | In | Type | Required | Description |
---|---|---|---|---|
body | body | NotificationSettingsDto | false | none |
Example responses
200 Response
{
"ids": [
"string"
],
"userId": [
"string"
],
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z"
}
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | This API is used to send notifications for given search criteria. | NotificationSettingsDto |
Code samples
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);
});
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
{
"isCritical": true,
"options": {},
"sentDate": "2019-08-24T14:15:22Z"
}
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
{
"isCritical": true,
"options": {},
"sentDate": "2019-08-24T14:15:22Z"
}
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | This API is used to send notifications for given Notification Id. | NotificationDtoExcluding_id-groupKey-receiver-subject-body-type_ |
Code samples
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);
});
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
{
"id": "string",
"subject": "string",
"body": "string",
"receiver": {},
"type": 0,
"sentDate": "2019-08-24T14:15:22Z",
"options": {},
"isDraft": true,
"groupKey": "string",
"isCritical": true
}
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | none |
body | body | NotificationPartial | false | none |
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Notification PATCH success | None |
Code samples
const headers = {
'Accept':'application/json'
};
fetch('/notifications/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
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 |
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | none |
Example responses
200 Response
{
"id": "string",
"subject": "string",
"body": "string",
"receiver": {},
"type": 0,
"sentDate": "2019-08-24T14:15:22Z",
"options": {},
"isDraft": true,
"groupKey": "string",
"isCritical": true
}
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | , to get the notification by ID | Notification |
Code samples
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);
});
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
{
"subject": "string",
"body": "string",
"receiver": {},
"type": 0,
"sentDate": "2019-08-24T14:15:22Z",
"options": {},
"groupKey": "string",
"isCritical": true
}
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
{
"id": "string",
"subject": "string",
"body": "string",
"receiver": {},
"type": 0,
"sentDate": "2019-08-24T14:15:22Z",
"options": {},
"isDraft": true,
"groupKey": "string",
"isCritical": true
}
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Notification model instance, This API end point will be used to send the notification to the user. | Notification |
Code samples
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);
});
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
{
"id": "string",
"subject": "string",
"body": "string",
"receiver": {},
"type": 0,
"sentDate": "2019-08-24T14:15:22Z",
"options": {},
"isDraft": true,
"groupKey": "string",
"isCritical": true
}
Name | In | Type | Required | Description |
---|---|---|---|---|
where | query | object | false | none |
body | body | NotificationPartial | false | none |
Example responses
200 Response
{
"count": 0
}
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Notification PATCH success count | loopback.Count |
Code samples
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);
});
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
Name | In | Type | Required | Description |
---|---|---|---|---|
filter | query | notifications.Filter | false | none |
Example responses
200 Response
[
{
"id": "string",
"subject": "string",
"body": "string",
"receiver": {},
"type": 0,
"sentDate": "2019-08-24T14:15:22Z",
"options": {},
"isDraft": true,
"groupKey": "string",
"isCritical": true
}
]
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Array of Notification model instances, To get the notifications | Inline |
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 |
Code samples
const headers = {
'Authorization':'Bearer {access-token}'
};
fetch('/notifications',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
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 |
Name | In | Type | Required | Description |
---|---|---|---|---|
where | query | object | false | none |
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Notification DELETE success | None |
Code samples
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);
});
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
{
"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
}
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | none |
body | body | NewNotificationUserInNotification | false | none |
Example responses
200 Response
{
"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
}
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Notification model instance | NotificationUser |
Code samples
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);
});
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
{
"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
}
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | none |
where | query | object | false | none |
body | body | NotificationUserPartial | false | none |
Example responses
200 Response
{
"count": 0
}
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Notification.NotificationUser PATCH success count | loopback.Count |
Code samples
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);
});
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 |
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | none |
filter | query | object | false | none |
Example responses
200 Response
[
{
"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
}
]
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Array of Notification has many NotificationUser | Inline |
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 |
Code samples
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);
});
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 |
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | none |
where | query | object | false | none |
Example responses
200 Response
{
"count": 0
}
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Notification.NotificationUser DELETE success count | loopback.Count |
Code samples
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);
});
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 |
Name | In | Type | Required | Description |
---|---|---|---|---|
where | query | object | false | none |
Example responses
200 Response
{
"count": 0
}
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | UserNotificationSettings model count | loopback.Count |
Code samples
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);
});
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
{
"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
}
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | none |
body | body | UserNotificationSettings | false | none |
Example responses
204 Response
null
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Return value of UserNotificationSettingsController.replaceById | None |
204 | No Content | No Content | Inline |
Status Code 204
UserNotificationSettings PUT success
Name | Type | Required | Restrictions | Description |
---|
Code samples
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);
});
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
{
"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
}
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | none |
body | body | UserNotificationSettingsPartial | false | none |
Example responses
204 Response
null
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Return value of UserNotificationSettingsController.updateById | None |
204 | No Content | No Content | Inline |
Status Code 204
UserNotificationSettings PATCH success
Name | Type | Required | Restrictions | Description |
---|
Code samples
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);
});
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 |
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | none |
Example responses
200 Response
{
"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
}
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | UserNotificationSettings model instance | UserNotificationSettingsWithRelations |
Code samples
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);
});
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 |
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | none |
Example responses
204 Response
null
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Return value of UserNotificationSettingsController.deleteById | None |
204 | No Content | No Content | Inline |
Status Code 204
UserNotificationSettings DELETE success
Name | Type | Required | Restrictions | Description |
---|
Code samples
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);
});
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
{
"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
}
Name | In | Type | Required | Description |
---|---|---|---|---|
body | body | NewUserNotificationSettings | false | none |
Example responses
200 Response
{
"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
}
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | UserNotificationSettings model instance | UserNotificationSettings |
Code samples
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);
});
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
{
"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
}
Name | In | Type | Required | Description |
---|---|---|---|---|
body | body | UserNotificationSettingsPartial | false | none |
Example responses
200 Response
{
"count": 0
}
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | UserNotificationSettings PATCH success count | loopback.Count |
Code samples
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);
});
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 |
Name | In | Type | Required | Description |
---|---|---|---|---|
filter | query | user_notification_settings.Filter | false | none |
Example responses
200 Response
[
{
"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
}
]
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Array of UserNotificationSettings model instances | Inline |
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 |
{
"id": "string",
"subject": "string",
"body": "string",
"receiver": {},
"type": 0,
"sentDate": "2019-08-24T14:15:22Z",
"options": {},
"isDraft": true,
"groupKey": "string",
"isCritical": true
}
Notification
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 |
{
"subject": "string",
"body": "string",
"receiver": {},
"type": 0,
"sentDate": "2019-08-24T14:15:22Z",
"options": {},
"groupKey": "string",
"isCritical": true
}
NotificationExcluding_id-isDraft_
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 |
{
"subject": "string",
"body": "string",
"receiver": {},
"isCritical": true,
"type": 0,
"groupKey": "string",
"options": {},
"sentDate": "2019-08-24T14:15:22Z"
}
NotificationDtoExcluding_id_
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 |
{
"subject": "string",
"body": "string",
"receiver": {},
"isCritical": true,
"type": 0,
"options": {},
"sentDate": "2019-08-24T14:15:22Z"
}
NotificationDtoExcluding_id-groupKey_
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 |
{
"isCritical": true,
"options": {},
"sentDate": "2019-08-24T14:15:22Z"
}
NotificationDtoExcluding_id-groupKey-receiver-subject-body-type_
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
isCritical | boolean | false | none | none |
options | object | false | none | none |
sentDate | string(date-time) | false | none | none |
{
"id": "string",
"subject": "string",
"body": "string",
"receiver": {},
"isCritical": true,
"type": 0,
"groupKey": "string",
"options": {},
"sentDate": "2019-08-24T14:15:22Z"
}
NotificationDto
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 |
{
"ids": [
"string"
],
"userId": [
"string"
],
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z"
}
NotificationSettingsDto
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 |
{
"subject": "string",
"body": "string",
"receiver": {},
"type": 0,
"sentDate": "2019-08-24T14:15:22Z",
"options": {},
"isDraft": true,
"groupKey": "string",
"isCritical": true
}
NotificationExcluding_id_
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 |
{
"id": "string",
"subject": "string",
"body": "string",
"receiver": {},
"type": 0,
"sentDate": "2019-08-24T14:15:22Z",
"options": {},
"isDraft": true,
"groupKey": "string",
"isCritical": true
}
NotificationPartial
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 |
{
"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
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 |
{
"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
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 |
{
"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
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 |
{
"ttl": 0,
"cipherKey": "string"
}
AccessResponseDto
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
ttl | number | false | none | none |
cipherKey | string | false | none | none |
{
"receiver": {},
"type": 0,
"options": {}
}
NotificationAccess
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 |
{
"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
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 |
{
"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
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 |
{
"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
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 |
{
"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
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 |
{
"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
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 |
{
"count": 0
}
loopback.Count
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
count | number | false | none | none |
{
"offset": 0,
"limit": 100,
"skip": 0,
"order": "string",
"where": {},
"fields": {},
"include": [
{}
]
}
notification_users.ScopeFilter
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 |
{
"relation": "notification",
"scope": {
"offset": 0,
"limit": 100,
"skip": 0,
"order": "string",
"where": {},
"fields": {},
"include": [
{}
]
}
}
notification_users.IncludeFilter.Items
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
relation | string | false | none | none |
scope | notification_users.ScopeFilter | false | none | none |
Property | Value |
---|---|
relation | notification |
{
"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
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 |
{
"offset": 0,
"limit": 100,
"skip": 0,
"order": "string",
"where": {},
"fields": {},
"include": [
{}
]
}
notifications.ScopeFilter
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 |
{
"relation": "notificationUsers",
"scope": {
"offset": 0,
"limit": 100,
"skip": 0,
"order": "string",
"where": {},
"fields": {},
"include": [
{}
]
}
}
notifications.IncludeFilter.Items
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
relation | string | false | none | none |
scope | notifications.ScopeFilter | false | none | none |
Property | Value |
---|---|
relation | notificationUsers |
{
"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
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 |
{
"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
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 |