Jump to

• Request
• Response

Retrieve the gateway security activities with criterias.

get

/spms/v2/ships/{shipId}/gatewaySecurity/activities

This is to retrieve the gateway security activities with criterias

Request

Supported Media Types

• application/json

Path Parameters

• shipId: number(12345678)
  Ship Identifier number

Query Parameters

• fullName(optional): string
  Full name is combination of First Name, Middle Name or Last Name
• gateMovement(optional): string
  Gateway Security movement types
• limit: integer(int32)
  Paging limit
• locationName(optional): string
  Location name
• movementDatetimeFrom(optional): string
  Start datetime of movement
• movementDatetimeTo(optional): string
  End datetime of movement
• offset: integer(int32)
  Paging offset
• orderBy(optional): string(stateroom:asc)
  Sorting records by columns in ascending or descending. Format: column name:asc or desc. if multiple columns needed then split it by comma
• profileId(optional): number(12345678)
  Profile identifier Number
• profileType(optional): array
  Profile types like Guest(P), Resident(R), Crew(C), Visitor(V)

  • [0]: array items

  {
      "name":"profileType",
      "description":"Profile types like Guest(P), Resident(R), Crew(C), Visitor(V)",
      "in":"query",
      "type":"array",
      "items":{
          "type":"array",
          "enum":[
              "P",
              "R",
              "C",
              "V"
          ]
      },
      "required":false,
      "x-example":"P"
  }

• searchValue(optional): string
  The search value allow to search full name or stateroom
• stateroom(optional): string
  Stateroom
• tenderBoatId(optional): number(12345678)
  Tender boat identifier number

Nested Schema : items

Type: array

Allowed Values: [ "P", "R", "C", "V" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object Oracle Responses - All gateway security activities
  Title: Oracle Responses - All gateway security activities

  The wrapper object when returning successful values in Oracle standard

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

Nested Schema : Oracle Responses - All gateway security activities

Type: object

Title: Oracle Responses - All gateway security activities

The wrapper object when returning successful values in Oracle standard

Show Source

• count(optional): integer
  The total number of items in the list.

  Example: 3
• hasMore(optional): boolean
  Flag which indicates whether or not there are more items.

  Example: false
• items(optional): array items

{
    "title":"Oracle Responses - All gateway security activities",
    "description":"The wrapper object when returning successful values in Oracle standard",
    "type":"object",
    "properties":{
        "count":{
            "description":"The total number of items in the list.",
            "type":"integer",
            "example":3
        },
        "hasMore":{
            "description":"Flag which indicates whether or not there are more items.",
            "type":"boolean",
            "example":false
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/GatewaySecurityActivities"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Oracle Responses - Gateway security activities
  Title: Oracle Responses - Gateway security activities

  The wrapper object when returning successful values in Oracle Standard

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

Nested Schema : Oracle Responses - Gateway security activities

Type: object

Title: Oracle Responses - Gateway security activities

The wrapper object when returning successful values in Oracle Standard

Show Source

• fullName(optional): string
  Example: Full Name
• gateMovement(optional): string
  Example: Coming On-board
• Id(optional): number
  Example: 12345
• locationName(optional): string
  Example: Gangway A
• movementDate(optional): string
  Example: 2020-01-31T00:00:00
• profileId(optional): number
  Example: 123456
• profileType(optional): string
  Example: P
• stateroom(optional): string
  Example: C1001
• swipeCard(optional): string
  Example: No
• tenderBoatId(optional): number
  Example: 1234567
• tenderBoatName(optional): string
  Example: Tender Boat A
• userName(optional): string
  Example: username
• workStation(optional): string
  Example: WK101

{
    "title":"Oracle Responses - Gateway security activities",
    "description":"The wrapper object when returning successful values in Oracle Standard",
    "type":"object",
    "properties":{
        "Id":{
            "type":"number",
            "example":12345
        },
        "profileId":{
            "type":"number",
            "example":123456
        },
        "fullName":{
            "type":"string",
            "example":"Full Name"
        },
        "stateroom":{
            "type":"string",
            "example":"C1001"
        },
        "movementDate":{
            "type":"string",
            "example":"2020-01-31T00:00:00"
        },
        "userName":{
            "type":"string",
            "example":"username"
        },
        "workStation":{
            "type":"string",
            "example":"WK101"
        },
        "locationName":{
            "type":"string",
            "example":"Gangway A"
        },
        "profileType":{
            "type":"string",
            "example":"P"
        },
        "swipeCard":{
            "type":"string",
            "example":"No"
        },
        "gateMovement":{
            "type":"string",
            "example":"Coming On-board"
        },
        "tenderBoatId":{
            "type":"number",
            "example":1234567
        },
        "tenderBoatName":{
            "type":"string",
            "example":"Tender Boat A"
        }
    }
}

204 Response

No Content

400 Response

Bad Request

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/GatewaySecActErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
        "title":"Bad Request",
        "detail":"limit must not be less than one!"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":"limit must not be less than one!"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/GatewaySecActErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
        "title":"Unauthorised",
        "detail":"Valid token is required to access this resource"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
    "title":"Unauthorised",
    "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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

403 Response

Forbidden

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/GatewaySecActErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
        "title":"Forbidden",
        "detail":"Access to this resource was forbidden"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

404 Response

Not Found

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/GatewaySecActErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
        "title":"Not Found",
        "detail":"Ship 123 was not found"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"Ship 123 was not found"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

405 Response

Method Not Allowed

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/GatewaySecActErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
        "title":"Method Not Supported",
        "detail":"HTTP method not supported for this resource"
    }
}

Example:

{
    "type":"https://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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

406 Response

Not Acceptable

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/GatewaySecActErrorResponse"
        }
    ],
    "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"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/GatewaySecActErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
        "title":"Internal Server Error",
        "detail":"Issue fulfilling request. Please retry or contact support"
    }
}

Example:

{
    "type":"https://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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

503 Response

Service unavailable

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/GatewaySecActErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
        "title":"Service Unavailable",
        "detail":"Service Unavailable.  Try again later"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
    "title":"Service Unavailable",
    "detail":"Service Unavailable.  Try again later"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

Back to Top