Antel API

<back to all web services

DepotDropOff

import Foundation
import ServiceStack

public class DepotDropOff : ApiServiceRequest
{
    public var sealNumber:String

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

    private enum CodingKeys : String, CodingKey {
        case sealNumber
    }

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

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

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 DepotDropOffResponse : ApiServiceResponse
{
    public var sealData:AntelSealData
    public var weightRequired:Bool
    public var atDepot:Bool
    public var skipConfirm:Bool

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

    private enum CodingKeys : String, CodingKey {
        case sealData
        case weightRequired
        case atDepot
        case skipConfirm
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        sealData = try container.decodeIfPresent(AntelSealData.self, forKey: .sealData)
        weightRequired = try container.decodeIfPresent(Bool.self, forKey: .weightRequired)
        atDepot = try container.decodeIfPresent(Bool.self, forKey: .atDepot)
        skipConfirm = try container.decodeIfPresent(Bool.self, forKey: .skipConfirm)
    }

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

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 AntelSealData : Codable
{
    public var sealNumber:String
    public var principalName:String
    public var sealId:Int
    public var operatorName:String
    public var outletName:String
    public var upliftDate:String
    public var sealExists:Bool
    public var isPaused:Bool
    public var pausedAwaitingAuth:Bool

    required public init(){}
}

Swift DepotDropOff DTOs

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

{
	sealNumber: String,
	apiKey: String,
	latitude: 0,
	longitude: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	sealData: 
	{
		sealNumber: String,
		principalName: String,
		sealId: 0,
		operatorName: String,
		outletName: String,
		upliftDate: String,
		sealExists: False,
		isPaused: False,
		pausedAwaitingAuth: False
	},
	weightRequired: False,
	atDepot: False,
	skipConfirm: 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
		}
	}
}