Customer API

API change history

Gets a list of subscriptions

Retrieves a list of web hook subscriptions. You can specify the number of pages returned and the number of elements per page. Results are automatically sorted by SubscriptionId, and in ascending order. Sort parameters are not configurable.

Try it

Request

Request URL

Request headers

  • (optional)
    integer

    CustomerAPI minor version

  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

Request was executed successfully.

Representations

[
  {
    "User": {
      "UserId": 0,
      "FirstName": "string",
      "LastName": "string",
      "EmployeeNumber": "string",
      "GroupName": "string"
    },
    "Vehicle": {
      "VehicleId": 0,
      "Name": "string",
      "VIN": "string",
      "DeviceName": "string",
      "SerialNumber": "string",
      "GroupName": "string"
    },
    "TimeTag": "string",
    "Location": {
      "Latitude": 0.0,
      "Longitude": 0.0
    },
    "Geofence": {
      "GeofenceId": 0,
      "CreatedUtc": "string",
      "ModifiedUtc": "string",
      "Name": "string",
      "Type": "string",
      "Shape": 0,
      "Address": {
        "LatLon": {
          "Latitude": 0.0,
          "Longitude": 0.0
        },
        "AddressLine1": "string",
        "AddressLine2": "string",
        "City": "string",
        "RegionName": "string",
        "PostalCode": "string",
        "CountryCode": "string",
        "SubRegionName": "string",
        "SubRegionCode": "string",
        "RegionCode": "string"
      },
      "Radius": 0.0,
      "UseGeofenceAddress": true
    },
    "Speed": 0.0,
    "Heading": 0.0,
    "Status": 1,
    "StatusTime": "string",
    "Distance": 0.0,
    "IgnitionOn": true,
    "LocationProvider": 1
  }
]
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "User": {
        "type": "object",
        "properties": {
          "UserId": {
            "format": "int32",
            "description": "UserId of the User.",
            "type": "integer"
          },
          "FirstName": {
            "description": "First name of the User.",
            "type": "string"
          },
          "LastName": {
            "description": "Last name of the User.",
            "type": "string"
          },
          "EmployeeNumber": {
            "description": "Employee number of the User.",
            "type": "string"
          },
          "GroupName": {
            "description": "Name of Group assigned to the User.",
            "type": "string"
          }
        },
        "description": "User associated with this GpsDataRecordApiModel."
      },
      "Vehicle": {
        "type": "object",
        "properties": {
          "VehicleId": {
            "format": "int64",
            "description": "Id of the BaseVehicleApiModel.",
            "type": "integer"
          },
          "Name": {
            "description": "Name of the BaseVehicleApiModel.",
            "type": "string"
          },
          "VIN": {
            "description": "Vehicle Identification Number of the BaseVehicleApiModel.",
            "type": "string"
          },
          "DeviceName": {
            "description": "Name of Device associated with the BaseVehicleApiModel.",
            "type": "string"
          },
          "SerialNumber": {
            "description": "SerialNumber of the BaseVehicleApiModel.",
            "type": "string"
          },
          "GroupName": {
            "description": "GroupName of the BaseVehicleApiModel.",
            "type": "string"
          }
        },
        "description": "Vehicle associated with this GpsDataRecordApiModel."
      },
      "TimeTag": {
        "format": "date-time",
        "description": "TimeTag associated with this GpsDataRecordApiModel.",
        "type": "string"
      },
      "Location": {
        "type": "object",
        "properties": {
          "Latitude": {
            "format": "double",
            "type": "number"
          },
          "Longitude": {
            "format": "double",
            "type": "number"
          }
        },
        "description": "Location associated with the start of this GpsDataRecordApiModel."
      },
      "Geofence": {
        "type": "object",
        "properties": {
          "GeofenceId": {
            "format": "int64",
            "description": "GeofenceId of the GeofenceApiModel.",
            "type": "integer"
          },
          "CreatedUtc": {
            "format": "date-time",
            "description": "CreatedUtc of the GeofenceApiModel.",
            "type": "string"
          },
          "ModifiedUtc": {
            "format": "date-time",
            "description": "ModifiedUtc of the GeofenceApiModel.",
            "type": "string"
          },
          "Name": {
            "description": "Name of the GeofenceApiModelBase.",
            "type": "string"
          },
          "Type": {
            "description": "Type of the GeofenceApiModel.",
            "type": "string"
          },
          "Shape": {
            "format": "int32",
            "description": "Shape of the GeofenceApiModel.",
            "enum": [
              0,
              1
            ],
            "type": "integer"
          },
          "Address": {
            "type": "object",
            "properties": {
              "LatLon": {
                "type": "object",
                "properties": {
                  "Latitude": {
                    "format": "double",
                    "type": "number"
                  },
                  "Longitude": {
                    "format": "double",
                    "type": "number"
                  }
                },
                "description": "GPS Location associated with the start of this LocationApiModel."
              },
              "AddressLine1": {
                "description": "AddressLine1 of this LocationApiModel.",
                "type": "string"
              },
              "AddressLine2": {
                "description": "AddressLine1 of this LocationApiModel.",
                "type": "string"
              },
              "City": {
                "description": "City of the LocationApiModel.",
                "type": "string"
              },
              "RegionName": {
                "description": "Region Name of the LocationApiModel.",
                "type": "string"
              },
              "PostalCode": {
                "description": "Postal Code of the LocationApiModel.",
                "type": "string"
              },
              "CountryCode": {
                "description": "ISO 3166-1 alpha-2 code.",
                "type": "string"
              },
              "SubRegionName": {
                "description": "SubRegion of the LocationApiModel.",
                "type": "string"
              },
              "SubRegionCode": {
                "description": "SubRegion Code of the LocationApiModel.",
                "type": "string"
              },
              "RegionCode": {
                "description": "Region Code of the LocationApiModel.",
                "type": "string"
              }
            },
            "description": "LocationApiModel of the GeofenceApiModel."
          },
          "Radius": {
            "format": "double",
            "description": "Radius of the GeofenceApiModel.",
            "type": "number"
          },
          "UseGeofenceAddress": {
            "description": "UseGeofenceAddress of the GeofenceApiModel.",
            "type": "boolean"
          }
        },
        "description": "Geofence associated with the start of this GpsDataRecordApiModel."
      },
      "Speed": {
        "format": "double",
        "description": "Speed of movement associated with this GpsDataRecordApiModel.",
        "type": "number"
      },
      "Heading": {
        "format": "double",
        "description": "Compass direction in degrees associated with this GpsDataRecordApiModel.",
        "type": "number"
      },
      "Status": {
        "format": "int32",
        "description": "ApiMovementStatus associated with the OrderBaseApiModel - (Stopped: 1, Idle: 2, Moving: 3, NotTracking: 4) : OrderStatusApiModel.",
        "enum": [
          1,
          2,
          3,
          4
        ],
        "type": "integer"
      },
      "StatusTime": {
        "description": "Point in time this GpsDataRecordApiModel Status was set.",
        "type": "string"
      },
      "Distance": {
        "format": "double",
        "description": "Distance traveled in localized units associated with this TripApiModel.",
        "type": "number"
      },
      "IgnitionOn": {
        "description": "Status of vehicle ignition associated with this GpsDataRecordApiModel.",
        "type": "boolean"
      },
      "LocationProvider": {
        "format": "int32",
        "description": "Api Location Provider associated with this GpsDataRecordApiModel - (GPS: 1, Network: 2).",
        "enum": [
          1,
          2
        ],
        "type": "integer"
      }
    }
  }
}
[
  {
    "User": {
      "UserId": 0,
      "FirstName": "string",
      "LastName": "string",
      "EmployeeNumber": "string",
      "GroupName": "string"
    },
    "Vehicle": {
      "VehicleId": 0,
      "Name": "string",
      "VIN": "string",
      "DeviceName": "string",
      "SerialNumber": "string",
      "GroupName": "string"
    },
    "TimeTag": "string",
    "Location": {
      "Latitude": 0.0,
      "Longitude": 0.0
    },
    "Geofence": {
      "GeofenceId": 0,
      "CreatedUtc": "string",
      "ModifiedUtc": "string",
      "Name": "string",
      "Type": "string",
      "Shape": 0,
      "Address": {
        "LatLon": {
          "Latitude": 0.0,
          "Longitude": 0.0
        },
        "AddressLine1": "string",
        "AddressLine2": "string",
        "City": "string",
        "RegionName": "string",
        "PostalCode": "string",
        "CountryCode": "string",
        "SubRegionName": "string",
        "SubRegionCode": "string",
        "RegionCode": "string"
      },
      "Radius": 0.0,
      "UseGeofenceAddress": true
    },
    "Speed": 0.0,
    "Heading": 0.0,
    "Status": 1,
    "StatusTime": "string",
    "Distance": 0.0,
    "IgnitionOn": true,
    "LocationProvider": 1
  }
]
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "User": {
        "type": "object",
        "properties": {
          "UserId": {
            "format": "int32",
            "description": "UserId of the User.",
            "type": "integer"
          },
          "FirstName": {
            "description": "First name of the User.",
            "type": "string"
          },
          "LastName": {
            "description": "Last name of the User.",
            "type": "string"
          },
          "EmployeeNumber": {
            "description": "Employee number of the User.",
            "type": "string"
          },
          "GroupName": {
            "description": "Name of Group assigned to the User.",
            "type": "string"
          }
        },
        "description": "User associated with this GpsDataRecordApiModel."
      },
      "Vehicle": {
        "type": "object",
        "properties": {
          "VehicleId": {
            "format": "int64",
            "description": "Id of the BaseVehicleApiModel.",
            "type": "integer"
          },
          "Name": {
            "description": "Name of the BaseVehicleApiModel.",
            "type": "string"
          },
          "VIN": {
            "description": "Vehicle Identification Number of the BaseVehicleApiModel.",
            "type": "string"
          },
          "DeviceName": {
            "description": "Name of Device associated with the BaseVehicleApiModel.",
            "type": "string"
          },
          "SerialNumber": {
            "description": "SerialNumber of the BaseVehicleApiModel.",
            "type": "string"
          },
          "GroupName": {
            "description": "GroupName of the BaseVehicleApiModel.",
            "type": "string"
          }
        },
        "description": "Vehicle associated with this GpsDataRecordApiModel."
      },
      "TimeTag": {
        "format": "date-time",
        "description": "TimeTag associated with this GpsDataRecordApiModel.",
        "type": "string"
      },
      "Location": {
        "type": "object",
        "properties": {
          "Latitude": {
            "format": "double",
            "type": "number"
          },
          "Longitude": {
            "format": "double",
            "type": "number"
          }
        },
        "description": "Location associated with the start of this GpsDataRecordApiModel."
      },
      "Geofence": {
        "type": "object",
        "properties": {
          "GeofenceId": {
            "format": "int64",
            "description": "GeofenceId of the GeofenceApiModel.",
            "type": "integer"
          },
          "CreatedUtc": {
            "format": "date-time",
            "description": "CreatedUtc of the GeofenceApiModel.",
            "type": "string"
          },
          "ModifiedUtc": {
            "format": "date-time",
            "description": "ModifiedUtc of the GeofenceApiModel.",
            "type": "string"
          },
          "Name": {
            "description": "Name of the GeofenceApiModelBase.",
            "type": "string"
          },
          "Type": {
            "description": "Type of the GeofenceApiModel.",
            "type": "string"
          },
          "Shape": {
            "format": "int32",
            "description": "Shape of the GeofenceApiModel.",
            "enum": [
              0,
              1
            ],
            "type": "integer"
          },
          "Address": {
            "type": "object",
            "properties": {
              "LatLon": {
                "type": "object",
                "properties": {
                  "Latitude": {
                    "format": "double",
                    "type": "number"
                  },
                  "Longitude": {
                    "format": "double",
                    "type": "number"
                  }
                },
                "description": "GPS Location associated with the start of this LocationApiModel."
              },
              "AddressLine1": {
                "description": "AddressLine1 of this LocationApiModel.",
                "type": "string"
              },
              "AddressLine2": {
                "description": "AddressLine1 of this LocationApiModel.",
                "type": "string"
              },
              "City": {
                "description": "City of the LocationApiModel.",
                "type": "string"
              },
              "RegionName": {
                "description": "Region Name of the LocationApiModel.",
                "type": "string"
              },
              "PostalCode": {
                "description": "Postal Code of the LocationApiModel.",
                "type": "string"
              },
              "CountryCode": {
                "description": "ISO 3166-1 alpha-2 code.",
                "type": "string"
              },
              "SubRegionName": {
                "description": "SubRegion of the LocationApiModel.",
                "type": "string"
              },
              "SubRegionCode": {
                "description": "SubRegion Code of the LocationApiModel.",
                "type": "string"
              },
              "RegionCode": {
                "description": "Region Code of the LocationApiModel.",
                "type": "string"
              }
            },
            "description": "LocationApiModel of the GeofenceApiModel."
          },
          "Radius": {
            "format": "double",
            "description": "Radius of the GeofenceApiModel.",
            "type": "number"
          },
          "UseGeofenceAddress": {
            "description": "UseGeofenceAddress of the GeofenceApiModel.",
            "type": "boolean"
          }
        },
        "description": "Geofence associated with the start of this GpsDataRecordApiModel."
      },
      "Speed": {
        "format": "double",
        "description": "Speed of movement associated with this GpsDataRecordApiModel.",
        "type": "number"
      },
      "Heading": {
        "format": "double",
        "description": "Compass direction in degrees associated with this GpsDataRecordApiModel.",
        "type": "number"
      },
      "Status": {
        "format": "int32",
        "description": "ApiMovementStatus associated with the OrderBaseApiModel - (Stopped: 1, Idle: 2, Moving: 3, NotTracking: 4) : OrderStatusApiModel.",
        "enum": [
          1,
          2,
          3,
          4
        ],
        "type": "integer"
      },
      "StatusTime": {
        "description": "Point in time this GpsDataRecordApiModel Status was set.",
        "type": "string"
      },
      "Distance": {
        "format": "double",
        "description": "Distance traveled in localized units associated with this TripApiModel.",
        "type": "number"
      },
      "IgnitionOn": {
        "description": "Status of vehicle ignition associated with this GpsDataRecordApiModel.",
        "type": "boolean"
      },
      "LocationProvider": {
        "format": "int32",
        "description": "Api Location Provider associated with this GpsDataRecordApiModel - (GPS: 1, Network: 2).",
        "enum": [
          1,
          2
        ],
        "type": "integer"
      }
    }
  }
}
<CustomerAPI-Models-Tracking-GpsDataRecordApiModelArray-2>
  <User>
    <UserId>0</UserId>
    <FirstName>string</FirstName>
    <LastName>string</LastName>
    <EmployeeNumber>string</EmployeeNumber>
    <GroupName>string</GroupName>
  </User>
  <Vehicle>
    <VehicleId>0</VehicleId>
    <Name>string</Name>
    <VIN>string</VIN>
    <DeviceName>string</DeviceName>
    <SerialNumber>string</SerialNumber>
    <GroupName>string</GroupName>
  </Vehicle>
  <TimeTag>string</TimeTag>
  <Location>
    <Latitude>0</Latitude>
    <Longitude>0</Longitude>
  </Location>
  <Geofence>
    <GeofenceId>0</GeofenceId>
    <CreatedUtc>string</CreatedUtc>
    <ModifiedUtc>string</ModifiedUtc>
    <Name>string</Name>
    <Type>string</Type>
    <Shape>0</Shape>
    <Address>
      <LatLon>
        <Latitude>0</Latitude>
        <Longitude>0</Longitude>
      </LatLon>
      <AddressLine1>string</AddressLine1>
      <AddressLine2>string</AddressLine2>
      <City>string</City>
      <RegionName>string</RegionName>
      <PostalCode>string</PostalCode>
      <CountryCode>string</CountryCode>
      <SubRegionName>string</SubRegionName>
      <SubRegionCode>string</SubRegionCode>
      <RegionCode>string</RegionCode>
    </Address>
    <Radius>0</Radius>
    <UseGeofenceAddress>true</UseGeofenceAddress>
  </Geofence>
  <Speed>0</Speed>
  <Heading>0</Heading>
  <Status>1</Status>
  <StatusTime>string</StatusTime>
  <Distance>0</Distance>
  <IgnitionOn>true</IgnitionOn>
  <LocationProvider>1</LocationProvider>
