Billiecart API

<back to all web services

RegisterCarRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
PUT,PATCH/cars/{Id}/register
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Infrastructure.Api.Interfaces.ServiceOperations.Cars;
using Infrastructure.Api.Interfaces.ServiceOperations;
using Application.Interfaces.Resources;

namespace Application.Interfaces.Resources
{
    public partial class Car
        : IIdentifiableResource
    {
        public Car()
        {
            Managers = new List<CarManager>{};
        }

        public virtual CarManufacturer Manufacturer { get; set; }
        public virtual CarLicensePlate Plate { get; set; }
        public virtual CarOwner Owner { get; set; }
        public virtual List<CarManager> Managers { get; set; }
        public virtual string Status { get; set; }
        public virtual bool? Altered { get; set; }
        public virtual string Id { get; set; }
    }

    public partial class CarLicensePlate
    {
        public virtual string Jurisdiction { get; set; }
        public virtual string Number { get; set; }
    }

    public partial class CarManager
    {
        public virtual string Id { get; set; }
    }

    public partial class CarManufacturer
    {
        public virtual int Year { get; set; }
        public virtual string Make { get; set; }
        public virtual string Model { get; set; }
    }

    public partial class CarOwner
    {
        public virtual string Id { get; set; }
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations
{
    public partial class PutPatchOperationTenanted<TResponse>
        : PutPatchOperationUnTenanted<TResponse>, ITenantedRequest
    {
        public virtual string OrganisationId { get; set; }
    }

    public partial class PutPatchOperationUnTenanted<TResponse>
        : IPatch, IPut
    {
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations.Cars
{
    public partial class RegisterCarRequest
        : PutPatchOperationTenanted<RegisterCarResponse>
    {
        public virtual string Id { get; set; }
        public virtual string Jurisdiction { get; set; }
        public virtual string Number { get; set; }
    }

    public partial class RegisterCarResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual Car Car { get; set; }
    }

}

C# RegisterCarRequest DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: String,
	jurisdiction: String,
	number: String,
	organisationId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
	}
}