12.44 New Customization for RESTful Web Service
Below are the list of services introduced and it follows new naming statndard for custom elements in request/response.
- Advance Disbursement Service (GET)
- Advance Disbursement Service (POST)
- Usage and Rental Service (GET)
- Collateral Usage History (POST)
- Asset Service (GET)
- Asset Service (POST)
- Application Contract Service (POST)
- User Create Service (POST)
- Rental Application Entry Service (POST)
- Vendor Create Service (POST)
- Vendor Update Service (PUT)
- Vendor Detail Fetch Service (GET)
- Vendor Comment Create service (POST)
- Vendor Comment Fetch Service (GET)
- Asset Valuation Create Service (POST)
- Asset Valuation Update Service (PUT)
- Asset Valuation Fetch Service (GET)
- Producer Comment Create Service (POST)
- Producer Comment Fetch Service (GET)
- Producer Contact Fetch Service (GET)
- Producer Contact Create Service (POST)
- Producer Compansaction Fetch Service (GET)
- Producer Holdback Fetch Service (GET)
- Producer Statement Fetch Service (GET)
- Subvention Detail Service (GET)
- Account Monitory Transaction History Fetch Service (GET)
- Webhook get maintenance details (GET)
- Webhook update event status details (PUT)
- Webhook Maintenance Post Service (POST)
- Webhook Maintenance Fetch Service (GET)
- Webhook Maintenance Update Service (PUT)
- User Update Service (PUT)
- Master Account Rolledup Balance Detail Service (GET)
- Application Decision Fetch Service (GET)
- Application Decision Update Service (PUT)
- Work Order Fetch Service (GET)
- Work Order Update Service (PUT)
- Work Order Post Service (POST)
Below mentioned are the custom fields. Custom fields will be supported in request/response for POST/PUT services and will be supported only in response for GET services.
Table 12-37 New Customization for RESTful Web Service
| Element name | Sub element | Data type |
|---|---|---|
| StringData | KeyName | String |
| KeyValue | String | |
| NumberData | KeyName | String |
| KeyValue | Number (Decimal) | |
| DateData | KeyName | String |
| KeyValue | Date (YYYY-MM-DDTHH:MM:SS) |
Sample
XML
<Custom>
<StringData>
<KeyName>OrgName</KeyName>
<KeyValue>Oracle</KeyValue>
</StringData>
<NumberData>
<KeyName>BusinessPhoneNumber</KeyName>
<KeyValue>1234.01</KeyValue>
</NumberData>
<DateData>
<KeyName>CreationDate</KeyName>
<KeyValue>2017-12-18T00:00:00</KeyValue>
</DateData>
</Custom>Sample
JSON
"Custom": {
"StringData": [
{
"KeyName": "StringName",
"KeyValue": "StringValue"
}
],
"NumberData": [
{
"KeyName": "NumberName",
"KeyValue": NumberValue
}
],
"DateData": [
{
"KeyName": "DateName",
"KeyValue": "DateValue"
}
]
}Below is the list of services which uses the Tracking Attribute in request/response
similar to Custom Elements for extensibilty.
- Producer Create Service (POST)
- Producer Update Service (PUT)
- Producer Fetch Service (GET)
- Account Tracking Attribute Fetch Service (GET)
Below mentioned are the Tracking Attribute fields. Tracking Attribute fields will be supported in request/response for POST/PUT services and will be supported only in response for GET services.
Table 12-38 Tracking Attribute fields
| Element name | Sub element | Data type |
|---|---|---|
| StringData | KeyName | String |
| KeyValue | String | |
| NumberData | KeyName | String |
| KeyValue | Number (Decimal) | |
| DateData | KeyName | String |
| KeyValue | Date (YYYY-MM-DDTHH:MM:SS) |
Sample
XML
<TrackingAttributes>
<StringData>
<KeyName>OrgName</KeyName>
<KeyValue>Oracle</KeyValue>
</StringData>
<NumberData>
<KeyName>BusinessPhoneNumber</KeyName>
<KeyValue>1234.01</KeyValue>
</NumberData>
<DateData>
<KeyName>CreationDate</KeyName>
<KeyValue>2017-12-18T00:00:00</KeyValue>
</DateData>
</TrackingAttributes>Sample
JSON
" TrackingAttributes ": {
" StringData": [
{
"KeyName": " StringName ",
"KeyValue": " StringValue "
}
],
" NumberData": [
{
"KeyName": " NumberName ",
"KeyValue": NumberValue
}
],
" DateData": [
{
"KeyName": " DateName ",
"KeyValue": " DateValue"
}
]
}Below mentioned are the package details and exit points for the above listed services.
Table 12-39 we
| Service name | Wrapper Package | Main Package | Exit Point Packages | ||
|---|---|---|---|---|---|
| Before | Replace | After | |||
| Advance Disbursement Service (GET) |
|
|
|
||
|
|
|
|||
| Advance Disbursement Service (POST) |
|
|
|
||
|
|
|
|||
| Application Contract Service (POST) |
|
|
|
||
|
|
|
|||
| Rental Application Entry Service (POST) |
|
|
|
||
|
|
|
|||
|
|
||||
|
|
|
|||
|
|
||||
|
|
|
|||
|
|
||||
|
|
|
|||
| Usage and Rental Service (GET) |
|
|
|
||
|
|
|
|||
| Asset Service (GET) |
|
|
|
||
|
|
|
|||
| Asset Service (POST) |
|
|
|
||
|
|
|
|||
|
|
||||
|
|
|
|||
| Asset Service (PUT) |
|
|
|
||
|
|
|
|||
| Asset Valuations Service (PUT) |
|
|
|
||
|
|
|
|||
| Asset Valuations Service (POST) |
|
|
|
||
|
|
|
|||
| Asset Valuations Service (GET) |
|
|
|
||
|
|
|
|||
| User Service (POST) |
|
|
|
||
|
|
|
|||
| Account Monitory Transaction History Fetch Service (GET) |
|
|
|
||
|
|
|
|||
|
|
||||
|
|
|
|||
| Vendor details fetch service (GET) |
|
|
|
||
|
|
|
|||
| Vendor Comment fetch service (GET) |
|
|
|
||
|
|
|
|||
| Vendor Create Service (POST) |
|
|
|
||
|
|
|
|||
|
|
||||
|
|
|
|||
| Vendor Comment Create Service (POST) |
|
|
|
||
|
|
|
|||
| Vendor Update Service (PUT) |
|
|
|
||
|
|
|
|||
| Producer Create Service (POST) |
|
|
|
||
|
|
|
|||
|
|
||||
|
|
|
|||
| Producer Fetch Service (GET) |
|
|
|
||
|
|
|
|||
|
|
||||
|
|
|
|||
| Producer Update Service (PUT) |
|
|
|
||
|
|
|
|||
|
|
||||
|
|
|
|||
| Producer Contact Service (POST) |
|
|
|
||
|
|
|
|||
|
|
||||
|
|
|
|||
| Producer Contact Service (GET) |
|
|
|
||
|
|
|
|||
|
|
||||
|
|
|
|||
| Producer Comment Service (POST) |
|
|
|
||
|
|
|
|||
|
|
||||
|
|
|
|||
| Producer Comment Service (GET) |
|
|
|
||
|
|
|
|||
|
|
||||
|
|
|
|||
| Producer Subvention Service (GET) |
|
|
|
||
|
|
|
|||
|
|
||||
|
|
|
|||
| Producer Compensation Service (GET) |
|
|
|
||
|
|
|
|||
|
|
||||
|
|
|
|||
| Producer Statement Service (GET) |
|
|
|
||
|
|
|
|||
|
|
||||
|
|
|
|||
| Producer Holdback Service (GET) |
|
|
|
||
|
|
|
|||
|
|
||||
|
|
|
|||
| Get webhook maintenance (GET) |
|
|
|
||
|
|
|
|||
|
|
||||
|
|
|
|||
| Webhooks update event status |
|
|
|
||
|
|
|
|||
| Webhooks maintenance : Save the webservice details (POST) |
|
|
|
||
|
|
|
|||
| Webhook Maintenance : retrieve the webservice details(GET) |
|
|
|
||
|
|
|
|||
|
|
|
|||
| Work Order Service (GET) |
|
|
|
||
|
|
|
|||
|
|
||||
|
|
|
|||
| Work Order Service (PUT) |
|
|
|
||
|
|
|
|||
|
|
||||
|
|
|
|||
| Work Order Service (POST) |
|
|
|
||
|
|
|
|||
|
|
||||
|
|
|
|||
Extensible parameters are Tab Type
object
CREATE OR REPLACE TYPE xws_att_str_rec_t AS OBJECT (
ATT_NAME VARCHAR2(30),
ATT_VALUE VARCHAR2(4000));
CREATE OR REPLACE TYPE xws_att_num_rec_t AS OBJECT (
ATT_NAME VARCHAR2(30),
ATT_VALUE NUMBER );
CREATE OR REPLACE TYPE xws_att_date_rec_t AS OBJECT (
ATT_NAME VARCHAR2(30),
ATT_VALUE DATE );
CREATE OR REPLACE TYPE XUS_USR_REC_T AS OBJECT (
XCS_USR_CODE VARCHAR2(30),
USR_CODE VARCHAR2(30),
USR_COM_COMPANY VARCHAR2(30),
USR_CMB_BRANCH VARCHAR2(30),
USR_CBD_DEPT VARCHAR2(30),
USR_FIRST_NAME VARCHAR2(30),
USR_MIDDLE_NAME VARCHAR2(30),
USR_LAST_NAME VARCHAR2(30),
USR_RESPONSIBILITY_CD VARCHAR2(30),
USR_RRQ_SUP_USR_CODE VARCHAR2(30),
USR_PHONE_NO1 NUMBER,
USR_PHONE_EXTN1 NUMBER,
USR_PHONE_NO2 NUMBER,
USR_PHONE_EXTN2 NUMBER,
USR_FAX_NO1 NUMBER,
USR_FAX_NO2 NUMBER,
USR_ENABLED_IND VARCHAR2(30),
USR_START_DT DATE,
USR_END_DT DATE,
USR_REPLACEMENT_USR_CODE VARCHAR2(30),
USR_REPLACEMENT_DT DATE,
USR_TYPE_CD VARCHAR2(30),
USR_TYPE_REFERENCE_ID NUMBER,
USR_EMAIL_ADDRESS VARCHAR2(160),
USR_TIME_ZONE_CD VARCHAR2(30),
USR_DEFAULT_LANGUAGE_CD VARCHAR2(30),
USR_TIME_ZONE_LEVEL_CD VARCHAR2(30),
STR_ATTR XWS_ATT_STR_TAB_T,
NUM_ATTR XWS_ATT_NUM_TAB_T,
DATE_ATTR XWS_ATT_DATE_TAB_T,
USR_RESULT XUS_RES_REC_T);Parent topic: RESTful Web Services Extensibility