Antel Merchandiser App API

FinaliseUpliftRequest

The following routes are available for this service:
POST	/upliftrequest/finalise

import Foundation
import ServiceStack

public class FinaliseUpliftRequest : ApiServiceRequest
{
    public var upliftRequestId:Int?
    public var incompleteUpliftRequestId:String?

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

    private enum CodingKeys : String, CodingKey {
        case upliftRequestId
        case incompleteUpliftRequestId
    }

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

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

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 SaveUpliftRequestResponse : ApiServiceResponse
{
    public var upliftRequestProductIds:[Int] = []
    public var authRequestId:String?
    public var upliftRequestId:Int?
    public var deleteFromDevice:Bool?
    public var imageIds:[String] = []

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

    private enum CodingKeys : String, CodingKey {
        case upliftRequestProductIds
        case authRequestId
        case upliftRequestId
        case deleteFromDevice
        case imageIds
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        upliftRequestProductIds = try container.decodeIfPresent([Int].self, forKey: .upliftRequestProductIds) ?? []
        authRequestId = try container.decodeIfPresent(String.self, forKey: .authRequestId)
        upliftRequestId = try container.decodeIfPresent(Int.self, forKey: .upliftRequestId)
        deleteFromDevice = try container.decodeIfPresent(Bool.self, forKey: .deleteFromDevice)
        imageIds = try container.decodeIfPresent([String].self, forKey: .imageIds) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if upliftRequestProductIds.count > 0 { try container.encode(upliftRequestProductIds, forKey: .upliftRequestProductIds) }
        if authRequestId != nil { try container.encode(authRequestId, forKey: .authRequestId) }
        if upliftRequestId != nil { try container.encode(upliftRequestId, forKey: .upliftRequestId) }
        if deleteFromDevice != nil { try container.encode(deleteFromDevice, forKey: .deleteFromDevice) }
        if imageIds.count > 0 { try container.encode(imageIds, forKey: .imageIds) }
    }
}

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(){}
}

Swift FinaliseUpliftRequest 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 /upliftrequest/finalise HTTP/1.1 
Host: returnit-api-dev.happen.zone 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"UpliftRequestId":0,"ApiKey":"String","Latitude":0,"Longitude":0}

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

{"UpliftRequestProductIds":[0],"UpliftRequestId":0,"DeleteFromDevice":false,"ImageIds":["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"}}}