Versions Compared

Key

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

KFS Chart Web Services

WSDL location: http://localhost:8080/WebService/DWHServer?wsdl

Endpoint: http://localhost:8080/WebService/DWHServer

isValidKFSCharts(List of kfsChartCode)

...

ParameterDescriptionRequired?Data Type (max length)
kfsChartCodeThe KFS chart of accounts codeYesString (2)

...

DB Query:

Code Block
select distinct
'IR',
case when not exists (select * FROM dwhs_ods..ca_chart_t a  where a.fin_coa_cd= 'IR' 
                       AND a.FIN_COA_ACTIVE_CD <> 'N' )
then 'false'
else 'true'
end
 
SELECT FIN_COA_CD, FIN_COA_ACTIVE_CD FROM dwhs_ods..ca_chart_t WHERE fin_coa_cd IN ('IR', 'MC');

...

ParameterDescriptionData TypeExample
kfsChartCodeKFS Chart CodeString (2)'IR'
isValidIs the Chart Active for that Fiscal Period?booleantrue

WS Example

Request
Code Block
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adc="http://www.adcom.uci.edu">
   <soapenv:Header/>
   <soapenv:Body>
      <adc:isValidKFSCharts>
         <!--Zero or more repetitions:-->
         <kfsChartCodeList>IR</kfsChartCodeList>
         <kfsChartCodeList>MC</kfsChartCodeList>
         <kfsChartCodeList>XX</kfsChartCodeList>
         <kfsChartCodeList>MC</kfsChartCodeList>
      </adc:isValidKFSCharts>
   </soapenv:Body>
</soapenv:Envelope>
Response
Code Block
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns2:isValidKFSChartsResponse xmlns:ns2="http://www.adcom.uci.edu">
         <return>
            <kfsChartCode>XX</kfsChartCode>
            <valid>false</valid>
         </return>
         <return>
            <kfsChartCode>IR</kfsChartCode>
            <valid>true</valid>
         </return>
         <return>
            <kfsChartCode>MC</kfsChartCode>
            <valid>true</valid>
         </return>
      </ns2:isValidKFSChartsResponse>
   </soap:Body>
</soap:Envelope>

...

ParameterDescriptionRequired?Data Type (max length)
kfsChartCodeListA list of KFS chart of accounts codeYesA List of String (2)

...

DB Query:

Code Block
SELECT FIN_COA_CD
      ,FIN_COA_DESC
      ,FIN_COA_ACTIVE_CD
      ,FIN_CASH_OBJ_CD
      ,FIN_AP_OBJ_CD
      ,INCBDGT_ELIMOBJ_CD
      ,EXPBDGT_ELIMOBJ_CD
      ,RPTS_TO_FIN_COA_CD
      ,FIN_AR_OBJ_CD
      ,FIN_INT_ENC_OBJ_CD
      ,FIN_EXT_ENC_OBJ_CD
      ,FIN_PRE_ENC_OBJ_CD
      ,ICR_INC_FIN_OBJ_CD
      ,ICR_EXP_FIN_OBJ_CD
      ,FND_BAL_OBJ_CD
  FROM ca_chart_t
WHERE FIN_COA_ACTIVE_CD <> 'N' 
AND FIN_COA_CD IN ('<kfsChartCode1>', '<kfsChartCode2>', etc)

...

ParameterDescriptionData TypeExample
kfsChartCodeKFS Chart CodeString (2)'IR'
kfsChartDescriptionKFS Chart DescriptionString (40)'Irvine'
kfsChartActiveCodeKFS Chart Active Code ('Y' for yes, 'N' for no)String (1)'Y'
kfsFinCashObjCodeKFS Cash Object CodeString (4)'0000'
kfsFinAPObjCodeKFS Accounts Payable Object CodeString (4)'0000'
kfsIncBdgtElimObjCodeKFS Income Budget Elimination Object CodeString (4)'0000'
kfsExpBdgtElimObjCodeKFS Expense Budget Elimination Object CodeString (4)'0000'
kfsRptsToChartCodeKFS Reports to Chart CodeString (2)'MC'
kfsARObjCodeKFS Accounts Receivable Object CodeString (4)'0000'
kfsIntEncObjCodeKFS Internal Encumbrances Object CodeString (4)'0000'

