Jump to

• Request
• Response

Get a Calendar

get

/locations/{locationGid}/roleProfiles/{locationRoleGid}/calendars/{locationRoleProfCalSeq}

Request

Path Parameters

• locationGid(required): string
  Resource ID
• locationRoleGid(required): string
  Resource ID
• locationRoleProfCalSeq(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

• calendarGid: string
  The GID for the calendar entry associated with each row of the location role profile calendar entry.
• domainName: string
  Database domain where this data is stored.
• flexCommodityProfileGid: string
  The GID for the flex commodity profile. Used to specify when commodity specific activities can occur at the location.
• inboundLocationProfileGid: string
  The GID for the inbound location profile. Used to specify when shipments from locations in the inbound location profile can be received at the location.
• links: array links
  Read Only: true
• locationRoleProfCalSeq: number (int32)
  The internal sequence number for the location role profile calendar combination.
• modeProfileGid: string
  The GID for the mode profile. Used to specify when shipments of a certain mode can be shipped or received from the location.
• outboundLocationProfileGid: string
  The GID for the outbound location profile. Used to specify when shipments to locations in the outbound location profile can be shipped to.

{
    "properties":{
        "locationRoleProfCalSeq":{
            "description":"The internal sequence number for the location role profile calendar combination.",
            "type":"number",
            "format":"int32"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "flexCommodityProfileGid":{
            "description":"The GID for the flex commodity profile. Used to specify when commodity specific activities can occur at the location.",
            "type":"string"
        },
        "inboundLocationProfileGid":{
            "description":"The GID for the inbound location profile. Used to specify when shipments from locations in the inbound location profile can be received at the location.",
            "type":"string"
        },
        "outboundLocationProfileGid":{
            "description":"The GID for the outbound location profile. Used to specify when shipments to locations in the outbound location profile can be shipped to.",
            "type":"string"
        },
        "calendarGid":{
            "description":"The GID for the calendar entry associated with each row of the location role profile calendar entry.",
            "type":"string"
        },
        "modeProfileGid":{
            "description":"The GID for the mode profile. Used to specify when shipments of a certain mode can be shipped or received from the location.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

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

Type: object

Show Source

• href: string
• rel: string

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

Back to Top