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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Richemont.Booster2.PublicApi.MasterFile.ServiceModel;

namespace Richemont.Booster2.PublicApi.MasterFile.ServiceModel
{
    public partial class Equipment
    {
        public Equipment()
        {
            equipmentList = new List<EquipmentDetail>{};
        }

        public virtual bool equipmentFound { get; set; }
        public virtual List<EquipmentDetail> equipmentList { get; set; }
    }

    public partial class EquipmentDetail
    {
        public EquipmentDetail()
        {
            repairs = new List<EquipmentRepair>{};
            status = new List<EquipmentStatus>{};
            warranties = new List<EquipmentWarranty>{};
        }

        public virtual string articleCode { get; set; }
        public virtual string articleDescription { get; set; }
        public virtual string cassFamily { get; set; }
        public virtual string serialNumber { get; set; }
        public virtual string equipmentNumber { get; set; }
        public virtual string articleName { get; set; }
        public virtual string lastRepairNumber { get; set; }
        public virtual List<EquipmentRepair> repairs { get; set; }
        public virtual List<EquipmentStatus> status { get; set; }
        public virtual List<EquipmentWarranty> warranties { get; set; }
    }

    public partial class EquipmentRepair
    {
        public EquipmentRepair()
        {
            details = new List<EquipmentRepairDetail>{};
        }

        public virtual string equipmentNumber { get; set; }
        public virtual string repairNumber { get; set; }
        public virtual string repairCloseDate { get; set; }
        public virtual List<EquipmentRepairDetail> details { get; set; }
    }

    public partial class EquipmentRepairDetail
    {
        public virtual string equipmentNumber { get; set; }
        public virtual string repairNumber { get; set; }
        public virtual string itemCategory { get; set; }
        public virtual string item { get; set; }
    }

    public partial class EquipmentStatus
    {
        public virtual string equipmentNumber { get; set; }
        public virtual string statusCode { get; set; }
        public virtual string statusDescription { get; set; }
        public virtual string statusTextCode { get; set; }
    }

    public partial class EquipmentWarranty
    {
        public virtual string equipmentNumber { get; set; }
        public virtual string warrantyType { get; set; }
        public virtual string warrantyStartDate { get; set; }
        public virtual string warrantyEndDate { get; set; }
    }

    public partial class GetEquipment
    {
        ///<summary>
        ///Brand trigram
        ///</summary>
        [ApiMember(Description="Brand trigram", IsRequired=true)]
        public virtual string brand { get; set; }

        ///<summary>
        ///POS Legacy
        ///</summary>
        [ApiMember(Description="POS Legacy", IsRequired=true)]
        public virtual string posCode { get; set; }

        ///<summary>
        ///SerialNumber
        ///</summary>
        [ApiMember(Description="SerialNumber", IsRequired=true)]
        public virtual string serialNumber { get; set; }

        ///<summary>
        ///Reference like 'CRWSTA0030'
        ///</summary>
        [ApiMember(Description="Reference like 'CRWSTA0030'")]
        public virtual string articleCode { get; set; }
    }

    public partial class GetEquipmentResponse
        : Equipment
    {
    }

}

C# 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>