Jump to

• Request
• Response
• Examples

Get booking statuses

get

/rest/ofscCapacity/v1/bookingStatuses

This operation retrieves a collection of booking statuses for the specified dates and capacity areas.

Request

Query Parameters

• areas: array[string]
  Collection Format: csv

  The label of the capacity area.
• dates(required): string
  The dates for which the booking statuses must be retrieved. The date is specified in YYYY-MM-DD format.

Back to Top

Response

Supported Media Types

• application/schema+json
• application/json

200 Response

This section describes the 200 status response for this operation.

Body ()

Root Schema : Booking Status List

Type: object

Title: Booking Status List

The collection of booking statuses.

Show Source

• items: array Items
  Title: Items

  The list of booking statuses.

{
    "title":"Booking Status List",
    "description":"The collection of booking statuses.",
    "properties":{
        "items":{
            "type":"array",
            "title":"Items",
            "description":"The list of booking statuses.",
            "items":{
                "$ref":"#/definitions/bookingStatus"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The list of booking statuses.

Show Source

• Array of: object Booking Status
  Title: Booking Status

  An array of booking statuses.

{
    "type":"array",
    "title":"Items",
    "description":"The list of booking statuses.",
    "items":{
        "$ref":"#/definitions/bookingStatus"
    }
}

Nested Schema : Booking Status

Type: object

Title: Booking Status

An array of booking statuses.

Show Source

• area: string
  Title: Area

  Minimum Length: 1

  Maximum Length: 40

  The label of the capacity area specified in the request.
• date: string(date)
  Title: Date

  The date specified in the request.

  Example: 2016-07-22
• statuses: array Statuses
  Title: Statuses

  The list of statuses.

{
    "type":"object",
    "title":"Booking Status",
    "description":"An array of booking statuses.",
    "properties":{
        "date":{
            "type":"string",
            "format":"date",
            "example":"2016-07-22",
            "title":"Date",
            "description":"The date specified in the request."
        },
        "area":{
            "description":"The label of the capacity area specified in the request.",
            "type":"string",
            "minLength":1,
            "maxLength":40,
            "title":"Area"
        },
        "statuses":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "category":{
                        "title":"Category",
                        "description":"The label of the capacity category.",
                        "type":"string"
                    },
                    "workZone":{
                        "title":"Work Zone",
                        "description":"The label of the work zone.",
                        "type":"string"
                    },
                    "timeFrom":{
                        "title":"Time From",
                        "description":"The start time in HH:MM format from where the booking should be closed. By default, start time of the day.",
                        "type":"string"
                    },
                    "timeTo":{
                        "title":"Time To",
                        "description":"The end time in HH:MM format until where the booking should be closed. By default, end time of the day.",
                        "type":"string"
                    },
                    "bookingStatus":{
                        "title":"Booking Status",
                        "description":"The booking status of an item.",
                        "type":"object",
                        "properties":{
                            "state":{
                                "title":"State",
                                "description":"The state of the booking status.",
                                "type":"string",
                                "enum":[
                                    "open",
                                    "closed"
                                ]
                            },
                            "scheduledCloseTime":{
                                "title":"Scheduled Close Time",
                                "description":"The scheduled date and time when the booking closes. For example, 2016-10-30 11:00:00.",
                                "type":"string"
                            },
                            "closedAt":{
                                "title":"Closed At",
                                "description":"The date and time when the booking was closed (manually or by a closing condition).",
                                "type":"string"
                            }
                        }
                    }
                }
            },
            "title":"Statuses",
            "description":"The list of statuses."
        }
    }
}

Nested Schema : Statuses

Type: array

Title: Statuses

The list of statuses.

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "category":{
                "title":"Category",
                "description":"The label of the capacity category.",
                "type":"string"
            },
            "workZone":{
                "title":"Work Zone",
                "description":"The label of the work zone.",
                "type":"string"
            },
            "timeFrom":{
                "title":"Time From",
                "description":"The start time in HH:MM format from where the booking should be closed. By default, start time of the day.",
                "type":"string"
            },
            "timeTo":{
                "title":"Time To",
                "description":"The end time in HH:MM format until where the booking should be closed. By default, end time of the day.",
                "type":"string"
            },
            "bookingStatus":{
                "title":"Booking Status",
                "description":"The booking status of an item.",
                "type":"object",
                "properties":{
                    "state":{
                        "title":"State",
                        "description":"The state of the booking status.",
                        "type":"string",
                        "enum":[
                            "open",
                            "closed"
                        ]
                    },
                    "scheduledCloseTime":{
                        "title":"Scheduled Close Time",
                        "description":"The scheduled date and time when the booking closes. For example, 2016-10-30 11:00:00.",
                        "type":"string"
                    },
                    "closedAt":{
                        "title":"Closed At",
                        "description":"The date and time when the booking was closed (manually or by a closing condition).",
                        "type":"string"
                    }
                }
            }
        }
    },
    "title":"Statuses",
    "description":"The list of statuses."
}