kfsExtEncObjCode

KFS External Encumbrances Object CodeString (4)'0000'
kfsPreEncObjCodeKFS Pre Encumbrances Object CodeString (4)'0000'
kfsICRIncObjCodeKFS Indirect Cost Recovery Income Object CodeString (4)'0000'
kfsICRExpObjCodeKFS Indirect Cost Recovery Expense Object CodeString (4)'0000'
kfsFundBalObjCodeKFS Fund Balance Object CodeString (4)'0000'

WS Example

Request
Code Block
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adc="http://www.adcom.uci.edu">
   <soapenv:Header/>
   <soapenv:Body>
      <adc:getValidKFSCharts>
         <!--Zero or more repetitions:-->
         <kfsChartCodeList>IR</kfsChartCodeList>
         <kfsChartCodeList>MC</kfsChartCodeList>
         <kfsChartCodeList>MC</kfsChartCodeList>
      </adc:getValidKFSCharts>
   </soapenv:Body>
</soapenv:Envelope>
Response
Code Block
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns2:getValidKFSChartsResponse xmlns:ns2="http://www.adcom.uci.edu">
         <return>
            <kfsARObjCode>0052</kfsARObjCode>
            <kfsChartActiveCode>Y</kfsChartActiveCode>
            <kfsChartCode>IR</kfsChartCode>
            <kfsChartDescription>UC Irvine</kfsChartDescription>
            <kfsExtEncObjCode>9998</kfsExtEncObjCode>
            <kfsFinAPObjCode>0051</kfsFinAPObjCode>
            <kfsFinCashObjCode>CASH</kfsFinCashObjCode>
            <kfsFundBalObjCode>0000</kfsFundBalObjCode>
            <kfsICRExpObjCode>3800</kfsICRExpObjCode>
            <kfsICRIncObjCode>3800</kfsICRIncObjCode>
            <kfsIntEncObjCode>9998</kfsIntEncObjCode>
            <kfsPreEncObjCode>9998</kfsPreEncObjCode>
            <kfsRptsToChartCode>UC</kfsRptsToChartCode>
         </return>
         <return>
            <kfsARObjCode>0052</kfsARObjCode>
            <kfsChartActiveCode>Y</kfsChartActiveCode>
            <kfsChartCode>MC</kfsChartCode>
            <kfsChartDescription>Medical Center</kfsChartDescription>
            <kfsExtEncObjCode>9998</kfsExtEncObjCode>
            <kfsFinAPObjCode>0051</kfsFinAPObjCode>
            <kfsFinCashObjCode>CASH</kfsFinCashObjCode>
            <kfsFundBalObjCode>0000</kfsFundBalObjCode>
            <kfsICRExpObjCode>3800</kfsICRExpObjCode>
            <kfsICRIncObjCode>3800</kfsICRIncObjCode>
            <kfsIntEncObjCode>9998</kfsIntEncObjCode>
            <kfsPreEncObjCode>9998</kfsPreEncObjCode>
            <kfsRptsToChartCode>UC</kfsRptsToChartCode>
         </return>
      </ns2:getValidKFSChartsResponse>
   </soap:Body>
</soap:Envelope>

...

No input parameter, ALL charts will return in result set.

...

DB Query:

Code Block
SELECT FIN_COA_CD
      ,FIN_COA_DESC
      ,FIN_COA_ACTIVE_CD
      ,FIN_CASH_OBJ_CD
      ,FIN_AP_OBJ_CD
      ,INCBDGT_ELIMOBJ_CD
      ,EXPBDGT_ELIMOBJ_CD
      ,RPTS_TO_FIN_COA_CD
      ,FIN_AR_OBJ_CD
      ,FIN_INT_ENC_OBJ_CD
      ,FIN_EXT_ENC_OBJ_CD
      ,FIN_PRE_ENC_OBJ_CD
      ,ICR_INC_FIN_OBJ_CD
      ,ICR_EXP_FIN_OBJ_CD
      ,FND_BAL_OBJ_CD
  FROM ca_chart_t
