Retrieve the date and time display formats applicable for the system

get

/spms/v2/ships/{shipId}/configurations/dateTimeFormat

This is to retrieve date and time display formats applicable for the system

Request

Supported Media Types
Path Parameters
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : configurationsDateTimeFormat
Type: object
System configuration of date-time format object
Show Source
  • Default Value: dddd, MMMM dd, yyyy
    Allowed Values: [ "dddd, MMMM dd, yyyy", "MMMM d yyyy", "dddd, d MMMM yyyy", "d MMMM, yyyy" ]
    Long Date Format: * dddd, MMMM dd, yyyy - example: Sunday, September 22, 2019 * MMMM d yyyy - example: September 9 2019 * dddd, d MMMM yyyy - example: Sunday, 22 September 2019 * d MMMM, yyyy - example: 9 September, 2019
    Example: dddd, MMMM dd, yyyy
  • Default Value: M/d/yyyy
    Allowed Values: [ "M/d/yy", "M/d/yyyy", "MM/dd/yy", "MM/dd/yyyy", "yy/MM/dd", "yyyy-MM-dd", "dd-MMM-yy" ]
    Short Date Format: * M/d/yy - example: 8/6/01 * M/d/yyyy - example: 8/6/2001 * MM/dd/yy - example: 08/06/01 * MM/dd/yyyy - example: 08/06/2001 * yy/MM/dd - example: 01/08/06 * yyyy-MM-dd - example: 2001-08-06 * dd-MMM-yy - example: 06-Aug-01
    Example: M/d/yyyy
  • Default Value: hh:mm:ss tt
    Allowed Values: [ "h:mm:ss tt", "hh:mm:ss tt", "H:mm:ss", "HH:mm:ss" ]
    Long Time Format * hh:mm:ss tt - example: 08:20:33 AM * h:mm:ss tt - example: 8:20:33 AM * H:mm:ss - example: 8:20:33 * HH:mm:ss - example: 08:20:33
    Example: hh:mm:ss tt

401 Response

Unauthorized
Body ()
Root Schema : schema
Match All
Show Source
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
Body ()
Root Schema : schema
Match All
Show Source
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

404 Response

Not Found
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"Ship 186000000404 was not found"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

405 Response

Method Not Allowed
Body ()
Root Schema : schema
Match All
Show Source
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

406 Response

Not Acceptable
Body ()
Root Schema : schema
Match All
Show Source
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

410 Response

Gone
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11",
    "title":"Gone",
    "detail":"Requested Resource no longer exists"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

415 Response

Unsupported Media Type
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
    "title":"Unsupported Media Type",
    "detail":"Content type not supported"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

500 Response

Internal Server Error
Body ()
Root Schema : schema
Match All
Show Source
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

501 Response

Not Implemented
Body ()
Root Schema : schema
Match All
Show Source
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
Body ()
Root Schema : schema
Match All
Show Source
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
Back to Top