Jump to

• Request
• Response

Update a profile search template record

put

/spms/v1/profileSearchTemplate

This is to update a profile search template record

Request

Supported Media Types

• application/json

Body ()

Root Schema : templateEdit

Type: object

Show Source

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

  Example: true
• id(optional): integer
  Example: 1234
• name(optional): string
  Minimum Value: 1

  Maximum Value: 500

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

  Search Configuration Name

  Example: Basic Guest Search
• profileSearchFilter(optional): array profileSearchFilter
• profileSearchResult1(optional): array profileSearchResult1
• profileSearchStatus(optional): array profileSearchStatus
• startSearchCharacter(optional): integer
  Minimum Value: 1

  Maximum Value: 10

  Start Search After Character

  Example: 3

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "example":1234
        },
        "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
        },
        "profileSearchStatus":{
            "type":"array",
            "items":{
                "properties":{
                    "status":{
                        "type":"string",
                        "description":"Reservation Status",
                        "minimum":2,
                        "maximum":2
                    }
                }
            },
            "example":[
                {
                    "id":1,
                    "parentid":1234,
                    "status":"RR"
                },
                {
                    "id":2,
                    "parentid":1234,
                    "status":"CC"
                }
            ]
        },
        "profileSearchFilter":{
            "type":"array",
            "items":{
                "properties":{
                    "templateFieldId":{
                        "type":"integer",
                        "description":"Selected Search Filter",
                        "minimum":1
                    }
                }
            },
            "example":[
                {
                    "id":1,
                    "parentid":1234,
                    "templateFieldId":1
                },
                {
                    "id":2,
                    "parentid":1234,
                    "templateFieldId":2
                },
                {
                    "id":3,
                    "parentid":1234,
                    "templateFieldId":3
                }
            ]
        },
        "profileSearchResult1":{
            "type":"array",
            "items":{
                "properties":{
                    "templateFieldId":{
                        "type":"integer",
                        "description":"Selected Search Result",
                        "minimum":1
                    }
                }
            },
            "example":[
                {
                    "id":4,
                    "parentid":1234,
                    "templateFieldId":6
                },
                {
                    "id":5,
                    "parentid":1234,
                    "templateFieldId":7
                },
                {
                    "id":6,
                    "parentid":1234,
                    "templateFieldId":8
                }
            ]
        }
    }
}

Nested Schema : profileSearchFilter

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "properties":{
            "templateFieldId":{
                "type":"integer",
                "description":"Selected Search Filter",
                "minimum":1
            }
        }
    },
    "example":[
        {
            "id":1,
            "parentid":1234,
            "templateFieldId":1
        },
        {
            "id":2,
            "parentid":1234,
            "templateFieldId":2
        },
        {
            "id":3,
            "parentid":1234,
            "templateFieldId":3
        }
    ]
}

Example:

[
    {
        "id":1,
        "parentid":1234,
        "templateFieldId":1
    },
    {
        "id":2,
        "parentid":1234,
        "templateFieldId":2
    },
    {
        "id":3,
        "parentid":1234,
        "templateFieldId":3
    }
]

Nested Schema : profileSearchResult1

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "properties":{
            "templateFieldId":{
                "type":"integer",
                "description":"Selected Search Result",
                "minimum":1
            }
        }
    },
    "example":[
        {
            "id":4,
            "parentid":1234,
            "templateFieldId":6
        },
        {
            "id":5,
            "parentid":1234,
            "templateFieldId":7
        },
        {
            "id":6,
            "parentid":1234,
            "templateFieldId":8
        }
    ]
}

Example:

[
    {
        "id":4,
        "parentid":1234,
        "templateFieldId":6
    },
    {
        "id":5,
        "parentid":1234,
        "templateFieldId":7
    },
    {
        "id":6,
        "parentid":1234,
        "templateFieldId":8
    }
]

