| POST | /galaxy/vehicle/update | Update a user's vehicle license. |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class UpdateVehicleLicense extends ApiServiceRequest
{
/**
* ID Number of the user making this request.
*/
@ApiMember(Description="ID Number of the user making this request.", IsRequired=true)
public String IdNumber = null;
/**
* The scanned vehicle license disk information.
*/
@ApiMember(Description="The scanned vehicle license disk information.", IsRequired=true)
public VehicleData Vehicle = null;
public String getIdNumber() { return IdNumber; }
public UpdateVehicleLicense setIdNumber(String value) { this.IdNumber = value; return this; }
public VehicleData getVehicle() { return Vehicle; }
public UpdateVehicleLicense setVehicle(VehicleData value) { this.Vehicle = value; return this; }
}
public static class ApiServiceRequest implements IServiceRequest, IHasApiKey
{
/**
* The API Key required for authentication
*/
@ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
public String ApiKey = null;
public String getApiKey() { return ApiKey; }
public ApiServiceRequest setApiKey(String value) { this.ApiKey = value; return this; }
}
public static class VehicleData
{
/**
* The ID of the vehicle.
*/
@ApiMember(Description="The ID of the vehicle.")
public Integer Id = null;
/**
* Whether the vehicle has license disk information.
*/
@ApiMember(Description="Whether the vehicle has license disk information.")
public Boolean HasLicense = null;
/**
* The vehicle license number.
*/
@ApiMember(Description="The vehicle license number.")
public String LicenseNumber = null;
/**
* The vehicle registration number.
*/
@ApiMember(Description="The vehicle registration number.")
public String RegistrationNumber = null;
/**
* The vehicle VIN number.
*/
@ApiMember(Description="The vehicle VIN number.")
public String Vin = null;
/**
* The vehicle make.
*/
@ApiMember(Description="The vehicle make.")
public String Make = null;
/**
* The vehicle series.
*/
@ApiMember(Description="The vehicle series.")
public String Series = null;
/**
* The vehicle colour.
*/
@ApiMember(Description="The vehicle colour.")
public String Colour = null;
/**
* The vehicle license expiry date in ISO 8601 format.
*/
@ApiMember(Description="The vehicle license expiry date in ISO 8601 format.")
public String Expiry = null;
/**
* True if this vehicle's licence expiring soon.
*/
@ApiMember(Description="True if this vehicle's licence expiring soon.")
public Boolean ExpiresSoon = null;
/**
* True if this vehicle's license expired.
*/
@ApiMember(Description="True if this vehicle's license expired.")
public Boolean Expired = null;
public Integer getId() { return Id; }
public VehicleData setId(Integer value) { this.Id = value; return this; }
public Boolean isHasLicense() { return HasLicense; }
public VehicleData setHasLicense(Boolean value) { this.HasLicense = value; return this; }
public String getLicenseNumber() { return LicenseNumber; }
public VehicleData setLicenseNumber(String value) { this.LicenseNumber = value; return this; }
public String getRegistrationNumber() { return RegistrationNumber; }
public VehicleData setRegistrationNumber(String value) { this.RegistrationNumber = value; return this; }
public String getVin() { return Vin; }
public VehicleData setVin(String value) { this.Vin = value; return this; }
public String getMake() { return Make; }
public VehicleData setMake(String value) { this.Make = value; return this; }
public String getSeries() { return Series; }
public VehicleData setSeries(String value) { this.Series = value; return this; }
public String getColour() { return Colour; }
public VehicleData setColour(String value) { this.Colour = value; return this; }
public String getExpiry() { return Expiry; }
public VehicleData setExpiry(String value) { this.Expiry = value; return this; }
public Boolean isExpiresSoon() { return ExpiresSoon; }
public VehicleData setExpiresSoon(Boolean value) { this.ExpiresSoon = value; return this; }
public Boolean isExpired() { return Expired; }
public VehicleData setExpired(Boolean value) { this.Expired = value; return this; }
}
public static class UpdateVehicleLicenseResponse extends ApiServiceResponse
{
/**
* The newly update vehicle information.
*/
@ApiMember(Description="The newly update vehicle information.", IsRequired=true)
public VehicleData Vehicle = null;
public VehicleData getVehicle() { return Vehicle; }
public UpdateVehicleLicenseResponse setVehicle(VehicleData value) { this.Vehicle = value; return this; }
}
public static class ApiServiceResponse implements IServiceResponse
{
public String Description = null;
public String Heading = null;
public Boolean WasSuccessful = null;
public Object ModelState = null;
public String getDescription() { return Description; }
public ApiServiceResponse setDescription(String value) { this.Description = value; return this; }
public String getHeading() { return Heading; }
public ApiServiceResponse setHeading(String value) { this.Heading = value; return this; }
public Boolean isWasSuccessful() { return WasSuccessful; }
public ApiServiceResponse setWasSuccessful(Boolean value) { this.WasSuccessful = value; return this; }
public Object getModelState() { return ModelState; }
public ApiServiceResponse setModelState(Object value) { this.ModelState = value; return this; }
}
}
Java UpdateVehicleLicense DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /galaxy/vehicle/update HTTP/1.1
Host: galaxymobile.api.client.prod.86degrees.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateVehicleLicense xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Vehicles">
<ApiKey xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Base">String</ApiKey>
<IdNumber>String</IdNumber>
<Vehicle>
<Colour>String</Colour>
<Expired>false</Expired>
<ExpiresSoon>false</ExpiresSoon>
<Expiry>String</Expiry>
<HasLicense>false</HasLicense>
<Id>0</Id>
<LicenseNumber>String</LicenseNumber>
<Make>String</Make>
<RegistrationNumber>String</RegistrationNumber>
<Series>String</Series>
<Vin>String</Vin>
</Vehicle>
</UpdateVehicleLicense>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<UpdateVehicleLicenseResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Vehicles">
<Description xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Description>
<Heading xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Heading>
<ModelState xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base" />
<WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">false</WasSuccessful>
<Vehicle>
<Colour>String</Colour>
<Expired>false</Expired>
<ExpiresSoon>false</ExpiresSoon>
<Expiry>String</Expiry>
<HasLicense>false</HasLicense>
<Id>0</Id>
<LicenseNumber>String</LicenseNumber>
<Make>String</Make>
<RegistrationNumber>String</RegistrationNumber>
<Series>String</Series>
<Vin>String</Vin>
</Vehicle>
</UpdateVehicleLicenseResponse>