Click or drag to resize

TookanGetAllAgentsRequest Class

Add agent request
Inheritance Hierarchy
SystemObject
  NetQuarry.ServicesTookanBaseRequest
    NetQuarry.ServicesTookanGetAllAgentsRequest

Namespace:  NetQuarry.Services
Assembly:  EAP.Core (in EAP.Core.dll) Version: 2.0.0.0 (4.6.8.0)
Syntax
public class TookanGetAllAgentsRequest : TookanBaseRequest

The TookanGetAllAgentsRequest type exposes the following members.

Constructors
  NameDescription
Public methodTookanGetAllAgentsRequest
Initializes a new instance of the TookanGetAllAgentsRequest class
Top
Properties
  NameDescription
Public propertyapi_key
API key
(Inherited from TookanBaseRequest.)
Public propertydistance
This is used to get agents within the radius. This key works with latitude and longitude keys. Distance unit is KM
Public propertyfleet_id
You can pass on the fleet_id to get the data of a single fleet.
Public propertygeofence
This is used to enable the geofencing filter w.r.t to the lat long values.
Public propertyis_available_and_online
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.
Public propertylatitude
You can pass lat long values to get the distance between agent location and this location pointed by the lat long values.
Public propertylongitude
Both lat long values are required if you want distance measurement and/or enable geo-fence filtering of the agents.
Public propertytags
You can pass the tags, comma separated, if you want to filter the list of agents via tags.
Public propertyteam_id
You can pass the team_id, if you want to filter the list of agents via team.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Top
Extension Methods
  NameDescription
Public Extension MethodEqualValue
Determines if the object value is equal to another object. If the two objects are null, then this returns true. There is special handling for guid comparisons (since a guid could be a string formatted in up to 3 different ways). If the special guid handling is not performed, then the object.Equals method is used.
(Defined by EAPUtil.)
Top
See Also