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
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : schema
Type:
Show Source
array
-
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
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
Nested Schema : items
Match All
Show Source
-
object
templateHeader
profile search configuration header
-
object
items-allOf[1]
Nested Schema : templateHeader
Type:
object
profile search configuration header
Show Source
-
createdBy(optional):
integer
Minimum Value:
0
Creator IDExample:1234
-
createdDate(optional):
string(date-time)
Example:
1961-04-01T16:00:00.000+0000
-
deleted(optional):
integer
Minimum Value:
0
Maximum Value:1
Delete statusExample:0
-
enabled(optional):
boolean
Indicates whether this field is enabled or notExample:
true
-
modifiedBy(optional):
integer
Minimum Value:
0
Modifier IDExample: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 NameExample:Basic Guest Search
-
startSearchCharacter(optional):
integer
Minimum Value:
1
Maximum Value:10
Start Search After CharacterExample:3
Nested Schema : profileSearchField
Type:
Show Source
array
-
Array of:
object searchFields
search fields
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 = SearchResultExample:
1
204 Response
No Content
401 Response
Unauthorized
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
403 Response
Forbidden
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
405 Response
Method Not Allowed
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
406 Response
Not Acceptable
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
500 Response
Internal Server Error
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
503 Response
Service Unavailable
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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