Billiecart API

RegisterCarRequest

**Requires Authentication**
Requires the role:	manager

The following routes are available for this service:
PUT,PATCH	/cars/{Id}/register

import 'package:servicestack/servicestack.dart';

abstract class PutPatchOperationUnTenanted<TResponse> implements IPatch, IPut
{
    PutPatchOperationUnTenanted();
    PutPatchOperationUnTenanted.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

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

abstract class PutPatchOperationTenanted<TResponse> extends PutPatchOperationUnTenanted<TResponse> implements ITenantedRequest
{
    String? organisationId;

    PutPatchOperationTenanted({this.organisationId});
    PutPatchOperationTenanted.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        organisationId = json['organisationId'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'organisationId': organisationId
    });

    getTypeName() => "PutPatchOperationTenanted<$TResponse>";
    TypeContext? context = _ctx;
}

class CarManufacturer implements IConvertible
{
    int? year;
    String? make;
    String? model;

    CarManufacturer({this.year,this.make,this.model});
    CarManufacturer.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        year = json['year'];
        make = json['make'];
        model = json['model'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'year': year,
        'make': make,
        'model': model
    };

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

class CarLicensePlate implements IConvertible
{
    String? jurisdiction;
    String? number;

    CarLicensePlate({this.jurisdiction,this.number});
    CarLicensePlate.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        jurisdiction = json['jurisdiction'];
        number = json['number'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'jurisdiction': jurisdiction,
        'number': number
    };

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

class CarOwner implements IConvertible
{
    String? id;

    CarOwner({this.id});
    CarOwner.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id
    };

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

class CarManager implements IConvertible
{
    String? id;

    CarManager({this.id});
    CarManager.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id
    };

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

class Car implements IIdentifiableResource, IConvertible
{
    CarManufacturer? manufacturer;
    CarLicensePlate? plate;
    CarOwner? owner;
    List<CarManager>? managers;
    String? status;
    bool? altered;
    String? id;

    Car({this.manufacturer,this.plate,this.owner,this.managers,this.status,this.altered,this.id});
    Car.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        manufacturer = JsonConverters.fromJson(json['manufacturer'],'CarManufacturer',context!);
        plate = JsonConverters.fromJson(json['plate'],'CarLicensePlate',context!);
        owner = JsonConverters.fromJson(json['owner'],'CarOwner',context!);
        managers = JsonConverters.fromJson(json['managers'],'List<CarManager>',context!);
        status = json['status'];
        altered = json['altered'];
        id = json['id'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'manufacturer': JsonConverters.toJson(manufacturer,'CarManufacturer',context!),
        'plate': JsonConverters.toJson(plate,'CarLicensePlate',context!),
        'owner': JsonConverters.toJson(owner,'CarOwner',context!),
        'managers': JsonConverters.toJson(managers,'List<CarManager>',context!),
        'status': status,
        'altered': altered,
        'id': id
    };

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

class RegisterCarResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    Car? car;

    RegisterCarResponse({this.responseStatus,this.car});
    RegisterCarResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        car = JsonConverters.fromJson(json['car'],'Car',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'car': JsonConverters.toJson(car,'Car',context!)
    };

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

class RegisterCarRequest extends PutPatchOperationTenanted<RegisterCarResponse> implements IConvertible
{
    String? id;
    String? jurisdiction;
    String? number;

    RegisterCarRequest({this.id,this.jurisdiction,this.number});
    RegisterCarRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        id = json['id'];
        jurisdiction = json['jurisdiction'];
        number = json['number'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'id': id,
        'jurisdiction': jurisdiction,
        'number': number
    });

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

TypeContext _ctx = TypeContext(library: 'staging_api.billiecart.com.au', types: <String, TypeInfo> {
    'PutPatchOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'PutPatchOperationTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'CarManufacturer': TypeInfo(TypeOf.Class, create:() => CarManufacturer()),
    'CarLicensePlate': TypeInfo(TypeOf.Class, create:() => CarLicensePlate()),
    'CarOwner': TypeInfo(TypeOf.Class, create:() => CarOwner()),
    'CarManager': TypeInfo(TypeOf.Class, create:() => CarManager()),
    'Car': TypeInfo(TypeOf.Class, create:() => Car()),
    'List<CarManager>': TypeInfo(TypeOf.Class, create:() => <CarManager>[]),
    'RegisterCarResponse': TypeInfo(TypeOf.Class, create:() => RegisterCarResponse()),
    'RegisterCarRequest': TypeInfo(TypeOf.Class, create:() => RegisterCarRequest()),
});

Dart RegisterCarRequest 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.

PUT /cars/{Id}/register HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"id":"String","jurisdiction":"String","number":"String","organisationId":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"car":{"manufacturer":{"year":0,"make":"String","model":"String"},"plate":{"jurisdiction":"String","number":"String"},"owner":{"id":"String"},"managers":[{"id":"String"}],"status":"String","altered":false,"id":"String"}}