Antel Merchandiser App API

<back to all web services

FinaliseUpliftRequest

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

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

<FinaliseUpliftRequest 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>
  <IncompleteUpliftRequestId>00000000-0000-0000-0000-000000000000</IncompleteUpliftRequestId>
  <UpliftRequestId>0</UpliftRequestId>
</FinaliseUpliftRequest>

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

<SaveUpliftRequestResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models">
  <Description xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.Base">String</Description>
  <Heading xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.Base">String</Heading>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.Base">
    <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 xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.Base">false</WasSuccessful>
  <AuthRequestId>00000000-0000-0000-0000-000000000000</AuthRequestId>
  <DeleteFromDevice>false</DeleteFromDevice>
  <ImageIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ImageIds>
  <UpliftRequestId>0</UpliftRequestId>
  <UpliftRequestProductIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </UpliftRequestProductIds>
</SaveUpliftRequestResponse>