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 'package:servicestack/servicestack.dart';

abstract class PutOperationUnTenanted<TResponse> implements IPut
{
    PutOperationUnTenanted();
    PutOperationUnTenanted.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "PutOperationUnTenanted<$TResponse>";
    TypeContext? context = _ctx;
}

class OrganisationNotificationSettings implements IIdentifiableResource, IConvertible
{
    List<String>? warningNotificationRoles;
    List<String>? jobFinishedNotificationRoles;
    List<String>? userIdBlockList;
    String? id;

    OrganisationNotificationSettings({this.warningNotificationRoles,this.jobFinishedNotificationRoles,this.userIdBlockList,this.id});
    OrganisationNotificationSettings.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        warningNotificationRoles = JsonConverters.fromJson(json['warningNotificationRoles'],'List<String>',context!);
        jobFinishedNotificationRoles = JsonConverters.fromJson(json['jobFinishedNotificationRoles'],'List<String>',context!);
        userIdBlockList = JsonConverters.fromJson(json['userIdBlockList'],'List<String>',context!);
        id = json['id'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'warningNotificationRoles': JsonConverters.toJson(warningNotificationRoles,'List<String>',context!),
        'jobFinishedNotificationRoles': JsonConverters.toJson(jobFinishedNotificationRoles,'List<String>',context!),
        'userIdBlockList': JsonConverters.toJson(userIdBlockList,'List<String>',context!),
        'id': id
    };

    getTypeName() => "OrganisationNotificationSettings";
    TypeContext? context = _ctx;
}

class NotificationRolesResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    OrganisationNotificationSettings? notificationSettings;

    NotificationRolesResponse({this.responseStatus,this.notificationSettings});
    NotificationRolesResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        notificationSettings = JsonConverters.fromJson(json['notificationSettings'],'OrganisationNotificationSettings',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'notificationSettings': JsonConverters.toJson(notificationSettings,'OrganisationNotificationSettings',context!)
    };

    getTypeName() => "NotificationRolesResponse";
    TypeContext? context = _ctx;
}

class NotificationRolesRequest extends PutOperationUnTenanted<NotificationRolesResponse> implements IConvertible
{
    String? id;
    String? actionType;
    List<String>? roles;

    NotificationRolesRequest({this.id,this.actionType,this.roles});
    NotificationRolesRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        id = json['id'];
        actionType = json['actionType'];
        roles = JsonConverters.fromJson(json['roles'],'List<String>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'id': id,
        'actionType': actionType,
        'roles': JsonConverters.toJson(roles,'List<String>',context!)
    });

    getTypeName() => "NotificationRolesRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'foundrystage_api_app.azurewebsites.net', types: <String, TypeInfo> {
    'PutOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'OrganisationNotificationSettings': TypeInfo(TypeOf.Class, create:() => OrganisationNotificationSettings()),
    'NotificationRolesResponse': TypeInfo(TypeOf.Class, create:() => NotificationRolesResponse()),
    'NotificationRolesRequest': TypeInfo(TypeOf.Class, create:() => NotificationRolesRequest()),
});

Dart 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>