ITookanGetAllAgents Method

TookanGetAllAgentsResponse GetAllAgents(
	Nullable<int> teamId = null,
	Nullable<int> fleetId = null,
	string tags = null,
	Nullable<decimal> latitude = null,
	Nullable<decimal> longitude = null,
	int geofence = 0,
	bool isAvailableAndOnline = false,
	Nullable<decimal> distance = null
)

Function GetAllAgents ( 
	Optional teamId As Nullable(Of Integer) = Nothing,
	Optional fleetId As Nullable(Of Integer) = Nothing,
	Optional tags As String = Nothing,
	Optional latitude As Nullable(Of Decimal) = Nothing,
	Optional longitude As Nullable(Of Decimal) = Nothing,
	Optional geofence As Integer = 0,
	Optional isAvailableAndOnline As Boolean = false,
	Optional distance As Nullable(Of Decimal) = Nothing
) As TookanGetAllAgentsResponse

Parameters

teamId (Optional)

Type: SystemNullableInt32
You can pass the team_id, if you want to filter the list of agents via team.

fleetId (Optional)

Type: SystemNullableInt32
You can pass on the fleet_id to get the data of a single fleet.

tags (Optional)

Type: SystemString
You can pass the tags, comma separated, if you want to filter the list of agents via tags.

latitude (Optional)

Type: SystemNullableDecimal
You can pass lat long values to get the distance between agent location and this location pointed by the lat long values.

longitude (Optional)

Type: SystemNullableDecimal
Both lat long values are required if you want distance measurement and/or enable geo-fence filtering of the agents.

geofence (Optional)

Type: SystemInt32
This is used to enable the geofencing filter w.r.t to the lat long values.

isAvailableAndOnline (Optional)

Type: SystemBoolean
This is used to get only available/online agents. Send "1" to get only available/online agents otherwise send "0" to get all the agents.

distance (Optional)

Type: SystemNullableDecimal
This is used to get agents within the radius. This key works with latitude and longitude keys. Distance unit is KM

Return Value

Reference