WikiAdmin: 1 revision imported

2023-07-14T12:58:51Z

1 revision imported

← Older revision

Revision as of 12:58, 14 July 2023

Chanson: Created page with "CATEGORY: KSERVER ==Overview== The Keystone REST Server exposes a REST API which is used by the Keystone Customer Portal to communicate with the Keystone Application Serv..."

2023-05-08T19:25:35Z

Created page with "CATEGORY: KSERVER ==Overview== The Keystone REST Server exposes a REST API which is used by the Keystone Customer Portal to communicate with the Keystone Application Serv..."

New page

[[CATEGORY: KSERVER]]
==Overview==

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

See: [[Keystone_REST_Server_(KServer)]] for more on KServer.

===Example URIs:===
<PRE>http://127.0.0.1:8213/rest/kcpapi/v2/connection</PRE>

===Portal Functions===

====getcurrentorders====

<code>getcurrentorders</code>

: returns current and future orders for all customers

<code>getcurrentorders/{CustId}</code>

: returns current and future orders for specified CustId

<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;">
{
"currentorders": [
{
"sno": 510002,
"tno": 1,
"custid": "BER100",
"orderid": "510000",
"productid": "2510-01",
"description": "2500 PSI w\/ 57 Stone",
"qtyord": 60,
"slump": 3,
"custname": "Berkshire Power",
"jobid": "BELMONT RESERVOIR",
"shipto1": "BELMONT RESERVOIR PUMP STATION",
"usage": "SIDEWALK",
"ldcnt": 2,
"ldcompcnt": 8,
"completed": "N",
"deliverydt": "2016-03-17T10:00:00.000Z",
"nextlddt": "2016-03-17T14:36:28.000Z"
},
{
"sno": 510002,
"tno": 4,
"custid": "ALLEN",
"orderid": "510001",
"productid": "3010-01",
"description": "3000 PSI w\/ 1\" Stone",
"qtyord": 50,
"slump": 3,
"custname": "Allen Construction",
"jobid": "PARK-N-RIDE",
"shipto1": "2400 Corporate Exchange Dr",
"usage": "CURBS",
"ldcnt": 3,
"ldcompcnt": 7,
"completed": "N",
"deliverydt": "2016-03-17T10:15:00.000Z",
"nextlddt": "2016-03-17T14:45:00.000Z"
}
]
}
</pre>
</blockquote>

====gethistoricalorders====

<code>gethistoricalorders</code>

: returns historical orders for all customers for the last 30 days

<code>gethistoricalorders/{CustId}</code>

: returns historical orders for specified CustId for the last 30 days

<code>gethistoricalorders/{LoDate}/{HiDate}</code>

: returns historical orders for all customers within the specified Delivery Date range

<code>gethistoricalorders/{CustId}/{LoDate}/{HiDate}</code>

: returns historical orders for specified CustId within the specified Delivery Date range

<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;">
{
"historicalorders": [
{
"sno": 6980,
"tno": 7,
"custid": "COD",
"orderid": "2715",
"slump": 3,
"jobid": "JACK JOHNSON",
"shipto1": "Jack Johnson",
"custpo": "Verbal",
"custname": "CASH SALES",
"qtyord": 6,
"deliverydt": "2013-12-12T14:00:00.000Z"
},
{
"sno": 6980,
"tno": 4,
"custid": "ALLEN",
"orderid": "2714",
"slump": 3,
"jobid": "PARK-N-RIDE",
"shipto1": "2400 Corporate Exchange Dr",
"custname": "Allen Construction",
"usage": "BASE",
"qtyord": 100,
"deliverydt": "2013-12-12T13:30:00.000Z"
},
{
"sno": 6980,
"tno": 1,
"custid": "ALLEN",
"orderid": "2713",
"slump": 3,
"jobid": "ECCO VALLEY",
"custname": "Allen Construction",
"qtyord": 20,
"deliverydt": "2013-12-12T13:00:00.000Z"
}
]
}
</pre>
</blockquote>

====getorderdetails====

<code>getorderdetails/{SessionNo}/{TransNo}</code>

: returns order header, products and loads for specified order SessionNo, TransNo

