Jump to

• Request
• Response

Retrieve list of Profile Search template reservation status by ID

get

/spms/v1/profileSearchReservationStatus/{id}

This is to retrieve list of Profile Search template reservation status filter by Id

Request

Supported Media Types

• application/json

Path Parameters

• id: integer

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Profile Search Reservation Status

Type: object

Title: Profile Search Reservation Status

Profile Search Reservation Status

Show Source

• item(optional): item
• links(optional): array links

{
    "title":"Profile Search Reservation Status",
    "description":"Profile Search Reservation Status",
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/linksHeader"
                    }
                ],
                "example":{
                    "href":"http://hostname/spms/v1/profileSearchReservationStatus/1",
                    "operationId":"findByID",
                    "rel":"self",
                    "method":"get"
                }
            }
        },
        "item":{
            "allOf":[
                {
                    "$ref":"#/definitions/reservationStatusDetails"
                }
            ],
            "example":{
                "id":1,
                "status":"RR",
                "description":"Reservation"
            }
        }
    }
}

Nested Schema : item

Match All

Show Source

• object reservationStatusDetails
  Reservation status details

{
    "allOf":[
        {
            "$ref":"#/definitions/reservationStatusDetails"
        }
    ],
    "example":{
        "id":1,
        "status":"RR",
        "description":"Reservation"
    }
}

Example:

{
    "id":1,
    "status":"RR",
    "description":"Reservation"
}

Nested Schema : links

Type: array

Show Source

• Array of: items

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

Nested Schema : reservationStatusDetails

Type: object

Reservation status details

Show Source

• description(optional): string
  This is the profile search reservation status description

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

  Example: 1
• status(optional): 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":{
        "href":"http://hostname/spms/v1/profileSearchReservationStatus/1",
        "operationId":"findByID",
        "rel":"self",
        "method":"get"
    }
}

Example:

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

Nested Schema : linksHeader

Type: object

links detail

Show Source

• href(optional): string
• method(optional): string
• operationId(optional): string
• rel(optional): string
  Example: self

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

400 Response

Bad Request

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.1",
        "title":"Bad Request",
        "detail":"The parameter id has incorrect format"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":"The parameter id has incorrect format"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "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(optional): string
• title(optional): string
• type(optional): 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(optional): string
• title(optional): string
• type(optional): 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(optional): string
• title(optional): string
• type(optional): 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(optional): string
• title(optional): string
• type(optional): 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(optional): string
• title(optional): string
• type(optional): 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(optional): string
• title(optional): string
• type(optional): 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