| GET | /pulsit/profile |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using WebService.ClientApi.Services;
using WebService.ClientServiceModel.Base;
using CommonService.Api.Models.Base;
namespace CommonService.Api.Models.Base
{
public partial class ApiServiceResponse
: IServiceResponse
{
public virtual string Description { get; set; }
public virtual string Heading { get; set; }
public virtual bool WasSuccessful { get; set; }
public virtual Object ModelState { get; set; }
}
}
namespace WebService.ClientApi.Services
{
public partial class PulsitModuleStatusItem
{
public virtual string PulsitModuleId { get; set; }
public virtual double Latitude { get; set; }
public virtual double Longitude { get; set; }
public virtual string EventDescription { get; set; }
public virtual DateTime EventTime { get; set; }
public virtual string Status { get; set; }
public virtual int PulsitStartId { get; set; }
}
public partial class PulsitProfileDeviceItem
{
public virtual string PulsitModuleId { get; set; }
public virtual string Product { get; set; }
public virtual string Description { get; set; }
public virtual DeviceType Type { get; set; }
public virtual string TypeString { get; set; }
public enum DeviceType
{
Lock = 0,
HomeSecurity = 1,
}
}
public partial class PulsitProfileProductItem
{
public virtual string Product { get; set; }
public virtual string Make { get; set; }
public virtual string Model { get; set; }
public virtual string Year { get; set; }
public virtual string RegistrationNumber { get; set; }
public virtual string PulsitModuleId { get; set; }
public virtual PulsitModuleStatusItem LatestStatus { get; set; }
}
public partial class PulsitProfileRequest
: ApiServiceRequest
{
public virtual string IdNumber { get; set; }
}
public partial class PulsitProfileResponse
: ApiServiceResponse
{
public PulsitProfileResponse()
{
Products = new List<PulsitProfileProductItem>{};
Devices = new List<PulsitProfileDeviceItem>{};
}
public virtual List<PulsitProfileProductItem> Products { get; set; }
public virtual List<PulsitProfileDeviceItem> Devices { get; set; }
}
}
namespace WebService.ClientServiceModel.Base
{
public partial class ApiServiceRequest
: IServiceRequest, IHasApiKey
{
///<summary>
///The API Key required for authentication
///</summary>
[ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)]
public virtual string ApiKey { get; set; }
}
}
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.
GET /pulsit/profile HTTP/1.1 Host: galaxymobile.api.client.prod.86degrees.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<PulsitProfileResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientApi.Services">
<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>
<Devices>
<PulsitProfileDeviceItem>
<Description>String</Description>
<Product>String</Product>
<PulsitModuleId>String</PulsitModuleId>
<Type>Lock</Type>
</PulsitProfileDeviceItem>
</Devices>
<Products>
<PulsitProfileProductItem>
<LatestStatus>
<EventDescription>String</EventDescription>
<EventTime>0001-01-01T00:00:00</EventTime>
<Latitude>0</Latitude>
<Longitude>0</Longitude>
<PulsitModuleId>String</PulsitModuleId>
<PulsitStartId>0</PulsitStartId>
<Status>String</Status>
</LatestStatus>
<Make>String</Make>
<Model>String</Model>
<Product>String</Product>
<PulsitModuleId>String</PulsitModuleId>
<RegistrationNumber>String</RegistrationNumber>
<Year>String</Year>
</PulsitProfileProductItem>
</Products>
</PulsitProfileResponse>