AWB Summary

From WMS Wiki
Jump to: navigation, search

Contents

URL

http://<wms-url>/api/awb.summary.list

Description

Receives a date range and returns the AWB summary information.

Request

  • authenticationToken [varchar]
  • dateFrom [date]: Format must be mm/dd/yyyy.
  • dateTo [date]: Format must be mm/dd/yyyy.

Response

  • status [int]: returns 1 when successful and 0 when unsuccessful.
  • error [varchar]: returns "Invalid Security Token" if status is 0.
  • awbs [array]
    • masterAwb [varchar]
    • exportDate [date]
    • originAirport [varchar]
    • qtyFarmShipped [int]
    • qtyPQ [int]
    • qtyReceivedMiami [int]
    • qtyShippedMiami [int]
    • totalPieces [int]
    • totalFullBoxEquivalence [decimal]
    • comments [array]
      • postDate [date]
      • postedBy [varchar]
      • message [varchar]

Example

Request

     http://<wms-url>/api/awb.summary.list?authenticationToken=YOUR_TOKEN&dateFrom=01/01/2012&dateTo=01/10/2012

Response

Successful
  1. {
  2.     "awbs": [
  3.         {
  4.             "masterAwb": "729-0909-1212",
  5.             "exportDate": "12/20/2011",
  6.             "originAirport": "Medellin",
  7.             "qtyFarmShipped": 20,
  8.             "qtyPQ": 0,
  9.             "qtyReceivedMiami": 80,
  10.             "qtyShippedMiami": 0,
  11.             "totalPieces": 100,
  12.             "totalFullBoxEquivalence": 60.25,
  13.             "comments": [
  14.                 {
  15.                     "postDate": "12/21/2011 06:49",
  16.                     "postedBy": "John Doe",
  17.                     "message": "Sample comment"
  18.                 }
  19.             ]
  20.         },
  21.         {
  22.             "masterAwb": "404-0921-5454",
  23.             "exportDate": "12/20/2011",
  24.             "originAirport": "Medellin",
  25.             "qtyFarmShipped": 20,
  26.             "qtyPQ": 0,
  27.             "qtyReceivedMiami": 80,
  28.             "qtyShippedMiami": 0,
  29.             "totalPieces": 100,
  30.             "totalFullBoxEquivalence": 60.25,
  31.             "comments": [
  32.                 {
  33.                     "postDate": "12/21/2011 06:49",
  34.                     "postedBy": "John Doe",
  35.                     "message": "Sample comment"
  36.                 }
  37.             ]
  38.         }
  39.     ],
  40.     "status": 1
  41. }
Unsuccessful
     {"error":"Invalid Security Token.","status":0}

or

     {"error":"From date and to date are required.","status":0}

or

     {"error":"Invalid date range.","status":0}


Available Methods

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox