Antel API

CheckPrincipals

The following routes are available for this service:
POST	/principal/check

import Foundation
import ServiceStack

public class CheckPrincipals : ApiServiceRequest
{
    public var principals:[PrincipalAppSync] = []

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

    private enum CodingKeys : String, CodingKey {
        case principals
    }

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

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

public class ApiServiceRequest : IServiceRequest, IHasApiKey, IHasDeviceInfo, Codable
{
    /**
    * The API Key required for authentication
    */
    // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    public var apiKey:String

    /**
    * Latitude of the user making this request
    */
    // @ApiMember(DataType="double", Description="Latitude of the user making this request")
    public var latitude:Double

    /**
    * Longitude of the user making this request
    */
    // @ApiMember(DataType="double", Description="Longitude of the user making this request")
    public var longitude:Double

    required public init(){}
}

public class PrincipalAppSync : Codable
{
    public var principalId:Int
    public var lastUpdated:String

    required public init(){}
}

public class CheckPrincipalsResponse : ApiServiceResponse
{
    public var principalsToUpdate:[Int] = []
    public var principalAppSyncData:[PrincipalAppSync] = []
    public var authRules:[PrincipalAuthRuleData] = []

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

    private enum CodingKeys : String, CodingKey {
        case principalsToUpdate
        case principalAppSyncData
        case authRules
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        principalsToUpdate = try container.decodeIfPresent([Int].self, forKey: .principalsToUpdate) ?? []
        principalAppSyncData = try container.decodeIfPresent([PrincipalAppSync].self, forKey: .principalAppSyncData) ?? []
        authRules = try container.decodeIfPresent([PrincipalAuthRuleData].self, forKey: .authRules) ?? []
    }

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

public class ApiServiceResponse : IServiceResponse, Codable
{
    /**
    * Information about the response.
    */
    // @ApiMember(Description="Information about the response.", IsRequired=true)
    public var Description:String

    /**
    * Heading or summary of the response.
    */
    // @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
    public var heading:String

    /**
    * Did the intended operation for this response complete successfully?
    */
    // @ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
    public var wasSuccessful:Bool

    public var responseStatus:ResponseStatus

    required public init(){}
}

public class PrincipalAuthRuleData : Codable
{
    public var principalId:Int
    public var valueAuthRules:[AuthRuleData] = []
    public var unitAuthRules:[AuthRuleData] = []

    required public init(){}
}

public class AuthRuleData : Codable
{
    public var fromValue:Double
    public var toValue:Double
    public var allow:Bool
    public var delayedAuth:Bool
    public var authRequired:Bool
    public var channel:String
    public var region:String

    required public init(){}
}

Swift CheckPrincipals 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 /principal/check HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"principals":[{"principalId":0,"lastUpdated":"String"}],"apiKey":"String","latitude":0,"longitude":0}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"principalsToUpdate":[0],"principalAppSyncData":[{"principalId":0,"lastUpdated":"String"}],"authRules":[{"principalId":0,"valueAuthRules":[{}],"unitAuthRules":[{}]}],"description":"String","heading":"String","wasSuccessful":false,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}