WHERE FIN_COA_ACTIVE_CD <> 'N' 

...

ParameterDescriptionData TypeExample
kfsChartCodeKFS Chart CodeString (2)'IR'
kfsChartDescriptionKFS Chart DescriptionString (40)'Irvine'
kfsChartActiveCodeKFS Chart Active Code ('Y' for yes, 'N' for no)String (1)'Y'
kfsFinCashObjCodeKFS Cash Object CodeString (4)'0000'
kfsFinAPObjCodeKFS Accounts Payable Object CodeString (4)'0000'
kfsIncBdgtElimObjCodeKFS Income Budget Elimination Object CodeString (4)'0000'
kfsExpBdgtElimObjCodeKFS Expense Budget Elimination Object CodeString (4)'0000'
kfsRptsToChartCodeKFS Reports to Chart CodeString (2)'MC'
kfsARObjCodeKFS Accounts Receivable Object CodeString (4)'0000'
kfsIntEncObjCodeKFS Internal Encumbrances Object CodeString (4)'0000'

kfsExtEncObjCode

KFS External Encumbrances Object CodeString (4)'0000'
kfsPreEncObjCodeKFS Pre Encumbrances Object CodeString (4)'0000'
kfsICRIncObjCodeKFS Indirect Cost Recovery Income Object CodeString (4)'0000'
kfsICRExpObjCodeKFS Indirect Cost Recovery Expense Object CodeString (4)'0000'
kfsFundBalObjCodeKFS Fund Balance Object CodeString (4)'0000'

WS Example

Request
Code Block
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adc="http://www.adcom.uci.edu">
   <soapenv:Header/>
   <soapenv:Body>
      <adc:getAllKFSCharts/>
   </soapenv:Body>
