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

export class EquipmentRepairDetail
{
    public equipmentNumber: string;
    public repairNumber: string;
    public itemCategory: string;
    public item: string;

    public constructor(init?: Partial<EquipmentRepairDetail>) { (Object as any).assign(this, init); }
}

export class EquipmentRepair
{
    public equipmentNumber: string;
    public repairNumber: string;
    public repairCloseDate: string;
    public details: EquipmentRepairDetail[];

    public constructor(init?: Partial<EquipmentRepair>) { (Object as any).assign(this, init); }
}

export class EquipmentStatus
{
    public equipmentNumber: string;
    public statusCode: string;
    public statusDescription: string;
    public statusTextCode: string;

    public constructor(init?: Partial<EquipmentStatus>) { (Object as any).assign(this, init); }
}

export class EquipmentWarranty
{
    public equipmentNumber: string;
    public warrantyType: string;
    public warrantyStartDate: string;
    public warrantyEndDate: string;

    public constructor(init?: Partial<EquipmentWarranty>) { (Object as any).assign(this, init); }
}

export class EquipmentDetail
{
    public articleCode: string;
    public articleDescription: string;
    public cassFamily: string;
    public serialNumber: string;
    public equipmentNumber: string;
    public articleName: string;
    public lastRepairNumber: string;
    public repairs: EquipmentRepair[];
    public status: EquipmentStatus[];
    public warranties: EquipmentWarranty[];

    public constructor(init?: Partial<EquipmentDetail>) { (Object as any).assign(this, init); }
}

export class Equipment
{
    public equipmentFound: boolean;
    public equipmentList: EquipmentDetail[];

    public constructor(init?: Partial<Equipment>) { (Object as any).assign(this, init); }
}

export class GetEquipmentResponse extends Equipment
{

    public constructor(init?: Partial<GetEquipmentResponse>) { super(init); (Object as any).assign(this, init); }
}

export class GetEquipment
{
    /** @description Brand trigram */
    // @ApiMember(Description="Brand trigram", IsRequired=true)
    public brand: string;

    /** @description POS Legacy */
    // @ApiMember(Description="POS Legacy", IsRequired=true)
    public posCode: string;

    /** @description SerialNumber */
    // @ApiMember(Description="SerialNumber", IsRequired=true)
    public serialNumber: string;

    /** @description Reference like 'CRWSTA0030' */
    // @ApiMember(Description="Reference like 'CRWSTA0030'")
    public articleCode: string;

    public constructor(init?: Partial<GetEquipment>) { (Object as any).assign(this, init); }
}

TypeScript GetEquipment DTOs

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

HTTP + JSV

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