GET Applicator/GetApplicator?applicatorID={applicatorID}&locationIDFilter={locationIDFilter}

Returns a list of Applicators and the information available for each.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
applicatorID

The ID of the Applicator to return the full information for. (optional)

string

Default value is string.Empty

locationIDFilter

The Location ID Filter for the list of Applicators. (optional)

string

Default value is All

Body Parameters

Response Information

Resource Description

Returns a list of Applicators and the information available for each.

AgvApplicator
NameDescriptionTypeAdditional Information
Status

Status of the API call.

string
Message

Message of the API call.

string
Count

Count of how many ClsApplicator JSON dictionaries.

string
ApplicatorList

JSON dictionary of Applicators

Collection of ClsApplicator

Response Formats

application/json, text/json

Sample:
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "2",
  "ApplicatorList": [
    {
      "ID": "sample string 4",
      "FirstName": "sample string 6",
      "LastName": "sample string 7",
      "Address1": "sample string 8",
      "Address2": "sample string 9",
      "City": "sample string 10",
      "State": "sample string 11",
      "Zip": "sample string 12",
      "Phone": "sample string 13",
      "Phone2": "sample string 14",
      "BirthDate": "2022-12-08T02:55:34.5316134+00:00",
      "ApplicatorLicenseNumber": "sample string 15",
      "ApplicatorLicenseNumberExpirationDate": "2022-12-08T02:55:34.5316134+00:00",
      "LastDrugTestDate": "2022-12-08T02:55:34.5316134+00:00",
      "LastPhysicalDate": "2022-12-08T02:55:34.5316134+00:00",
      "CDLLicenseNumber": "sample string 16",
      "CDLLicenseNumberExpirationDate": "2022-12-08T02:55:34.5316134+00:00",
      "Comments": "sample string 17",
      "DriverType": "sample string 18",
      "EmailAddress": "sample string 19",
      "Inactive": true,
      "LocationID": "sample string 21",
      "DivisionType": 0,
      "DivisionTypeAsString": "All"
    },
    {
      "ID": "sample string 4",
      "FirstName": "sample string 6",
      "LastName": "sample string 7",
      "Address1": "sample string 8",
      "Address2": "sample string 9",
      "City": "sample string 10",
      "State": "sample string 11",
      "Zip": "sample string 12",
      "Phone": "sample string 13",
      "Phone2": "sample string 14",
      "BirthDate": "2022-12-08T02:55:34.5316134+00:00",
      "ApplicatorLicenseNumber": "sample string 15",
      "ApplicatorLicenseNumberExpirationDate": "2022-12-08T02:55:34.5316134+00:00",
      "LastDrugTestDate": "2022-12-08T02:55:34.5316134+00:00",
      "LastPhysicalDate": "2022-12-08T02:55:34.5316134+00:00",
      "CDLLicenseNumber": "sample string 16",
      "CDLLicenseNumberExpirationDate": "2022-12-08T02:55:34.5316134+00:00",
      "Comments": "sample string 17",
      "DriverType": "sample string 18",
      "EmailAddress": "sample string 19",
      "Inactive": true,
      "LocationID": "sample string 21",
      "DivisionType": 0,
      "DivisionTypeAsString": "All"
    }
  ]
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: No set method for property 'DivisionTypeAsString' in type 'SSI.AgDrv.ClsApplicator'.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: No set method for property 'DivisionTypeAsString' in type 'SSI.AgDrv.ClsApplicator'.