AWB House Summary

From WMS Wiki
Jump to: navigation, search

Contents

URL

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

Description

Receives an AWB and returns the house details.

Request

  • authenticationToken [varchar]
  • masterAwb [varchar]

Response

  • status [int]: returns 1 when successful and 0 when unsuccessful.
  • error [varchar]: returns "Invalid Security Token" if status is 0.
  • houses [array]
    • houseAwb [varchar]
    • grower [varchar]
    • group [varchar]
    • consignee [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.house.summary.list?authenticationToken=token&masterAwb=729-0101-0202

Response

Successful
  1. {
  2.     "houses": [
  3.         {
  4.             "houseAwb": "H001",
  5.             "grower": "Flores del Sol",
  6.             "group": "Flores del Sol",
  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 09:20",
  16.                     "postedBy": "John Doe",
  17.                     "message": "Sample comment on house AWB"
  18.                 }
  19.             ]
  20.         },
  21.         {
  22.             "houseAwb": "H002",
  23.             "grower": "Flores Ornamentales",
  24.             "group": "Flores Ornamentales",
  25.             "qtyFarmShipped": 17,
  26.             "qtyPQ": 0,
  27.             "qtyReceivedMiami": 30,
  28.             "qtyShippedMiami": 0,
  29.             "totalPieces": 47,
  30.             "totalFullBoxEquivalence": 25,
  31.             "comments": [
  32.                 {
  33.                     "postDate": "12/21/2011 09:20",
  34.                     "postedBy": "John Doe",
  35.                     "message": "Sample comment on house AWB"
  36.                 },
  37.                 {
  38.                     "postDate": "12/21/2011 10:28",
  39.                     "postedBy": "John Doe",
  40.                     "message": "An additional comment on the same house AWB"
  41.                 }
  42.             ]
  43.         }
  44.     ],
  45.     "status": 1
  46. }
Unsuccessful
     {"error":"Invalid Security Token.","status":0}


Available Methods

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox