Create/ Add a new profile search template
post
/spms/v1/profileSearchTemplate
This is to create/ add a new profile search template
Request
Supported Media Types
- application/json
Root Schema : templateCreate
Type:
Show Source
object
-
enabled(optional):
boolean
Indicates whether this field is enabled or notExample:
true
-
name(optional):
string
Minimum Value:
1
Maximum Value:500
Pattern:^[a-zA-Z0-9 ]*$
Search Configuration NameExample:Basic Guest Search
-
profileSearchFilter(optional):
array profileSearchFilter
-
profileSearchResult(optional):
array profileSearchResult
-
profileSearchStatus(optional):
array profileSearchStatus
-
startSearchCharacter(optional):
integer
Minimum Value:
1
Maximum Value:10
Start Search After CharacterExample:3
Nested Schema : profileSearchFilter
Type:
Show Source
array
Example:
[
{
"templateFieldId":1
},
{
"templateFieldId":2
},
{
"templateFieldId":3
}
]
Nested Schema : profileSearchResult
Type:
Show Source
array
Example:
[
{
"templateFieldId":6
},
{
"templateFieldId":7
},
{
"templateFieldId":8
}
]
Nested Schema : profileSearchStatus
Type:
Show Source
array
Example:
[
{
"status":"RR"
},
{
"status":"CC"
}
]
Nested Schema : items
Type:
Show Source
object
-
templateFieldId(optional):
integer
Minimum Value:
1
Selected Search Filter
Nested Schema : items
Type:
Show Source
object
-
templateFieldId(optional):
integer
Minimum Value:
1
Selected Search Result
Nested Schema : items
Type:
Show Source
object
-
status(optional):
string
Minimum Value:
2
Maximum Value:2
Reservation Status
Response
Supported Media Types
- application/json
201 Response
Created
Root Schema : SearchConfiguration
Type:
object
Search configuration response
Show Source
-
createdBy(optional):
integer
Creator IDExample:
1234
-
createdDate(optional):
string
Example:
1961-04-01T16:00:00.000+0000
-
deleted(optional):
integer
Delete statusExample:
0
-
enabled(optional):
boolean
Indicates whether this field is enabled or notExample:
true
-
id(optional):
integer
profile search configuration IdExample:
1234
-
modifiedBy(optional):
integer
Modifier IDExample:
1234
-
modifiedDate(optional):
string
Example:
1961-04-01T16:00:00.000+0000
-
name(optional):
string
Search Configuration NameExample:
Basic Guest Search
-
profileSearchFilter(optional):
array profileSearchFilter
-
profileSearchResult(optional):
array profileSearchResult
-
profileSearchStatus(optional):
array profileSearchStatus
-
startSearchCharacter(optional):
integer
Start Search After CharacterExample:
3
Nested Schema : profileSearchStatus
Type:
Show Source
array
-
Array of:
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
Reservation Status, RR=Reservation, RX=Cancelled, RE=Embark today, RN=No Show, CC=Checked In, CL=Leaving today, DD=DisembarkedExample: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
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
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.16",
"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