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 .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 /equipment/{brand}/{posCode}/{serialNumber} HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetEquipmentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.MasterFile.ServiceModel">
  <equipmentFound>false</equipmentFound>
  <equipmentList>
    <EquipmentDetail>
      <articleCode>String</articleCode>
      <articleDescription>String</articleDescription>
      <articleName>String</articleName>
      <cassFamily>String</cassFamily>
      <equipmentNumber>String</equipmentNumber>
      <lastRepairNumber>String</lastRepairNumber>
      <repairs>
        <EquipmentRepair>
          <details>
            <EquipmentRepairDetail>
              <equipmentNumber>String</equipmentNumber>
              <item>String</item>
              <itemCategory>String</itemCategory>
              <repairNumber>String</repairNumber>
            </EquipmentRepairDetail>
          </details>
          <equipmentNumber>String</equipmentNumber>
          <repairCloseDate>String</repairCloseDate>
          <repairNumber>String</repairNumber>
        </EquipmentRepair>
      </repairs>
      <serialNumber>String</serialNumber>
      <status>
        <EquipmentStatus>
          <equipmentNumber>String</equipmentNumber>
          <statusCode>String</statusCode>
          <statusDescription>String</statusDescription>
          <statusTextCode>String</statusTextCode>
        </EquipmentStatus>
      </status>
      <warranties>
        <EquipmentWarranty>
          <equipmentNumber>String</equipmentNumber>
          <warrantyEndDate>String</warrantyEndDate>
          <warrantyStartDate>String</warrantyStartDate>
          <warrantyType>String</warrantyType>
        </EquipmentWarranty>
      </warranties>
    </EquipmentDetail>
  </equipmentList>
</GetEquipmentResponse>