Richemont.Booster2.PublicApi

<back to all web services

GetEquipment

Requires Authentication
The following routes are available for this service:
GET/equipment/{brand}/{posCode}/{serialNumber}Get the list of SAP equipment
import java.math.*
import java.util.*
import net.servicestack.client.*


open class GetEquipment
{
    /**
    * Brand trigram
    */
    @ApiMember(Description="Brand trigram", IsRequired=true)
    var brand:String? = null

    /**
    * POS Legacy
    */
    @ApiMember(Description="POS Legacy", IsRequired=true)
    var posCode:String? = null

    /**
    * SerialNumber
    */
    @ApiMember(Description="SerialNumber", IsRequired=true)
    var serialNumber:String? = null

    /**
    * Reference like 'CRWSTA0030'
    */
    @ApiMember(Description="Reference like 'CRWSTA0030'")
    var articleCode:String? = null
}

open class GetEquipmentResponse : Equipment()
{
}

open class Equipment
{
    var equipmentFound:Boolean? = null
    var equipmentList:ArrayList<EquipmentDetail> = ArrayList<EquipmentDetail>()
}

open class EquipmentDetail
{
    var articleCode:String? = null
    var articleDescription:String? = null
    var cassFamily:String? = null
    var serialNumber:String? = null
    var equipmentNumber:String? = null
    var articleName:String? = null
    var lastRepairNumber:String? = null
    var repairs:ArrayList<EquipmentRepair> = ArrayList<EquipmentRepair>()
    var status:ArrayList<EquipmentStatus> = ArrayList<EquipmentStatus>()
    var warranties:ArrayList<EquipmentWarranty> = ArrayList<EquipmentWarranty>()
}

open class EquipmentRepair
{
    var equipmentNumber:String? = null
    var repairNumber:String? = null
    var repairCloseDate:String? = null
    var details:ArrayList<EquipmentRepairDetail> = ArrayList<EquipmentRepairDetail>()
}

open class EquipmentRepairDetail
{
    var equipmentNumber:String? = null
    var repairNumber:String? = null
    var itemCategory:String? = null
    var item:String? = null
}

open class EquipmentStatus
{
    var equipmentNumber:String? = null
    var statusCode:String? = null
    var statusDescription:String? = null
    var statusTextCode:String? = null
}

open class EquipmentWarranty
{
    var equipmentNumber:String? = null
    var warrantyType:String? = null
    var warrantyStartDate:String? = null
    var warrantyEndDate:String? = null
}

Kotlin GetEquipment DTOs

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

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}]}]}