Billiecart API

<back to all web services

CreateOrganisationRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
POST/organisations
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;

    Organisation({this.displayName,this.owners,this.isDefault,this.id});
    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'];
        return this;
    }

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

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

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

    CreateOrganisationResponse({this.responseStatus,this.organisation});
    CreateOrganisationResponse.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() => "CreateOrganisationResponse";
    TypeContext? context = _ctx;
}

class CreateOrganisationRequest extends PostOperationUnTenanted<CreateOrganisationResponse> implements IConvertible
{
    String? name;

    CreateOrganisationRequest({this.name});
    CreateOrganisationRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        name = json['name'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'name': name
    });

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

TypeContext _ctx = TypeContext(library: 'staging_api.billiecart.com.au', types: <String, TypeInfo> {
    'PostOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'Organisation': TypeInfo(TypeOf.Class, create:() => Organisation()),
    'CreateOrganisationResponse': TypeInfo(TypeOf.Class, create:() => CreateOrganisationResponse()),
    'CreateOrganisationRequest': TypeInfo(TypeOf.Class, create:() => CreateOrganisationRequest()),
});

Dart CreateOrganisationRequest 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 HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateOrganisationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Organisations">
  <Name>String</Name>
</CreateOrganisationRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateOrganisationResponse 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: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>
</CreateOrganisationResponse>