Jump to

• Request
• Response

Get a Calendar Event

get

/drivers/{driverGid}/calendarEvents/{driverCalEventGid}

Request

Path Parameters

• driverCalEventGid(required): string
  Resource ID
• 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/vnd.oracle.resource+json;type=singular

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• calEventTypeGid: string
  The type of the calendar event.
• domainName: string
  Database domain where this data is stored.
• driverCalEventGid: string
  The driver calendar event GID.
• driverCalEventXid: string
  The XID for the driver calendar event.
• eventEndTime: eventEndTime
  The end time of the activity for this particular driver and event.
• eventLocationGid: string
  The location where this calendar event is scheduled.
• eventStartTime: eventStartTime
  The Start time of the activity for this particular driver and event.
• links: array links
  Read Only: true

{
    "properties":{
        "driverCalEventGid":{
            "description":"The driver calendar event GID.",
            "type":"string"
        },
        "driverCalEventXid":{
            "description":"The XID for the driver calendar event.",
            "type":"string"
        },
        "eventStartTime":{
            "description":"The Start time of the activity for this particular driver and event.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "eventEndTime":{
            "description":"The end time of the activity for this particular driver and event.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "eventLocationGid":{
            "description":"The location where this calendar event is scheduled.",
            "type":"string"
        },
        "calEventTypeGid":{
            "description":"The type of the calendar event.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : eventEndTime

The end time of the activity for this particular driver and event.

Match All

Show Source

• object dateTimeType

{
    "description":"The end time of the activity for this particular driver and event.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : eventStartTime

The Start time of the activity for this particular driver and event.

Match All

Show Source

• object dateTimeType

{
    "description":"The Start time of the activity for this particular driver and event.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : dateTimeType

Type: object

Show Source

• timezone: string
  Timezone in Olson database format
• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        },
        "timezone":{
            "description":"Timezone in Olson database format",
            "type":"string"
        }
    }
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Back to Top