@one-view/example-api-types
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.3 • Public • Published

    FORMAT: 1A VERSION: 1.0.0

    example api

    Order List [/order-list/v1/orders{?page,perPage,orderBy}]

    get list of order based on specific parameter

    • Parameters

      • page - order of page
      • perPage - number of record of page
      • orderBy - order record based on selected criteria
    • Attributes (OrderList)

    Get order list [GET]

    • Request

      • Headers

          Authorization: bearer token
        
    • 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 (number)
    • errorMessage (string)

    Error_401 (object)

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

    Error_404 (object)

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

    Error_403 (object)

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

    Error_400 (object)

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

    Error_500 (object)

    • errorCode : 500 (number)
    • 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

    OrderList

    • list (array[OrderListEntry])

    Keywords

    none

    Install

    npm i @one-view/example-api-types

    DownloadsWeekly Downloads

    0

    Version

    1.0.3

    License

    none

    Unpacked Size

    10.3 kB

    Total Files

    4

    Last publish

    Collaborators

    • alipsidik
    • ramadimasatria
    • forex
    • ichsanrp
    • alicanakyuz
    • gabrielang-fp
    • hendra.wijaya
    • fp_apac_jonathan.sudibya
    • jianann-fp
    • shing-fp