WikiAdmin: 1 revision imported

2023-07-14T12:58:52Z

1 revision imported

← Older revision

Revision as of 12:58, 14 July 2023

Chanson at 15:19, 4 May 2023

2023-05-04T15:19:53Z

New page

[[CATEGORY: KSERVER]]
==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:===
<PRE>
http://127.0.0.1:8211/rest/kdiapi/v2/connection
</PRE>

==Connection Test API==

ROOT: /rest/kdiapi/v2

====connection====

<code>connection</code>

: tests connection with the server

<blockquote>
<pre style="white-space: pre-wrap;
white-space: -moz-pre-wrap;
white-space: -pre-wrap;
white-space: -o-pre-wrap;
word-wrap: break-word;">
{
"kdiapi": {
"request_status": {
"status": "200",
"msg": "Keystone Dispatch REST Server."
}
}
}
</pre>
</blockquote>

==API v1==

ROOT: /rest/kdiapi/v1

===Dispatch Functions===

====CustomerInvoices====

<code>
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)
</code>

: returns invoices, aging and contacts for specified CustId
:: uses monthly aging based on today's date if aging dates not specified

====CustomerList====

<code>CustomerList</code>

: returns list of customers

====InvoiceHistory====

<code>InvoiceHistory/{Id}</code>

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

====LoadGpsLocation====

<code>LoadGpsLocation/{Id}</code>

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

====ScheduleByCust====

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

: 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====

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

: 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====

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

: 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====

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

: 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====

<code>
ScheduleOrderLoads/{Id}
 ?IncComplete=true|false
</code>

: 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====

<code>
Ticket/{Id}
</code>

: 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'''

Keystone Dispatch REST API - Revision history

WikiAdmin: 1 revision imported

Chanson at 15:19, 4 May 2023