People | Notification Setup
Service to manage entities of type 'NotificationSetup'.
Overview
| URL | api/{tenantKey}/{orgKey}/peopleCore/notificationSetups |
| Methods Supported | GET, PUT |
All Operations
This service includes the following operations:
- GET:
- PUT:
All Resources
This service uses the following resources:
GET NotificationSetups
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See NotificationSetupResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET NotificationSetups (paged)
Returns a page of the list of all the entity records available.
The following elements are optional:
| page | (int) The index of the page of the list that should be returned. This is a query string parameter. |
| pageSize | (int) The number of page elements that should be returned (max. is 1000). This is a query string parameter. |
Response:
| When successful, the response body contains the list of records available. See NotificationSetupResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET NotificationSetup by identifier
Returns the entity record that matches the specified identifier.
The following elements are required:
| id | (string) The record identifier. |
Response:
| When successful, the response body contains the entity record. See NotificationSetupResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
GET NotificationSetup by key
Returns the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. |
| notificationSetupKey | (string) Notification Setup. |
Response:
| When successful, the response body contains the entity record. See NotificationSetupResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
PUT Set Company NotificationSetup
Updates the value of attribute 'Company' in the specified entity record.
The following elements are required:
| notificationSetupKey | (string) Notification Setup. |
| companyKey | (string) The company key. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set IsActive NotificationSetup
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| notificationSetupKey | (string) Notification Setup. |
| companyKey | (string) The company key. |
| value | (bool) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
PUT Set Notification NotificationSetup
Updates the value of attribute 'Notification' in the specified entity record.
The following elements are required:
| notificationSetupKey | (string) Notification Setup. |
| companyKey | (string) The company key. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set NotificationSetupKey NotificationSetup
Updates the value of attribute 'NotificationSetupKey' in the specified entity record.
The following elements are required:
| notificationSetupKey | (string) Notification Setup. |
| companyKey | (string) The company key. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set NotificationTypeDescription NotificationSetup
Updates the value of attribute 'NotificationTypeDescription' in the specified entity record.
The following elements are required:
| notificationSetupKey | (string) Notification Setup. |
| companyKey | (string) The company key. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set NotificationTypeId NotificationSetup
Updates the value of attribute 'NotificationTypeId' in the specified entity record.
The following elements are required:
| notificationSetupKey | (string) Notification Setup. |
| companyKey | (string) The company key. |
| value | (Guid) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Offset NotificationSetup
Updates the value of attribute 'Offset' in the specified entity record.
The following elements are required:
| notificationSetupKey | (string) Notification Setup. |
| companyKey | (string) The company key. |
| value | (int) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
Resources
NotificationSetupResource
The following elements are required:
| notificationSetupKey | (string) Notification Setup. |
| company | (string) Company.
(fk) Allowed value: the natural key of a record of type Company. |
| notification | (string) Notification.
(fk) Allowed value: the natural key of a record of type Notification. |
| offset | (int) Offset (Days). |
The following elements are optional:
| notificationTypeId | (Guid) Notification Type Id. |
| notificationTypeDescription | (string) Notification Type. |