BokaMera.API.Host

<back to all web services

AgreementQuery

The following routes are available for this service:
GET/agreementsGets agreements
import 'package:servicestack/servicestack.dart';

class AgreementQueryResponse implements IConvertible
{
    String? AgreementId;
    DateTime? AgreementCreated;
    List<String>? Documents;
    dynamic? ResponseStatus;

    AgreementQueryResponse({this.AgreementId,this.AgreementCreated,this.Documents,this.ResponseStatus});
    AgreementQueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        AgreementId = json['AgreementId'];
        AgreementCreated = JsonConverters.fromJson(json['AgreementCreated'],'DateTime',context!);
        Documents = JsonConverters.fromJson(json['Documents'],'List<String>',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'dynamic',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'AgreementId': AgreementId,
        'AgreementCreated': JsonConverters.toJson(AgreementCreated,'DateTime',context!),
        'Documents': JsonConverters.toJson(Documents,'List<String>',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'dynamic',context!)
    };

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

// @ApiResponse(Description="Returned if there is a validation error on the input parameters", StatusCode=400)
class AgreementQuery implements IConvertible
{
    AgreementQuery();
    AgreementQuery.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "AgreementQuery";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.bokamera.se', types: <String, TypeInfo> {
    'AgreementQueryResponse': TypeInfo(TypeOf.Class, create:() => AgreementQueryResponse()),
    'AgreementQuery': TypeInfo(TypeOf.Class, create:() => AgreementQuery()),
});

Dart AgreementQuery 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 /agreements HTTP/1.1 
Host: api.bokamera.se 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"AgreementCreated":"0001-01-01T00:00:00","Documents":["String"],"ResponseStatus":{}}