REL documentation
API changes: ACTION REQUIRED.
wmstools wmsevents (http://api.3plcentral.com/rels/wmstools/wmsevents)
Resource:
Collection: of wmsevent
C# Rel Const:
Rels.ToolSvc.WMSEventList
URI template:
wmsevents{?pgsiz,pgnum,lastrequestedwmseventid,reversesort}
Obtain URI from:
Billboard
Get a list of WMSEvent records where the wms event id is greater than 'lastRequestedWMSEventId', sorted by wms event id in ascending order.
Success status: 200
Name Data Type Description
pgsiz int max records to return per response; use "next" or "prev" link to paginate
pgnum int considering pgsiz, returns the pgnum-th page, 1-indexed
lastrequestedwmseventid Int64 the highest (numerically) wms event id of the last previously requested list of WMSEvent records
reversesort bool default false; if true, records will return ordered by wms event id deescending and pgsiz will be set to 1. This is for determining the maximum wms event id.
Type Description
TotalResults int
ResourceList IList<WmsTool.Models.WMSEvent>
WMSEventId Int64
WarehouseTransactionEventId Int64
Datetime DateTime ! ! ! DEPRECATED ! ! ! Use EventDatetimeUtc instead. The time (in UTC) the event occurred. Will always have the same value as EventDatetimeUtc.
EventDatetimeUtc DateTime The time (in UTC) the event occurred.
CreateDatetimeUtc DateTime The time (in UTC) the WMSEvent record was written, which may differ significantly from -- but always be later than -- when the event occurred (EventDatetimeUtc).
EventType string
TransactionId int? ...
CustomerId int? ...
ResourceLink Generic.Models.WMSLink
Href string
Rel string
OtherLinks IEnumerable<Generic.Models.WMSLinkBase>
Rel string
Data string
Tags string
Links IList<WebApi.Hal.Link>
- next
- prev
Sample accept: application/hal+json
{
  "totalResults": 1,
  "_embedded": {
    "http://api.3plCentral.com/rels/wmstools/wmsevent": [
      {
        "wmsEventId": 1,
        "warehouseTransactionEventId": 2,
        "datetime": "2016-12-25T23:00:00",
        "eventDatetimeUtc": "2016-12-25T23:00:00",
        "createDatetimeUtc": "2016-12-25T23:00:00",
        "eventType": "str",
        "transactionId": 1,
        "customerId": 1,
        "resourceLink": {
          "href": "str",
          "rel": "str"
        },
        "otherLinks": [
          {
            "rel": "str"
          }
        ],
        "data": "str",
        "tags": "str"
      }
    ]
  }
}

This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@extensiv.com with any questions about this documentation.