Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Usage

Dev WSDL location: https://thea.adcom.uci.edu/WebServices/DWHServer?wsdl

Dev Endpoint: https://thea.adcom.uci.edu/WebServices/DWHServer

isValidKFSSubObjects

Input Specifications

IndexParameterDescriptionRequired?Data Type (max length)Example
0kfsFiscalYearKFS Fiscal Year (e.g. 2013)YesString (4) 
1kfsChartCodeKFS Chart CodeYesString (2) 
2kfsAcctNumberKFS Account NumberYesString (7)'1234567'
3kfsObjectCodeKFS Object CodeYesString (4) 
4kfsSubObjectCodeKFS SubObject CodeYesString (4) 

DB Query

Code Block
SELECT SELECT 
CONVERT(varchar(4),UNIV_FISCAL_YR) AS UNIV_FISCAL_YR,  
FIN_COA_CD,  
ACCOUNT_NBR,  
FIN_OBJECT_CD,  
FIN_SUB_OBJ_CD,  
FIN_SUBOBJ_ACTV_CD

FROM CA_SUB_OBJECT_CD_T 
WHERE WHERE FINFIN_SUBOBJ_ACTV_CD <> 'N' AND 
(
 (univ_fiscal_yr = '2012' AND AND 
  fin_coa_cd='IR' AND AND 
  account_nbr='10007661000211' AND AND 
  fin_object_cd = 'CASH4400' AND AND 
  fin_sub_obj_cd = 'CASHBRM1') OR 
 (univ_fiscal_yr = '2012' AND 
  fin_coa_cd='IR' AND 
  account_nbr='1000211' AND 
  fin_object_cd = '4400' AND 
  fin_sub_obj_cd = 'ITM1') OR
 (univ_fiscal_yr = '2012' AND
  fin_coa_cd='IR' AND 
  account_nbr='10007661000211' AND 
  fin_object_cd = 'CASH0000' AND 
  fin_sub_obj_cd = 'XXXX')
);

Result Schema: A list of following elements (SubObjectValidation.java)

ParameterDescriptionData TypeExample
kfsFiscalYearThe KFS Fiscal YearString (4)'2013'
kfsChartCodeThe KFS chart of accounts codeString (2)

'IR'

kfsAcctNumberKFS Account NumberString(7)'1234567'
kfsObjCodeKFS Object CodeString (4)'CASH'
kfsSubObjCodeKFS SubObject CodeString (4)'CASH'
isValidIs the SubObject Active?booleantrue

WS Example

Request
Code Block
 
Response
Code Block
 

Java Client Example

Code Block
 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adc="http://www.adcom.uci.edu">
   <soapenv:Header/>
   <soapenv:Body>
      <adc:isValidKFSSubObjects>
         <kfsSubObjectList>
            <item>2012</item>
            <item>IR</item>
            <item>1000211</item>
            <item>4400</item>
            <item>BRM1</item>
         </kfsSubObjectList>
         <kfsSubObjectList>
            <item>2012</item>
            <item>IR</item>
            <item>1000211</item>
            <item>4400</item>
            <item>ITM1</item>
         </kfsSubObjectList>
         <kfsSubObjectList>
            <item>2012</item>
            <item>IR</item>
            <item>1000211</item>
            <item>0000</item>
            <item>XXXX</item>
         </kfsSubObjectList>
      </adc:isValidKFSSubObjects>
   </soapenv:Body>
