Richemont.Booster2.PublicApi

GetDocument

The following routes are available for this service:
GET	/document/{erpSystemId}/{documentType}/{documentId}/{relatedDocumentId*}	Get Document file

import 'package:servicestack/servicestack.dart';

class GetDocument implements IConvertible
{
    /**
    * ERP system id, e.g. ES100
    */
    // @ApiMember(Description="ERP system id, e.g. ES100", IsRequired=true)
    String? erpSystemId;

    /**
    * Document Type, e.g. INV, CRN, RAF, RDN, CAD
    */
    // @ApiMember(Description="Document Type, e.g. INV, CRN, RAF, RDN, CAD", IsRequired=true)
    String? documentType;

    /**
    * Unique Document Id, e.g. 12345
    */
    // @ApiMember(Description="Unique Document Id, e.g. 12345", IsRequired=true)
    int? documentId;

    /**
    * Unique related Document Id, e.g. 12345
    */
    // @ApiMember(Description="Unique related Document Id, e.g. 12345")
    int? relatedDocumentId;

    GetDocument({this.erpSystemId,this.documentType,this.documentId,this.relatedDocumentId});
    GetDocument.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        erpSystemId = json['erpSystemId'];
        documentType = json['documentType'];
        documentId = json['documentId'];
        relatedDocumentId = json['relatedDocumentId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'erpSystemId': erpSystemId,
        'documentType': documentType,
        'documentId': documentId,
        'relatedDocumentId': relatedDocumentId
    };

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

TypeContext _ctx = TypeContext(library: 'dev_api_booster.richemont.com', types: <String, TypeInfo> {
    'GetDocument': TypeInfo(TypeOf.Class, create:() => GetDocument()),
});

Dart GetDocument DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /document/{erpSystemId}/{documentType}/{documentId}/{relatedDocumentId*} HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{}