</soapenv:Envelope>
Response
Code Block
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns2:getAllKFSChartsResponse xmlns:ns2="http://www.adcom.uci.edu">
         <return>
            <kfsARObjCode>0052</kfsARObjCode>
            <kfsChartActiveCode>Y</kfsChartActiveCode>
            <kfsChartCode>FD</kfsChartCode>
            <kfsChartDescription>Foundation</kfsChartDescription>
            <kfsExtEncObjCode>9998</kfsExtEncObjCode>
            <kfsFinAPObjCode>0051</kfsFinAPObjCode>
            <kfsFinCashObjCode>CASH</kfsFinCashObjCode>
            <kfsFundBalObjCode>0000</kfsFundBalObjCode>
            <kfsICRExpObjCode>3800</kfsICRExpObjCode>
            <kfsICRIncObjCode>3800</kfsICRIncObjCode>
            <kfsIntEncObjCode>9998</kfsIntEncObjCode>
            <kfsPreEncObjCode>9998</kfsPreEncObjCode>
            <kfsRptsToChartCode>UC</kfsRptsToChartCode>
         </return>
         <return>
            <kfsARObjCode>0052</kfsARObjCode>
            <kfsChartActiveCode>Y</kfsChartActiveCode>
            <kfsChartCode>IR</kfsChartCode>
            <kfsChartDescription>UC Irvine</kfsChartDescription>
            <kfsExtEncObjCode>9998</kfsExtEncObjCode>
            <kfsFinAPObjCode>0051</kfsFinAPObjCode>
            <kfsFinCashObjCode>CASH</kfsFinCashObjCode>
            <kfsFundBalObjCode>0000</kfsFundBalObjCode>
            <kfsICRExpObjCode>3800</kfsICRExpObjCode>
            <kfsICRIncObjCode>3800</kfsICRIncObjCode>
            <kfsIntEncObjCode>9998</kfsIntEncObjCode>
            <kfsPreEncObjCode>9998</kfsPreEncObjCode>
            <kfsRptsToChartCode>UC</kfsRptsToChartCode>
         </return>
         <return>
            <kfsARObjCode>0052</kfsARObjCode>
            <kfsChartActiveCode>Y</kfsChartActiveCode>
            <kfsChartCode>MC</kfsChartCode>
            <kfsChartDescription>Medical Center</kfsChartDescription>
            <kfsExtEncObjCode>9998</kfsExtEncObjCode>
            <kfsFinAPObjCode>0051</kfsFinAPObjCode>
            <kfsFinCashObjCode>CASH</kfsFinCashObjCode>
            <kfsFundBalObjCode>0000</kfsFundBalObjCode>
            <kfsICRExpObjCode>3800</kfsICRExpObjCode>
            <kfsICRIncObjCode>3800</kfsICRIncObjCode>
            <kfsIntEncObjCode>9998</kfsIntEncObjCode>
            <kfsPreEncObjCode>9998</kfsPreEncObjCode>
            <kfsRptsToChartCode>UC</kfsRptsToChartCode>
         </return>
         <return>
            <kfsARObjCode>0052</kfsARObjCode>
            <kfsChartActiveCode>Y</kfsChartActiveCode>
            <kfsChartCode>PL</kfsChartCode>
            <kfsChartDescription>Plant</kfsChartDescription>
            <kfsExtEncObjCode>9998</kfsExtEncObjCode>
            <kfsFinAPObjCode>0051</kfsFinAPObjCode>
            <kfsFinCashObjCode>CASH</kfsFinCashObjCode>
            <kfsFundBalObjCode>0000</kfsFundBalObjCode>
            <kfsICRExpObjCode>3800</kfsICRExpObjCode>
            <kfsICRIncObjCode>3800</kfsICRIncObjCode>
            <kfsIntEncObjCode>9998</kfsIntEncObjCode>
            <kfsPreEncObjCode>9998</kfsPreEncObjCode>
            <kfsRptsToChartCode>UC</kfsRptsToChartCode>
         </return>
         <return>
            <kfsARObjCode>0052</kfsARObjCode>
            <kfsChartActiveCode>Y</kfsChartActiveCode>
            <kfsChartCode>SW</kfsChartCode>
            <kfsChartDescription>Systemwide</kfsChartDescription>
            <kfsExtEncObjCode>9998</kfsExtEncObjCode>
            <kfsFinAPObjCode>0051</kfsFinAPObjCode>
            <kfsFinCashObjCode>CASH</kfsFinCashObjCode>
            <kfsFundBalObjCode>0000</kfsFundBalObjCode>
            <kfsICRExpObjCode>3800</kfsICRExpObjCode>
            <kfsICRIncObjCode>3800</kfsICRIncObjCode>
            <kfsIntEncObjCode>9998</kfsIntEncObjCode>
            <kfsPreEncObjCode>9998</kfsPreEncObjCode>
            <kfsRptsToChartCode>UC</kfsRptsToChartCode>
         </return>
         <return>
            <kfsARObjCode>0052</kfsARObjCode>
            <kfsChartActiveCode>Y</kfsChartActiveCode>
            <kfsChartCode>UC</kfsChartCode>
            <kfsChartDescription>University of California</kfsChartDescription>
            <kfsExtEncObjCode>9998</kfsExtEncObjCode>
            <kfsFinAPObjCode>0051</kfsFinAPObjCode>
            <kfsFinCashObjCode>CASH</kfsFinCashObjCode>
            <kfsFundBalObjCode>0000</kfsFundBalObjCode>
            <kfsICRExpObjCode>3800</kfsICRExpObjCode>
            <kfsICRIncObjCode>3800</kfsICRIncObjCode>
            <kfsIntEncObjCode>9998</kfsIntEncObjCode>
            <kfsPreEncObjCode>9998</kfsPreEncObjCode>
            <kfsRptsToChartCode>UC</kfsRptsToChartCode>
         </return>
      </ns2:getAllKFSChartsResponse>
   </soap:Body>
</soap:Envelope>

...