Retrieve list of all profile search templates
get
/spms/v1/profileSearchTemplate
This is to retrieve list of all profile search templates
Request
Supported Media Types
- application/json
Query Parameters
-
fields: string
Filter response fields
-
limit: integer(int32)
Minimum Value:
0
Paging limit -
offset: integer(int32)
Minimum Value:
0
Paging offset -
orderBy: string
Sorting field (support only asc)
-
q: string
keyword(name)
Response
Supported Media Types
- application/json
200 Response
OK
Nested Schema : items
Match All
Show Source
-
object
List of profile search configuration
Title:
List of profile search configuration
List of profile search configuration
Nested Schema : List of profile search configuration
Type:
object
Title:
List of profile search configuration
List of profile search configuration
Show Source
Nested Schema : item
Match All
Show Source
-
object
templateHeader
profile search configuration header
-
object
item-allOf[1]
Nested Schema : links
Match All
Show Source
-
object
linksHeader
links detail
Example:
{
"href":"http://hostname/spms/v1/profileSearchTemplate/1001",
"operationId":"findByID",
"rel":"self",
"method":"get"
}
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 : item-allOf[1]
Type:
Show Source
object
-
createdBy(optional):
string
profile search configuration created byExample:
0
-
createdDate(optional):
string(date-time)
profile search configuration created dateExample:
2019-08-29T00:00:00
-
deleted(optional):
integer
profile search configuration deletedExample:
0
-
enabled(optional):
string
profile search configuration enabledExample:
true
-
id(optional):
integer
profile search configuration IdExample:
1234
-
modifiedBy(optional):
string
profile search configuration created byExample:
0
-
modifiedDate(optional):
string(date-time)
profile search configuration modified dateExample:
2021-03-29T21:29:51
-
name(optional):
string
profile search configuration nameExample:
Basic Guest Search
-
profileSearchFilter(optional):
array profileSearchFilter
-
profileSearchResult(optional):
array profileSearchResult
-
profileSearchStatus(optional):
array profileSearchStatus
-
startSearchCharacter(optional):
string
profile search configuration start search characterExample:
3
Nested Schema : profileSearchFilter
Type:
Show Source
array
Example:
[
{
"id":1,
"parentId":1234,
"templateFieldId":1,
"type":1,
"fieldDetails":{
"id":1234,
"tableName":"guest",
"fieldName":"firstName",
"type":1,
"description":"First Name"
}
},
{
"id":2,
"parentId":1234,
"templateFieldId":2,
"type":1,
"fieldDetails":{
"id":1002,
"tableName":"Profile",
"fieldName":"lastName",
"type":1,
"description":"Last Name"
}
},
{
"id":3,
"parentId":1234,
"templateFieldId":3,
"type":1,
"fieldDetails":{
"id":1003,
"tableName":"Profile",
"fieldName":"passportNum",
"type":1,
"description":"Passport Number"
}
}
]
Nested Schema : profileSearchResult
Type:
Show Source
array
Example:
[
{
"id":4,
"parentId":1234,
"templateFieldId":6,
"type":2,
"fieldDetails":{
"id":1004,
"tableName":"Profile",
"fieldName":"photo",
"type":2,
"description":"Photo"
}
},
{
"id":5,
"parentId":1234,
"templateFieldId":7,
"type":2,
"fieldDetails":{
"id":1005,
"tableName":"Reservation",
"fieldName":"cabinNum",
"type":2,
"description":"Cabin Number"
}
},
{
"id":6,
"parentId":1001,
"templateFieldId":8,
"type":2,
"fieldDetails":{
"id":1006,
"tableName":"Profile",
"fieldName":"firstName",
"type":2,
"description":"First Name"
}
}
]
Nested Schema : profileSearchStatus
Type:
Show Source
array
-
Array of:
object reservationStatus
reservation status
Example:
[
{
"id":1,
"parentId":1234,
"status":"RR"
},
{
"id":2,
"parentId":1234,
"status":"CC"
}
]
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
Nested Schema : reservationStatus
Type:
object
reservation status
Show Source
-
id(optional):
integer
This is the profile search reservation status idExample:
1
-
parentId(optional):
integer
This is the profile search reservation status parent idExample:
1234
-
status(optional):
string
This is the profile search reservation statusExample:
RR
400 Response
Bad Request
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.1",
"title":"Bad Request",
"detail":"The parameter typeId has incorrect format"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
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
404 Response
Not Found
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.5",
"title":"Not Found",
"detail":"This resource path does not exist"
}
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
415 Response
Unsupported Media Type
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.5",
"title":"Invalid content",
"detail":"Content type not supported"
}
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