| GET | /equipment/{brand}/{posCode}/{serialNumber} | Get the list of SAP equipment |
|---|
import Foundation
import ServiceStack
public class GetEquipment : Codable
{
/**
* Brand trigram
*/
// @ApiMember(Description="Brand trigram", IsRequired=true)
public var brand:String
/**
* POS Legacy
*/
// @ApiMember(Description="POS Legacy", IsRequired=true)
public var posCode:String
/**
* SerialNumber
*/
// @ApiMember(Description="SerialNumber", IsRequired=true)
public var serialNumber:String
/**
* Reference like 'CRWSTA0030'
*/
// @ApiMember(Description="Reference like 'CRWSTA0030'")
public var articleCode:String
required public init(){}
}
public class GetEquipmentResponse : Equipment
{
required public init(){ super.init() }
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
}
}
public class Equipment : Codable
{
public var equipmentFound:Bool
public var equipmentList:[EquipmentDetail] = []
required public init(){}
}
public class EquipmentDetail : Codable
{
public var articleCode:String
public var articleDescription:String
public var cassFamily:String
public var serialNumber:String
public var equipmentNumber:String
public var articleName:String
public var lastRepairNumber:String
public var repairs:[EquipmentRepair] = []
public var status:[EquipmentStatus] = []
public var warranties:[EquipmentWarranty] = []
required public init(){}
}
public class EquipmentRepair : Codable
{
public var equipmentNumber:String
public var repairNumber:String
public var repairCloseDate:String
public var details:[EquipmentRepairDetail] = []
required public init(){}
}
public class EquipmentRepairDetail : Codable
{
public var equipmentNumber:String
public var repairNumber:String
public var itemCategory:String
public var item:String
required public init(){}
}
public class EquipmentStatus : Codable
{
public var equipmentNumber:String
public var statusCode:String
public var statusDescription:String
public var statusTextCode:String
required public init(){}
}
public class EquipmentWarranty : Codable
{
public var equipmentNumber:String
public var warrantyType:String
public var warrantyStartDate:String
public var warrantyEndDate:String
required public init(){}
}
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>