Foundry API

<back to all web services

NotificationRolesRequest

Requires Authentication
The following routes are available for this service:
PUT/organisations/{Id}/notification/roles/{ActionType}
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class NotificationRolesRequest extends PutOperationUnTenanted<NotificationRolesResponse>
    {
        public String id = null;
        public String actionType = null;
        public ArrayList<String> roles = null;
        
        public String getId() { return id; }
        public NotificationRolesRequest setId(String value) { this.id = value; return this; }
        public String getActionType() { return actionType; }
        public NotificationRolesRequest setActionType(String value) { this.actionType = value; return this; }
        public ArrayList<String> getRoles() { return roles; }
        public NotificationRolesRequest setRoles(ArrayList<String> value) { this.roles = value; return this; }
    }

    public static class PutOperationUnTenanted<TResponse> implements IPut
    {
        
    }

    public static class NotificationRolesResponse
    {
        public ResponseStatus responseStatus = null;
        public OrganisationNotificationSettings notificationSettings = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public NotificationRolesResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public OrganisationNotificationSettings getNotificationSettings() { return notificationSettings; }
        public NotificationRolesResponse setNotificationSettings(OrganisationNotificationSettings value) { this.notificationSettings = value; return this; }
    }

    public static class OrganisationNotificationSettings implements IIdentifiableResource
    {
        public ArrayList<String> warningNotificationRoles = null;
        public ArrayList<String> jobFinishedNotificationRoles = null;
        public ArrayList<String> userIdBlockList = null;
        public String id = null;
        
        public ArrayList<String> getWarningNotificationRoles() { return warningNotificationRoles; }
        public OrganisationNotificationSettings setWarningNotificationRoles(ArrayList<String> value) { this.warningNotificationRoles = value; return this; }
        public ArrayList<String> getJobFinishedNotificationRoles() { return jobFinishedNotificationRoles; }
        public OrganisationNotificationSettings setJobFinishedNotificationRoles(ArrayList<String> value) { this.jobFinishedNotificationRoles = value; return this; }
        public ArrayList<String> getUserIdBlockList() { return userIdBlockList; }
        public OrganisationNotificationSettings setUserIdBlockList(ArrayList<String> value) { this.userIdBlockList = value; return this; }
        public String getId() { return id; }
        public OrganisationNotificationSettings setId(String value) { this.id = value; return this; }
    }

}

Java NotificationRolesRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /organisations/{Id}/notification/roles/{ActionType} HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<NotificationRolesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Organisations">
  <ActionType>String</ActionType>
  <Id>String</Id>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Roles>
</NotificationRolesRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<NotificationRolesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Organisations">
  <NotificationSettings xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
    <d2p1:Id>String</d2p1:Id>
    <d2p1:JobFinishedNotificationRoles xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:JobFinishedNotificationRoles>
    <d2p1:UserIdBlockList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:UserIdBlockList>
    <d2p1:WarningNotificationRoles xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:WarningNotificationRoles>
  </NotificationSettings>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</NotificationRolesResponse>