| GET | /pulsit/profile |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports WebService.ClientApi.Services
Imports WebService.ClientServiceModel.Base
Imports CommonService.Api.Models.Base
Namespace Global
Namespace CommonService.Api.Models.Base
Public Partial Class ApiServiceResponse
Implements IServiceResponse
Public Overridable Property Description As String
Public Overridable Property Heading As String
Public Overridable Property WasSuccessful As Boolean
Public Overridable Property ModelState As Object
End Class
End Namespace
Namespace WebService.ClientApi.Services
Public Partial Class PulsitModuleStatusItem
Public Overridable Property PulsitModuleId As String
Public Overridable Property Latitude As Double
Public Overridable Property Longitude As Double
Public Overridable Property EventDescription As String
Public Overridable Property EventTime As Date
Public Overridable Property Status As String
Public Overridable Property PulsitStartId As Integer
End Class
Public Partial Class PulsitProfileDeviceItem
Public Overridable Property PulsitModuleId As String
Public Overridable Property Product As String
Public Overridable Property Description As String
Public Overridable Property Type As DeviceType
Public Overridable Property TypeString As String
Public Enum DeviceType
Lock = 0
HomeSecurity = 1
End Enum
End Class
Public Partial Class PulsitProfileProductItem
Public Overridable Property Product As String
Public Overridable Property Make As String
Public Overridable Property Model As String
Public Overridable Property Year As String
Public Overridable Property RegistrationNumber As String
Public Overridable Property PulsitModuleId As String
Public Overridable Property LatestStatus As PulsitModuleStatusItem
End Class
Public Partial Class PulsitProfileRequest
Inherits ApiServiceRequest
Public Overridable Property IdNumber As String
End Class
Public Partial Class PulsitProfileResponse
Inherits ApiServiceResponse
Public Sub New()
Products = New List(Of PulsitProfileProductItem)
Devices = New List(Of PulsitProfileDeviceItem)
End Sub
Public Overridable Property Products As List(Of PulsitProfileProductItem)
Public Overridable Property Devices As List(Of PulsitProfileDeviceItem)
End Class
End Namespace
Namespace WebService.ClientServiceModel.Base
Public Partial Class ApiServiceRequest
Implements IServiceRequest
Implements IHasApiKey
'''<Summary>
'''The API Key required for authentication
'''</Summary>
<ApiMember(DataType:="string", Description:="The API Key required for authentication", IsRequired:=true)>
Public Overridable Property ApiKey As String
End Class
End Namespace
End Namespace
VB.NET PulsitProfileRequest 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.
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>