Jump to

• Request
• Response
• Examples

Get booking closing schedule

get

/rest/ofscCapacity/v1/bookingClosingSchedule

This operation returns a booking closing schedule for one or more capacity areas.

Request

Query Parameters

• areas(required): array[string]
  Collection Format: csv

  The labels of the capacity areas or the capacity area groups.

Back to Top

Response

Supported Media Types

• application/json
• application/schema+json

200 Response

This section describes the 200 status response for this operation.

Body ()

Root Schema : bookingClosingScheduleList

Type: object

The collection of closing schedules for bookings.

Show Source

• items: array items

{
    "description":"The collection of closing schedules for bookings.",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/bookingClosingSchedule"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Booking Closing Schedule
  Title: Booking Closing Schedule

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/bookingClosingSchedule"
    }
}

Nested Schema : Booking Closing Schedule

Type: object

Title: Booking Closing Schedule

Show Source

• area: string
  Title: Area

  Minimum Length: 1

  Maximum Length: 40

  The label of the area from which the booking is closed.
• category: string
  Title: Category

  The label of the capacity category for which the booking is closed. If this field is not returned, then the bookings for all categories are closed.
• closeTime: string
  Title: Close Time

  The time at which the booking is closed. This time corresponds to the timezone of the capacity area.
• dayOffset: integer
  Title: Day Offset

  Minimum Value: 1

  Maximum Value: 255

  The offset determines the day on which the booking is closed. For example, if "1" is returned, then the booking for tomorrow is closed today.
• endTime: string
  Title: End Time

  The end time of the booking closing schedule. [:] Valid values for hours: [0 to 48]. The dash sign after 24, for example, 24 - represents overnight work. Minutes are optional. Valid values for minutes: [0 to 59].
• startTime: string
  Title: Start Time

  The start time of the booking closing schedule. If Start Time and End Time values are not returned, then it means that the bookings are closed for the entire day. This operation checks if a specified time interval is supported or configured for the area. The intervals that are not currently configured are not returned, even if the database contains such records.
• workZone: string
  Title: Work Zone

  The label of the work zone from which the booking is closed. If this field is not returned, then the bookings are closed for all work zones (even if a particular work zone does not have its own close time).

{
    "type":"object",
    "title":"Booking Closing Schedule",
    "properties":{
        "area":{
            "type":"string",
            "minLength":"1",
            "maxLength":"40",
            "title":"Area",
            "description":"The label of the area from which the booking is closed."
        },
        "dayOffset":{
            "type":"integer",
            "minimum":"1",
            "maximum":"255",
            "title":"Day Offset",
            "description":"The offset determines the day on which the booking is closed. For example, if \"1\" is returned, then the booking for tomorrow is closed today."
        },
        "category":{
            "type":"string",
            "title":"Category",
            "description":"The label of the capacity category for which the booking is closed. If this field is not returned, then the bookings for all categories are closed."
        },
        "workZone":{
            "type":"string",
            "title":"Work Zone",
            "description":"The label of the work zone from which the booking is closed. If this field is not returned, then the bookings are closed for all work zones (even if a particular work zone does not have its own close time)."
        },
        "startTime":{
            "type":"string",
            "title":"Start Time",
            "description":"The start time of the booking closing schedule. If Start Time and End Time values are not returned, then it means that the bookings are closed for the entire day. This operation checks if a specified time interval is supported or configured for the area. The intervals that are not currently configured are not returned, even if the database contains such records."
        },
        "endTime":{
            "type":"string",
            "title":"End Time",
            "description":"The end time of the booking closing schedule.\n<hours>[:<minutes>]\n Valid values for hours: [0 to 48]. The dash sign after 24, for example, 24 - represents overnight work. Minutes are optional. Valid values for minutes: [0 to 59]."
        },
        "closeTime":{
            "type":"string",
            "title":"Close Time",
            "description":"The time at which the booking is closed. This time corresponds to the timezone of the capacity area."
        }
    }
}

Default Response

This section describes the default error response for this operation.

Body ()

Root Schema : Error

Type: object

Show Source

• detail: string
  The detailed description of this error.
• status: string
  The HTTP status code of this error.
• title(required): string
  The brief description of this error.
• type(required): string
  The URL of the web page containing more details about this error.

{
    "properties":{
        "type":{
            "type":"string",
            "description":"The URL of the web page containing more details about this error."
        },
        "title":{
            "type":"string",
            "description":"The brief description of this error."
        },
        "status":{
            "type":"string",
            "description":"The HTTP status code of this error."
        },
        "detail":{
            "type":"string",
            "description":"The detailed description of this error."
        }
    },
    "required":[
        "type",
        "title"
    ]
}

Back to Top

Examples

The following example shows how to get the booking closing schedule by submitting a GET request on the REST resource.

Example of Request Header

The following shows an example of the request header.

GET /rest/ofscCapacity/v1/bookingClosingSchedule?areas=CapacityArea
Connection: close
Accept-Encoding: gzip,deflate
Authorization: Basic bXlyb290QHFhNTUwMzox
Host: <instance_name>.fs.ocs.oraclecloud.com
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Server: nginx
Date: Wed, 23 Aug 2017 12:34:00 GMT
Content-Type: application/json; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Access-Control-Allow-Credentials: true
Strict-Transport-Security: max-age=31536000; includeSubDomains;

Example of Response Body

The following example shows the contents of the response body in JSON format.

{"items": [
      {
      "area": "CapacityArea",
      "category": "TC",
      "startTime": "12:00",
      "endTime": "18:00",
      "closeTime": "09:00:00"
   },
      {
      "area": "CapacityArea",
      "dayOffset": 1,
      "category": "DI",
      "closeTime": "21:00:00"
   },
      {
      "area": "CapacityArea",
      "dayOffset": 1,
      "category": "TC",
      "startTime": "8:00",
      "endTime": "12:00",
      "closeTime": "21:00:00"
   }
]}

Back to Top