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 'package:servicestack/servicestack.dart';

class EquipmentRepairDetail implements IConvertible
{
    String? equipmentNumber;
    String? repairNumber;
    String? itemCategory;
    String? item;

    EquipmentRepairDetail({this.equipmentNumber,this.repairNumber,this.itemCategory,this.item});
    EquipmentRepairDetail.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        equipmentNumber = json['equipmentNumber'];
        repairNumber = json['repairNumber'];
        itemCategory = json['itemCategory'];
        item = json['item'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'equipmentNumber': equipmentNumber,
        'repairNumber': repairNumber,
        'itemCategory': itemCategory,
        'item': item
    };

    getTypeName() => "EquipmentRepairDetail";
    TypeContext? context = _ctx;
}

class EquipmentRepair implements IConvertible
{
    String? equipmentNumber;
    String? repairNumber;
    String? repairCloseDate;
    List<EquipmentRepairDetail>? details;

    EquipmentRepair({this.equipmentNumber,this.repairNumber,this.repairCloseDate,this.details});
    EquipmentRepair.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        equipmentNumber = json['equipmentNumber'];
        repairNumber = json['repairNumber'];
        repairCloseDate = json['repairCloseDate'];
        details = JsonConverters.fromJson(json['details'],'List<EquipmentRepairDetail>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'equipmentNumber': equipmentNumber,
        'repairNumber': repairNumber,
        'repairCloseDate': repairCloseDate,
        'details': JsonConverters.toJson(details,'List<EquipmentRepairDetail>',context!)
    };

    getTypeName() => "EquipmentRepair";
    TypeContext? context = _ctx;
}

class EquipmentStatus implements IConvertible
{
    String? equipmentNumber;
    String? statusCode;
    String? statusDescription;
    String? statusTextCode;

    EquipmentStatus({this.equipmentNumber,this.statusCode,this.statusDescription,this.statusTextCode});
    EquipmentStatus.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        equipmentNumber = json['equipmentNumber'];
        statusCode = json['statusCode'];
        statusDescription = json['statusDescription'];
        statusTextCode = json['statusTextCode'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'equipmentNumber': equipmentNumber,
        'statusCode': statusCode,
        'statusDescription': statusDescription,
        'statusTextCode': statusTextCode
    };

    getTypeName() => "EquipmentStatus";
    TypeContext? context = _ctx;
}

class EquipmentWarranty implements IConvertible
{
    String? equipmentNumber;
    String? warrantyType;
    String? warrantyStartDate;
    String? warrantyEndDate;

    EquipmentWarranty({this.equipmentNumber,this.warrantyType,this.warrantyStartDate,this.warrantyEndDate});
    EquipmentWarranty.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        equipmentNumber = json['equipmentNumber'];
        warrantyType = json['warrantyType'];
        warrantyStartDate = json['warrantyStartDate'];
        warrantyEndDate = json['warrantyEndDate'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'equipmentNumber': equipmentNumber,
        'warrantyType': warrantyType,
        'warrantyStartDate': warrantyStartDate,
        'warrantyEndDate': warrantyEndDate
    };

    getTypeName() => "EquipmentWarranty";
    TypeContext? context = _ctx;
}

class EquipmentDetail implements IConvertible
{
    String? articleCode;
    String? articleDescription;
    String? cassFamily;
    String? serialNumber;
    String? equipmentNumber;
    String? articleName;
    String? lastRepairNumber;
    List<EquipmentRepair>? repairs;
    List<EquipmentStatus>? status;
    List<EquipmentWarranty>? warranties;

