GET api/{version}/Schedules?startDate={startDate}&endDate={endDate}&page={page}&perPage={perPage}&sort={sort}&count={count}&clientId={clientId}

Gets a list of scheduled items, associated to the employee who sent the request, and that match the search filters and parameters (provided in the query string).

Request Information

URI Parameters

NameDescriptionTypeAdditional information
startDate

a search filter; it is any valid date, the operation will return only scheduled items that have a DatePlaned greater or equal at this date.

date

None.

endDate

a search filter; it is any valid date, the operation will return only scheduled items that have a DatePlaned smaller or equal at this date.

date

None.

page

a search filter; it is a valid integer that tell the operation that pagination should be used and that it should only return the scheduled items that are on this page number.

integer

None.

perPage

a search filter; it is a valid integer that will tell the operation to use pagination and that each page should contain this number of scheduled items.

integer

None.

sort

an input parameter; it contains the name of one of the properties in the model to be used to sort the results.

string

None.

count

an input parameter; set it to 1 to include in the response a "TotalCount" header with the total count of elements.

integer

None.

clientId

a search filter; it is any valid client id, the operation will return scheduled items that either are assigned to that client id or to a group to which that client belongs.

integer

None.

version

string

None.

Body Parameters

None.

Response Information

Resource Description

An Http response message with the folliwing status codes: 200 = success (always includes a list of clients; however this list can be empty), 400 = bad request (the request is malformed or with invalid data), 403 = forbidden (the employee or client doing the request is not recognized), 500 = something went wrong (the request was not processed).

Collection of TzPlannerDto
NameDescriptionTypeAdditional information
TimeZone

TimeZoneInfo

None.

DateAndTimePlannedUtc

date

None.

WeekOfTimeUtc

date

None.

PlannerId

integer

None.

EmployeeId

integer

None.

ClientId

integer

None.

WeekOfTime

date

None.

DatePlanned

date

None.

TimePlanned

date

None.

Duration

integer

None.

VisitStatus

string

None.

VisitTypeId

integer

None.

VisitTypeDescription

string

None.

VisitTypeLabel

string

None.

VisitTypeFormId

integer

None.

Note

string

None.

LocationId

integer

None.

LocationDescription

string

None.

LocationCode

string

None.

ProgramId

integer

None.

ProgramDescription

string

None.

ProgramCode

string

None.

GroupId

integer

None.

FormGroupId

integer

None.

FromGroupName

string

None.

PlannerGroupId

integer

None.

PlannerGroupName

string

None.

EmployeeFullName

string

None.

DateAndTimePlanned

date

None.

EvvTransaction

EvvTransaction

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.