</CustomerAPI-Models-Tracking-GpsDataRecordApiModelArray-2>
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "User": {
        "type": "object",
        "properties": {
          "UserId": {
            "format": "int32",
            "description": "UserId of the User.",
            "type": "integer"
          },
          "FirstName": {
            "description": "First name of the User.",
            "type": "string"
          },
          "LastName": {
            "description": "Last name of the User.",
            "type": "string"
          },
          "EmployeeNumber": {
            "description": "Employee number of the User.",
            "type": "string"
          },
          "GroupName": {
            "description": "Name of Group assigned to the User.",
            "type": "string"
          }
        },
        "description": "User associated with this GpsDataRecordApiModel."
      },
      "Vehicle": {
        "type": "object",
        "properties": {
          "VehicleId": {
            "format": "int64",
            "description": "Id of the BaseVehicleApiModel.",
            "type": "integer"
          },
          "Name": {
            "description": "Name of the BaseVehicleApiModel.",
            "type": "string"
          },
          "VIN": {
            "description": "Vehicle Identification Number of the BaseVehicleApiModel.",
            "type": "string"
          },
          "DeviceName": {
            "description": "Name of Device associated with the BaseVehicleApiModel.",
            "type": "string"
          },
          "SerialNumber": {
            "description": "SerialNumber of the BaseVehicleApiModel.",
            "type": "string"
          },
          "GroupName": {
            "description": "GroupName of the BaseVehicleApiModel.",
            "type": "string"
          }
        },
        "description": "Vehicle associated with this GpsDataRecordApiModel."
      },
      "TimeTag": {
        "format": "date-time",
        "description": "TimeTag associated with this GpsDataRecordApiModel.",
        "type": "string"
      },
      "Location": {
        "type": "object",
        "properties": {
          "Latitude": {
            "format": "double",
            "type": "number"
          },
          "Longitude": {
            "format": "double",
            "type": "number"
          }
        },
        "description": "Location associated with the start of this GpsDataRecordApiModel."
      },
      "Geofence": {
        "type": "object",
        "properties": {
          "GeofenceId": {
            "format": "int64",
            "description": "GeofenceId of the GeofenceApiModel.",
            "type": "integer"
          },
          "CreatedUtc": {
            "format": "date-time",
            "description": "CreatedUtc of the GeofenceApiModel.",
            "type": "string"
          },
          "ModifiedUtc": {
            "format": "date-time",
            "description": "ModifiedUtc of the GeofenceApiModel.",
            "type": "string"
          },
          "Name": {
            "description": "Name of the GeofenceApiModelBase.",
            "type": "string"
          },
          "Type": {
            "description": "Type of the GeofenceApiModel.",
            "type": "string"
          },
          "Shape": {
            "format": "int32",
            "description": "Shape of the GeofenceApiModel.",
            "enum": [
              0,
              1
            ],
            "type": "integer"
          },
          "Address": {
            "type": "object",
            "properties": {
              "LatLon": {
                "type": "object",
                "properties": {
                  "Latitude": {
                    "format": "double",
                    "type": "number"
                  },
                  "Longitude": {
                    "format": "double",
                    "type": "number"
                  }
                },
                "description": "GPS Location associated with the start of this LocationApiModel."
              },
              "AddressLine1": {
                "description": "AddressLine1 of this LocationApiModel.",
                "type": "string"
              },
              "AddressLine2": {
                "description": "AddressLine1 of this LocationApiModel.",
                "type": "string"
              },
              "City": {
                "description": "City of the LocationApiModel.",
                "type": "string"
              },
              "RegionName": {
                "description": "Region Name of the LocationApiModel.",
                "type": "string"
              },
              "PostalCode": {
                "description": "Postal Code of the LocationApiModel.",
                "type": "string"
              },
              "CountryCode": {
                "description": "ISO 3166-1 alpha-2 code.",
                "type": "string"
              },
              "SubRegionName": {
                "description": "SubRegion of the LocationApiModel.",
                "type": "string"
              },
              "SubRegionCode": {
                "description": "SubRegion Code of the LocationApiModel.",
                "type": "string"
              },
              "RegionCode": {
                "description": "Region Code of the LocationApiModel.",
                "type": "string"
              }
            },
            "description": "LocationApiModel of the GeofenceApiModel."
          },
          "Radius": {
            "format": "double",
            "description": "Radius of the GeofenceApiModel.",
            "type": "number"
          },
          "UseGeofenceAddress": {
            "description": "UseGeofenceAddress of the GeofenceApiModel.",
            "type": "boolean"
          }
        },
        "description": "Geofence associated with the start of this GpsDataRecordApiModel."
      },
      "Speed": {
        "format": "double",
        "description": "Speed of movement associated with this GpsDataRecordApiModel.",
        "type": "number"
      },
      "Heading": {
        "format": "double",
        "description": "Compass direction in degrees associated with this GpsDataRecordApiModel.",
        "type": "number"
      },
      "Status": {
        "format": "int32",
        "description": "ApiMovementStatus associated with the OrderBaseApiModel - (Stopped: 1, Idle: 2, Moving: 3, NotTracking: 4) : OrderStatusApiModel.",
        "enum": [
          1,
          2,
          3,
          4
        ],
        "type": "integer"
      },
      "StatusTime": {
        "description": "Point in time this GpsDataRecordApiModel Status was set.",
        "type": "string"
      },
      "Distance": {
        "format": "double",
        "description": "Distance traveled in localized units associated with this TripApiModel.",
        "type": "number"
      },
      "IgnitionOn": {
        "description": "Status of vehicle ignition associated with this GpsDataRecordApiModel.",
        "type": "boolean"
      },
      "LocationProvider": {
        "format": "int32",
        "description": "Api Location Provider associated with this GpsDataRecordApiModel - (GPS: 1, Network: 2).",
        "enum": [
          1,
          2
        ],
        "type": "integer"
      }
    }
  }
}
<CustomerAPI-Models-Tracking-GpsDataRecordApiModelArray-3>
  <User>
    <UserId>0</UserId>
    <FirstName>string</FirstName>
    <LastName>string</LastName>
    <EmployeeNumber>string</EmployeeNumber>
    <GroupName>string</GroupName>
  </User>
  <Vehicle>
    <VehicleId>0</VehicleId>
    <Name>string</Name>
    <VIN>string</VIN>
    <DeviceName>string</DeviceName>
    <SerialNumber>string</SerialNumber>
    <GroupName>string</GroupName>
  </Vehicle>
  <TimeTag>string</TimeTag>
  <Location>
    <Latitude>0</Latitude>
    <Longitude>0</Longitude>
  </Location>
  <Geofence>
    <GeofenceId>0</GeofenceId>
    <CreatedUtc>string</CreatedUtc>
    <ModifiedUtc>string</ModifiedUtc>
    <Name>string</Name>
    <Type>string</Type>
    <Shape>0</Shape>
    <Address>
      <LatLon>
        <Latitude>0</Latitude>
        <Longitude>0</Longitude>
      </LatLon>
      <AddressLine1>string</AddressLine1>
      <AddressLine2>string</AddressLine2>
      <City>string</City>
      <RegionName>string</RegionName>
      <PostalCode>string</PostalCode>
      <CountryCode>string</CountryCode>
      <SubRegionName>string</SubRegionName>
      <SubRegionCode>string</SubRegionCode>
      <RegionCode>string</RegionCode>
    </Address>
    <Radius>0</Radius>
    <UseGeofenceAddress>true</UseGeofenceAddress>
  </Geofence>
  <Speed>0</Speed>
  <Heading>0</Heading>
  <Status>1</Status>
  <StatusTime>string</StatusTime>
  <Distance>0</Distance>
  <IgnitionOn>true</IgnitionOn>
  <LocationProvider>1</LocationProvider>
