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
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'
    """

Python GetEquipment DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}]}]}