Jump to

• Request
• Response

Retrieve a profile search fields excluded from search filter or results

get

/spms/v1/profileSearchTemplateField/type/{typeId}/searchOption/{templateId}

This is to retrieve a profile search fields excluded from search filter or results

Request

Supported Media Types

• application/json

Path Parameters

• templateId: integer
• typeId: integer
  1 = ReturnFilter, 2 = SearchResult

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object List of profile search template response excluded field
  Title: List of profile search template response excluded field

  List of profile search template response excluded field

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

Nested Schema : List of profile search template response excluded field

Type: object

Title: List of profile search template response excluded field

List of profile search template response excluded field

Show Source

• items(optional): array items

{
    "title":"List of profile search template response excluded field",
    "description":"List of profile search template response excluded field",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/templateHeader"
                    },
                    {
                        "properties":{
                            "profileSearchField":{
                                "type":"array",
                                "items":{
                                    "$ref":"#/definitions/searchFields"
                                },
                                "example":[
                                    {
                                        "id":4,
                                        "tableName":"reservation",
                                        "fieldName":"bookingNumber",
                                        "description":"Booking Number",
                                        "type":1
                                    },
                                    {
                                        "id":5,
                                        "tableName":"guest",
                                        "fieldName":"passportNumber",
                                        "description":"Passport Number",
                                        "type":1
                                    }
                                ]
                            }
                        }
                    }
                ]
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: items

{
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/templateHeader"
            },
            {
                "properties":{
                    "profileSearchField":{
                        "type":"array",
                        "items":{
                            "$ref":"#/definitions/searchFields"
                        },
                        "example":[
                            {
                                "id":4,
                                "tableName":"reservation",
                                "fieldName":"bookingNumber",
                                "description":"Booking Number",
                                "type":1
                            },
                            {
                                "id":5,
                                "tableName":"guest",
                                "fieldName":"passportNumber",
                                "description":"Passport Number",
                                "type":1
                            }
                        ]
                    }
                }
            }
        ]
    }
}

Nested Schema : items

Match All

Show Source

• object templateHeader
  profile search configuration header
• object items-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/templateHeader"
        },
        {
            "properties":{
                "profileSearchField":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/searchFields"
                    },
                    "example":[
                        {
                            "id":4,
                            "tableName":"reservation",
                            "fieldName":"bookingNumber",
                            "description":"Booking Number",
                            "type":1
                        },
                        {
                            "id":5,
                            "tableName":"guest",
                            "fieldName":"passportNumber",
                            "description":"Passport Number",
                            "type":1
                        }
                    ]
                }
            }
        }
    ]
}

Nested Schema : templateHeader

Type: object

profile search configuration header

Show Source

• createdBy(optional): integer
  Minimum Value: 0

  Creator ID

  Example: 1234
• createdDate(optional): string(date-time)
  Example: 1961-04-01T16:00:00.000+0000
• deleted(optional): integer
  Minimum Value: 0

  Maximum Value: 1

  Delete status

  Example: 0
• enabled(optional): boolean
  Indicates whether this field is enabled or not

  Example: true
• modifiedBy(optional): integer
  Minimum Value: 0

  Modifier ID

  Example: 1234
• modifiedDate(optional): string(date-time)
  Example: 1961-04-01T16:00:00.000+0000
• name(optional): string
  Minimum Value: 1

  Maximum Value: 500

  Pattern: ^[a-zA-Z0-9 ]*$

  Search Configuration Name

  Example: Basic Guest Search
• startSearchCharacter(optional): integer
  Minimum Value: 1

  Maximum Value: 10

  Start Search After Character

  Example: 3

{
    "description":"profile search configuration header",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Search Configuration Name",
            "minimum":1,
            "maximum":500,
            "pattern":"^[a-zA-Z0-9 ]*$",
            "example":"Basic Guest Search"
        },
        "startSearchCharacter":{
            "type":"integer",
            "description":"Start Search After Character",
            "minimum":1,
            "maximum":10,
            "example":3
        },
        "enabled":{
            "type":"boolean",
            "description":"Indicates whether this field is enabled or not",
            "example":true
        },
        "createdBy":{
            "type":"integer",
            "description":"Creator ID",
            "minimum":0,
            "example":"1234"
        },
        "modifiedBy":{
            "type":"integer",
            "description":"Modifier ID",
            "minimum":0,
            "example":"1234"
        },
        "createdDate":{
            "type":"string",
            "format":"date-time",
            "example":"1961-04-01T16:00:00.000+0000"
        },
        "modifiedDate":{
            "type":"string",
            "format":"date-time",
            "example":"1961-04-01T16:00:00.000+0000"
        },
        "deleted":{
            "type":"integer",
            "description":"Delete status",
            "minimum":0,
            "maximum":1,
            "example":0
        }
    }
}

Nested Schema : items-allOf[1]

Type: object

Show Source

• profileSearchField(optional): array profileSearchField

{
    "properties":{
        "profileSearchField":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/searchFields"
            },
            "example":[
                {
                    "id":4,
                    "tableName":"reservation",
                    "fieldName":"bookingNumber",
                    "description":"Booking Number",
                    "type":1
                },
                {
                    "id":5,
                    "tableName":"guest",
                    "fieldName":"passportNumber",
                    "description":"Passport Number",
                    "type":1
                }
            ]
        }
    }
}

Nested Schema : profileSearchField

Type: array

Show Source

• Array of: object searchFields
  search fields

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/searchFields"
    },
    "example":[
        {
            "id":4,
            "tableName":"reservation",
            "fieldName":"bookingNumber",
            "description":"Booking Number",
            "type":1
        },
        {
            "id":5,
            "tableName":"guest",
            "fieldName":"passportNumber",
            "description":"Passport Number",
            "type":1
        }
    ]
}

Example:

[
    {
        "id":4,
        "tableName":"reservation",
        "fieldName":"bookingNumber",
        "description":"Booking Number",
        "type":1
    },
    {
        "id":5,
        "tableName":"guest",
        "fieldName":"passportNumber",
        "description":"Passport Number",
        "type":1
    }
]

Nested Schema : searchFields

Type: object

search fields

Show Source

• description(optional): string
• fieldName(optional): string
• tableName(optional): string
• type(optional): integer
  1 = ReturnFilter, 2 = SearchResult

  Example: 1

{
    "description":"search fields",
    "type":"object",
    "properties":{
        "tableName":{
            "type":"string"
        },
        "fieldName":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "type":{
            "type":"integer",
            "description":"1 = ReturnFilter, 2 = SearchResult",
            "example":1
        }
    }
}

204 Response

No Content

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":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
        "title":"Forbidden",
        "detail":"Access to this resource is forbidden"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
    "title":"Forbidden",
    "detail":"Access to this resource is 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":"http://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":"http://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":"HTTP://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":"HTTP://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