</CustomerAPI-Models-Tracking-GpsDataRecordApiModelArray-3>
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "User": {
        "type": "object",
        "properties": {
          "UserId": {
            "format": "int32",
            "description": "UserId of the User.",
            "type": "integer"
          },
          "FirstName": {
            "description": "First name of the User.",
            "type": "string"
          },
          "LastName": {
            "description": "Last name of the User.",
            "type": "string"
          },
          "EmployeeNumber": {
            "description": "Employee number of the User.",
            "type": "string"
          },
          "GroupName": {
            "description": "Name of Group assigned to the User.",
            "type": "string"
          }
        },
        "description": "User associated with this GpsDataRecordApiModel."
      },
      "Vehicle": {
        "type": "object",
        "properties": {
          "VehicleId": {
            "format": "int64",
            "description": "Id of the BaseVehicleApiModel.",
            "type": "integer"
          },
          "Name": {
            "description": "Name of the BaseVehicleApiModel.",
            "type": "string"
          },
          "VIN": {
            "description": "Vehicle Identification Number of the BaseVehicleApiModel.",
            "type": "string"
          },
          "DeviceName": {
            "description": "Name of Device associated with the BaseVehicleApiModel.",
            "type": "string"
          },
          "SerialNumber": {
            "description": "SerialNumber of the BaseVehicleApiModel.",
            "type": "string"
          },
          "GroupName": {
            "description": "GroupName of the BaseVehicleApiModel.",
            "type": "string"
          }
        },
        "description": "Vehicle associated with this GpsDataRecordApiModel."
      },
      "TimeTag": {
        "format": "date-time",
        "description": "TimeTag associated with this GpsDataRecordApiModel.",
        "type": "string"
      },
      "Location": {
        "type": "object",
        "properties": {
          "Latitude": {
            "format": "double",
            "type": "number"
          },
          "Longitude": {
            "format": "double",
            "type": "number"
          }
        },
        "description": "Location associated with the start of this GpsDataRecordApiModel."
      },
      "Geofence": {
        "type": "object",
        "properties": {
          "GeofenceId": {
            "format": "int64",
            "description": "GeofenceId of the GeofenceApiModel.",
            "type": "integer"
          },
          "CreatedUtc": {
            "format": "date-time",
            "description": "CreatedUtc of the GeofenceApiModel.",
            "type": "string"
          },
          "ModifiedUtc": {
            "format": "date-time",
            "description": "ModifiedUtc of the GeofenceApiModel.",
            "type": "string"
          },
          "Name": {
            "description": "Name of the GeofenceApiModelBase.",
            "type": "string"
          },
          "Type": {
            "description": "Type of the GeofenceApiModel.",
            "type": "string"
          },
          "Shape": {
            "format": "int32",
            "description": "Shape of the GeofenceApiModel.",
            "enum": [
              0,
              1
            ],
            "type": "integer"
          },
          "Address": {
            "type": "object",
            "properties": {
              "LatLon": {
                "type": "object",
                "properties": {
                  "Latitude": {
                    "format": "double",
                    "type": "number"
                  },
                  "Longitude": {
                    "format": "double",
                    "type": "number"
                  }
                },
                "description": "GPS Location associated with the start of this LocationApiModel."
              },
              "AddressLine1": {
                "description": "AddressLine1 of this LocationApiModel.",
                "type": "string"
              },
              "AddressLine2": {
                "description": "AddressLine1 of this LocationApiModel.",
                "type": "string"
              },
              "City": {
                "description": "City of the LocationApiModel.",
                "type": "string"
              },
              "RegionName": {
                "description": "Region Name of the LocationApiModel.",
                "type": "string"
              },
              "PostalCode": {
                "description": "Postal Code of the LocationApiModel.",
                "type": "string"
              },
              "CountryCode": {
                "description": "ISO 3166-1 alpha-2 code.",
                "type": "string"
              },
              "SubRegionName": {
                "description": "SubRegion of the LocationApiModel.",
                "type": "string"
              },
              "SubRegionCode": {
                "description": "SubRegion Code of the LocationApiModel.",
                "type": "string"
              },
              "RegionCode": {
                "description": "Region Code of the LocationApiModel.",
                "type": "string"
              }
            },
            "description": "LocationApiModel of the GeofenceApiModel."
          },
          "Radius": {
            "format": "double",
            "description": "Radius of the GeofenceApiModel.",
            "type": "number"
          },
          "UseGeofenceAddress": {
            "description": "UseGeofenceAddress of the GeofenceApiModel.",
            "type": "boolean"
          }
        },
        "description": "Geofence associated with the start of this GpsDataRecordApiModel."
      },
      "Speed": {
        "format": "double",
        "description": "Speed of movement associated with this GpsDataRecordApiModel.",
        "type": "number"
      },
      "Heading": {
        "format": "double",
        "description": "Compass direction in degrees associated with this GpsDataRecordApiModel.",
        "type": "number"
      },
      "Status": {
        "format": "int32",
        "description": "ApiMovementStatus associated with the OrderBaseApiModel - (Stopped: 1, Idle: 2, Moving: 3, NotTracking: 4) : OrderStatusApiModel.",
        "enum": [
          1,
          2,
          3,
          4
        ],
        "type": "integer"
      },
      "StatusTime": {
        "description": "Point in time this GpsDataRecordApiModel Status was set.",
        "type": "string"
      },
      "Distance": {
        "format": "double",
        "description": "Distance traveled in localized units associated with this TripApiModel.",
        "type": "number"
      },
      "IgnitionOn": {
        "description": "Status of vehicle ignition associated with this GpsDataRecordApiModel.",
        "type": "boolean"
      },
      "LocationProvider": {
        "format": "int32",
        "description": "Api Location Provider associated with this GpsDataRecordApiModel - (GPS: 1, Network: 2).",
        "enum": [
          1,
          2
        ],
        "type": "integer"
      }
    }
  }
}