Nested Schema : profileSearchStatus

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "properties":{
            "status":{
                "type":"string",
                "description":"Reservation Status",
                "minimum":2,
                "maximum":2
            }
        }
    },
    "example":[
        {
            "id":1,
            "parentid":1234,
            "status":"RR"
        },
        {
            "id":2,
            "parentid":1234,
            "status":"CC"
        }
    ]
}

Example:

[
    {
        "id":1,
        "parentid":1234,
        "status":"RR"
    },
    {
        "id":2,
        "parentid":1234,
        "status":"CC"
    }
]

Nested Schema : items

Type: object

Show Source

• templateFieldId(optional): integer
  Minimum Value: 1

  Selected Search Filter

{
    "properties":{
        "templateFieldId":{
            "type":"integer",
            "description":"Selected Search Filter",
            "minimum":1
        }
    }
}

Nested Schema : items

Type: object

Show Source

• templateFieldId(optional): integer
  Minimum Value: 1

  Selected Search Result

{
    "properties":{
        "templateFieldId":{
            "type":"integer",
            "description":"Selected Search Result",
            "minimum":1
        }
    }
}

Nested Schema : items

Type: object

Show Source

• status(optional): string
  Minimum Value: 2

  Maximum Value: 2

  Reservation Status

{
    "properties":{
        "status":{
            "type":"string",
            "description":"Reservation Status",
            "minimum":2,
            "maximum":2
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : SearchConfiguration

Type: object

Search configuration response

Show Source

• createdBy(optional): integer
  Creator ID

  Example: 1234
• createdDate(optional): string
  Example: 1961-04-01T16:00:00.000+0000
• deleted(optional): integer
  Delete status

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

  Example: true
• id(optional): integer
  profile search configuration Id

  Example: 1234
• modifiedBy(optional): integer
  Modifier ID

  Example: 1234
• modifiedDate(optional): string
  Example: 1961-04-01T16:00:00.000+0000
• name(optional): string
  Search Configuration Name

  Example: Basic Guest Search
• profileSearchFilter(optional): array profileSearchFilter
• profileSearchResult(optional): array profileSearchResult
• profileSearchStatus(optional): array profileSearchStatus
• startSearchCharacter(optional): integer
  Start Search After Character

  Example: 3

{
    "description":"Search configuration response",
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"profile search configuration Id",
            "example":1234
        },
        "name":{
            "type":"string",
            "description":"Search Configuration Name",
            "example":"Basic Guest Search"
        },
        "startSearchCharacter":{
            "type":"integer",
            "description":"Start Search After Character",
            "example":3
        },
        "enabled":{
            "type":"boolean",
            "description":"Indicates whether this field is enabled or not",
            "example":true
        },
        "createdBy":{
            "type":"integer",
            "description":"Creator ID",
            "example":"1234"
        },
        "modifiedBy":{
            "type":"integer",
            "description":"Modifier ID",
            "example":"1234"
        },
        "createdDate":{
            "type":"string",
            "example":"1961-04-01T16:00:00.000+0000"
        },
        "modifiedDate":{
            "type":"string",
            "example":"1961-04-01T16:00:00.000+0000"
        },
        "deleted":{
            "type":"integer",
            "description":"Delete status",
            "example":0
        },
        "profileSearchStatus":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reservationStatus",
                "example":[
                    {
                        "id":1,
                        "parentId":1234,
                        "status":"RR"
                    },
                    {
                        "id":2,
                        "parentId":1234,
                        "status":"CC"
                    }
                ]
            }
        },
        "profileSearchFilter":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/templateFieldDetails",
                "example":[
                    {
                        "id":1,
                        "parentId":1234,
                        "templateFieldId":1,
                        "type":1,
                        "fieldDetails":null
                    },
                    {
                        "id":2,
                        "parentId":1234,
                        "templateFieldId":2,
                        "type":2,
                        "fieldDetails":null
                    },
                    {
                        "id":3,
                        "parentId":1234,
                        "templateFieldId":3,
                        "type":3,
                        "fieldDetails":null
                    }
                ]
            }
        },
        "profileSearchResult":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/templateFieldDetails",
                "example":[
                    {
                        "id":4,
                        "parentId":1234,
                        "templateFieldId":6,
                        "type":3,
                        "fieldDetails":null
                    },
                    {
                        "id":5,
                        "parentId":1234,
                        "templateFieldId":7,
                        "type":3,
                        "fieldDetails":null
                    },
                    {
                        "id":6,
                        "parentId":1234,
                        "templateFieldId":8,
                        "type":2,
                        "fieldDetails":null
                    }
                ]
            }
        }
    }
}

