Antel Merchandiser App API

<back to all web services

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

POST /antel/upliftrequestcompleted HTTP/1.1 
Host: returnit-api-dev.happen.zone 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpliftRequestCompleted xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.Base">String</ApiKey>
  <Latitude xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.Base">0</Latitude>
  <Longitude xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.Base">0</Longitude>
  <CompletedDate>0001-01-01T00:00:00</CompletedDate>
  <ReturnItUpliftRequestId>0</ReturnItUpliftRequestId>
  <SubmissionDocumentUrl>String</SubmissionDocumentUrl>
  <TotalUnits>0</TotalUnits>
  <TotalWeight>0</TotalWeight>
  <UpliftNumber>String</UpliftNumber>
</UpliftRequestCompleted>

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

<ApiServiceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.Base">
  <Description>String</Description>
  <Heading>String</Heading>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <WasSuccessful>false</WasSuccessful>
</ApiServiceResponse>