Jump to

• Request
• Response

Create a Driver Commercial Drivers License

post

/drivers/{driverGid}/driverCdls

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.driverCdls"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

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

Nested Schema : schema

Type: object

Show Source

• cdlClass: string
  The commercial driving license class type.
• cdlExpDate: cdlExpDate
  The expiration date of the commercial driving license.
• cdlIssueCountryGid: string
  The country which issued the commercial driving license.
• cdlIssueState: string
  The state that issued the commercial driving license.
• cdlNum: string
  The unique commercial driving license number.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "cdlNum":{
            "description":"The unique commercial driving license number.",
            "type":"string"
        },
        "cdlClass":{
            "description":"The commercial driving license class type.",
            "type":"string"
        },
        "cdlIssueState":{
            "description":"The state that issued the commercial driving license.",
            "type":"string"
        },
        "cdlIssueCountryGid":{
            "description":"The country which issued the commercial driving license.",
            "type":"string"
        },
        "cdlExpDate":{
            "description":"The expiration date of the commercial driving license.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : cdlExpDate

The expiration date of the commercial driving license.

Match All

The expiration date of the commercial driving license.

Show Source

• object dateType

{
    "description":"The expiration date of the commercial driving license.",
    "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

• cdlClass: string
  The commercial driving license class type.
• cdlExpDate: cdlExpDate
  The expiration date of the commercial driving license.
• cdlIssueCountryGid: string
  The country which issued the commercial driving license.
• cdlIssueState: string
  The state that issued the commercial driving license.
• cdlNum: string
  The unique commercial driving license number.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "cdlNum":{
            "description":"The unique commercial driving license number.",
            "type":"string"
        },
        "cdlClass":{
            "description":"The commercial driving license class type.",
            "type":"string"
        },
        "cdlIssueState":{
            "description":"The state that issued the commercial driving license.",
            "type":"string"
        },
        "cdlIssueCountryGid":{
            "description":"The country which issued the commercial driving license.",
            "type":"string"
        },
        "cdlExpDate":{
            "description":"The expiration date of the commercial driving license.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : cdlExpDate

The expiration date of the commercial driving license.

Match All

The expiration date of the commercial driving license.

Show Source

• object dateType

{
    "description":"The expiration date of the commercial driving license.",
    "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

• cdlClass: string
  The commercial driving license class type.
• cdlExpDate: cdlExpDate
  The expiration date of the commercial driving license.
• cdlIssueCountryGid: string
  The country which issued the commercial driving license.
• cdlIssueState: string
  The state that issued the commercial driving license.
• cdlNum: string
  The unique commercial driving license number.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "cdlNum":{
            "description":"The unique commercial driving license number.",
            "type":"string"
        },
        "cdlClass":{
            "description":"The commercial driving license class type.",
            "type":"string"
        },
        "cdlIssueState":{
            "description":"The state that issued the commercial driving license.",
            "type":"string"
        },
        "cdlIssueCountryGid":{
            "description":"The country which issued the commercial driving license.",
            "type":"string"
        },
        "cdlExpDate":{
            "description":"The expiration date of the commercial driving license.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : cdlExpDate

The expiration date of the commercial driving license.

Match All

The expiration date of the commercial driving license.

Show Source

• object dateType

{
    "description":"The expiration date of the commercial driving license.",
    "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