Richemont.Booster2.PublicApi

<back to all web services

GetTransferRequest

Requires Authentication
The following routes are available for this service:
GET/stock/{brand}/transferRequestGet Transfer RequestsGet a list of Transfer Requests related to given POSes
namespace Richemont.Booster2.PublicApi.Stock.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type TransferRequest() = 
        ///<summary>
        ///Transfer Request ID, e.g. 1234567
        ///</summary>
        [<ApiMember(Description="Transfer Request ID, e.g. 1234567", IsRequired=true)>]
        member val transferRequestId:Int32 = new Int32() with get,set

        ///<summary>
        ///Transfer Request Status: 'PEN', 'ACC', 'ERR', 'INP', 'COM', 'REJ', 'CAN'
        ///</summary>
        [<ApiMember(Description="Transfer Request Status: 'PEN', 'ACC', 'ERR', 'INP', 'COM', 'REJ', 'CAN'", IsRequired=true)>]
        member val status:String = null with get,set

        ///<summary>
        ///Transfer Request creation date e.g. 2022-01-01
        ///</summary>
        [<ApiMember(Description="Transfer Request creation date e.g. 2022-01-01", IsRequired=true)>]
        member val createdDate:String = null with get,set

        ///<summary>
        ///Transfer Request created user
        ///</summary>
        [<ApiMember(Description="Transfer Request created user", IsRequired=true)>]
        member val createdBy:String = null with get,set

        ///<summary>
        ///POS Code of the transfer Source POS, e.g. ES100:102048
        ///</summary>
        [<ApiMember(Description="POS Code of the transfer Source POS, e.g. ES100:102048", IsRequired=true)>]
        member val posCodeFrom:String = null with get,set

        ///<summary>
        ///POS Code of the transfer Target POS, e.g. ES100:101469
        ///</summary>
        [<ApiMember(Description="POS Code of the transfer Target POS, e.g. ES100:101469", IsRequired=true)>]
        member val posCodeTo:String = null with get,set

        ///<summary>
        ///Legacy Article Code of the item to be transferred
        ///</summary>
        [<ApiMember(Description="Legacy Article Code of the item to be transferred", IsRequired=true)>]
        member val articleCode:String = null with get,set

        ///<summary>
        ///Serial Number of the Article to be transferred
        ///</summary>
        [<ApiMember(Description="Serial Number of the Article to be transferred")>]
        member val serialNumber:String = null with get,set

        ///<summary>
        ///Notes
        ///</summary>
        [<ApiMember(Description="Notes")>]
        member val notes:String = null with get,set

        ///<summary>
        ///Return Number of the Authroization form document / PDF if exists
        ///</summary>
        [<ApiMember(Description="Return Number of the Authroization form document / PDF if exists")>]
        member val returnNumber:Nullable<Int64> = new Nullable<Int64>() with get,set

        ///<summary>
        ///Context of the Transfer request, can be either PUSH or PULL
        ///</summary>
        [<ApiMember(Description="Context of the Transfer request, can be either PUSH or PULL")>]
        member val context:String = null with get,set

    [<AllowNullLiteral>]
    type GetTransferRequestResponse() = 
        inherit ResizeArray<TransferRequest>()

    [<AllowNullLiteral>]
    type GetTransferRequest() = 
        ///<summary>
        ///Brand Trigram, e.g. CAR, IWC
        ///</summary>
        [<ApiMember(Description="Brand Trigram, e.g. CAR, IWC", IsRequired=true)>]
        member val brand:String = null with get,set

        ///<summary>
        ///List of POS Codes in interest, e.g. ES100:102048,ES100:101469
        ///</summary>
        [<ApiMember(Description="List of POS Codes in interest, e.g. ES100:102048,ES100:101469", IsRequired=true)>]
        member val posCodes:ResizeArray<String> = new ResizeArray<String>() with get,set

F# GetTransferRequest 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.

GET /stock/{brand}/transferRequest HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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