| GET | /pulsit/profile |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IdNumber | query | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | form | string | Yes | The API Key required for authentication |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Products | form | List<PulsitProfileProductItem> | No | |
| Devices | form | List<PulsitProfileDeviceItem> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Description | form | string | No | |
| Heading | form | string | No | |
| WasSuccessful | form | bool | No | |
| ModelState | form | Object | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Product | form | string | No | |
| Make | form | string | No | |
| Model | form | string | No | |
| Year | form | string | No | |
| RegistrationNumber | form | string | No | |
| PulsitModuleId | form | string | No | |
| LatestStatus | form | PulsitModuleStatusItem | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PulsitModuleId | form | string | No | |
| Latitude | form | double | No | |
| Longitude | form | double | No | |
| EventDescription | form | string | No | |
| EventTime | form | DateTime | No | |
| Status | form | string | No | |
| PulsitStartId | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PulsitModuleId | form | string | No | |
| Product | form | string | No | |
| Description | form | string | No | |
| Type | form | DeviceType | No | |
| TypeString | form | string | No |
| Name | Value | |
|---|---|---|
| Lock | 0 | |
| HomeSecurity | 1 |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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: {}
}