GET | /unit | ||
---|---|---|---|
GET | /unit/{Id} | ||
GET POST | /GetUnit | ||
GET POST | /GetUnit/{Id} |
// @DataContract
export class Location
{
// @DataMember
public latitude: number;
// @DataMember
public longitude: number;
public constructor(init?: Partial<Location>) { (Object as any).assign(this, init); }
}
// @DataContract
export class Address
{
// @DataMember
public country: string;
// @DataMember
public zipCode: string;
// @DataMember
public city: string;
// @DataMember
public streetAddress: string;
public constructor(init?: Partial<Address>) { (Object as any).assign(this, init); }
}
// @DataContract
export class Unit
{
// @DataMember
public id: string;
// @DataMember
public serialNumber: string;
// @DataMember
public phoneNumber: string;
// @DataMember
public vehicleType: string;
// @DataMember
public deviceType: string;
// @DataMember
public deviceModel: string;
// @DataMember
public name: string;
// @DataMember
public displayName: string;
// @DataMember
public referenceNumber: string;
// @DataMember
public note: string;
// @DataMember
public createdAt: string;
// @DataMember
public input1Name: string;
// @DataMember
public input2Name: string;
// @DataMember
public input3Name: string;
// @DataMember
public input4Name: string;
// @DataMember
public categoryId: string;
// @DataMember
public clientId: string;
// @DataMember
public gpsFixTime?: string;
// @DataMember
public messageTime?: string;
// @DataMember
public location: Location;
// @DataMember
public altitude?: number;
// @DataMember
public heading?: number;
// @DataMember
public speed?: number;
// @DataMember
public address: Address;
// @DataMember
public temperature1?: number;
// @DataMember
public temperature2?: number;
// @DataMember
public gsmLevel?: number;
// @DataMember
public gsmSignalQuality: string;
// @DataMember
public gpsSignalQuality: string;
// @DataMember
public batteryLevel?: number;
// @DataMember
public externalPower?: number;
// @DataMember
public preRun1: number;
// @DataMember
public preRun2: number;
// @DataMember
public run1?: number;
// @DataMember
public run2?: number;
// @DataMember
public run3?: number;
// @DataMember
public run4?: number;
// @DataMember
public runOdo?: number;
// @DataMember
public preKm: number;
// @DataMember
public km?: number;
// @DataMember
public input1?: boolean;
// @DataMember
public input2?: boolean;
// @DataMember
public input3?: boolean;
// @DataMember
public input4?: boolean;
// @DataMember
public input5?: boolean;
// @DataMember
public input6?: boolean;
// @DataMember
public input7?: boolean;
// @DataMember
public input8?: boolean;
// @DataMember
public input9?: boolean;
// @DataMember
public input10?: boolean;
// @DataMember
public output1?: boolean;
// @DataMember
public output2?: boolean;
// @DataMember
public output3?: boolean;
// @DataMember
public output4?: boolean;
// @DataMember
public output5?: boolean;
// @DataMember
public analogInput1?: number;
// @DataMember
public analogInput2?: number;
// @DataMember
public analogInput4?: number;
// @DataMember
public input1ChangeCounter?: number;
// @DataMember
public input2ChangeCounter?: number;
// @DataMember
public input3ChangeCounter?: number;
// @DataMember
public input4ChangeCounter?: number;
// @DataMember
public isActive: boolean;
// @DataMember
public keyId: string;
// @DataMember
public isOwn: boolean;
// @DataMember
public currentStop?: number;
public constructor(init?: Partial<Unit>) { (Object as any).assign(this, init); }
}
// @DataContract
export class GetUnitResponse
{
// @DataMember
public list: Unit[];
// @DataMember
public responseStatus: ResponseStatus;
public constructor(init?: Partial<GetUnitResponse>) { (Object as any).assign(this, init); }
}
// @DataContract
export class GetUnit
{
// @DataMember
public id: string;
// @DataMember
public serialNumber: string;
// @DataMember
public referenceNumber: string;
// @DataMember
public categoryId: string;
// @DataMember
public clientId: string;
// @DataMember
public groupId: string;
// @DataMember
public zoneId: string;
// @DataMember
public pointId: string;
// @DataMember
public point: Location;
// @DataMember
public radius?: number;
public constructor(init?: Partial<GetUnit>) { (Object as any).assign(this, init); }
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /GetUnit HTTP/1.1
Host: api.trackunit.com
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"id":"String","serialNumber":"String","referenceNumber":"String","categoryId":"String","clientId":"String","groupId":"String","zoneId":"String","pointId":"String","point":{"latitude":0,"longitude":0},"radius":0}
HTTP/1.1 200 OK Content-Type: text/jsonl Content-Length: length {"list":[{"id":"String","serialNumber":"String","phoneNumber":"String","vehicleType":"String","deviceType":"String","deviceModel":"String","name":"String","displayName":"String","referenceNumber":"String","note":"String","createdAt":"0001-01-01T00:00:00.0000000Z","input1Name":"String","input2Name":"String","input3Name":"String","input4Name":"String","categoryId":"String","clientId":"String","gpsFixTime":"0001-01-01T00:00:00.0000000Z","messageTime":"0001-01-01T00:00:00.0000000Z","location":{"latitude":0,"longitude":0},"altitude":0,"heading":0,"speed":0,"address":{"country":"String","zipCode":"String","city":"String","streetAddress":"String"},"temperature1":0,"temperature2":0,"gsmLevel":0,"gsmSignalQuality":"String","gpsSignalQuality":"String","batteryLevel":0,"externalPower":0,"preRun1":0,"preRun2":0,"run1":0,"run2":0,"run3":0,"run4":0,"runOdo":0,"preKm":0,"km":0,"input1":false,"input2":false,"input3":false,"input4":false,"input5":false,"input6":false,"input7":false,"input8":false,"input9":false,"input10":false,"output1":false,"output2":false,"output3":false,"output4":false,"output5":false,"analogInput1":0,"analogInput2":0,"analogInput4":0,"input1ChangeCounter":0,"input2ChangeCounter":0,"input3ChangeCounter":0,"input4ChangeCounter":0,"isActive":false,"keyId":"String","isOwn":false,"currentStop":0}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}