Nested Schema : items

Type: object

Show Source

• bookingStatus: object Booking Status
  Title: Booking Status

  The booking status of an item.
• category: string
  Title: Category

  The label of the capacity category.
• timeFrom: string
  Title: Time From

  The start time in HH:MM format from where the booking should be closed. By default, start time of the day.
• timeTo: string
  Title: Time To

  The end time in HH:MM format until where the booking should be closed. By default, end time of the day.
• workZone: string
  Title: Work Zone

  The label of the work zone.

{
    "type":"object",
    "properties":{
        "category":{
            "title":"Category",
            "description":"The label of the capacity category.",
            "type":"string"
        },
        "workZone":{
            "title":"Work Zone",
            "description":"The label of the work zone.",
            "type":"string"
        },
        "timeFrom":{
            "title":"Time From",
            "description":"The start time in HH:MM format from where the booking should be closed. By default, start time of the day.",
            "type":"string"
        },
        "timeTo":{
            "title":"Time To",
            "description":"The end time in HH:MM format until where the booking should be closed. By default, end time of the day.",
            "type":"string"
        },
        "bookingStatus":{
            "title":"Booking Status",
            "description":"The booking status of an item.",
            "type":"object",
            "properties":{
                "state":{
                    "title":"State",
                    "description":"The state of the booking status.",
                    "type":"string",
                    "enum":[
                        "open",
                        "closed"
                    ]
                },
                "scheduledCloseTime":{
                    "title":"Scheduled Close Time",
                    "description":"The scheduled date and time when the booking closes. For example, 2016-10-30 11:00:00.",
                    "type":"string"
                },
                "closedAt":{
                    "title":"Closed At",
                    "description":"The date and time when the booking was closed (manually or by a closing condition).",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : Booking Status

Type: object

Title: Booking Status

The booking status of an item.

Show Source

• closedAt: string
  Title: Closed At

  The date and time when the booking was closed (manually or by a closing condition).
• scheduledCloseTime: string
  Title: Scheduled Close Time

  The scheduled date and time when the booking closes. For example, 2016-10-30 11:00:00.
• state: string
  Title: State

  Allowed Values: [ "open", "closed" ]

  The state of the booking status.

{
    "title":"Booking Status",
    "description":"The booking status of an item.",
    "type":"object",
    "properties":{
        "state":{
            "title":"State",
            "description":"The state of the booking status.",
            "type":"string",
            "enum":[
                "open",
                "closed"
            ]
        },
        "scheduledCloseTime":{
            "title":"Scheduled Close Time",
            "description":"The scheduled date and time when the booking closes. For example, 2016-10-30 11:00:00.",
            "type":"string"
        },
        "closedAt":{
            "title":"Closed At",
            "description":"The date and time when the booking was closed (manually or by a closing condition).",
            "type":"string"
        }
    }
}

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 statuses 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/bookingStatuses?dates=2017-08-23&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:51:13 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": [{
   "date": "2017-08-23",
   "area": "CapacityArea",
   "statuses":    [
      {"bookingStatus": {"state": "open"}},
            {
         "category": "IN",
         "bookingStatus": {"state": "open"}
      },
            {
         "category": "TC",
         "bookingStatus":          {
            "state": "closed",
            "closedAt": "2017-08-23 09:00:47"
         }
      },
            {
         "category": "DI",
         "bookingStatus":          {
            "state": "closed",
            "closedAt": "2017-08-16 05:29:01"
         }
      },
            {
         "bookingStatus": {"state": "open"},
         "timeFrom": "12:00",
         "timeTo": "18:00"
      },
            {
         "bookingStatus": {"state": "open"},
         "timeFrom": "08:00",
         "timeTo": "12:00"
      },
            {
         "category": "IN",
         "bookingStatus": {"state": "open"},
         "timeFrom": "12:00",
         "timeTo": "18:00"
      },
            {
         "category": "IN",
         "bookingStatus": {"state": "open"},
         "timeFrom": "08:00",
         "timeTo": "12:00"
      },
            {
         "category": "TC",
         "bookingStatus": {"state": "open"},
         "timeFrom": "12:00",
         "timeTo": "18:00"
      },
            {
         "category": "TC",
         "bookingStatus": {"state": "open"},
         "timeFrom": "08:00",
         "timeTo": "12:00"
      },
            {
         "category": "DI",
         "bookingStatus": {"state": "open"},
         "timeFrom": "12:00",
         "timeTo": "18:00"
      },
            {
         "category": "DI",
         "bookingStatus": {"state": "open"},
         "timeFrom": "08:00",
         "timeTo": "12:00"
      }
   ]
}]}

Back to Top