Skip to content

Latest commit

 

History

History
2557 lines (1964 loc) · 53.7 KB

openapi.md

File metadata and controls

2557 lines (1964 loc) · 53.7 KB
title language_tabs language_clients toc_footers includes search highlight_theme headingLevel
Notification Service v1.0.0
'javascript
JavaScript
'javascript--nodejs
Node.JS'
'javascript
request'
'javascript--nodejs
false
darkula
2

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.

sandbox

Base URLs:

Authentication

  • HTTP Authentication, scheme: bearer

NotificationUserController

NotificationUserController.createAll

Code samples

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": {}
  }
];
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:3000/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

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": {}
  }
]

Parameters

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": {}
}

Responses

Status Meaning Description Schema
200 OK Notification User model instance NotificationUser
This operation does not require authentication

NotificationUserController.count

Code samples

const fetch = require('node-fetch');

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

fetch('http://localhost:3000/notification-users/count',
{
  method: 'GET',

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

GET /notification-users/count

Parameters

Name In Type Required Description
where query object false none

Example responses

200 Response

{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK NotificationUser model count loopback.Count
This operation does not require authentication

NotificationUserController.deleteAllHard

Code samples

const fetch = require('node-fetch');

fetch('http://localhost:3000/notification-users/hard',
{
  method: 'DELETE'

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

DELETE /notification-users/hard

Parameters

Name In Type Required Description
where query object false none

Responses

Status Meaning Description Schema
204 No Content Notification DELETE success None
This operation does not require authentication

NotificationUserController.replaceById

Code samples

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": {}
};
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:3000/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}

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": {}
}

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
This operation does not require authentication

NotificationUserController.updateById

Code samples

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": {}
};
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:3000/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}

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": {}
}

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
This operation does not require authentication

NotificationUserController.findById

Code samples

const fetch = require('node-fetch');

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

fetch('http://localhost:3000/notification-users/{id}',
{
  method: 'GET',

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

GET /notification-users/{id}

Parameters

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": {}
}

Responses

Status Meaning Description Schema
200 OK NotificationUser instance NotificationUser
This operation does not require authentication

NotificationUserController.deleteById

Code samples

const fetch = require('node-fetch');

fetch('http://localhost:3000/notification-users/{id}',
{
  method: 'DELETE'

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

DELETE /notification-users/{id}

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
204 No Content NotificationUser DELETE success None
This operation does not require authentication

NotificationUserController.create

Code samples

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": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:3000/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

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": {}
}

Parameters

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": {}
}

Responses

Status Meaning Description Schema
200 OK NotificationUser model instance NotificationUser
This operation does not require authentication

NotificationUserController.updateAll

Code samples

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": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:3000/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

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": {}
}

Parameters

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

Example responses

200 Response

