| GET | /equipment/{brand}/{posCode}/{serialNumber} | Get the list of SAP equipment |
|---|
"use strict";
export class EquipmentRepairDetail {
/** @param {{equipmentNumber?:string,repairNumber?:string,itemCategory?:string,item?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
equipmentNumber;
/** @type {string} */
repairNumber;
/** @type {string} */
itemCategory;
/** @type {string} */
item;
}
export class EquipmentRepair {
/** @param {{equipmentNumber?:string,repairNumber?:string,repairCloseDate?:string,details?:EquipmentRepairDetail[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
equipmentNumber;
/** @type {string} */
repairNumber;
/** @type {string} */
repairCloseDate;
/** @type {EquipmentRepairDetail[]} */
details;
}
export class EquipmentStatus {
/** @param {{equipmentNumber?:string,statusCode?:string,statusDescription?:string,statusTextCode?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
equipmentNumber;
/** @type {string} */
statusCode;
/** @type {string} */
statusDescription;
/** @type {string} */
statusTextCode;
}
export class EquipmentWarranty {
/** @param {{equipmentNumber?:string,warrantyType?:string,warrantyStartDate?:string,warrantyEndDate?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
equipmentNumber;
/** @type {string} */
warrantyType;
/** @type {string} */
warrantyStartDate;
/** @type {string} */
warrantyEndDate;
}
export class EquipmentDetail {
/** @param {{articleCode?:string,articleDescription?:string,cassFamily?:string,serialNumber?:string,equipmentNumber?:string,articleName?:string,lastRepairNumber?:string,repairs?:EquipmentRepair[],status?:EquipmentStatus[],warranties?:EquipmentWarranty[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
articleCode;
/** @type {string} */
articleDescription;
/** @type {string} */
cassFamily;
/** @type {string} */
serialNumber;
/** @type {string} */
equipmentNumber;
/** @type {string} */
articleName;
/** @type {string} */
lastRepairNumber;
/** @type {EquipmentRepair[]} */
repairs;
/** @type {EquipmentStatus[]} */
status;
/** @type {EquipmentWarranty[]} */
warranties;
}
export class Equipment {
/** @param {{equipmentFound?:boolean,equipmentList?:EquipmentDetail[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {boolean} */
equipmentFound;
/** @type {EquipmentDetail[]} */
equipmentList;
}
export class GetEquipmentResponse extends Equipment {
/** @param {{equipmentFound?:boolean,equipmentList?:EquipmentDetail[]}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
export class GetEquipment {
/** @param {{brand?:string,posCode?:string,serialNumber?:string,articleCode?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Brand trigram */
brand;
/**
* @type {string}
* @description POS Legacy */
posCode;
/**
* @type {string}
* @description SerialNumber */
serialNumber;
/**
* @type {string}
* @description Reference like 'CRWSTA0030' */
articleCode;
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>