WikiAdmin: 1 revision imported

2023-07-14T12:58:52Z

1 revision imported

← Older revision

Revision as of 12:58, 14 July 2023

Chanson: /* Overview */

2023-05-08T20:12:23Z

Overview

New page

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

The Keystone REST Server exposes a REST API which is used to support Keystone Reports.

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

===Example URIs:===
<PRE>
http://127.0.0.1:8211/rest/kOLrepapi/v1/connection
</PRE>

==Connection Test API==

<b>ROOT: /rest/kOLrepapi/v1</b>

====connection====

<code>connection</code>

: tests connection with the server

<pre>
{
"status": "200",
"msg": "Keystone Online Report REST Server."
}
</pre>

==API v1==

<b>ROOT: /rest/kOLrepapi/v1</b>

====ARCustomerList====

<code>
ARCustomerList
</code>

: returns list of customers and customer information

====LookupARCODFlag====

<code>
LookupARCODFlag
</code>

: returns list of codes and descriptions of those codes

<pre>
[
{
"code": "Y",
"desc": "C.O.D."
},
{
"code": "N",
"desc": "Charge"
},
{
"code": "C",
"desc": "Cash"
},
{
"code": "B",
"desc": "Blocked"
},
{
"code": "D",
"desc": "Bad Debt"
}
]
</pre>

====LookupARCustomer====

<code>
LookupARCustomer
</code>

: returns list of customers and customer information

====LookupARCustomerClass====

<code>
LookupARCustomerClass
</code>

<pre>
[
{
"CLASS_NO": "00",
"ACTIVE_FLAG": "N"
},
{
"CLASS_NO": "CC",
"DESCRIPTION": "Commercial Concrete Contractor",
"ACTIVE_FLAG": "Y"
},
{
"CLASS_NO": "CD",
"DESCRIPTION": "COMMERICAL DIRECT",
"ACTIVE_FLAG": "Y"
},
{
"CLASS_NO": "CH",
"DESCRIPTION": "Church",
"ACTIVE_FLAG": "N"
},
{
"CLASS_NO": "CP",
"DESCRIPTION": "CONCRETE PRODUCERS-PRECAST",
"ACTIVE_FLAG": "Y"
},
{
"CLASS_NO": "CT",
"DESCRIPTION": "CONCRETE TESTING",
"ACTIVE_FLAG": "Y"
},
{
"CLASS_NO": "EM",
"DESCRIPTION": "Employee",
"ACTIVE_FLAG": "Y"
},
{
"CLASS_NO": "GC",
"DESCRIPTION": "GENERAL CONTRACTOR",
"ACTIVE_FLAG": "Y"
},
{
"CLASS_NO": "GO",
"DESCRIPTION": "MADOT / Municipal Contractors",
"ACTIVE_FLAG": "Y"
},
{
"CLASS_NO": "HB",
"DESCRIPTION": "Home Builders & Developers",
"ACTIVE_FLAG": "Y"
},
{
"CLASS_NO": "IN",
"DESCRIPTION": "Invite",
"ACTIVE_FLAG": "N"
},
{
"CLASS_NO": "KD",
"DESCRIPTION": "DEMOLITION/ENVIRONMENTAL",
"ACTIVE_FLAG": "Y"
},
{
"CLASS_NO": "MC",
"DESCRIPTION": "MASONRY CONTRACTOR",
"ACTIVE_FLAG": "Y"
},
{
"CLASS_NO": "MU",
"DESCRIPTION": "MUNCIPALITY",
"ACTIVE_FLAG": "Y"
},
{
"CLASS_NO": "NP",
"DESCRIPTION": "Not for profit",
"ACTIVE_FLAG": "Y"
},
{
"CLASS_NO": "PA",
"DESCRIPTION": "ASPHALT-PAVING",
"ACTIVE_FLAG": "Y"
},
{
"CLASS_NO": "RE",
"DESCRIPTION": "RESIDENTIAL CONTRACTOR",
"ACTIVE_FLAG": "N"
},
{
"CLASS_NO": "RF",
"DESCRIPTION": "Residential Flatwork",
"ACTIVE_FLAG": "Y"
},
{
"CLASS_NO": "RW",
"DESCRIPTION": "Residential Foundations",
"ACTIVE_FLAG": "Y"
},
{
"CLASS_NO": "SC",
"DESCRIPTION": "School/College/Universities",
"ACTIVE_FLAG": "Y"
},
{
"CLASS_NO": "SG",
"DESCRIPTION": "SAND & GRAVEL",
"ACTIVE_FLAG": "Y"
},
{
"CLASS_NO": "SW",
"DESCRIPTION": "Site Contractors",
"ACTIVE_FLAG": "Y"
},
{
"CLASS_NO": "UT",
"DESCRIPTION": "Utility Contractor",
"ACTIVE_FLAG": "Y"
}
]
</pre>

: returns list of customer classes

====LookupARPriceGroup====

<code>
LookupARPriceGroup
</code>

<pre>
[
{
"GROUP_NO": "1",
"DESCRIPTION": "$1.00 OFF LIST",
"ACTIVE_FLAG": "Y"
},
{
"GROUP_NO": "10",
"DESCRIPTION": "10.00",
"ACTIVE_FLAG": "Y"
},
{
"GROUP_NO": "2",
"DESCRIPTION": "$2.00 OFF LIST",
"ACTIVE_FLAG": "Y"
},
{
"GROUP_NO": "3",
"DESCRIPTION": "$3.00 OFF LIST",
"ACTIVE_FLAG": "Y"
},
{
"GROUP_NO": "4",
"DESCRIPTION": "$ 4.00 OFF LIST",
"ACTIVE_FLAG": "Y"
},
{
"GROUP_NO": "5",
"DESCRIPTION": "$5 OFF LIST",
"ACTIVE_FLAG": "Y"
},
{
"GROUP_NO": "6",
"DESCRIPTION": "$ 6.00 OFF LIST",
"ACTIVE_FLAG": "Y"
},
{
"GROUP_NO": "7",
"DESCRIPTION": "$ 7.00 OFF LIST",
"ACTIVE_FLAG": "Y"
},
{
"GROUP_NO": "8",
"DESCRIPTION": "$ 8.00 OFF LIST",
"ACTIVE_FLAG": "Y"
},
{
"GROUP_NO": "9",
"DESCRIPTION": "$ 9.00 OFF LIST",
"ACTIVE_FLAG": "Y"
}
]
</pre>

: returns list of different price categories

====LookupARSalesperson====

<code>
LookupARSalesperson
</code>

:returns info about salesmen

Keystone Online Reports API Ver. 1 - Revision history

WikiAdmin: 1 revision imported

Chanson: /* Overview */