Retrieve list of all gangway customized messages
get
/spms/v1/configurations/messages
This is to retrieve a list of all customized messages to be displayed in gangway with different movement
Request
Supported Media Types
- application/json
Query Parameters
-
code: string
Search Value based on the message code
-
enabled: boolean
Returns validation messages which is true or false
-
limit: integer(int32)
Paging limit
-
offset: integer(int32)
Paging offset
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : schema
Type:
Show Source
array
-
Array of:
object Message Response List
Title:
Message Response List
Message Response List
Nested Schema : Message Response List
Type:
object
Title:
Message Response List
Message Response List
Show Source
-
count(optional):
integer
Example:
1
-
hasMore(optional):
boolean
Example:
true
-
items(optional):
array items
-
limit(optional):
integer
Example:
5
-
offset(optional):
integer
Example:
1
Nested Schema : items
Type:
Show Source
array
-
Array of:
object validationMessages
Validation Messages
Nested Schema : validationMessages
Type:
object
Validation Messages
Show Source
-
code(optional):
string
Minimum Value:
1
Maximum Value:100
Pattern:^[a-zA-Z ]*$
Example:SCI008
-
comment(optional):
string
Minimum Value:
1
Maximum Value:200
Pattern:^[a-zA-Z ]*$
Example:Invalid Onboard Account
-
enabled(optional):
boolean
Example:
true
-
id(optional):
number
Example:
1.60000011301E11
-
name(optional):
string
Minimum Value:
1
Maximum Value:200
Pattern:^[a-zA-Z ]*$
Example:Invalid Onboard Account
204 Response
No Content
400 Response
Bad Request
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"title":"Bad Request",
"detail":"Invalid parameter(s)",
"type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
}
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":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
"title":"Forbidden",
"detail":"Access to this resource was 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":"https://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
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":"https://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