Keystone Dispatch REST API

Overview

The Keystone REST Server exposes a REST API which is used by Keystone Dispatch to communicate with the Keystone Application Server.

Keystone Dispatch is accessed from Keystone Cloud applications.

See: Keystone_REST_Server_(KServer) for more on KServer.

Example URIs:

http://127.0.0.1:8211/rest/kdiapi/v2/connection

Connection Test API

ROOT: /rest/kdiapi/v2

connection

connection

tests connection with the server

{
  "kdiapi": {
    "request_status": {
      "status": "200",
      "msg": "Keystone Dispatch REST Server."
    }
  }
}

API v1

ROOT: /rest/kdiapi/v1

Dispatch Functions

CustomerInvoices

CustomerInvoices/{CustId}/{AgingDateLo1}/{AgingDateLo2}/{AgingDateHi2}/{AgingDateLo3}/{AgingDateHi3}/{AgingDateLo4}/{AgingDateHi4}/{AgingDateHi5}
?AgeByDate=0|1 (0=Invoice Date, 1=Due Date)
?IncPaid=N|Y (N=Open Invoices only, Y=All Invoices)

returns invoices, aging and contacts for specified CustId

uses monthly aging based on today's date if aging dates not specified

CustomerList

CustomerList

returns list of customers

InvoiceHistory

InvoiceHistory/{Id}

returns invoice history (tickets and payments) for the specified Id (where Id is <session#>K<trans#>)

LoadGpsLocation

LoadGpsLocation/{Id}

returns load gps location information for the specified Id (where Id is <session#>K<trans#>K<load#>)

ScheduleByCust

ScheduleByCust/{BegSchedDT}/{EndSchedDT}
?IncComplete=true|false
?SlsId={SlsId}

returns schedule information summarized by customer

uses today's date if BegSchedDT not specified

uses last second of BegSchedDt if EndSchedDT not specified

includes completed orders if IncComplete is true

restrict to salesperson SlsId if specified

ScheduleByPlant

ScheduleByPlant/{BegSchedDT}/{EndSchedDT}
?IncComplete=true|false

returns schedule information summarized by plant

uses today's date if BegSchedDT not specified

uses last second of BegSchedDt if EndSchedDT not specified

includes completed orders if IncComplete is true

ScheduleBySls

ScheduleBySls/{BegSchedDT}/{EndSchedDT}
?IncComplete=true|false

returns schedule information summarized by salesperson

uses today's date if BegSchedDT not specified

uses last second of BegSchedDt if EndSchedDT not specified

includes completed orders if IncComplete is true

results restricted to single salesperson if current user is locked to a salesperson (NOT IMPLEMENTED YET)

ScheduleOrders

ScheduleOrders/{BegSchedDT}/{EndSchedDT}/{ActiveCarryHrs}/{UndelvCarryHrs}/{NTLLookAheadHrs}/{OrdselRangeHrs}
?IncComplete=true|false
?SlsId={SlsId}
?CustId={CustId}
?PlantId={PlantId}

returns schedule order information

includes completed orders if IncComplete is true

restrict to salesperson SlsId if specified

restrict to customer CustId if specified

restrict to plant PlantId if specified

ScheduleOrderLoads

ScheduleOrderLoads/{Id}
?IncComplete=true|false

returns schedule order load information (active & completed loads) for the specified Id (where Id is <session#>K<trans#>)

includes completed orders if IncComplete is true

Ticket

Ticket/{Id}

returns ticket, products and batch weights information for the specified Id (where Id is <session#>K<trans#>)

Additional Information

Order Status Codes

• CANCELLED X
• CLOSED C
• COMPLETED F
• HOLD H
• OPEN O
• QUOTE Q