Rosters - Visualcare Support Centre

GET /rosters

Default limit is 200 items. Maximum limit is 20,000. If you exceed the maximum, the API reverts to the default.

Example: GET /rosters?fromDate=2018-02-19&toDate=2018-02-20&page=0&limit=100 Parameter names are case-sensitive: Limit, Page, CarerId and similar spellings are silently ignored. Query parameters:

Parameter	Default	Description
`limit`	200	Default 200, max 20,000
`page`	0	Pagination offset
`fromDate`	-	Roster items with `DateOfService` >= value. Format: `YYYY-MM-DD`
`toDate`	-	Roster items with `DateOfService` <= value. Format: `YYYY-MM-DD`
`createdTimeFrom`	-	Roster items with `CreatedTime` >= value. Format: `YYYY-MM-DD`
`createdTimeTo`	-	Roster items with `CreatedTime` <= value. Format: `YYYY-MM-DD`
`rosterItemId`	-	Filter by roster item ID
`clientId`	-	Filter by client ID
`carerId`	-	Filter by carer ID
`serviceId`	-	Filter by service ID
`includeNotes`	-	If `TRUE`, adds a `Notes` array to each roster item
`onHoldType`	-	Filter by a specific hold type value, for example `LEAVE-HOS`. The value is matched literally, so `ALL` returns no rows

Response fields:

Field	Type	Notes
`RosterItemId`	integer
`RosterMasterId`	integer	Links to `MasterId` in `/roster-master`
`ClientId`	integer
`CarerId`	integer	`-1` when unallocated
`PayerId`	integer
`ServiceId`	integer
`LocationId`	integer	`-1` when not set
`CategoryId`	integer	`-1` when not set
`DateOfService`	string	Date
`StartTime`	string	Time
`Minutes`	integer
`ChargeRate`	number	Decimal
`PayRate`	number	Decimal
`FixedFee`	integer
`HasBreak`	integer	0/1
`BreakStartTime1`	string	Time
`BreakMinutes1`	integer
`BreakMinutes2`	integer
`OrderNumber`	string
`RecurrenceId`	integer
`RecurrenceStart`	string	Date
`RecurrenceEnd`	string	Date
`RecurrenceType`	string	for example `"UNTIL"`
`OccurenceDays`	string	for example `"TU,TH,SU"`
`OccurenceCount`	integer
`OccurencePeriodic`	string	for example `"WEEKLY"`
`OccurenceInterval`	integer
`OnHoldType`	string
`OnHoldNote`	string
`OnHoldCode`	string
`OnHoldChargePer`	integer
`OnHoldPayMinutes`	integer
`OnHoldDateTime`	string	Datetime. `0000-00-00 00:00:00` when not set
`TimeSheetId`	integer
`AgreementId`	integer
`AgreementItemId`	integer
`DEXCaseId`	integer
`DEXServiceTypeId`	integer
`APP_StartTime`	string	Datetime
`APP_FinishTime`	string	Datetime
`APP_LastLongtitude`	string
`APP_LastLatitude`	string
`LastModified`	string	Datetime
`LastModifiedBy`	string	Email
`LastModifiedType`	string	for example `"UNALLOCATE A SHIFT"`
`CreatedTime`	string	Datetime
`CreatedBy`	string	Email
`Notes`	array	Only when `includeNotes=TRUE`. Objects of `{ RosterItemId, NoteId, CategoryId, Note, NoteType, Timestamp }`

GET /roster-master

Returns all roster master records that have not been flagged as deleted. MasterId links to RosterMasterId in the roster items endpoint above. Query parameters: None. This endpoint is not paginated and returns every roster master in one response; limit, carerId and clientId are ignored. Response fields:

Field	Type	Notes
`MasterId`	integer
`ClientId`	integer
`LocationId`	integer
`RosterId`	string
`Reference`	string
`Complete`	integer	0/1
`DefaultServiceId`	integer
`DefaultDateOfService`	string	Date
`IsDraft`	integer	0/1
`RosterTimeZone`	string	for example `"Adelaide"`
`Type`	string	for example `"TRAN"`, `"SC"` or empty
`CategoryId`	integer
`LimitBookingsPeriod`	integer
`VisibleOnline`	integer	0/1
`Status`	string

⌘I