BctNotification

<back to all web services

GetApiKeys

auth
Requires Authentication
The following routes are available for this service:
All Verbs/apikeys
All Verbs/apikeys/{Environment}
import Foundation
import ServiceStack

// @DataContract
public class GetApiKeys : IGet, IMeta, Codable
{
    // @DataMember(Order=1)
    public var environment:String

    // @DataMember(Order=2)
    public var meta:[String:String] = [:]

    required public init(){}
}

// @DataContract
public class GetApiKeysResponse : IMeta, Codable
{
    // @DataMember(Order=1)
    public var results:[UserApiKey] = []

    // @DataMember(Order=2)
    public var meta:[String:String] = [:]

    // @DataMember(Order=3)
    public var responseStatus:ResponseStatus

    required public init(){}
}

// @DataContract
public class UserApiKey : IMeta, Codable
{
    // @DataMember(Order=1)
    public var key:String

    // @DataMember(Order=2)
    public var keyType:String

    // @DataMember(Order=3)
    public var expiryDate:Date?

    // @DataMember(Order=4)
    public var meta:[String:String] = [:]

    required public init(){}
}


Swift GetApiKeys DTOs

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

HTTP + X-MSGPACK

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

POST /apikeys HTTP/1.1 
Host: notifications.breastcancertrials.org.au 
Accept: application/x-msgpack
Content-Type: application/x-msgpack
Content-Length: length

{"environment":"String","meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: application/x-msgpack
Content-Length: length

{"results":[{"key":"String","keyType":"String","expiryDate":"0001-01-01T00:00:00.0000000","meta":{"String":"String"}}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}