Antel Merchandiser App 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 clientId:Int?
    public var vatValue:Double?
    public var refreshToken:String?
    public var friendlyName:String?
    public var outlets:[OutletData] = []
    public var upliftRequestSyncInterval:Int?
    public var enableReturnOfStock:Bool?
    public var enableTimeKeeping:Bool?
    public var enableCustomerComplaintForm:Bool?
    public var clientLogoUrl:String?
    public var clientColor:String?
    public var clientName:String?

    required public init(){}
}

public class OutletData : Codable
{
    public var id:Int?
    public var name:String?
    public var lastRequestedDate:String?
    public var hasGeneralUpliftRequest:Bool?
    public var upliftRequestCount:Int?
    public var assignedPrincipalIds:[Int] = []
    public var assignedRegions:[OutletRegionData] = []
    public var channel:String?
    public var nextScheduledDate:String?

    required public init(){}
}

public class OutletRegionData : Codable
{
    public var principalId:Int?
    public var region:String?

    required public init(){}
}


Swift AutoLogin DTOs

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

HTTP + CSV

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

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

{"SystemUserId":0,"RefreshToken":"String","UtcOffset":0,"ApiKey":"String","Latitude":0,"Longitude":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Data":{"SystemUserId":0,"ClientId":0,"VatValue":0,"RefreshToken":"String","FriendlyName":"String","Outlets":[{}],"UpliftRequestSyncInterval":0,"EnableReturnOfStock":false,"EnableTimeKeeping":false,"EnableCustomerComplaintForm":false,"ClientLogoUrl":"String","ClientColor":"String","ClientName":"String"},"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"}}}