<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;">
{
"orderinfo": [
{
"custid": "BER100",
"orderid": "510000",
"slump": 3,
"jobid": "BELMONT RESERVOIR",
"shipto1": "BELMONT RESERVOIR PUMP STATION",
"custname": "Berkshire Power",
"usage": "SIDEWALK",
"qtyord": 60,
"qtydel": 30,
"deliverydt": "2016-03-17T10:00:00.000Z"
}
],
"orderproducts": [
{
"lno": 1,
"productid": "2510-01",
"description": "2500 PSI w\/ 57 Stone",
"qtyord": 60,
"ldsize": 5,
"ums": "CY"
},
{
"lno": 2,
"productid": "FIBER-01",
"description": "FiberMesh",
"qtyord": 3,
"ldsize": 0,
"ums": "LB"
}
],
"orderloads": [
{
"ldno": 1,
"plantid": "01",
"truckid": "101",
"ldsize": 5,
"status": 8,
"ticketno": 510001,
"ticketdt": "2016-03-17T09:52:00.000Z",
"onjobdt": "2016-03-17T10:07:23.000Z",
"beginpourdt": "2016-03-17T10:15:11.000Z",
"endpourdt": "2016-03-17T10:44:12.000Z"
},
{
"ldno": 2,
"plantid": "01",
"truckid": "110",
"ldsize": 5,
"status": 8,
"ticketno": 510008,
"ticketdt": "2016-03-17T10:18:00.000Z",
"onjobdt": "2016-03-17T10:25:51.000Z",
"beginpourdt": "2016-03-17T10:33:50.000Z",
"endpourdt": "2016-03-17T11:02:41.000Z"
},
{
"ldno": 3,
"plantid": "01",
"truckid": "101",
"ldsize": 5,
"status": 8,
"ticketno": 510015,
"ticketdt": "2016-03-17T10:45:00.000Z",
"onjobdt": "2016-03-17T10:57:13.000Z",
"beginpourdt": "2016-03-17T11:04:53.000Z",
"endpourdt": "2016-03-17T11:33:39.000Z"
},
{
"ldno": 4,
"plantid": "01",
"truckid": "110",
"ldsize": 5,
"status": 8,
"ticketno": 510022,
"ticketdt": "2016-03-17T11:17:00.000Z",
"onjobdt": "2016-03-17T11:30:12.000Z",
"beginpourdt": "2016-03-17T11:38:00.000Z",
"endpourdt": "2016-03-17T12:07:30.000Z"
},
{
"ldno": 5,
"plantid": "01",
"truckid": "101",
"ldsize": 5,
"status": 8,
"ticketno": 510029,
"ticketdt": "2016-03-17T11:49:00.000Z",
"onjobdt": "2016-03-17T12:00:29.000Z",
"beginpourdt": "2016-03-17T12:08:52.000Z",
"endpourdt": "2016-03-17T12:37:44.000Z"
},
{
"ldno": 6,
"plantid": "01",
"truckid": "110",
"ldsize": 5,
"status": 8,
"ticketno": 510036,
"ticketdt": "2016-03-17T12:17:00.000Z",
"onjobdt": "2016-03-17T12:27:43.000Z",
"beginpourdt": "2016-03-17T12:35:43.000Z",
"endpourdt": "2016-03-17T13:06:10.000Z"
},
{
"ldno": 7,
"plantid": "01",
"truckid": "101",
"ldsize": 5,
"status": 5,
"ticketno": 510042,
"ticketdt": "2016-03-17T12:43:00.000Z",
"onjobdt": "2016-03-17T12:51:52.000Z",
"beginpourdt": "2016-03-17T12:59:27.000Z",
"endpourdt": "2016-03-17T13:29:27.000Z"
},
{
"ldno": 8,
"plantid": "01",
"truckid": "103",
"ldsize": 5,
"status": 3,
"ticketno": 510048,
"ticketdt": "2016-03-17T13:17:00.000Z",
"onjobdt": "2016-03-17T13:26:41.000Z",
"beginpourdt": "2016-03-17T13:35:41.000Z",
"endpourdt": "2016-03-17T14:05:41.000Z"
}
]
}
</pre>
</blockquote>

Keystone Customer Portal REST API Ver. 2 - Revision history

WikiAdmin: 1 revision imported

Chanson: Created page with "CATEGORY: KSERVER ==Overview== The Keystone REST Server exposes a REST API which is used by the Keystone Customer Portal to communicate with the Keystone Application Serv..."