GET api/group/basicapplicantheatmap?pageSize={pageSize}

Return the lat and longs for every applicant in the system Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
RangeFrom

The range from, expressed as a date and time.

date

None.

RangeTo

The range to, expressed as a date and time.

date

None.

BranchId

The unique identifier of the related branch resource.

integer

None.

RoleTypes

The collection of role types.

Collection of string

None.

pageSize

The page size value supplied with the request.

integer

Default value is 3

Body Parameters

None.

Response Information

Resource Description

The response returned after the operation completes.

Collection of HeatMapDataContract
NameDescriptionTypeAdditional information
Latitude

The latitude value.

decimal number

None.

Longitude

The longitude value.

decimal number

None.

Weight

The weight value.

decimal number

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Latitude": 1.1,
    "Longitude": 2.1,
    "Weight": 3.1
  },
  {
    "Latitude": 1.1,
    "Longitude": 2.1,
    "Weight": 3.1
  }
]