Billiecart API

<back to all web services

OfflineCarRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
PUT,PATCH/cars/{Id}/offline
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class OfflineCarRequest extends PutPatchOperationTenanted<OfflineCarResponse>
    {
        public String id = null;
        public Date fromUtc = null;
        public Date toUtc = null;
        
        public String getId() { return id; }
        public OfflineCarRequest setId(String value) { this.id = value; return this; }
        public Date getFromUtc() { return fromUtc; }
        public OfflineCarRequest setFromUtc(Date value) { this.fromUtc = value; return this; }
        public Date getToUtc() { return toUtc; }
        public OfflineCarRequest setToUtc(Date value) { this.toUtc = value; return this; }
    }

    public static class PutPatchOperationTenanted<TResponse> extends PutPatchOperationUnTenanted<TResponse> implements ITenantedRequest
    {
        public String organisationId = null;
        
        public String getOrganisationId() { return organisationId; }
        public PutPatchOperationTenanted<TResponse> setOrganisationId(String value) { this.organisationId = value; return this; }
    }

    public static class PutPatchOperationUnTenanted<TResponse> implements IPatch, IPut
    {
        
    }

    public static class OfflineCarResponse
    {
        public ResponseStatus responseStatus = null;
        public Car car = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public OfflineCarResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public Car getCar() { return car; }
        public OfflineCarResponse setCar(Car value) { this.car = value; return this; }
    }

    public static class Car implements IIdentifiableResource
    {
        public CarManufacturer manufacturer = null;
        public CarLicensePlate plate = null;
        public CarOwner owner = null;
        public ArrayList<CarManager> managers = null;
        public String status = null;
        public Boolean altered = null;
        public String id = null;
        
        public CarManufacturer getManufacturer() { return manufacturer; }
        public Car setManufacturer(CarManufacturer value) { this.manufacturer = value; return this; }
        public CarLicensePlate getPlate() { return plate; }
        public Car setPlate(CarLicensePlate value) { this.plate = value; return this; }
        public CarOwner getOwner() { return owner; }
        public Car setOwner(CarOwner value) { this.owner = value; return this; }
        public ArrayList<CarManager> getManagers() { return managers; }
        public Car setManagers(ArrayList<CarManager> value) { this.managers = value; return this; }
        public String getStatus() { return status; }
        public Car setStatus(String value) { this.status = value; return this; }
        public Boolean isAltered() { return altered; }
        public Car setAltered(Boolean value) { this.altered = value; return this; }
        public String getId() { return id; }
        public Car setId(String value) { this.id = value; return this; }
    }

    public static class CarManufacturer
    {
        public Integer year = null;
        public String make = null;
        public String model = null;
        
        public Integer getYear() { return year; }
        public CarManufacturer setYear(Integer value) { this.year = value; return this; }
        public String getMake() { return make; }
        public CarManufacturer setMake(String value) { this.make = value; return this; }
        public String getModel() { return model; }
        public CarManufacturer setModel(String value) { this.model = value; return this; }
    }

    public static class CarLicensePlate
    {
        public String jurisdiction = null;
        public String number = null;
        
        public String getJurisdiction() { return jurisdiction; }
        public CarLicensePlate setJurisdiction(String value) { this.jurisdiction = value; return this; }
        public String getNumber() { return number; }
        public CarLicensePlate setNumber(String value) { this.number = value; return this; }
    }

    public static class CarOwner
    {
        public String id = null;
        
        public String getId() { return id; }
        public CarOwner setId(String value) { this.id = value; return this; }
    }

    public static class CarManager
    {
        public String id = null;
        
        public String getId() { return id; }
        public CarManager setId(String value) { this.id = value; return this; }
    }

}

Java OfflineCarRequest DTOs

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

HTTP + XML

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

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

<OfflineCarRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Cars">
  <OrganisationId xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations">String</OrganisationId>
  <FromUtc>0001-01-01T00:00:00</FromUtc>
  <Id>String</Id>
  <ToUtc>0001-01-01T00:00:00</ToUtc>
</OfflineCarRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<OfflineCarResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Cars">
  <Car xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
    <d2p1:Altered>false</d2p1:Altered>
    <d2p1:Id>String</d2p1:Id>
    <d2p1:Managers>
      <d2p1:CarManager>
        <d2p1:Id>String</d2p1:Id>
      </d2p1:CarManager>
    </d2p1:Managers>
    <d2p1:Manufacturer>
      <d2p1:Make>String</d2p1:Make>
      <d2p1:Model>String</d2p1:Model>
      <d2p1:Year>0</d2p1:Year>
    </d2p1:Manufacturer>
    <d2p1:Owner>
      <d2p1:Id>String</d2p1:Id>
    </d2p1:Owner>
    <d2p1:Plate>
      <d2p1:Jurisdiction>String</d2p1:Jurisdiction>
      <d2p1:Number>String</d2p1:Number>
    </d2p1:Plate>
    <d2p1:Status>String</d2p1:Status>
  </Car>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</OfflineCarResponse>