Get Calendars
get
/drivers/{driverGid}/calendars
Request
Path Parameters
-
driverGid(required): string
Resource ID
Query Parameters
-
expand: string
Comma-delimited string of child resource names that you want to expand so that the contents return with the parent in the same GET request.
-
fields: string
Comma-delimited string of field names that you wanted returned in a GET request.
-
limit: integer(int32)
Positive integer value that specifies the maximum number of items returned by the server.
-
offset: integer(int32)
Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.
-
orderBy: string
Comma-separated string of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
-
q: string
Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.
-
totalResults: boolean
Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/vnd.oracle.resource+json;type=collection
Default Response
Default Response.
Nested Schema : drivers.calendars
Type:
Show Source
object
-
activityCalendarGid: string
The activity calendar of the driver defined for this work profile.
-
domainName: string
Database domain where this data is stored.
-
effectiveDate:
effectiveDate
The effective date for this driver work profile.
-
expiryDate:
expiryDate
The expiry date for this driver work profile.
-
homeLocationGid: string
The home location of the driver defined for this work profile.
-
isShiftBased: string
Allows you to select whether the work profile for the driver is Shift Based or not. If you set this to Yes, then the work profile is evaluated when you try and get the driver home. The driver will be sent home at the end of each shift, and they will start from their home location for their next assignment.
-
links: array
links
Read Only:
true
Nested Schema : effectiveDate
The effective date for this driver work profile.
Match All
Show Source