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.IO;
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 virtual bool equipmentFound { get; set; }
        public virtual List<EquipmentDetail>? equipmentList { get; set; }
    }

    public partial class EquipmentDetail
    {
        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 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 .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"}]}]}