Antel Merchandiser App API

<back to all web services

UpliftRequestAuthRequest

import Foundation
import ServiceStack

public class UpliftRequestAuthRequest : ApiServiceRequest
{
    public var upliftRequestOnDeviceId:String?
    public var outletId:Int?
    public var principalId:Int?
    public var totalValue:Double?
    public var totalUnits:Double?
    public var region:String?
    public var channel:String?
    public var products:[UpliftRequestProductData] = []

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

    private enum CodingKeys : String, CodingKey {
        case upliftRequestOnDeviceId
        case outletId
        case principalId
        case totalValue
        case totalUnits
        case region
        case channel
        case products
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        upliftRequestOnDeviceId = try container.decodeIfPresent(String.self, forKey: .upliftRequestOnDeviceId)
        outletId = try container.decodeIfPresent(Int.self, forKey: .outletId)
        principalId = try container.decodeIfPresent(Int.self, forKey: .principalId)
        totalValue = try container.decodeIfPresent(Double.self, forKey: .totalValue)
        totalUnits = try container.decodeIfPresent(Double.self, forKey: .totalUnits)
        region = try container.decodeIfPresent(String.self, forKey: .region)
        channel = try container.decodeIfPresent(String.self, forKey: .channel)
        products = try container.decodeIfPresent([UpliftRequestProductData].self, forKey: .products) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if upliftRequestOnDeviceId != nil { try container.encode(upliftRequestOnDeviceId, forKey: .upliftRequestOnDeviceId) }
        if outletId != nil { try container.encode(outletId, forKey: .outletId) }
        if principalId != nil { try container.encode(principalId, forKey: .principalId) }
        if totalValue != nil { try container.encode(totalValue, forKey: .totalValue) }
        if totalUnits != nil { try container.encode(totalUnits, forKey: .totalUnits) }
        if region != nil { try container.encode(region, forKey: .region) }
        if channel != nil { try container.encode(channel, forKey: .channel) }
        if products.count > 0 { try container.encode(products, forKey: .products) }
    }
}

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 UpliftRequestProductData : Codable
{
    public var id:String?
    public var upliftRequestProductId:Int?
    public var productId:Int?
    public var principalId:Int?
    public var unitPrice:Double?
    public var name:String?
    public var category:String?
    public var unitBarcode:String?
    public var unitSize:String?
    public var unitWeight:Double?
    public var code:String?
    public var images:[Object] = []
    public var quantity:Double?
    public var value:Double?
    public var productionDate:String?
    public var expiryDate:String?
    public var batchCode:String?
    public var seal:SealData?
    public var serialNumber:String?
    public var stockStatusId:Int?
    public var principalLogoUrl:String?
    public var principalName:String?
    public var stockStatusName:String?
    public var stockStatusColor:String?
    public var unitOfMeasureId:Int?

    required public init(){}
}

public class SealData : Seal
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class Seal : Codable
{
    public var number:String?
    public var weight:Double?

    required public init(){}
}

public class UpliftRequestAuthRequestResponse : ApiServiceResponse
{
    public var upliftRequestAuthRequestId:String?

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

    private enum CodingKeys : String, CodingKey {
        case upliftRequestAuthRequestId
    }

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

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

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 UpliftRequestAuthRequest DTOs

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

<UpliftRequestAuthRequest 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>
  <Channel>String</Channel>
  <OutletId>0</OutletId>
  <PrincipalId>0</PrincipalId>
  <Products>
    <UpliftRequestProductData>
      <BatchCode>String</BatchCode>
      <Category>String</Category>
      <Code>String</Code>
      <ExpiryDate>String</ExpiryDate>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <Images xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:anyType />
      </Images>
      <Name>String</Name>
      <PrincipalId>0</PrincipalId>
      <PrincipalLogoUrl>String</PrincipalLogoUrl>
      <PrincipalName>String</PrincipalName>
      <ProductId>0</ProductId>
      <ProductionDate>String</ProductionDate>
      <Quantity>0</Quantity>
      <Seal>
        <Number xmlns="http://schemas.datacontract.org/2004/07/BusinessLogic.Entities">String</Number>
        <Weight xmlns="http://schemas.datacontract.org/2004/07/BusinessLogic.Entities">0</Weight>
      </Seal>
      <SerialNumber>String</SerialNumber>
      <StockStatusColor>String</StockStatusColor>
      <StockStatusId>0</StockStatusId>
      <StockStatusName>String</StockStatusName>
      <UnitBarcode>String</UnitBarcode>
      <UnitOfMeasureId>0</UnitOfMeasureId>
      <UnitPrice>0</UnitPrice>
      <UnitSize>String</UnitSize>
      <UnitWeight>0</UnitWeight>
      <UpliftRequestProductId>0</UpliftRequestProductId>
      <Value>0</Value>
    </UpliftRequestProductData>
  </Products>
  <Region>String</Region>
  <TotalUnits>0</TotalUnits>
  <TotalValue>0</TotalValue>
  <UpliftRequestOnDeviceId>00000000-0000-0000-0000-000000000000</UpliftRequestOnDeviceId>
</UpliftRequestAuthRequest>

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

<UpliftRequestAuthRequestResponse 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>
  <UpliftRequestAuthRequestId>00000000-0000-0000-0000-000000000000</UpliftRequestAuthRequestId>
</UpliftRequestAuthRequestResponse>