Billiecart API

<back to all web services

GetCurrentPersonRequest

The following routes are available for this service:
GET/persons/current
import Foundation
import ServiceStack

public class GetCurrentPersonRequest : GetOperationUnTenanted<GetCurrentPersonResponse>
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class GetOperationUnTenanted<TResponse : Codable> : IHasGetOptions, IGet, Codable
{
    public var embed:String?

    required public init(){}
}

public class GetCurrentPersonResponse : Codable
{
    public var responseStatus:ResponseStatus?
    public var person:CurrentPerson?

    required public init(){}
}

public class CurrentPerson : Person
{
    public var isAuthenticated:Bool?
    public var roles:[String] = []

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

    private enum CodingKeys : String, CodingKey {
        case isAuthenticated
        case roles
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        isAuthenticated = try container.decodeIfPresent(Bool.self, forKey: .isAuthenticated)
        roles = try container.decodeIfPresent([String].self, forKey: .roles) ?? []
    }

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

public class Person : IIdentifiableResource, Codable
{
    public var name:UserAccountName?
    public var displayName:String?
    public var email:String?
    public var phoneNumber:String?
    public var timezone:String?
    public var defaultOrganisationId:String?
    public var id:String?

    required public init(){}
}

public class UserAccountName : Codable
{
    public var firstName:String?
    public var lastName:String?

    required public init(){}
}


Swift GetCurrentPersonRequest DTOs

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

HTTP + CSV

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

GET /persons/current HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/csv
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"}},"person":{"isAuthenticated":false,"roles":["String"],"name":{"firstName":"String","lastName":"String"},"displayName":"String","email":"String","phoneNumber":"String","timezone":"String","defaultOrganisationId":"String","id":"String"}}