Jump to

• Request
• Response

Create a Calendar

post

/drivers/{driverGid}/calendars

Request

Path Parameters

• driverGid(required): string
  Resource ID

Supported Media Types

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

Request Body - application/vnd.oracle.resource+json;type=collection ()

Root Schema : schema

Type: object

Show Source

• items(required): array items

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/drivers.calendars"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/drivers.calendars"
    }
}

Nested Schema : schema

Type: object

Show Source

• 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

{
    "properties":{
        "homeLocationGid":{
            "description":"The home location of the driver defined for this work profile.",
            "type":"string"
        },
        "activityCalendarGid":{
            "description":"The activity calendar of the driver defined for this work profile.",
            "type":"string"
        },
        "effectiveDate":{
            "description":"The effective date for this driver work profile.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expiryDate":{
            "description":"The expiry date for this driver work profile.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "isShiftBased":{
            "description":"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.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

The effective date for this driver work profile.

Match All

Show Source

• object dateType

{
    "description":"The effective date for this driver work profile.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expiryDate

The expiry date for this driver work profile.

Match All

Show Source

• object dateType

{
    "description":"The expiry date for this driver work profile.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

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 : dateType

Type: object

Show Source

• value: string (date-time)
  Date in ISO 8601 format

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

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

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

Request Body - application/vnd.oracle.resource+json;type=singular ()

Root Schema : schema

Type: object

Show Source

• 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

{
    "properties":{
        "homeLocationGid":{
            "description":"The home location of the driver defined for this work profile.",
            "type":"string"
        },
        "activityCalendarGid":{
            "description":"The activity calendar of the driver defined for this work profile.",
            "type":"string"
        },
        "effectiveDate":{
            "description":"The effective date for this driver work profile.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expiryDate":{
            "description":"The expiry date for this driver work profile.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "isShiftBased":{
            "description":"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.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

The effective date for this driver work profile.

Match All

Show Source

• object dateType

{
    "description":"The effective date for this driver work profile.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expiryDate

The expiry date for this driver work profile.

Match All

Show Source

• object dateType

{
    "description":"The expiry date for this driver work profile.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

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 : dateType

Type: object

Show Source

• value: string (date-time)
  Date in ISO 8601 format

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

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

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

Back to Top

Response

Supported Media Types

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

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• 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

{
    "properties":{
        "homeLocationGid":{
            "description":"The home location of the driver defined for this work profile.",
            "type":"string"
        },
        "activityCalendarGid":{
            "description":"The activity calendar of the driver defined for this work profile.",
            "type":"string"
        },
        "effectiveDate":{
            "description":"The effective date for this driver work profile.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expiryDate":{
            "description":"The expiry date for this driver work profile.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "isShiftBased":{
            "description":"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.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

The effective date for this driver work profile.

Match All

Show Source

• object dateType

{
    "description":"The effective date for this driver work profile.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expiryDate

The expiry date for this driver work profile.

Match All

Show Source

• object dateType

{
    "description":"The expiry date for this driver work profile.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

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 : dateType

Type: object

Show Source

• value: string (date-time)
  Date in ISO 8601 format

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

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

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

Back to Top