204 No Content

This is returned when there are now records.

401 Unauthorized

Unauthorized request.

500 Internal Server Error

This error is always an indication of a bug on the server side, it possibly due to an unhandled exception.

503 Service Unavailable

Service temporarily unavailable, because other services are temporarily unavailable (such as Azure service, required 3rd party service like Google API).

Code samples

@ECHO OFF

curl -v -X GET "https://customerapi-encore.actsoft.com/tracking/v1/tracking/gpsdata/subscriptions"
-H "X-API-Version: "
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("X-API-Version", "");
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://customerapi-encore.actsoft.com/tracking/v1/tracking/gpsdata/subscriptions?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://customerapi-encore.actsoft.com/tracking/v1/tracking/gpsdata/subscriptions");


            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("X-API-Version", "");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://customerapi-encore.actsoft.com/tracking/v1/tracking/gpsdata/subscriptions?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("X-API-Version","");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://customerapi-encore.actsoft.com/tracking/v1/tracking/gpsdata/subscriptions";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"" forHTTPHeaderField:@"X-API-Version"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://customerapi-encore.actsoft.com/tracking/v1/tracking/gpsdata/subscriptions');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'X-API-Version' => '',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'X-API-Version': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('customerapi-encore.actsoft.com')
    conn.request("GET", "/tracking/v1/tracking/gpsdata/subscriptions?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'X-API-Version': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('customerapi-encore.actsoft.com')
    conn.request("GET", "/tracking/v1/tracking/gpsdata/subscriptions?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://customerapi-encore.actsoft.com/tracking/v1/tracking/gpsdata/subscriptions')


request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['X-API-Version'] = ''
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body