WikiAdmin: 1 revision imported

2023-07-14T12:58:52Z

1 revision imported

← Older revision

Revision as of 12:58, 14 July 2023

Chanson at 16:50, 19 April 2018

2018-04-19T16:50:05Z

New page

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

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

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

==Negotiation API==

<b>ROOT: /rest</b>

====apinegotiate====

<code>apinegotiate/{ClientId}/{ClientApiMin}/{ClientApi}</code>

: negotiates API version with the server and returns

<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;">
1
</pre>
</blockquote>

==API v1==

<b>ROOT: /rest/kmsapi1</b>

===System/Session Functions===

====systeminfo====

<code>systeminfo</code>

: returns system license information and list of companies

<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;">
{ "licenseinfo":
[
{ "serialno": 12345,
"sysloc": 0,
"licenseename": "XYZ Company"
}
],
"companylist":
[
{ "id": "001",
"name": "XYZ Company",
"type": "N"
},
{ "id": "002",
"name": "Practice",
"type": "P"
}
]
}
</pre>
</blockquote>

====userlogin====

<code>userlogin/{CoId}/{UserId}/{EncryptedPassword}/{OSVersion}</code>

: logs in specified UserId and returns session information

<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;">
{ "session":
{ "sessionname": "abcdefg",
"loginname": "john",
"fullname": "John Q Public",
"groupname": "user",
"securityclass": "50",
"lastcoid": "001",
"entityid": "",
"roleclass": "U",
"options": ""
}
}
</pre>
</blockquote>

====userlogout====

<code>userlogout/{SessionKey}</code>

: logs out user and closes out session for specified SessionKey

====usersessionexpired====

<code>usersessionexpired/{UserId}</code>

: logs out specified UserId

===Mobile Functions===

====customerinvoices====

<code>customerinvoices/{CustId}/{IncludePaid}/{AgeByDate}/{AgingDateLo1}/{AgingDateLo2}/{AgingDateHi2}/{AgingDateLo3}/{AgingDateHi3}/{AgingDateLo4}/{AgingDateHi4}/{AgingDateHi5}</code>

: returns invoices for specified CustId

====customerlist====

<code>customerlist</code>

: returns list of customers

====invoicehistory====

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

: returns invoice history (tickets and payments) for specified invoice (SessionNo, TransNo)

====loadgpslocation====

<code>loadgpslocation/{OrderSessionNo}/{OrderTransNo}/{LoadNo}</code>

: returns gps location information for specified load (OrderSessionNo, OrderTransNo, LoadNo)

====schedulecust====

<code>schedulecust/{SlsId}/{BegSchedDT}/{EndSchedDT}/{ActiveCarryHrs}/{UndelvCarryHrs}/{NTLLookAheadHrs}/{OrdselRangeHrs}/{ShowCompletedOrders}</code>

: returns schedule information summarized by customer for salesperson SlsId

====schedulecustorderloads====

<code>schedulecustorderloads/{SessionNo}/{TransNo}/{BegSchedDT}/{EndSchedDT}/{ActiveCarryHrs}/{UndelvCarryHrs}/{NTLLookAheadHrs}/{OrdselRangeHrs}/{ShowCompletedOrders}</code>

: returns schedule information (active & completed loads) for specified order (SessionNo, TransNo)

====schedulecustorders====

<code>schedulecustorders/{SlsId}/{CustId}/{BegSchedDT}/{EndSchedDT}/{ActiveCarryHrs}/{UndelvCarryHrs}/{NTLLookAheadHrs}/{OrdselRangeHrs}/{ShowCompletedOrders}</code>

: returns schedule information (active & completed orders) for salesperson SlsId customer CustId

====scheduleplant====

<code>scheduleplant/{BegSchedDT}/{EndSchedDT}/{ActiveCarryHrs}/{UndelvCarryHrs}/{NTLLookAheadHrs}/{OrdselRangeHrs}/{ShowCompletedOrders}</code>

: returns schedule information summarized by plant

====scheduleplantorderloads====

<code>scheduleplantorderloads/{SessionNo}/{TransNo}/{BegSchedDT}/{EndSchedDT}/{ActiveCarryHrs}/{UndelvCarryHrs}/{NTLLookAheadHrs}/{OrdselRangeHrs}/{ShowCompletedOrders}</code>

: returns schedule information (active & completed loads) for specified order (SessionNo, TransNo)

====scheduleplantorders====

<code>scheduleplantorders/{PlantId}/{BegSchedDT}/{EndSchedDT}/{ActiveCarryHrs}/{UndelvCarryHrs}/{NTLLookAheadHrs}/{OrdselRangeHrs}/{ShowCompletedOrders}</code>

: returns schedule information (active & completed orders) for plant PlantId

====schedulesls====

<code>schedulesls/{BegSchedDT}/{EndSchedDT}/{ActiveCarryHrs}/{UndelvCarryHrs}/{NTLLookAheadHrs}/{OrdselRangeHrs}/{ShowCompletedOrders}</code>

: returns schedule information summarized by salesperson
:: results restricted to single salesperson if current user is locked to a salesperson (New in Keystone 3.1.9)

====ticketinfo====

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

: returns ticket detail information for specified ticket (SessionNo, TransNo)

Keystone Mobile Server REST API - Revision history

WikiAdmin: 1 revision imported

Chanson at 16:50, 19 April 2018