@one-view/pd-oneview-order-panel-types v0.0.5

FORMAT: 1A VERSION: 1.0.0 HOST: https://api.pd-oneview.net/order-panel

pd-oneview-order-panel

backend for order panel plugin

Order List /v1/orders{?page,perPage,orderBy,GID,filterKey,filterValue}

get list of order based on specific parameter

• Parameters

  • page (integer, optional) - order of page
    • Default: 1
  • perPage (integer, optional) - number of record of page
    • Default: 10
  • orderBy (string, optional) - order record based on selected criteria
    • Default: timestamp-desc
  • GID (string, optional) - global entity id
    • Default: FP_SG
  • filterKey (string, optional) - filter key used for filtering
  • filterValue (string, optional) - filter value used for filter key

• Attributes (OrderList)

Get order list GET

• Request

  • Headers

      Authorization: bearer token
      X-Contact-Id: case-id

• Response 200 (application/json)

  • Attributes (OrderList)

• Response 400 (application/json)

  • Attributes (Error_400)

• Response 403 (application/json)

  • Attributes (Error_403)

• Response 404 (application/json)

  • Attributes (Error_404)

• Response 500 (application/json)

  • Attributes (Error_500)

Data Structures

int8 (number)

int64 (number)

integer (number)

float (number)

date (string)

Error (object)

• errorCode (int64)
• errorMessage (string)

Error_401 (object)

• errorCode : 401 (int64)
• errorMessage : not authorize (string)

Error_404 (object)

• errorCode : 404 (int64)
• errorMessage : not found (string)

Error_403 (object)

• errorCode : 403 (int64)
• errorMessage : forbidden (string)

Error_400 (object)

• errorCode : 400 (int64)
• errorMessage : bad request (string)

Error_500 (object)

• errorCode : 500 (int64)
• errorMessage : internal server error (string)

OrderListEntry

• code : anba-ejsk (string) - order code
• itemCount : 3 (int64) - number of items in the order
• timestamp : 1572499999 (int64) - epoch timestamp the order was created
• amount : 18.50 (number) - order price
• status : ACTIVE (string) - order status
• currency : sgd (string) - currency

OrderList

• list (arrayOrderListEntry)