| GET | /equipment/{brand}/{posCode}/{serialNumber} | Get the list of SAP equipment |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EquipmentRepairDetail:
equipment_number: Optional[str] = None
repair_number: Optional[str] = None
item_category: Optional[str] = None
item: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EquipmentRepair:
equipment_number: Optional[str] = None
repair_number: Optional[str] = None
repair_close_date: Optional[str] = None
details: Optional[List[EquipmentRepairDetail]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EquipmentStatus:
equipment_number: Optional[str] = None
status_code: Optional[str] = None
status_description: Optional[str] = None
status_text_code: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EquipmentWarranty:
equipment_number: Optional[str] = None
warranty_type: Optional[str] = None
warranty_start_date: Optional[str] = None
warranty_end_date: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EquipmentDetail:
article_code: Optional[str] = None
article_description: Optional[str] = None
cass_family: Optional[str] = None
serial_number: Optional[str] = None
equipment_number: Optional[str] = None
article_name: Optional[str] = None
last_repair_number: Optional[str] = None
repairs: Optional[List[EquipmentRepair]] = None
status: Optional[List[EquipmentStatus]] = None
warranties: Optional[List[EquipmentWarranty]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Equipment:
equipment_found: bool = False
equipment_list: Optional[List[EquipmentDetail]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetEquipmentResponse(Equipment):
pass
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetEquipment:
# @ApiMember(Description="Brand trigram", IsRequired=true)
brand: Optional[str] = None
"""
Brand trigram
"""
# @ApiMember(Description="POS Legacy", IsRequired=true)
pos_code: Optional[str] = None
"""
POS Legacy
"""
# @ApiMember(Description="SerialNumber", IsRequired=true)
serial_number: Optional[str] = None
"""
SerialNumber
"""
# @ApiMember(Description="Reference like 'CRWSTA0030'")
article_code: Optional[str] = None
"""
Reference like 'CRWSTA0030'
"""
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>