GET | /organisations/{Id}/notification-settings |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | path | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Embed | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
NotificationSettings | form | OrganisationNotificationSettings | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
WarningNotificationRoles | form | List<string> | No | |
JobFinishedNotificationRoles | form | List<string> | No | |
UserIdBlockList | form | List<string> | No | |
Id | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
NotificationSettings | form | OrganisationNotificationSettings | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /organisations/{Id}/notification-settings HTTP/1.1 Host: foundrystage-api-app.azurewebsites.net Accept: text/jsv
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } }, notificationSettings: { warningNotificationRoles: [ String ], jobFinishedNotificationRoles: [ String ], userIdBlockList: [ String ], id: String } }