NOT FOR PUBLIC DISTRIBUTION: 2020-09-23

Jump to

• Request
• Response

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

To retrieve list of validation messages

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object Oracle Response object
  Title: Oracle Response object

  The wrapper object when returning successful values in Oracle standard

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/OracleResponseList"
    }
}

Nested Schema : Oracle Response object

Type: object

Title: Oracle Response object

The wrapper object when returning successful values in Oracle standard

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

{
    "title":"Oracle Response object",
    "description":"The wrapper object when returning successful values in Oracle standard",
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "example":1
        },
        "hasMore":{
            "type":"boolean",
            "example":true
        },
        "limit":{
            "type":"integer",
            "example":5
        },
        "offset":{
            "type":"integer",
            "example":1
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/validationMessages"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object validationMessages
  Validation Messages

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/validationMessages"
    }
}

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

{
    "description":"Validation Messages",
    "type":"object",
    "properties":{
        "id":{
            "type":"number",
            "example":1.60000011301E11
        },
        "code":{
            "type":"string",
            "minimum":1,
            "maximum":100,
            "pattern":"^[a-zA-Z ]*$",
            "example":"SCI008"
        },
        "name":{
            "type":"string",
            "minimum":1,
            "maximum":200,
            "pattern":"^[a-zA-Z ]*$",
            "example":"Invalid Onboard Account"
        },
        "comment":{
            "type":"string",
            "minimum":1,
            "maximum":200,
            "pattern":"^[a-zA-Z ]*$",
            "example":"Invalid Onboard Account"
        },
        "enabled":{
            "type":"boolean",
            "example":"true"
        }
    }
}

204 Response

No Contents are available

401 Response

You are not authorized to use this API

Body ()

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

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

403 Response

This API is not allowed for your current user role

Body ()

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

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

404 Response

Invalid parameter(s) passed in

Body ()

Root Schema : Oracle Response object with singular object returned

Type: object

Title: Oracle Response object with singular object returned

The wrapper object when returning successful values in Oracle standard

Show Source

• item(optional): array item
  A list object that contains error message and field.

{
    "title":"Oracle Response object with singular object returned",
    "description":"The wrapper object when returning successful values in Oracle standard",
    "type":"object",
    "properties":{
        "item":{
            "type":"array",
            "description":"A list object that contains error message and field."
        }
    }
}

Nested Schema : item

Type: array

A list object that contains error message and field.

Example Response (application/json)

{
    "title":"Not Found",
    "detail":"message code - SFTR00 is invalid",
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5"
}

405 Response

Method requested not available

Body ()

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

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

415 Response

This media supplied is not supported

Body ()

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

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

500 Response

Error occured while processing this request

Body ()

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

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

502 Response

Bad Gateway

503 Response

Service not available

Back to Top