Nested Schema : profileSearchFilter

Type: array

Show Source

• Array of: object templateFieldDetails

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/templateFieldDetails",
        "example":[
            {
                "id":1,
                "parentId":1234,
                "templateFieldId":1,
                "type":1,
                "fieldDetails":null
            },
            {
                "id":2,
                "parentId":1234,
                "templateFieldId":2,
                "type":2,
                "fieldDetails":null
            },
            {
                "id":3,
                "parentId":1234,
                "templateFieldId":3,
                "type":3,
                "fieldDetails":null
            }
        ]
    }
}

Nested Schema : profileSearchResult

Type: array

Show Source

• Array of: object templateFieldDetails

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/templateFieldDetails",
        "example":[
            {
                "id":4,
                "parentId":1234,
                "templateFieldId":6,
                "type":3,
                "fieldDetails":null
            },
            {
                "id":5,
                "parentId":1234,
                "templateFieldId":7,
                "type":3,
                "fieldDetails":null
            },
            {
                "id":6,
                "parentId":1234,
                "templateFieldId":8,
                "type":2,
                "fieldDetails":null
            }
        ]
    }
}

Nested Schema : profileSearchStatus

Type: array

Show Source

• Array of: object reservationStatus
  reservation status

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reservationStatus",
        "example":[
            {
                "id":1,
                "parentId":1234,
                "status":"RR"
            },
            {
                "id":2,
                "parentId":1234,
                "status":"CC"
            }
        ]
    }
}

Nested Schema : templateFieldDetails

Type: object

Show Source

• fieldDetails(optional): object fieldDetails
• id(optional): integer
• parentId(optional): integer
• templateFieldId(optional): integer
• type(optional): integer

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer"
        },
        "parentId":{
            "type":"integer"
        },
        "type":{
            "type":"integer"
        },
        "templateFieldId":{
            "type":"integer"
        },
        "fieldDetails":{
            "type":"object",
            "items":{
                "$ref":"#/definitions/searchFields"
            }
        }
    }
}

Nested Schema : fieldDetails

Type: object

Show Source

• Array of: object searchFields
  search fields

{
    "type":"object",
    "items":{
        "$ref":"#/definitions/searchFields"
    }
}

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
        }
    }
}

Nested Schema : reservationStatus

Type: object

reservation status

Show Source

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

  Example: 1
• parentId(optional): integer
  This is the profile search reservation status parent id

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

  Example: RR

{
    "description":"reservation status",
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"This is the profile search reservation status id",
            "example":1
        },
        "parentId":{
            "type":"integer",
            "description":"This is the profile search reservation status parent id",
            "example":1234
        },
        "status":{
            "type":"string",
            "description":"This is the profile search reservation status",
            "example":"RR"
        }
    }
}

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 typeId has incorrect format"
    }
}

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

• 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":"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"
        }
    }
}

404 Response

Not Found

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.5",
        "title":"Not Found",
        "detail":"This resource path does not exist"
    }
}

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

• 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"
        }
    }
}

415 Response

Unsupported Media Type

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.16",
        "title":"Invalid content",
        "detail":"Content type Not supported"
    }
}

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

• 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