</soapenv:Envelope>
Response
Code Block
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns2:isValidKFSSubObjectsResponse xmlns:ns2="http://www.adcom.uci.edu">
         <return>
            <kfsAcctNumber>1000211</kfsAcctNumber>
            <kfsChartCode>IR</kfsChartCode>
            <kfsFiscalYear>2012</kfsFiscalYear>
            <kfsObjCode>4400</kfsObjCode>
            <kfsSubObjCode>BRM1</kfsSubObjCode>
            <valid>true</valid>
         </return>
         <return>
            <kfsAcctNumber>1000211</kfsAcctNumber>
            <kfsChartCode>IR</kfsChartCode>
            <kfsFiscalYear>2012</kfsFiscalYear>
            <kfsObjCode>4400</kfsObjCode>
            <kfsSubObjCode>ITM1</kfsSubObjCode>
            <valid>true</valid>
         </return>
         <return>
            <kfsAcctNumber>1000211</kfsAcctNumber>
            <kfsChartCode>IR</kfsChartCode>
            <kfsFiscalYear>2012</kfsFiscalYear>
            <kfsObjCode>0000</kfsObjCode>
            <kfsSubObjCode>XXXX</kfsSubObjCode>
            <valid>false</valid>
         </return>
      </ns2:isValidKFSSubObjectsResponse>
   </soap:Body>
</soap:Envelope>

Java Client Example

Code Block
DWHServerService dss = new DWHServerService();
DWHServer ds = dss.getDWHServerPortCustom();

System.out.println("\n=======================================isValidKFSSubObjects()================================");
List<SubObjectValidation> resultList22 = myBean.isValidKFSSubObjects(new String[][] {{"2012","IR","1000211","4400","BRM1"},{"2012","IR","1000211","4400","ITM1"},{"2012","IR","1000211","0000","XXXX"}});
if (resultList22 != null) {
	for (Iterator i = resultList22.iterator(); i.hasNext();) {
		SubObjectValidation element = (SubObjectValidation)i.next();
		System.out.println("SERVER UNIT TEST-Result List22: " + element.toString());
	}
} else {
	System.out.println("something bad happened...please check your query");
}

 

...

getValidKFSSubObjects

Input Specifications

IndexParameterDescriptionRequired?Data Type (max length)Example
0kfsFiscalYearKFS Fiscal Year (e.g. 2013)YesString (4) 
1kfsChartCodeKFS Chart CodeYesString (2) 
2kfsAcctNumberKFS Account NumberYesString (7)'1234567'
3kfsObjectCodeKFS Object CodeYesString (4) 
4kfsSubObjectCodeKFS SubObject CodeYesString (4) 

DB Query

Code Block
SELECT SELECT 
CONVERT(varchar(4), a.univ_fiscal_yr) AS UNIV_FISCAL_YR,
a.fin_coa_cd,  
a.account_nbr,  
a.fin_object_cd,  
b.fin_obj_cd_nm,  
a.fin_sub_obj_cd,  
a.fin_sub_obj_cd_nm 
FROM CA_SUB_OBJECT_CD_T a, CA_OBJECT_CODE_T b 
WHERE a.fin_object_cd = b.fin_object_cd AND a.FIN_SUBOBJ_ACTV_CD <> 'N' AND
(
 (a.univ_fiscal_yr = '2012' AND 
  a.fin_coa_cd='IR' AND 
  a.account_nbr='1000211' AND 
  a.fin_object_cd = '4400' AND 
  a.fin_sub_obj_cd = 'BRM1') OR 
 (a.univ_fiscal_yr = '2012' AND 
  a.fin_coa_cd='IR' AND 
  a.account_nbr= '10007661000211' AND 
  a.fin_object_cd = 'CASH4400' AND 
  a.fin_sub_obj_cd = 'CASHITM1') OR
 (a.univ_fiscal_yr = '2012' AND
  a.fin_coa_cd='IR' AND 
  a.account_nbr='10007661000211' AND 
  a.fin_object_cd = 'CASH0000' AND 
  a.fin_sub_obj_cd = 'XXXX')
);

Result Schema: A list of following elements (SubObjectDetails.java)

DB ParameterJava ParameterDescriptionData Type 
UNIV_FISCAL_YR
kfsFiscalYearKFS Fiscal YearString (4)2012
FIN_COA_CD
kfsChartCodeKFS Chart CodeString (2)'IR'
ACCOUNT_NBM
kfsAcctNumberKFS Account NumberString (7)

'1234567'

FIN_OBJECT_CD
kfsObjCodeKFS Object CodeString (4)'CASH'
FIN_OBJ_CD_NM
kfsObjCodeNameKFS Object Code NameString (40) 
FIN_SUB_OBJ_CD
kfsSubObjCodeKFS SubObject CodeString (4)'CASH'
FIN_SUB_OBJ_CD_NM
kfsSubObjCodeNameKFS SubObject Code NameString (40) 

