NOT FOR PUBLIC DISTRIBUTION: 2020-09-23

Jump to

• Request
• Response

Retrieve list of gangway activities by parameters

get

/spms/v1/gangwayActivities

This is to retrieve a list of gangway activities by passing in different parameters

Request

Supported Media Types

• application/json

Query Parameters

• accountType(optional): array
  Allowed Values: [ "A", "C" ]

  • [0]: string

  {
      "in":"query",
      "name":"accountType",
      "type":"array",
      "items":{
          "type":"string"
      },
      "enum":[
          "A",
          "C"
      ],
      "required":false
  }

• cabinNum: array
  • [0]: string

  {
      "in":"query",
      "name":"cabinNum",
      "type":"array",
      "items":{
          "type":"string"
      }
  }

• fullName(optional): string
• gateLocation: array
  • [0]: string

  {
      "in":"query",
      "name":"gateLocation",
      "type":"array",
      "items":{
          "type":"string"
      }
  }

• gateMovement: array
  • [0]: string

  {
      "in":"query",
      "name":"gateMovement",
      "type":"array",
      "items":{
          "type":"string"
      }
  }

• movementDateFrom(optional): string
• movementDateTo(optional): string
• profileId(optional): number
• searchValue(optional): string

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns a Gangway Activities Record

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object Oracle Response object containing list items
  Title: Oracle Response object containing list items

  The wrapper object when returning a list of objects in Oracle standard

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

Nested Schema : Oracle Response object containing list items

Type: object

Title: Oracle Response object containing list items

The wrapper object when returning a list of objects in Oracle standard

Show Source

• count(optional): number
  Example: 1
• hasMore(optional): boolean
  Example: false
• items(optional): array items
• limit(optional): number
  Example: 5
• offset(optional): number
  Example: 1

{
    "title":"Oracle Response object containing list items",
    "description":"The wrapper object when returning a list of objects in Oracle standard",
    "type":"object",
    "properties":{
        "count":{
            "type":"number",
            "example":1
        },
        "hasMore":{
            "type":"boolean",
            "example":false
        },
        "limit":{
            "type":"number",
            "example":5
        },
        "offset":{
            "type":"number",
            "example":1
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/gangwayActivitiesbyConditionList"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object gangwayActivitiesbyConditionList
  gangwayActivitiesList

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

Nested Schema : gangwayActivitiesbyConditionList

Type: object

gangwayActivitiesList

Show Source

• accountType(optional): string
  Example: P
• cabinNum(optional): string
  Example: 456
• fullName(optional): string
  Example: Quennie Ling
• gateLocation(optional): string
  Example: Manual Reset
• gateMovement(optional): string
  Example: Coming On-board
• Id(optional): number
  Example: 8202363
• movementDate(optional): string
  Example: 2016-03-18
• profileId(optional): number
  Example: 1072706
• swipeCard(optional): string
  Example: No
• userName(optional): string
  Example: hello
• workStation(optional): string
  Example: JESLYN

{
    "description":"gangwayActivitiesList",
    "type":"object",
    "properties":{
        "Id":{
            "type":"number",
            "example":8202363
        },
        "profileId":{
            "type":"number",
            "example":1072706
        },
        "fullName":{
            "type":"string",
            "example":"Quennie Ling"
        },
        "cabinNum":{
            "type":"string",
            "example":"456"
        },
        "movementDate":{
            "type":"string",
            "example":"2016-03-18"
        },
        "userName":{
            "type":"string",
            "example":"hello"
        },
        "workStation":{
            "type":"string",
            "example":"JESLYN"
        },
        "gateLocation":{
            "type":"string",
            "example":"Manual Reset"
        },
        "accountType":{
            "type":"string",
            "example":"P"
        },
        "swipeCard":{
            "type":"string",
            "example":"No"
        },
        "gateMovement":{
            "type":"string",
            "example":"Coming On-board"
        }
    }
}

400 Response

Unknown request found

401 Response

You do not have valid authorization

403 Response

You are not authorized to use the service

404 Response

Record not found

415 Response

Content format not supported

500 Response

Internal server error occurred

Back to Top