| 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 .jsv suffix or ?format=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
}
]
}
]
}