Antel API

<back to all web services

AutoLogin

import Foundation
import ServiceStack

public class AutoLogin : ApiServiceRequest
{
    public var systemUserId:Int
    public var refreshToken:String
    public var utcOffset:Int

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

    private enum CodingKeys : String, CodingKey {
        case systemUserId
        case refreshToken
        case utcOffset
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        systemUserId = try container.decodeIfPresent(Int.self, forKey: .systemUserId)
        refreshToken = try container.decodeIfPresent(String.self, forKey: .refreshToken)
        utcOffset = try container.decodeIfPresent(Int.self, forKey: .utcOffset)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if systemUserId != nil { try container.encode(systemUserId, forKey: .systemUserId) }
        if refreshToken != nil { try container.encode(refreshToken, forKey: .refreshToken) }
        if utcOffset != nil { try container.encode(utcOffset, forKey: .utcOffset) }
    }
}

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 AutoLoginResponse : ApiServiceResponse
{
    public var data:LoginData

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

    private enum CodingKeys : String, CodingKey {
        case data
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        data = try container.decodeIfPresent(LoginData.self, forKey: .data)
    }

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

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 LoginData : Codable
{
    public var systemUserId:Int
    public var refreshToken:String
    public var friendlyName:String
    public var vatValue:Double
    public var canUplift:Bool
    public var stockCanDropOff:Bool
    public var stockCanCloseArrival:Bool
    public var blockUpliftIfLineCountDoesNotMatch:Bool
    public var blockUpliftIfQuantityDoesNotMatch:Bool
    public var canRipTip:Bool
    public var canDeleteUplifts:Bool
    public var stockOperators:[StockOperatorData] = []
    public var claimNumberRules:[ClaimNumberRule] = []
    public var upliftSyncInterval:Int
    public var lateUpliftThreshold:Int
    public var pauseUpliftReasons:[String] = []
    public var noGoodsToUpliftReasons:[String] = []
    public var blurryImageErrorScore:Double
    public var blurryImageWarningScore:Double
    public var blurryImageDetectionEnabled:Bool
    public var profileImageUrl:String
    public var claimValueWarningVariance:Double
    public var stockCanVehicleAssignment:Bool
    public var stockCanOperatorAssignment:Bool
    public var stockCanStockEnd:Bool
    public var stockCanCheckSealDetails:Bool
    public var stockManualEnabled:Bool

    required public init(){}
}

public class StockOperatorData : Codable
{
    public var id:Int
    public var name:String

    required public init(){}
}

public class ClaimNumberRule : Codable
{
    public var principalId:Int
    public var channelName:String
    public var rulePattern:String

    required public init(){}
}


Swift AutoLogin DTOs

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

HTTP + JSV

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

POST /jsv/reply/AutoLogin HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	systemUserId: 0,
	refreshToken: String,
	utcOffset: 0,
	apiKey: String,
	latitude: 0,
	longitude: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	data: 
	{
		systemUserId: 0,
		refreshToken: String,
		friendlyName: String,
		vatValue: 0,
		canUplift: False,
		stockCanDropOff: False,
		stockCanCloseArrival: False,
		blockUpliftIfLineCountDoesNotMatch: False,
		blockUpliftIfQuantityDoesNotMatch: False,
		canRipTip: False,
		canDeleteUplifts: False,
		stockOperators: 
		[
			{
				
			}
		],
		claimNumberRules: 
		[
			{
				
			}
		],
		upliftSyncInterval: 0,
		lateUpliftThreshold: 0,
		pauseUpliftReasons: 
		[
			String
		],
		noGoodsToUpliftReasons: 
		[
			String
		],
		blurryImageErrorScore: 0,
		blurryImageWarningScore: 0,
		blurryImageDetectionEnabled: False,
		profileImageUrl: String,
		claimValueWarningVariance: 0,
		stockCanVehicleAssignment: False,
		stockCanOperatorAssignment: False,
		stockCanStockEnd: False,
		stockCanCheckSealDetails: False,
		stockManualEnabled: False
	},
	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
		}
	}
}