Richemont.Booster2.PublicApi

GetEquipment

The following routes are available for this service:
GET	/equipment/{brand}/{posCode}/{serialNumber}	Get the list of SAP equipment

namespace Richemont.Booster2.PublicApi.MasterFile.ServiceModel

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

    [<AllowNullLiteral>]
    type EquipmentRepairDetail() = 
        member val equipmentNumber:String = null with get,set
        member val repairNumber:String = null with get,set
        member val itemCategory:String = null with get,set
        member val item:String = null with get,set

    [<AllowNullLiteral>]
    type EquipmentRepair() = 
        member val equipmentNumber:String = null with get,set
        member val repairNumber:String = null with get,set
        member val repairCloseDate:String = null with get,set
        member val details:ResizeArray<EquipmentRepairDetail> = new ResizeArray<EquipmentRepairDetail>() with get,set

    [<AllowNullLiteral>]
    type EquipmentStatus() = 
        member val equipmentNumber:String = null with get,set
        member val statusCode:String = null with get,set
        member val statusDescription:String = null with get,set
        member val statusTextCode:String = null with get,set

    [<AllowNullLiteral>]
    type EquipmentWarranty() = 
        member val equipmentNumber:String = null with get,set
        member val warrantyType:String = null with get,set
        member val warrantyStartDate:String = null with get,set
        member val warrantyEndDate:String = null with get,set

    [<AllowNullLiteral>]
    type EquipmentDetail() = 
        member val articleCode:String = null with get,set
        member val articleDescription:String = null with get,set
        member val cassFamily:String = null with get,set
        member val serialNumber:String = null with get,set
        member val equipmentNumber:String = null with get,set
        member val articleName:String = null with get,set
        member val lastRepairNumber:String = null with get,set
        member val repairs:ResizeArray<EquipmentRepair> = new ResizeArray<EquipmentRepair>() with get,set
        member val status:ResizeArray<EquipmentStatus> = new ResizeArray<EquipmentStatus>() with get,set
        member val warranties:ResizeArray<EquipmentWarranty> = new ResizeArray<EquipmentWarranty>() with get,set

    [<AllowNullLiteral>]
    type Equipment() = 
        member val equipmentFound:Boolean = new Boolean() with get,set
        member val equipmentList:ResizeArray<EquipmentDetail> = new ResizeArray<EquipmentDetail>() with get,set

    [<AllowNullLiteral>]
    type GetEquipmentResponse() = 
        inherit Equipment()

    [<AllowNullLiteral>]
    type GetEquipment() = 
        ///<summary>
        ///Brand trigram
        ///</summary>
        [<ApiMember(Description="Brand trigram", IsRequired=true)>]
        member val brand:String = null with get,set

        ///<summary>
        ///POS Legacy
        ///</summary>
        [<ApiMember(Description="POS Legacy", IsRequired=true)>]
        member val posCode:String = null with get,set

        ///<summary>
        ///SerialNumber
        ///</summary>
        [<ApiMember(Description="SerialNumber", IsRequired=true)>]
        member val serialNumber:String = null with get,set

        ///<summary>
        ///Reference like 'CRWSTA0030'
        ///</summary>
        [<ApiMember(Description="Reference like 'CRWSTA0030'")>]
        member val articleCode:String = null with get,set

F# GetEquipment DTOs

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

HTTP + JSV

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

GET /equipment/{brand}/{posCode}/{serialNumber} HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	equipmentFound: False,
	equipmentList: 
	[
		{
			articleCode: String,
			articleDescription: String,
			cassFamily: String,
			serialNumber: String,
			equipmentNumber: String,
			articleName: String,
			lastRepairNumber: String,
			repairs: 
			[
				{
					equipmentNumber: String,
					repairNumber: String,
					repairCloseDate: String,
					details: 
					[
						{
							equipmentNumber: String,
							repairNumber: String,
							itemCategory: String,
							item: String
						}
					]
				}
			],
			status: 
			[
				{
					equipmentNumber: String,
					statusCode: String,
					statusDescription: String,
					statusTextCode: String
				}
			],
			warranties: 
			[
				{
					equipmentNumber: String,
					warrantyType: String,
					warrantyStartDate: String,
					warrantyEndDate: String
				}
			]
		}
	]
}