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.*;

public class dtos
{

    public static class GetEquipment
    {
        /**
        * Brand trigram
        */
        @ApiMember(Description="Brand trigram", IsRequired=true)
        public String brand = null;

        /**
        * POS Legacy
        */
        @ApiMember(Description="POS Legacy", IsRequired=true)
        public String posCode = null;

        /**
        * SerialNumber
        */
        @ApiMember(Description="SerialNumber", IsRequired=true)
        public String serialNumber = null;

        /**
        * Reference like 'CRWSTA0030'
        */
        @ApiMember(Description="Reference like 'CRWSTA0030'")
        public String articleCode = null;
        
        public String getBrand() { return brand; }
        public GetEquipment setBrand(String value) { this.brand = value; return this; }
        public String getPosCode() { return posCode; }
        public GetEquipment setPosCode(String value) { this.posCode = value; return this; }
        public String getSerialNumber() { return serialNumber; }
        public GetEquipment setSerialNumber(String value) { this.serialNumber = value; return this; }
        public String getArticleCode() { return articleCode; }
        public GetEquipment setArticleCode(String value) { this.articleCode = value; return this; }
    }

    public static class GetEquipmentResponse extends Equipment
    {
        
    }

    public static class Equipment
    {
        public Boolean equipmentFound = null;
        public ArrayList<EquipmentDetail> equipmentList = null;
        
        public Boolean isEquipmentFound() { return equipmentFound; }
        public Equipment setEquipmentFound(Boolean value) { this.equipmentFound = value; return this; }
        public ArrayList<EquipmentDetail> getEquipmentList() { return equipmentList; }
        public Equipment setEquipmentList(ArrayList<EquipmentDetail> value) { this.equipmentList = value; return this; }
    }

    public static class EquipmentDetail
    {
        public String articleCode = null;
        public String articleDescription = null;
        public String cassFamily = null;
        public String serialNumber = null;
        public String equipmentNumber = null;
        public String articleName = null;
        public String lastRepairNumber = null;
        public ArrayList<EquipmentRepair> repairs = null;
        public ArrayList<EquipmentStatus> status = null;
        public ArrayList<EquipmentWarranty> warranties = null;
        
        public String getArticleCode() { return articleCode; }
        public EquipmentDetail setArticleCode(String value) { this.articleCode = value; return this; }
        public String getArticleDescription() { return articleDescription; }
        public EquipmentDetail setArticleDescription(String value) { this.articleDescription = value; return this; }
        public String getCassFamily() { return cassFamily; }
        public EquipmentDetail setCassFamily(String value) { this.cassFamily = value; return this; }
        public String getSerialNumber() { return serialNumber; }
        public EquipmentDetail setSerialNumber(String value) { this.serialNumber = value; return this; }
        public String getEquipmentNumber() { return equipmentNumber; }
        public EquipmentDetail setEquipmentNumber(String value) { this.equipmentNumber = value; return this; }
        public String getArticleName() { return articleName; }
        public EquipmentDetail setArticleName(String value) { this.articleName = value; return this; }
        public String getLastRepairNumber() { return lastRepairNumber; }
        public EquipmentDetail setLastRepairNumber(String value) { this.lastRepairNumber = value; return this; }
        public ArrayList<EquipmentRepair> getRepairs() { return repairs; }
        public EquipmentDetail setRepairs(ArrayList<EquipmentRepair> value) { this.repairs = value; return this; }
        public ArrayList<EquipmentStatus> getStatus() { return status; }
        public EquipmentDetail setStatus(ArrayList<EquipmentStatus> value) { this.status = value; return this; }
        public ArrayList<EquipmentWarranty> getWarranties() { return warranties; }
        public EquipmentDetail setWarranties(ArrayList<EquipmentWarranty> value) { this.warranties = value; return this; }
    }

    public static class EquipmentRepair
    {
        public String equipmentNumber = null;
        public String repairNumber = null;
        public String repairCloseDate = null;
        public ArrayList<EquipmentRepairDetail> details = null;
        
        public String getEquipmentNumber() { return equipmentNumber; }
        public EquipmentRepair setEquipmentNumber(String value) { this.equipmentNumber = value; return this; }
        public String getRepairNumber() { return repairNumber; }
        public EquipmentRepair setRepairNumber(String value) { this.repairNumber = value; return this; }
        public String getRepairCloseDate() { return repairCloseDate; }
        public EquipmentRepair setRepairCloseDate(String value) { this.repairCloseDate = value; return this; }
        public ArrayList<EquipmentRepairDetail> getDetails() { return details; }
        public EquipmentRepair setDetails(ArrayList<EquipmentRepairDetail> value) { this.details = value; return this; }
    }

    public static class EquipmentRepairDetail
    {
        public String equipmentNumber = null;
        public String repairNumber = null;
        public String itemCategory = null;
        public String item = null;
        
        public String getEquipmentNumber() { return equipmentNumber; }
        public EquipmentRepairDetail setEquipmentNumber(String value) { this.equipmentNumber = value; return this; }
        public String getRepairNumber() { return repairNumber; }
        public EquipmentRepairDetail setRepairNumber(String value) { this.repairNumber = value; return this; }
        public String getItemCategory() { return itemCategory; }
        public EquipmentRepairDetail setItemCategory(String value) { this.itemCategory = value; return this; }
        public String getItem() { return item; }
        public EquipmentRepairDetail setItem(String value) { this.item = value; return this; }
    }

    public static class EquipmentStatus
    {
        public String equipmentNumber = null;
        public String statusCode = null;
        public String statusDescription = null;
        public String statusTextCode = null;
        
        public String getEquipmentNumber() { return equipmentNumber; }
        public EquipmentStatus setEquipmentNumber(String value) { this.equipmentNumber = value; return this; }
        public String getStatusCode() { return statusCode; }
        public EquipmentStatus setStatusCode(String value) { this.statusCode = value; return this; }
        public String getStatusDescription() { return statusDescription; }
        public EquipmentStatus setStatusDescription(String value) { this.statusDescription = value; return this; }
        public String getStatusTextCode() { return statusTextCode; }
        public EquipmentStatus setStatusTextCode(String value) { this.statusTextCode = value; return this; }
    }

    public static class EquipmentWarranty
    {
        public String equipmentNumber = null;
        public String warrantyType = null;
        public String warrantyStartDate = null;
        public String warrantyEndDate = null;
        
        public String getEquipmentNumber() { return equipmentNumber; }
        public EquipmentWarranty setEquipmentNumber(String value) { this.equipmentNumber = value; return this; }
        public String getWarrantyType() { return warrantyType; }
        public EquipmentWarranty setWarrantyType(String value) { this.warrantyType = value; return this; }
        public String getWarrantyStartDate() { return warrantyStartDate; }
        public EquipmentWarranty setWarrantyStartDate(String value) { this.warrantyStartDate = value; return this; }
        public String getWarrantyEndDate() { return warrantyEndDate; }
        public EquipmentWarranty setWarrantyEndDate(String value) { this.warrantyEndDate = value; return this; }
    }

}

Java 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>