Antel Merchandiser App API

<back to all web services

CheckPrincipals

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 authRequired:Bool?
    public var region:String?
    public var channel:String?
    public var unitOfMeasure:UnitOfMeasureData?

    required public init(){}
}

public class UnitOfMeasureData : Codable
{
    public var id:Int?
    public var name:String?

    required public init(){}
}

Swift CheckPrincipals DTOs

POST /principal/check HTTP/1.1 
Host: returnit-api-dev.happen.zone 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Principals":[{"PrincipalId":0,"LastUpdated":"String"}],"ApiKey":"String","Latitude":0,"Longitude":0}

HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}