Jump to

• Request
• Response

Booking Fields Dependencies

get

/rest/ofscCapacity/v1/bookingFieldsDependencies

The function provides a list of fields and properties that required by showBookingGrid API function to determine parameters of activity that is going to be booked.
It is a GET function without parameters.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

This section describes the 200 status response for this operation.

Body ()

Root Schema : Booking Fields Dependencies

Type: object

Title: Booking Fields Dependencies

The collection of Booking Dependencies. The response contains five arrays of objects that enumerate required fields and properties to determine the appropriate entity.
Each object in the list it is a pair of the label and appropriate API parameter name.
Key Notes

• The same field (e.g., activityType) may appear in multiple sections if it affects different booking aspects (duration, skills, etc.).
• All fields from commonDependencies must always be provided.

Show Source

• commonDependencies: array Common Dependencies
  Title: Common Dependencies

  A list of mandatory activity fields required for the showBookingGrid API function to work under any circumstances. These fields must always be provided.
• durationDependencies: array Duration Dependencies
  Title: Duration Dependencies

  A list of activity fields and properties needed to determine the duration of the booked activity.
• travelTimeDependencies: array Travel Time Dependencies
  Title: Travel Time Dependencies

  A list of activity fields and properties needed to determine the travel time of the booked activity.
• workSkillDependencies: array Work Skill Dependencies
  Title: Work Skill Dependencies

  A list of activity fields and properties needed to determine the work skills of the booked activity (required to match capacity categories and find suitable capacity areas).
• workZoneDependencies: array Work Zone Dependencies
  Title: Work Zone Dependencies

  A list of activity fields and properties needed to determine the work zone of the booked activity (required to find suitable capacity areas).

{
    "title":"Booking Fields Dependencies",
    "description":"The collection of Booking Dependencies. The response contains five arrays of objects that enumerate required fields and properties to determine the appropriate entity. <br />Each object in the list it is a pair of the label and appropriate API parameter name. <br /><strong>Key Notes</strong><ul><li>The same field (e.g., activityType) may appear in multiple sections if it affects different booking aspects (duration, skills, etc.).</li><li>All fields from commonDependencies must always be provided.</li></ul>",
    "type":"object",
    "properties":{
        "commonDependencies":{
            "title":"Common Dependencies",
            "description":"A list of mandatory activity fields required for the showBookingGrid API function to work <strong>under any circumstances</strong>. These fields must always be provided.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/showBookingDependencyItem"
            }
        },
        "durationDependencies":{
            "title":"Duration Dependencies",
            "description":"A list of activity fields and properties needed to determine the duration of the booked activity.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/showBookingDependencyItem"
            }
        },
        "travelTimeDependencies":{
            "title":"Travel Time Dependencies",
            "description":"A list of activity fields and properties needed to determine the travel time of the booked activity.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/showBookingDependencyItem"
            }
        },
        "workZoneDependencies":{
            "title":"Work Zone Dependencies",
            "description":"A list of activity fields and properties needed to determine the work zone of the booked activity (required to find suitable capacity areas).",
            "type":"array",
            "items":{
                "$ref":"#/definitions/showBookingDependencyItem"
            }
        },
        "workSkillDependencies":{
            "title":"Work Skill Dependencies",
            "description":"A list of activity fields and properties needed to determine the work skills of the booked activity (required to match capacity categories and find suitable capacity areas).",
            "type":"array",
            "items":{
                "$ref":"#/definitions/showBookingDependencyItem"
            }
        }
    }
}

Nested Schema : Common Dependencies

Type: array

Title: Common Dependencies

A list of mandatory activity fields required for the showBookingGrid API function to work under any circumstances. These fields must always be provided.

Show Source

• Array of: array showBookingDependencyItem

{
    "title":"Common Dependencies",
    "description":"A list of mandatory activity fields required for the showBookingGrid API function to work <strong>under any circumstances</strong>. These fields must always be provided.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/showBookingDependencyItem"
    }
}

Nested Schema : Duration Dependencies

Type: array

Title: Duration Dependencies

A list of activity fields and properties needed to determine the duration of the booked activity.

Show Source

• Array of: array showBookingDependencyItem

{
    "title":"Duration Dependencies",
    "description":"A list of activity fields and properties needed to determine the duration of the booked activity.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/showBookingDependencyItem"
    }
}

Nested Schema : Travel Time Dependencies

Type: array

Title: Travel Time Dependencies

A list of activity fields and properties needed to determine the travel time of the booked activity.

Show Source

• Array of: array showBookingDependencyItem

{
    "title":"Travel Time Dependencies",
    "description":"A list of activity fields and properties needed to determine the travel time of the booked activity.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/showBookingDependencyItem"
    }
}

Nested Schema : Work Skill Dependencies

Type: array

Title: Work Skill Dependencies

A list of activity fields and properties needed to determine the work skills of the booked activity (required to match capacity categories and find suitable capacity areas).

Show Source

• Array of: array showBookingDependencyItem

{
    "title":"Work Skill Dependencies",
    "description":"A list of activity fields and properties needed to determine the work skills of the booked activity (required to match capacity categories and find suitable capacity areas).",
    "type":"array",
    "items":{
        "$ref":"#/definitions/showBookingDependencyItem"
    }
}

Nested Schema : Work Zone Dependencies

Type: array

Title: Work Zone Dependencies

A list of activity fields and properties needed to determine the work zone of the booked activity (required to find suitable capacity areas).

Show Source

• Array of: array showBookingDependencyItem

{
    "title":"Work Zone Dependencies",
    "description":"A list of activity fields and properties needed to determine the work zone of the booked activity (required to find suitable capacity areas).",
    "type":"array",
    "items":{
        "$ref":"#/definitions/showBookingDependencyItem"
    }
}

Nested Schema : showBookingDependencyItem

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "label":{
                "description":"Internal label",
                "type":"string"
            },
            "apiParameterName":{
                "description":"API parameter name",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• apiParameterName: string
  API parameter name
• label: string
  Internal label

{
    "type":"object",
    "properties":{
        "label":{
            "description":"Internal label",
            "type":"string"
        },
        "apiParameterName":{
            "description":"API parameter name",
            "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