{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK NotificationUser PATCH success count loopback.Count
This operation does not require authentication

NotificationUserController.find

Code samples

const fetch = require('node-fetch');

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

fetch('http://localhost:3000/notification-users',
{
  method: 'GET',

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

GET /notification-users

Parameters

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": {}
  }
]

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
This operation does not require authentication

NotificationUserController.deleteAll

Code samples

const fetch = require('node-fetch');

fetch('http://localhost:3000/notification-users',
{
  method: 'DELETE'

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

DELETE /notification-users

Parameters

Name In Type Required Description
where query object false none

Responses

Status Meaning Description Schema
204 No Content Notification DELETE success None
This operation does not require authentication

NotificationUserNotificationController

NotificationUserNotificationController.getNotification

Code samples

const fetch = require('node-fetch');

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

fetch('http://localhost:3000/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

Parameters

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": {}
  }
]

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 true none none
»» type number true none none
»» sentDate string(date-time) false none none
»» options object false none none
This operation does not require authentication

PubnubNotificationController

PubnubNotificationController.grantAccess

Code samples

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('http://localhost:3000/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}

Body parameter

{
  "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

{
  "ttl": 0,
  "cipherKey": "string"
}

Responses

Status Meaning Description Schema
200 OK Access response AccessResponseDto
This operation does not require authentication

PubnubNotificationController.revokeAccess

Code samples

const fetch = require('node-fetch');

fetch('http://localhost:3000/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
This operation does not require authentication

NotificationController

NotificationController.createBulkNotificaitions

Code samples

const fetch = require('node-fetch');
const inputBody = [
  {
    "subject": "string",
    "body": "string",
    "receiver": {},
    "type": 0,
    "sentDate": "2019-08-24T14:15:22Z",
    "options": {}
  }
];
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:3000/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

Body parameter

[
  {
    "subject": "string",
    "body": "string",
    "receiver": {},
    "type": 0,
    "sentDate": "2019-08-24T14:15:22Z",
    "options": {}
  }
]

Parameters

Name In Type Required Description
body body NotificationExcluding_id_ false none

Example responses

Responses

Status Meaning Description Schema
200 OK Array of Notifications None

Response Schema

This operation does not require authentication

NotificationController.count

Code samples

const fetch = require('node-fetch');

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

fetch('http://localhost:3000/notifications/count',
{
  method: 'GET',

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

GET /notifications/count

Parameters

Name In Type Required Description
where query object false none

Example responses

200 Response

{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Notification model count loopback.Count
This operation does not require authentication

NotificationController.findById

Code samples

const fetch = require('node-fetch');

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

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

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

GET /notifications/{id}

Parameters

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": {}
}

Responses

Status Meaning Description Schema
200 OK Notification model instance Notification
This operation does not require authentication

NotificationController.create

Code samples

const fetch = require('node-fetch');
const inputBody = {
  "subject": "string",
  "body": "string",
  "receiver": {},
  "type": 0,
  "sentDate": "2019-08-24T14:15:22Z",
  "options": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

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

POST /notifications

Body parameter

{
  "subject": "string",
  "body": "string",
  "receiver": {},
  "type": 0,
  "sentDate": "2019-08-24T14:15:22Z",
  "options": {}
}

Parameters

Name In Type Required Description
body body NotificationExcluding_id_ false none

Example responses

200 Response

{
  "id": "string",
  "subject": "string",
  "body": "string",
  "receiver": {},
  "type": 0,
  "sentDate": "2019-08-24T14:15:22Z",
  "options": {}
}

Responses

Status Meaning Description Schema
200 OK Notification model instance Notification
This operation does not require authentication

NotificationController.find

Code samples

const fetch = require('node-fetch');

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

fetch('http://localhost:3000/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

[
  {
    "id": "string",
    "subject": "string",
    "body": "string",
    "receiver": {},
    "type": 0,
    "sentDate": "2019-08-24T14:15:22Z",
    "options": {}
  }
]

Responses

Status Meaning Description Schema
200 OK Array of Notification model instances 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 true none none
»» type number true none none
»» sentDate string(date-time) false none none
»» options object false none none
This operation does not require authentication

NotificationController.deleteAll

Code samples

const fetch = require('node-fetch');

fetch('http://localhost:3000/notifications',
{
  method: 'DELETE'

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

DELETE /notifications

Parameters

Name In Type Required Description
where query object false none

Responses

Status Meaning Description Schema
204 No Content Notification DELETE success None
This operation does not require authentication

NotificationNotificationUserController

NotificationNotificationUserController.create

Code samples

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": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:3000/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

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": {}
}

Parameters

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": {}
}

Responses

Status Meaning Description Schema
200 OK Notification model instance NotificationUser
This operation does not require authentication

NotificationNotificationUserController.patch

Code samples

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": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:3000/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

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": {}
}

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

{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Notification.NotificationUser PATCH success count loopback.Count
This operation does not require authentication

NotificationNotificationUserController.find

Code samples

const fetch = require('node-fetch');

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

fetch('http://localhost:3000/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

Parameters

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": {}
  }
]

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
This operation does not require authentication

NotificationNotificationUserController.delete

Code samples

const fetch = require('node-fetch');

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

fetch('http://localhost:3000/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

Parameters

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

Example responses

200 Response

{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Notification.NotificationUser DELETE success count loopback.Count
This operation does not require authentication

PingController

PingController.ping

Code samples

const fetch = require('node-fetch');

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

fetch('http://localhost:3000/ping',
{
  method: 'GET',

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

GET /ping

Example responses

200 Response

{
  "greeting": "string",
  "date": "string",
  "url": "string",
  "headers": {
    "Content-Type": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Ping Response PingResponse
This operation does not require authentication

HomePageController

HomePageController.homePage

Code samples

const fetch = require('node-fetch');

const headers = {
  'Accept':'text/html'
};

fetch('http://localhost:3000/',
{
  method: 'GET',

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

GET /

Example responses

200 Response

"string"

Responses

Status Meaning Description Schema
200 OK Home Page string
This operation does not require authentication

Schemas

Notification

{
  "id": "string",
  "subject": "string",
  "body": "string",
  "receiver": {},
  "type": 0,
  "sentDate": "2019-08-24T14:15:22Z",
  "options": {}
}

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 true none none
type number true none none
sentDate string(date-time) false none none
options object false none none

NotificationExcluding_id_

{
  "subject": "string",
  "body": "string",
  "receiver": {},
  "type": 0,
  "sentDate": "2019-08-24T14:15:22Z",
  "options": {}
}

NotificationExcluding_id_

Properties

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

NotificationUser

{
  "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": {}
}

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

NewNotificationUser

{
  "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": {}
}

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

NotificationUserPartial

{
  "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": {}
}

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

AccessResponseDto

{
  "ttl": 0,
  "cipherKey": "string"
}

AccessResponseDto

Properties

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

NotificationAccess

{
  "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

{
  "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": {}
}

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

loopback.Count

{
  "count": 0
}

loopback.Count

Properties

Name Type Required Restrictions Description
count number false none none

notification_users.ScopeFilter

{
  "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

{
  "relation": "string",
  "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

notification_users.Filter

{
  "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
  },
  "include": [
    {
      "relation": "string",
      "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

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

{
  "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

{
  "relation": "string",
  "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

notifications.Filter

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

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

PingResponse

{
  "greeting": "string",
  "date": "string",
  "url": "string",
  "headers": {
    "Content-Type": "string"
  }
}

PingResponse

Properties

Name Type Required Restrictions Description
greeting string false none none
date string false none none
url string false none none
headers object false none none
» Content-Type string false none none