WS Example

Request

...

Code Block
 
Response
Code Block
 

Java Client Example

Code Block
 

 

getAllKFSSubObjects

No input parameter, ALL active KFS sub object details will be returned in result set.

DB Query

Code Block
SELECT 
CONVERT(varchar(4), a.univ_fiscal_yr) AS UNIV_FISCAL_YR,
a.fin_coa_cd, 
a.account_nbr, 
a.fin_object_cd, 
b.fin_obj_cd_nm, 
a.fin_sub_obj_cd, 
a.fin_sub_obj_cd_nm 
FROM CA_SUB_OBJECT_CD_T a, CA_OBJECT_CODE_T b 
WHERE a.fin_object_cd = b.fin_object_cd AND a.FIN_SUBOBJ_ACTV_CD <> 'N'

Result Schema: Same as getValidKFSSubObjects()

WS Example

Request
Code Block
 
Response
Code Block
 

Java Client Example

Code Block
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adc="http://www.adcom.uci.edu">
   <soapenv:Header/>
   <soapenv:Body>
      <adc:getValidKFSSubObjects>
         <kfsSubObjectList>
            <item>2012</item>
            <item>IR</item>
            <item>1000211</item>
            <item>4400</item>
            <item>BRM1</item>
         </kfsSubObjectList>
         <kfsSubObjectList>
            <item>2012</item>
            <item>IR</item>
            <item>1000211</item>
            <item>4400</item>
            <item>ITM1</item>
         </kfsSubObjectList>
         <kfsSubObjectList>
            <item>2012</item>
            <item>IR</item>
            <item>1000211</item>
            <item>0000</item>
            <item>XXXX</item>
         </kfsSubObjectList>      
      </adc:getValidKFSSubObjects>
   </soapenv:Body>
</soapenv:Envelope>
Response
Code Block
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns2:getValidKFSSubObjectsResponse xmlns:ns2="http://www.adcom.uci.edu">
         <return>
            <kfsAcctNumber>1000211</kfsAcctNumber>
            <kfsChartCode>IR</kfsChartCode>
            <kfsFiscalYear>2012</kfsFiscalYear>
            <kfsObjCode>4400</kfsObjCode>
            <kfsObjCodeName>METERED MAIL</kfsObjCodeName>
            <kfsSubObjCode>BRM1</kfsSubObjCode>
            <kfsSubObjCodeName>BUSINESS REPLY MAIL</kfsSubObjCodeName>
         </return>
         <return>
            <kfsAcctNumber>1000211</kfsAcctNumber>
            <kfsChartCode>IR</kfsChartCode>
            <kfsFiscalYear>2012</kfsFiscalYear>
            <kfsObjCode>4400</kfsObjCode>
            <kfsObjCodeName>METERED MAIL</kfsObjCodeName>
            <kfsSubObjCode>ITM1</kfsSubObjCode>
            <kfsSubObjCodeName>INTERNATIONAL MAIL</kfsSubObjCodeName>
         </return>
      </ns2:getValidKFSSubObjectsResponse>
   </soap:Body>
</soap:Envelope>

Java Client Example

Code Block
DWHServerService dss = new DWHServerService();
DWHServer ds = dss.getDWHServerPortCustom();

System.out.println("\n=======================================getValidKFSSubObjects()================================");
List<SubObjectDetails> resultList23 = myBean.getValidKFSSubObjects(new String[][]{{"2012","IR","1000211","4400","BRM1"},{"2012","IR","1000211","4400","ITM1"},{"2012","IR","1000211","0000","XXXX"}});
if (resultList23 != null) {
	for (Iterator i = resultList23.iterator(); i.hasNext();) {
		SubObjectDetails element = (SubObjectDetails)i.next();
		System.out.println("SERVER UNIT TEST-Result List23: " + element.toString());
	}
} else {
	System.out.println("something bad happened...please check your query");
}

 

...