Retrieve a harbor using code
get
/spms/v1/configurations/harbors/{code}
This is to retrieve a harbor record by using harbor code
Request
Supported Media Types
- application/json
Path Parameters
Back to Top
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : Harbors
Type:
object
Title:
Harbors
Harbors
Show Source
-
additionalTranslation(optional):
string
Maximum Value:
50
Example:USMIA|MIAMI
-
code(optional):
string
Minimum Value:
1
Maximum Value:6
Pattern:^[a-zA-Z_0-9- ]*$
Example:USMIA
-
comment(optional):
string
Maximum Value:
4000
Example:Port of Miami
-
companyName(optional):
string
Maximum Value:
100
Pattern:^[a-zA-Z0-9 ]*$
Example:COMPANY
-
contactPerson(optional):
string
Maximum Value:
100
Pattern:^[a-zA-Z0-9 ]*$
Example:NAME or FIRST NAME / SURNAME
-
country(optional):
string
Maximum Value:
6
Example:US
-
doorOffSet(optional):
string
Maximum Value:
10
Example:5
-
emailAddress(optional):
string
Maximum Value:
100
Pattern:^([a-zA-Z0-9_\\\\-\\\\.]+)@([a-zA-Z0-9_\\\\-]+)(\\\\.([a-zA-Z]{2,5})){1,}$
Example:EMAIL ADD
-
enabled(optional):
boolean
Example:
True
-
id(optional):
integer
This value is the primary key for HarborsExample:
160000000000
-
name(optional):
string
Maximum Value:
1000
Example:MIAMI
-
phoneNumber(optional):
string
Maximum Value:
15
Pattern:^\\+?(?:[0-9] ?){6,14}[0-9]$"
Example:0123456789
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 supplied parameter(s) is not valid"
}
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":"You are not authorized to use this API"
}
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":"You are forbidden to use this API"
}
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":"The harbors 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 Allowed",
"detail":"This method is not available"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
415 Response
Invalid content
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":"This media supplied is 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":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
"title":"Internal Server Error",
"detail":"Error occured while processing this request"
}
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 not available"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source