Richemont.Booster2.PublicApi

<back to all web services

ExportMovement

Requires Authentication
The following routes are available for this service:
POST/stock/{brand}/movement/exportExport Stock Movement Data
import Foundation
import ServiceStack

public class ExportMovement : MovementsRequest
{
    /**
    * Export Request ID of the API Consumers
    */
    // @ApiMember(Description="Export Request ID of the API Consumers", IsRequired=true)
    public var downloadRequestId:String

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

    private enum CodingKeys : String, CodingKey {
        case downloadRequestId
    }

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

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

public class MovementsRequest : Codable
{
    /**
    * Brand
    */
    // @ApiMember(Description="Brand", IsRequired=true)
    public var brand:String

    /**
    * POS Legacy
    */
    // @ApiMember(Description="POS Legacy", IsRequired=true)
    public var posCodes:[String] = []

    /**
    * Movement Type Ids
    */
    // @ApiMember(Description="Movement Type Ids")
    public var movementTypeIds:[Int] = []

    /**
    * Search Key (Article or SerialNumber)
    */
    // @ApiMember(Description="Search Key (Article or SerialNumber)")
    public var searchKey:String

    /**
    * In Stock Since date from 
    */
    // @ApiMember(Description="In Stock Since date from ")
    public var dateFrom:Date?

    /**
    * In Stock Since date to
    */
    // @ApiMember(Description="In Stock Since date to")
    public var dateTo:Date?

    /**
    * Sort by date could be: 'DateDESC' or 'DateASC' (default is descending) 
    */
    // @ApiMember(Description="Sort by date could be: 'DateDESC' or 'DateASC' (default is descending) ")
    public var sortBy:String

    required public init(){}
}

public class ExportMovementResponse : Codable
{
    /**
    * Unique Identifier of the Export Request created
    */
    // @ApiMember(Description="Unique Identifier of the Export Request created", IsRequired=true)
    public var asyncTaskId:String

    required public init(){}
}


Swift ExportMovement DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /stock/{brand}/movement/export HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ExportMovement xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Stock.ServiceModel">
  <brand>String</brand>
  <dateFrom>0001-01-01T00:00:00</dateFrom>
  <dateTo>0001-01-01T00:00:00</dateTo>
  <movementTypeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </movementTypeIds>
  <posCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </posCodes>
  <searchKey>String</searchKey>
  <sortBy>String</sortBy>
  <downloadRequestId>String</downloadRequestId>
</ExportMovement>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ExportMovementResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Stock.ServiceModel">
  <asyncTaskId>00000000-0000-0000-0000-000000000000</asyncTaskId>
</ExportMovementResponse>