Antel Merchandiser App API

UpliftRequestCompleted

The following routes are available for this service:
POST	/antel/upliftrequestcompleted

import Foundation
import ServiceStack

public class UpliftRequestCompleted : ApiServiceRequest
{
    public var returnItUpliftRequestId:Int?
    public var completedDate:Date?
    public var submissionDocumentUrl:String?
    public var upliftNumber:String?
    public var totalUnits:Double?
    public var totalWeight:Double?

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

    private enum CodingKeys : String, CodingKey {
        case returnItUpliftRequestId
        case completedDate
        case submissionDocumentUrl
        case upliftNumber
        case totalUnits
        case totalWeight
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        returnItUpliftRequestId = try container.decodeIfPresent(Int.self, forKey: .returnItUpliftRequestId)
        completedDate = try container.decodeIfPresent(Date.self, forKey: .completedDate)
        submissionDocumentUrl = try container.decodeIfPresent(String.self, forKey: .submissionDocumentUrl)
        upliftNumber = try container.decodeIfPresent(String.self, forKey: .upliftNumber)
        totalUnits = try container.decodeIfPresent(Double.self, forKey: .totalUnits)
        totalWeight = try container.decodeIfPresent(Double.self, forKey: .totalWeight)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if returnItUpliftRequestId != nil { try container.encode(returnItUpliftRequestId, forKey: .returnItUpliftRequestId) }
        if completedDate != nil { try container.encode(completedDate, forKey: .completedDate) }
        if submissionDocumentUrl != nil { try container.encode(submissionDocumentUrl, forKey: .submissionDocumentUrl) }
        if upliftNumber != nil { try container.encode(upliftNumber, forKey: .upliftNumber) }
        if totalUnits != nil { try container.encode(totalUnits, forKey: .totalUnits) }
        if totalWeight != nil { try container.encode(totalWeight, forKey: .totalWeight) }
    }
}

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 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 UpliftRequestCompleted 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 /antel/upliftrequestcompleted HTTP/1.1 
Host: returnit-api-dev.happen.zone 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ReturnItUpliftRequestId":0,"CompletedDate":"0001-01-01T00:00:00.0000000","SubmissionDocumentUrl":"String","UpliftNumber":"String","TotalUnits":0,"TotalWeight":0,"ApiKey":"String","Latitude":0,"Longitude":0}

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

{"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"}}}