Retrieve configured Address State code records
get
/spms/v2/ships/{shipId}/configurations/profiles/addressStateCodes
This is to retrieve the configured Address State codes.
Request
Supported Media Types
- application/json
Path Parameters
-
shipId: number
Ship Id
Query Parameters
-
countryCode(optional): string
Country CodeDefault Value:
oracle.doceng.json.BetterJsonNull@5c44bce3
-
limit: integer(int32)
Minimum Value:
1
Paging limitDefault Value:50
-
offset: integer(int32)
Minimum Value:
0
Paging offset -
orderBy: string
order by stateCode and stateCodeName with format column1:asc/desc,column2:asc/descDefault Value:
id:desc
-
stateCode(optional): string
State CodeDefault Value:
oracle.doceng.json.BetterJsonNull@7b4b6dca
-
stateCodeName(optional): string
State Code NameDefault Value:
oracle.doceng.json.BetterJsonNull@5baabba
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : Oracle Response
Type:
object
Title:
Oracle Response
The wrapper object when returning successful values in Oracle standard
Show Source
-
count(optional):
number
The total number of items in the list.Example:
20
-
hasMore(optional):
boolean
Flag which indicates whether or not there are more items.Example:
false
-
items(optional):
array items
-
limit(optional):
number
Paging limitExample:
1
-
offset(optional):
number
Paging offsetExample:
10
Nested Schema : items
Type:
Show Source
array
-
Array of:
array addressStateCodes
Address State Codes details
Example:
[
{
"countryCode":"US",
"countryName":"United States",
"stateCodeId":17008,
"stateCode":"IA",
"stateCodeDescription":"Iowa",
"cityShortName":"GWX",
"cityName":"Glenwood"
}
]
Nested Schema : addressStateCodes
Type:
array
Address State Codes details
Show Source
-
Array of:
object AddressStateCodesDetails
Address State Codes Details
Example:
[
{
"countryCode":"US",
"countryName":"United States",
"stateCodeId":17008,
"stateCode":"IA",
"stateCodeDescription":"Iowa",
"cityShortName":"GWX",
"cityName":"Glenwood"
}
]
Nested Schema : AddressStateCodesDetails
Type:
object
Address State Codes Details
Show Source
-
cityName(optional):
string
City NameExample:
Glenwood
-
cityShortName(optional):
string
City Short NameExample:
GWX
-
countryCode(optional):
string
Country CodeExample:
US
-
countryName(optional):
string
Country NameExample:
United States
-
stateCode(optional):
string
State CodeExample:
IA
-
stateCodeDescription(optional):
string
State Code DescriptionExample:
Iowa
-
stateCodeId(optional):
number
Minimum Value:
1
Pattern:^[0-9]*$
Address State Code IdExample:2223333
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:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Bad Request",
"detail":"Invalid parameter(s) passed in"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
401 Response
Valid token is required to access this resource
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"title":"Unauthorized",
"detail":"Valid token is required to access this resource",
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
403 Response
You are forbidden to use this API
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"title":"Forbidden",
"detail":"Access to this resource is forbidden",
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4"
}
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:
{
"title":"Not Found",
"detail":"Reservation not found",
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
405 Response
This method is not available
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"title":"Method Not Supported",
"detail":"HTTP method not supported for this resource",
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6"
}
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:
{
"title":"Not Acceptable",
"detail":"HTTP not acceptable for this resource",
"type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
410 Response
Gone
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"title":"Gone",
"detail":"HTTP gone for this resource",
"type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11"
}
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:
{
"title":"Unsupported Media Type",
"detail":"HTTP unsupported media type for this resource",
"type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
500 Response
Error occured while processing this request
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"title":"Internal Server Error",
"details":"Issue fulfilling request. Please retry or contact support",
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
501 Response
Not implemented
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.2",
"title":"Not implemented",
"detail":"Resource is not implemented in this version of the API"
}
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":"http://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