GET api/mobile/mobileservice/{userID}/{token}/{groupID}?serviceIDs={serviceIDs}

Get information about the services in a group or a list of services

Request Information

URI Parameters

Name	Description	Type	Additional information
userID	The ID returned from a successful login	unsigned integer	Required
token	The authentication token returned from a successful login	string	Required
groupID	The group id being queried	unsigned integer	Required
serviceIDs	A comma seperated list of service ids. If any services are specified this takes priority over a group id supplied	string	Default value is

Body Parameters

None.

Response Information

Resource Description

A collection of MobileServiceResponses

Collection of MobileServiceResponse

Name	Description	Type	Additional information
ID	The service ID	unsigned integer	None.
Registration	The service registration	string	None.
IconURL	The service icon url, will use v5 icon if possible	string	None.
GPSOrientation	The GPS orientation in degrees	decimal number	None.
GPSLatitude	The GPS latitude in degrees	decimal number	None.
GPSLongitude	The GPS longitude in degrees	decimal number	None.
GPSSpeed	The GPS speed in miles per hour	decimal number	None.
GPSTime	The GPS time in UTC	date	None.
POI	The name of a POI if the service is inside one	string	None.
Street	The street where the service is located	string	None.
Town	The town where the service is located	string	None.
Postcode	The postcode where the service is located	string	None.
Country	The country where the service is located	string	None.
JourneyStatus	Indicates if the service is in a journey	boolean	None.
IdleStatus	Indicates if the service is idling	boolean	None.
AssetsAssociated	A collection of assets current associated to the service	Collection of MobileAssetResponse	None.
DeviceType	The type of the device associated to the service	DeviceType	None.
ConfigurationID	The id of the configuration	integer	None.
BatteryStatus	The status of the battery	MagtrackBatteryStatus	None.
BatteryStatusV2	The status of the battery for the v2 devices	MagtrackBatteryStatus	None.
Voltage	The last voltage	decimal number	None.
LocationAccuracy	The location accuracy in metres if a cell tower lookup was performed	integer	None.
RecoveryProvider	Details of a recovery provider for a service or null if there isn't one	RecoveryProvider	None.
Recovering	True if the service is being recovered by a recovery provider	boolean	None.
CameraCount	Number of cameras	integer	None.
IMEI	The service's IMEI	string	None.
CameraDetails	Any camera details	CameraDetails	None.
OutputStates		OutputStates	None.
ExternalDeviceTypes		Collection of ExternalDeviceType	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ID": 1,
    "Registration": "sample string 2",
    "IconURL": "sample string 3",
    "GPSOrientation": 4.1,
    "GPSLatitude": 5.1,
    "GPSLongitude": 6.1,
    "GPSSpeed": 7.1,
    "GPSTime": "2025-06-15T21:02:18.7288693+00:00",
    "POI": "sample string 9",
    "Street": "sample string 10",
    "Town": "sample string 11",
    "Postcode": "sample string 12",
    "Country": "sample string 13",
    "JourneyStatus": true,
    "IdleStatus": true,
    "AssetsAssociated": [
      {
        "ID": 1,
        "Name": "sample string 2",
        "TyrePressure": 3.1,
        "Temperature": 4.1,
        "AssetType": 1
      },
      {
        "ID": 1,
        "Name": "sample string 2",
        "TyrePressure": 3.1,
        "Temperature": 4.1,
        "AssetType": 1
      }
    ],
    "DeviceType": 0,
    "ConfigurationID": 17,
    "BatteryStatus": 0,
    "BatteryStatusV2": 0,
    "Voltage": 18.1,
    "LocationAccuracy": 19,
    "RecoveryProvider": {
      "Name": "sample string 1",
      "PhoneNumber": "sample string 2"
    },
    "Recovering": true,
    "CameraCount": 21,
    "IMEI": "sample string 22",
    "CameraDetails": {
      "HostAddress": "sample string 1",
      "HostPort": 2,
      "Username": "sample string 3",
      "Password": "sample string 4",
      "ExternalDeviceId": "sample string 5",
      "NumberOfCameras": 6
    },
    "OutputStates": {
      "Output0State": true,
      "Output0Label": "sample string 2",
      "Output1State": true,
      "Output1Label": "sample string 4",
      "Output2State": true,
      "Output2Label": "sample string 6",
      "Output3State": true,
      "Output3Label": "sample string 8"
    },
    "ExternalDeviceTypes": [
      0,
      0
    ]
  },
  {
    "ID": 1,
    "Registration": "sample string 2",
    "IconURL": "sample string 3",
    "GPSOrientation": 4.1,
    "GPSLatitude": 5.1,
    "GPSLongitude": 6.1,
    "GPSSpeed": 7.1,
    "GPSTime": "2025-06-15T21:02:18.7288693+00:00",
    "POI": "sample string 9",
    "Street": "sample string 10",
    "Town": "sample string 11",
    "Postcode": "sample string 12",
    "Country": "sample string 13",
    "JourneyStatus": true,
    "IdleStatus": true,
    "AssetsAssociated": [
      {
        "ID": 1,
        "Name": "sample string 2",
        "TyrePressure": 3.1,
        "Temperature": 4.1,
        "AssetType": 1
      },
      {
        "ID": 1,
        "Name": "sample string 2",
        "TyrePressure": 3.1,
        "Temperature": 4.1,
        "AssetType": 1
      }
    ],
    "DeviceType": 0,
    "ConfigurationID": 17,
    "BatteryStatus": 0,
    "BatteryStatusV2": 0,
    "Voltage": 18.1,
    "LocationAccuracy": 19,
    "RecoveryProvider": {
      "Name": "sample string 1",
      "PhoneNumber": "sample string 2"
    },
    "Recovering": true,
    "CameraCount": 21,
    "IMEI": "sample string 22",
    "CameraDetails": {
      "HostAddress": "sample string 1",
      "HostPort": 2,
      "Username": "sample string 3",
      "Password": "sample string 4",
      "ExternalDeviceId": "sample string 5",
      "NumberOfCameras": 6
    },
    "OutputStates": {
      "Output0State": true,
      "Output0Label": "sample string 2",
      "Output1State": true,
      "Output1Label": "sample string 4",
      "Output2State": true,
      "Output2Label": "sample string 6",
      "Output3State": true,
      "Output3Label": "sample string 8"
    },
    "ExternalDeviceTypes": [
      0,
      0
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfMobileServiceResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <MobileServiceResponse>
    <ID>1</ID>
    <Registration>sample string 2</Registration>
    <IconURL>sample string 3</IconURL>
    <GPSOrientation>4.1</GPSOrientation>
    <GPSLatitude>5.1</GPSLatitude>
    <GPSLongitude>6.1</GPSLongitude>
    <GPSSpeed>7.1</GPSSpeed>
    <GPSTime>2025-06-15T21:02:18.7288693+00:00</GPSTime>
    <POI>sample string 9</POI>
    <Street>sample string 10</Street>
    <Town>sample string 11</Town>
    <Postcode>sample string 12</Postcode>
    <Country>sample string 13</Country>
    <JourneyStatus>true</JourneyStatus>
    <IdleStatus>true</IdleStatus>
    <AssetsAssociated>
      <MobileAssetResponse>
        <ID>1</ID>
        <Name>sample string 2</Name>
        <TyrePressure>3.1</TyrePressure>
        <Temperature>4.1</Temperature>
        <AssetType>Driver</AssetType>
      </MobileAssetResponse>
      <MobileAssetResponse>
        <ID>1</ID>
        <Name>sample string 2</Name>
        <TyrePressure>3.1</TyrePressure>
        <Temperature>4.1</Temperature>
        <AssetType>Driver</AssetType>
      </MobileAssetResponse>
    </AssetsAssociated>
    <DeviceType>Default</DeviceType>
    <RawConfiguration>sample string 16</RawConfiguration>
    <ConfigurationID>17</ConfigurationID>
    <BatteryStatus>Full</BatteryStatus>
    <BatteryStatusV2>Full</BatteryStatusV2>
    <Voltage>18.1</Voltage>
    <LocationAccuracy>19</LocationAccuracy>
    <RecoveryProvider>
      <Name>sample string 1</Name>
      <PhoneNumber>sample string 2</PhoneNumber>
    </RecoveryProvider>
    <Recovering>true</Recovering>
    <CameraCount>21</CameraCount>
    <IMEI>sample string 22</IMEI>
    <CameraDetails>
      <HostAddress>sample string 1</HostAddress>
      <HostPort>2</HostPort>
      <Username>sample string 3</Username>
      <Password>sample string 4</Password>
      <ExternalDeviceId>sample string 5</ExternalDeviceId>
      <NumberOfCameras>6</NumberOfCameras>
    </CameraDetails>
    <OutputStates>
      <Output0State>true</Output0State>
      <Output0Label>sample string 2</Output0Label>
      <Output1State>true</Output1State>
      <Output1Label>sample string 4</Output1Label>
      <Output2State>true</Output2State>
      <Output2Label>sample string 6</Output2Label>
      <Output3State>true</Output3State>
      <Output3Label>sample string 8</Output3Label>
    </OutputStates>
    <ExternalDeviceTypes>
      <ExternalDeviceType>HD22Camera</ExternalDeviceType>
      <ExternalDeviceType>HD22Camera</ExternalDeviceType>
    </ExternalDeviceTypes>
  </MobileServiceResponse>
  <MobileServiceResponse>
    <ID>1</ID>
    <Registration>sample string 2</Registration>
    <IconURL>sample string 3</IconURL>
    <GPSOrientation>4.1</GPSOrientation>
    <GPSLatitude>5.1</GPSLatitude>
    <GPSLongitude>6.1</GPSLongitude>
    <GPSSpeed>7.1</GPSSpeed>
    <GPSTime>2025-06-15T21:02:18.7288693+00:00</GPSTime>
    <POI>sample string 9</POI>
    <Street>sample string 10</Street>
    <Town>sample string 11</Town>
    <Postcode>sample string 12</Postcode>
    <Country>sample string 13</Country>
    <JourneyStatus>true</JourneyStatus>
    <IdleStatus>true</IdleStatus>
    <AssetsAssociated>
      <MobileAssetResponse>
        <ID>1</ID>
        <Name>sample string 2</Name>
        <TyrePressure>3.1</TyrePressure>
        <Temperature>4.1</Temperature>
        <AssetType>Driver</AssetType>
      </MobileAssetResponse>
      <MobileAssetResponse>
        <ID>1</ID>
        <Name>sample string 2</Name>
        <TyrePressure>3.1</TyrePressure>
        <Temperature>4.1</Temperature>
        <AssetType>Driver</AssetType>
      </MobileAssetResponse>
    </AssetsAssociated>
    <DeviceType>Default</DeviceType>
    <RawConfiguration>sample string 16</RawConfiguration>
    <ConfigurationID>17</ConfigurationID>
    <BatteryStatus>Full</BatteryStatus>
    <BatteryStatusV2>Full</BatteryStatusV2>
    <Voltage>18.1</Voltage>
    <LocationAccuracy>19</LocationAccuracy>
    <RecoveryProvider>
      <Name>sample string 1</Name>
      <PhoneNumber>sample string 2</PhoneNumber>
    </RecoveryProvider>
    <Recovering>true</Recovering>
    <CameraCount>21</CameraCount>
    <IMEI>sample string 22</IMEI>
    <CameraDetails>
      <HostAddress>sample string 1</HostAddress>
      <HostPort>2</HostPort>
      <Username>sample string 3</Username>
      <Password>sample string 4</Password>
      <ExternalDeviceId>sample string 5</ExternalDeviceId>
      <NumberOfCameras>6</NumberOfCameras>
    </CameraDetails>
    <OutputStates>
      <Output0State>true</Output0State>
      <Output0Label>sample string 2</Output0Label>
      <Output1State>true</Output1State>
      <Output1Label>sample string 4</Output1Label>
      <Output2State>true</Output2State>
      <Output2Label>sample string 6</Output2Label>
      <Output3State>true</Output3State>
      <Output3Label>sample string 8</Output3Label>
    </OutputStates>
    <ExternalDeviceTypes>
      <ExternalDeviceType>HD22Camera</ExternalDeviceType>
      <ExternalDeviceType>HD22Camera</ExternalDeviceType>
    </ExternalDeviceTypes>
  </MobileServiceResponse>
</ArrayOfMobileServiceResponse>