Billiecart API

<back to all web services

ChangeDefaultOrganisationRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
PUT/organisations/default
import Foundation
import ServiceStack

public class ChangeDefaultOrganisationRequest : PutOperationUnTenanted<ChangeDefaultOrganisationResponse>
{
    public var id:String?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case id
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        id = try container.decodeIfPresent(String.self, forKey: .id)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if id != nil { try container.encode(id, forKey: .id) }
    }
}

public class PutOperationUnTenanted<TResponse : Codable> : IPut, Codable
{
    required public init(){}
}

public class ChangeDefaultOrganisationResponse : Codable
{
    public var responseStatus:ResponseStatus?
    public var organisation:Organisation?

    required public init(){}
}

public class Organisation : IIdentifiableResource, Codable
{
    public var displayName:String?
    public var owners:[String] = []
    public var isDefault:Bool?
    public var id:String?

    required public init(){}
}


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

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

<ChangeDefaultOrganisationResponse 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>
</ChangeDefaultOrganisationResponse>