Foundry API

<back to all web services

AssignOrganisationRolesRequest

Requires Authentication
The following routes are available for this service:
POST/organisations/{Id}/roles/assign
import 'package:servicestack/servicestack.dart';

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

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

class Organisation implements IIdentifiableResource, IConvertible
{
    String? displayName;
    List<String>? owners;
    bool? isDefault;
    String? id;
    bool? forceTwoFactor;

    Organisation({this.displayName,this.owners,this.isDefault,this.id,this.forceTwoFactor});
    Organisation.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        displayName = json['displayName'];
        owners = JsonConverters.fromJson(json['owners'],'List<String>',context!);
        isDefault = json['isDefault'];
        id = json['id'];
        forceTwoFactor = json['forceTwoFactor'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'displayName': displayName,
        'owners': JsonConverters.toJson(owners,'List<String>',context!),
        'isDefault': isDefault,
        'id': id,
        'forceTwoFactor': forceTwoFactor
    };

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

class AssignOrganisationRolesResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    Organisation? organisation;

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

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

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

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

class AssignOrganisationRolesRequest extends PostOperationUnTenanted<AssignOrganisationRolesResponse> implements IConvertible
{
    String? id;
    String? userId;
    List<String>? roles;

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

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

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

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

TypeContext _ctx = TypeContext(library: 'foundrystage_api_app.azurewebsites.net', types: <String, TypeInfo> {
    'PostOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'Organisation': TypeInfo(TypeOf.Class, create:() => Organisation()),
    'AssignOrganisationRolesResponse': TypeInfo(TypeOf.Class, create:() => AssignOrganisationRolesResponse()),
    'AssignOrganisationRolesRequest': TypeInfo(TypeOf.Class, create:() => AssignOrganisationRolesRequest()),
});

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

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

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

<AssignOrganisationRolesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Organisations">
  <Organisation xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
    <d2p1:DisplayName>String</d2p1:DisplayName>
    <d2p1:ForceTwoFactor>false</d2p1:ForceTwoFactor>
    <d2p1:Id>String</d2p1:Id>
    <d2p1:IsDefault>false</d2p1:IsDefault>
    <d2p1:Owners xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Owners>
  </Organisation>
  <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>
</AssignOrganisationRolesResponse>