GET | /alarmLog | ||
---|---|---|---|
GET POST | /GetAlarmLog |
// @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 Location
{
// @DataMember
public latitude: number;
// @DataMember
public longitude: number;
public constructor(init?: Partial<Location>) { (Object as any).assign(this, init); }
}
// @DataContract
export class AlarmRecipient
{
// @DataMember
public contactId: string;
// @DataMember
public sentVia: string;
// @DataMember
public phoneNumber: string;
// @DataMember
public email: string;
// @DataMember
public delivered: boolean;
public constructor(init?: Partial<AlarmRecipient>) { (Object as any).assign(this, init); }
}
// @DataContract
export class AlarmLog
{
// @DataMember
public alarmId: string;
// @DataMember
public unitId: string;
// @DataMember
public triggeredAt: string;
// @DataMember
public address: Address;
// @DataMember
public location: Location;
// @DataMember
public recipients: AlarmRecipient[];
public constructor(init?: Partial<AlarmLog>) { (Object as any).assign(this, init); }
}
// @DataContract
export class GetAlarmLogResponse
{
// @DataMember
public list: AlarmLog[];
// @DataMember
public responseStatus: ResponseStatus;
public constructor(init?: Partial<GetAlarmLogResponse>) { (Object as any).assign(this, init); }
}
// @DataContract
export class GetAlarmLog
{
// @DataMember
public unitId: string;
// @DataMember
public dateFrom?: string;
// @DataMember
public dateTo?: string;
public constructor(init?: Partial<GetAlarmLog>) { (Object as any).assign(this, init); }
}
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 /GetAlarmLog HTTP/1.1
Host: api.trackunit.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetAlarmLog xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<DateFrom>0001-01-01T00:00:00</DateFrom>
<DateTo>0001-01-01T00:00:00</DateTo>
<UnitId>String</UnitId>
</GetAlarmLog>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <GetAlarmLogResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types"> <List> <AlarmLog> <Address> <City>String</City> <Country>String</Country> <StreetAddress>String</StreetAddress> <ZipCode>String</ZipCode> </Address> <AlarmId>String</AlarmId> <Location> <Latitude>0</Latitude> <Longitude>0</Longitude> </Location> <Recipients> <AlarmRecipient> <ContactId>String</ContactId> <Delivered>false</Delivered> <Email>String</Email> <PhoneNumber>String</PhoneNumber> <SentVia>String</SentVia> </AlarmRecipient> </Recipients> <TriggeredAt>0001-01-01T00:00:00</TriggeredAt> <UnitId>String</UnitId> </AlarmLog> </List> <ResponseStatus> <ErrorCode>String</ErrorCode> <Message>String</Message> <StackTrace>String</StackTrace> <Errors> <ResponseError> <ErrorCode>String</ErrorCode> <FieldName>String</FieldName> <Message>String</Message> <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> </Meta> </ResponseError> </Errors> <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> </Meta> </ResponseStatus> </GetAlarmLogResponse>