NOT FOR PUBLIC DISTRIBUTION: 2020-09-23
Update the settings for required visa check at gangway
put
/spms/v1/configurations/visaChecks
This is to update the settings for required visa check at gangway
Request
Supported Media Types
- application/json
Root Schema : UpdateVisaCheck
Type:
object
Title:
Show Source
UpdateVisaCheck
-
comment(optional):
string
Example:
0-Turn Check off, 1-Turn Check On
-
description(optional):
string
Example:
Port/Visa Check
-
enabled(optional):
boolean
Example:
true
-
value(optional):
string
Example:
0
Response
Supported Media Types
- application/json
200 Response
Successful Response
Root Schema : GetVisaCheck
Type:
object
Title:
Show Source
GetVisaCheck
-
comment(optional):
string
Example:
0-Turn Check off, 1-Turn Check On
-
description(optional):
string
Example:
Port/Visa Check
-
enabled(optional):
boolean
Example:
true
-
name(optional):
string
Example:
Enable Visa Checks
-
value(optional):
string
Example:
0
Example Response (application/json)
[
{
"name":"Enable Visa Check",
"enabled":true,
"value":"0",
"description":"Port/Visa Check",
"comment":"0-Turn Check off, 1-Turn Check On"
}
]
204 Response
No data is available
401 Response
Full authentication is required to access this resource
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
403 Response
You are forbidden to use this API
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
500 Response
Error occured while processing this request
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
502 Response
Bad Gateway
503 Response
Service not available