    EquipmentDetail({this.articleCode,this.articleDescription,this.cassFamily,this.serialNumber,this.equipmentNumber,this.articleName,this.lastRepairNumber,this.repairs,this.status,this.warranties});
    EquipmentDetail.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        articleCode = json['articleCode'];
        articleDescription = json['articleDescription'];
        cassFamily = json['cassFamily'];
        serialNumber = json['serialNumber'];
        equipmentNumber = json['equipmentNumber'];
        articleName = json['articleName'];
        lastRepairNumber = json['lastRepairNumber'];
        repairs = JsonConverters.fromJson(json['repairs'],'List<EquipmentRepair>',context!);
        status = JsonConverters.fromJson(json['status'],'List<EquipmentStatus>',context!);
        warranties = JsonConverters.fromJson(json['warranties'],'List<EquipmentWarranty>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'articleCode': articleCode,
        'articleDescription': articleDescription,
        'cassFamily': cassFamily,
        'serialNumber': serialNumber,
        'equipmentNumber': equipmentNumber,
        'articleName': articleName,
        'lastRepairNumber': lastRepairNumber,
        'repairs': JsonConverters.toJson(repairs,'List<EquipmentRepair>',context!),
        'status': JsonConverters.toJson(status,'List<EquipmentStatus>',context!),
        'warranties': JsonConverters.toJson(warranties,'List<EquipmentWarranty>',context!)
    };

    getTypeName() => "EquipmentDetail";
    TypeContext? context = _ctx;
}

class Equipment implements IConvertible
{
    bool? equipmentFound;
    List<EquipmentDetail>? equipmentList;

    Equipment({this.equipmentFound,this.equipmentList});
    Equipment.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        equipmentFound = json['equipmentFound'];
        equipmentList = JsonConverters.fromJson(json['equipmentList'],'List<EquipmentDetail>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'equipmentFound': equipmentFound,
        'equipmentList': JsonConverters.toJson(equipmentList,'List<EquipmentDetail>',context!)
    };

    getTypeName() => "Equipment";
    TypeContext? context = _ctx;
}

class GetEquipmentResponse extends Equipment implements IConvertible
{
    GetEquipmentResponse();
    GetEquipmentResponse.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "GetEquipmentResponse";
    TypeContext? context = _ctx;
}

class GetEquipment implements IConvertible
{
    /**
    * Brand trigram
    */
    // @ApiMember(Description="Brand trigram", IsRequired=true)
    String? brand;

    /**
    * POS Legacy
    */
    // @ApiMember(Description="POS Legacy", IsRequired=true)
    String? posCode;

    /**
    * SerialNumber
    */
    // @ApiMember(Description="SerialNumber", IsRequired=true)
    String? serialNumber;

    /**
    * Reference like 'CRWSTA0030'
    */
    // @ApiMember(Description="Reference like 'CRWSTA0030'")
    String? articleCode;

    GetEquipment({this.brand,this.posCode,this.serialNumber,this.articleCode});
    GetEquipment.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        brand = json['brand'];
        posCode = json['posCode'];
        serialNumber = json['serialNumber'];
        articleCode = json['articleCode'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'brand': brand,
        'posCode': posCode,
        'serialNumber': serialNumber,
        'articleCode': articleCode
    };

    getTypeName() => "GetEquipment";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'dev_api_booster.richemont.com', types: <String, TypeInfo> {
    'EquipmentRepairDetail': TypeInfo(TypeOf.Class, create:() => EquipmentRepairDetail()),
    'EquipmentRepair': TypeInfo(TypeOf.Class, create:() => EquipmentRepair()),
    'List<EquipmentRepairDetail>': TypeInfo(TypeOf.Class, create:() => <EquipmentRepairDetail>[]),
    'EquipmentStatus': TypeInfo(TypeOf.Class, create:() => EquipmentStatus()),
    'EquipmentWarranty': TypeInfo(TypeOf.Class, create:() => EquipmentWarranty()),
    'EquipmentDetail': TypeInfo(TypeOf.Class, create:() => EquipmentDetail()),
    'List<EquipmentRepair>': TypeInfo(TypeOf.Class, create:() => <EquipmentRepair>[]),
    'List<EquipmentStatus>': TypeInfo(TypeOf.Class, create:() => <EquipmentStatus>[]),
    'List<EquipmentWarranty>': TypeInfo(TypeOf.Class, create:() => <EquipmentWarranty>[]),
    'Equipment': TypeInfo(TypeOf.Class, create:() => Equipment()),
    'List<EquipmentDetail>': TypeInfo(TypeOf.Class, create:() => <EquipmentDetail>[]),
    'GetEquipmentResponse': TypeInfo(TypeOf.Class, create:() => GetEquipmentResponse()),
    'GetEquipment': TypeInfo(TypeOf.Class, create:() => GetEquipment()),
});

Dart GetEquipment DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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