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
GetEquipment Parameters:
NameParameterData TypeRequiredDescription
brandpathstringYesBrand trigram
posCodepathstringYesPOS Legacy
serialNumberpathstringYesSerialNumber
articleCodequerystringNoReference like 'CRWSTA0030'
Equipment Parameters:
NameParameterData TypeRequiredDescription
equipmentFoundformboolNo
equipmentListformList<EquipmentDetail>No
EquipmentDetail Parameters:
NameParameterData TypeRequiredDescription
articleCodeformstringNo
articleDescriptionformstringNo
cassFamilyformstringNo
serialNumberformstringNo
equipmentNumberformstringNo
articleNameformstringNo
lastRepairNumberformstringNo
repairsformList<EquipmentRepair>No
statusformList<EquipmentStatus>No
warrantiesformList<EquipmentWarranty>No
EquipmentRepair Parameters:
NameParameterData TypeRequiredDescription
equipmentNumberformstringNo
repairNumberformstringNo
repairCloseDateformstringNo
detailsformList<EquipmentRepairDetail>No
EquipmentRepairDetail Parameters:
NameParameterData TypeRequiredDescription
equipmentNumberformstringNo
repairNumberformstringNo
itemCategoryformstringNo
itemformstringNo
EquipmentStatus Parameters:
NameParameterData TypeRequiredDescription
equipmentNumberformstringNo
statusCodeformstringNo
statusDescriptionformstringNo
statusTextCodeformstringNo
EquipmentWarranty Parameters:
NameParameterData TypeRequiredDescription
equipmentNumberformstringNo
warrantyTypeformstringNo
warrantyStartDateformstringNo
warrantyEndDateformstringNo

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
				}
			]
		}
	]
}