Billiecart API

<back to all web services

PromoteOrganisationOwnerRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
POST/organisations/{Id}/owners
import Foundation
import ServiceStack

public class PromoteOrganisationOwnerRequest : PostOperationUnTenanted<PromoteOrganisationOwnerResponse>
{
    public var id:String?
    public var userAccountId:String?

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

    private enum CodingKeys : String, CodingKey {
        case id
        case userAccountId
    }

    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)
        userAccountId = try container.decodeIfPresent(String.self, forKey: .userAccountId)
    }

    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) }
        if userAccountId != nil { try container.encode(userAccountId, forKey: .userAccountId) }
    }
}

public class PostOperationUnTenanted<TResponse : Codable> : IPost, Codable
{
    required public init(){}
}

public class PromoteOrganisationOwnerResponse : 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 PromoteOrganisationOwnerRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /organisations/{Id}/owners HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"id":"String","userAccountId":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"organisation":{"displayName":"String","owners":["String"],"isDefault":false,"id":"String"}}