Jump to

• Request
• Response

Retrieve list of profile search template reservation status

get

/spms/v1/profileSearchReservationStatus

This is to retrieve a list of profile search template reservation status

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : List of profile search reservation status

Type: object

Title: List of profile search reservation status

List of profile search reservation status

Show Source

• count: number
  The total number of items in the list.

  Example: 1
• hasMore: boolean
  Flag which indicates whether or not there are more items.

  Example: false
• items: array items
• limit: number
  Paging limit

  Example: 5
• offset: number
  Paging offset

  Example: 10

{
    "title":"List of profile search reservation status",
    "description":"List of profile search reservation status",
    "type":"object",
    "properties":{
        "count":{
            "description":"The total number of items in the list.",
            "type":"number",
            "example":"1"
        },
        "hasMore":{
            "description":"Flag which indicates whether or not there are more items.",
            "type":"boolean",
            "example":false
        },
        "items":{
            "type":"array",
            "items":{
                "properties":{
                    "links":{
                        "type":"array",
                        "items":{
                            "allOf":[
                                {
                                    "$ref":"#/definitions/linksHeader"
                                }
                            ],
                            "example":{
                                "rel":"self",
                                "href":"http://hostname/spms/v1/profileSearchReservationStatus/1",
                                "method":"get",
                                "operationId":"findByID"
                            }
                        }
                    },
                    "item":{
                        "allOf":[
                            {
                                "$ref":"#/definitions/reservationStatusDetails"
                            }
                        ]
                    }
                }
            }
        },
        "limit":{
            "description":"Paging limit",
            "type":"number",
            "example":"5"
        },
        "offset":{
            "description":"Paging offset",
            "type":"number",
            "example":"10"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "properties":{
            "links":{
                "type":"array",
                "items":{
                    "allOf":[
                        {
                            "$ref":"#/definitions/linksHeader"
                        }
                    ],
                    "example":{
                        "rel":"self",
                        "href":"http://hostname/spms/v1/profileSearchReservationStatus/1",
                        "method":"get",
                        "operationId":"findByID"
                    }
                }
            },
            "item":{
                "allOf":[
                    {
                        "$ref":"#/definitions/reservationStatusDetails"
                    }
                ]
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• item: item
• links: array links

{
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/linksHeader"
                    }
                ],
                "example":{
                    "rel":"self",
                    "href":"http://hostname/spms/v1/profileSearchReservationStatus/1",
                    "method":"get",
                    "operationId":"findByID"
                }
            }
        },
        "item":{
            "allOf":[
                {
                    "$ref":"#/definitions/reservationStatusDetails"
                }
            ]
        }
    }
}

Nested Schema : item

Match All

Show Source

• object reservationStatusDetails
  Reservation status details

{
    "allOf":[
        {
            "$ref":"#/definitions/reservationStatusDetails"
        }
    ]
}

Nested Schema : links

Type: array

Show Source

• Array of: items

{
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/linksHeader"
            }
        ],
        "example":{
            "rel":"self",
            "href":"http://hostname/spms/v1/profileSearchReservationStatus/1",
            "method":"get",
            "operationId":"findByID"
        }
    }
}

Nested Schema : reservationStatusDetails

Type: object

Reservation status details

Show Source

• description: string
  This is the profile search reservation status description

  Example: Reservation
• id: integer
  This is the profile search reservation status id

  Example: 1
• status: string
  This is the profile search reservation status

  Example: RR

{
    "description":"Reservation status details",
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"This is the profile search reservation status id",
            "example":"1"
        },
        "status":{
            "type":"string",
            "description":"This is the profile search reservation status",
            "example":"RR"
        },
        "description":{
            "type":"string",
            "description":"This is the profile search reservation status description",
            "example":"Reservation"
        }
    }
}

Nested Schema : items

Match All

Show Source

• object linksHeader
  links detail

{
    "allOf":[
        {
            "$ref":"#/definitions/linksHeader"
        }
    ],
    "example":{
        "rel":"self",
        "href":"http://hostname/spms/v1/profileSearchReservationStatus/1",
        "method":"get",
        "operationId":"findByID"
    }
}

Example:

{
    "rel":"self",
    "href":"http://hostname/spms/v1/profileSearchReservationStatus/1",
    "method":"get",
    "operationId":"findByID"
}

Nested Schema : linksHeader

Type: object

links detail

Show Source

• href: string
• method: string
• operationId: string
• rel: string
  Example: self

{
    "description":"links detail",
    "type":"object",
    "properties":{
        "href":{
            "type":"string"
        },
        "operationId":{
            "type":"string"
        },
        "rel":{
            "type":"string",
            "example":"self"
        },
        "method":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ProfileSearchConfigurationsErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
        "title":"Unauthorized",
        "detail":"Valid token is required to access this resource"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
    "title":"Unauthorized",
    "detail":"Valid token is required to access this resource"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

403 Response

Forbidden

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ProfileSearchConfigurationsErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
        "title":"Forbidden",
        "detail":"Access to this resource was forbidden"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
    "title":"Forbidden",
    "detail":"Access to this resource was forbidden"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

405 Response

Method Not Allowed

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ProfileSearchConfigurationsErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
        "title":"Method Not Supported",
        "detail":"HTTP method not supported for this resource"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
    "title":"Method Not Supported",
    "detail":"HTTP method not supported for this resource"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

406 Response

Not Acceptable

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ProfileSearchConfigurationsErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7",
        "title":"Not Acceptable",
        "detail":"Request a Mime type that is supported for this Resource"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7",
    "title":"Not Acceptable",
    "detail":"Request a Mime type that is supported for this Resource"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ProfileSearchConfigurationsErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
        "title":"Internal Server Error",
        "detail":"Issue fulfilling request. Please retry or contact support"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
    "title":"Internal Server Error",
    "detail":"Issue fulfilling request. Please retry or contact support"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

503 Response

Service Unavailable

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ProfileSearchConfigurationsErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
        "title":"Service Unavailable",
        "detail":"Service Unavailable. Try again later"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
    "title":"Service Unavailable",
    "detail":"Service Unavailable. Try again later"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

Back to Top