Billiecart API

<back to all web services

SearchAllCarsRequest

import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class SearchAllCarsRequest : SearchOperationTenanted<SearchAllCarsResponse>()
{
}

open class SearchOperationTenanted<TResponse> : SearchOperationUnTenanted<TResponse>(), ITenantedRequest
{
    var organisationId:String? = null
}

open class SearchOperationUnTenanted<TResponse> : GetOperationUnTenanted<TResponse>(), IHasSearchOptions
{
    var distinct:String? = null
    var limit:Int? = null
    var offset:Int? = null
    var sort:String? = null
    var filter:String? = null
    var search:String? = null
}

open class GetOperationUnTenanted<TResponse> : IHasGetOptions, IGet
{
    var embed:String? = null
}

open class SearchAllCarsResponse : SearchOperationResponse()
{
    var responseStatus:ResponseStatus? = null
    var cars:ArrayList<Car> = ArrayList<Car>()
}

open class SearchOperationResponse
{
    var metadata:SearchMetadata? = null
}

open class SearchMetadata
{
    var total:Int? = null
    var limit:Int? = null
    var offset:Int? = null
    var sort:Sorting? = null
    var filter:Filtering? = null
}

open class Sorting
{
    @SerializedName("by") var By:String? = null
    var direction:SortDirection? = null
}

enum class SortDirection
{
    Ascending,
    Descending,
}

open class Filtering
{
    var fields:ArrayList<String> = ArrayList<String>()
    var search:String? = null
}

open class Car : IIdentifiableResource
{
    var manufacturer:CarManufacturer? = null
    var plate:CarLicensePlate? = null
    var owner:CarOwner? = null
    var managers:ArrayList<CarManager> = ArrayList<CarManager>()
    var status:String? = null
    var altered:Boolean? = null
    var id:String? = null
}

open class CarManufacturer
{
    var year:Int? = null
    var make:String? = null
    var model:String? = null
}

open class CarLicensePlate
{
    var jurisdiction:String? = null
    var number:String? = null
}

open class CarOwner
{
    var id:String? = null
}

open class CarManager
{
    var id:String? = null
}

Kotlin SearchAllCarsRequest DTOs

GET /cars HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/jsv

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
		}
	},
	cars: 
	[
		{
			manufacturer: 
			{
				year: 0,
				make: String,
				model: String
			},
			plate: 
			{
				jurisdiction: String,
				number: String
			},
			owner: 
			{
				id: String
			},
			managers: 
			[
				{
					id: String
				}
			],
			status: String,
			altered: False,
			id: String
		}
	],
	metadata: 
	{
		total: 0,
		limit: 0,
		offset: 0,
		sort: 
		{
			by: String,
			direction: Ascending
		},
		filter: 
		{
			fields: 
			[
				String
			],
			search: String
		}
	}
}