Requires the role: | manager |
PUT,PATCH | /organisations/{Id} |
---|
import Foundation
import ServiceStack
public class UpdateOrganisationRequest : PutPatchOperationUnTenanted<UpdateOrganisationResponse>
{
public var id:String?
public var displayName:String?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case id
case displayName
}
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)
displayName = try container.decodeIfPresent(String.self, forKey: .displayName)
}
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 displayName != nil { try container.encode(displayName, forKey: .displayName) }
}
}
public class PutPatchOperationUnTenanted<TResponse : Codable> : IPatch, IPut, Codable
{
required public init(){}
}
public class UpdateOrganisationResponse : 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 UpdateOrganisationRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /organisations/{Id} HTTP/1.1
Host: staging-api.billiecart.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"id":"String","displayName":"String"}
HTTP/1.1 200 OK Content-Type: text/csv 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"}}