GalaxyMobile Client API

<back to all web services

PulsitProfileRequest

The following routes are available for this service:
GET/pulsit/profile
namespace CommonService.Api.Models.Base

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ApiServiceResponse() = 
        member val Description:String = null with get,set
        member val Heading:String = null with get,set
        member val WasSuccessful:Boolean = new Boolean() with get,set
        member val ModelState:Object = null with get,set

    [<AllowNullLiteral>]
    type PulsitModuleStatusItem() = 
        member val PulsitModuleId:String = null with get,set
        member val Latitude:Double = new Double() with get,set
        member val Longitude:Double = new Double() with get,set
        member val EventDescription:String = null with get,set
        member val EventTime:DateTime = new DateTime() with get,set
        member val Status:String = null with get,set
        member val PulsitStartId:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type PulsitProfileProductItem() = 
        member val Product:String = null with get,set
        member val Make:String = null with get,set
        member val Model:String = null with get,set
        member val Year:String = null with get,set
        member val RegistrationNumber:String = null with get,set
        member val PulsitModuleId:String = null with get,set
        member val LatestStatus:PulsitModuleStatusItem = null with get,set

    type DeviceType =
        | Lock = 0
        | HomeSecurity = 1

    [<AllowNullLiteral>]
    type PulsitProfileDeviceItem() = 
        member val PulsitModuleId:String = null with get,set
        member val Product:String = null with get,set
        member val Description:String = null with get,set
        member val Type:DeviceType = new DeviceType() with get,set
        member val TypeString:String = null with get,set

    [<AllowNullLiteral>]
    type PulsitProfileResponse() = 
        inherit ApiServiceResponse()
        member val Products:ResizeArray<PulsitProfileProductItem> = new ResizeArray<PulsitProfileProductItem>() with get,set
        member val Devices:ResizeArray<PulsitProfileDeviceItem> = new ResizeArray<PulsitProfileDeviceItem>() with get,set

    [<AllowNullLiteral>]
    type ApiServiceRequest() = 
        ///<summary>
        ///The API Key required for authentication
        ///</summary>
        [<ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)>]
        member val ApiKey:String = null with get,set

    [<AllowNullLiteral>]
    type PulsitProfileRequest() = 
        inherit ApiServiceRequest()
        member val IdNumber:String = null with get,set

F# PulsitProfileRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Products: 
	[
		{
			Product: String,
			Make: String,
			Model: String,
			Year: String,
			RegistrationNumber: String,
			PulsitModuleId: String,
			LatestStatus: 
			{
				PulsitModuleId: String,
				Latitude: 0,
				Longitude: 0,
				EventDescription: String,
				EventTime: 0001-01-01,
				Status: String,
				PulsitStartId: 0
			}
		}
	],
	Devices: 
	[
		{
			PulsitModuleId: String,
			Product: String,
			Description: String,
			Type: 0,
			TypeString: Lock
		}
	],
	Description: String,
	Heading: String,
	WasSuccessful: False,
	ModelState: {}
}