| GET | /equipment/{brand}/{posCode}/{serialNumber} | Get the list of SAP equipment |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| brand | path | string | Yes | Brand trigram |
| posCode | path | string | Yes | POS Legacy |
| serialNumber | path | string | Yes | SerialNumber |
| articleCode | query | string | No | Reference like 'CRWSTA0030' |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| equipmentFound | form | bool | No | |
| equipmentList | form | List<EquipmentDetail> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| articleCode | form | string | No | |
| articleDescription | form | string | No | |
| cassFamily | form | string | No | |
| serialNumber | form | string | No | |
| equipmentNumber | form | string | No | |
| articleName | form | string | No | |
| lastRepairNumber | form | string | No | |
| repairs | form | List<EquipmentRepair> | No | |
| status | form | List<EquipmentStatus> | No | |
| warranties | form | List<EquipmentWarranty> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| equipmentNumber | form | string | No | |
| repairNumber | form | string | No | |
| repairCloseDate | form | string | No | |
| details | form | List<EquipmentRepairDetail> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| equipmentNumber | form | string | No | |
| repairNumber | form | string | No | |
| itemCategory | form | string | No | |
| item | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| equipmentNumber | form | string | No | |
| statusCode | form | string | No | |
| statusDescription | form | string | No | |
| statusTextCode | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| equipmentNumber | form | string | No | |
| warrantyType | form | string | No | |
| warrantyStartDate | form | string | No | |
| warrantyEndDate | form | string | No |
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>