Page Comparison

isValidKFSOrganizations(List of (kfsOrgCode, kfsChartCode))

This service is used to validate KFS organization. Returns an XML result set with a value of true or false for each organization.

Input Specifications

Index	Parameter	Description	Required?	Data Type (max length)	Example
0	kfsChartCode	KFS Chart Code	Yes	String(2)	IR
1	kfsOrgCode	KFS Organization Code	Yes	String(4)	9999

DB Query

Code Block

SELECT FIN_COA_CD, ORG_CD, ORG_ACTIVE_CD FROM CA_ORG_T a WHERE a.ORG_ACTIVE_CD <> 'N' AND 
(
(a.ORG_CD='9999' AND a.FIN_COA_CD='UC') OR 
(a.ORG_CD='9999' AND a.FIN_COA_CD='IR') OR 
(a.ORG_CD='9999' AND a.FIN_COA_CD='MC') OR
(a.ORG_CD='0000' AND a.FIN_COA_CD='XX')
);

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

Parameter	Description	Data Type	Example
kfsChartCode	KFS Chart Code	String(2)	IR
kfsOrgCode	KFS Organization Code	String(4)	9999
isValid	Is the KFS Project Code valid?	boolean	true

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:isValidKFSOrganizations>
         <kfsOrganizationList>
            <kfsChartCode>UC</kfsChartCode>
            <kfsOrgCode>9999</kfsOrgCode>
         </kfsOrganizationList>
         <kfsOrganizationList>
            <kfsChartCode>IR</kfsChartCode>
            <kfsOrgCode>9999</kfsOrgCode>
         </kfsOrganizationList>
         <kfsOrganizationList>
            <kfsChartCode>MC</kfsChartCode>
            <kfsOrgCode>9999</kfsOrgCode>
         </kfsOrganizationList>
         <kfsOrganizationList>
            <kfsChartCode>XX</kfsChartCode>
            <kfsOrgCode>0000</kfsOrgCode>
         </kfsOrganizationList>
      </adc:isValidKFSOrganizations>
   </soapenv:Body>
</soapenv:Envelope>

Response

Code Block

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns2:isValidKFSOrganizationsResponse xmlns:ns2="http://www.adcom.uci.edu">
         <return>
            <kfsChartCode>MC</kfsChartCode>
            <kfsOrgCode>9999</kfsOrgCode>
            <valid>true</valid>
         </return>
         <return>
            <kfsChartCode>IR</kfsChartCode>
            <kfsOrgCode>9999</kfsOrgCode>
            <valid>true</valid>
         </return>
         <return>
            <kfsChartCode>UC</kfsChartCode>
            <kfsOrgCode>9999</kfsOrgCode>
            <valid>true</valid>
         </return>
         <return>
            <kfsChartCode>XX</kfsChartCode>
            <kfsOrgCode>0000</kfsOrgCode>
            <valid>false</valid>
         </return>
      </ns2:isValidKFSOrganizationsResponse>
   </soap:Body>
</soap:Envelope>

Java Client Example

Code Block

DWHServerService dss = new DWHServerService();
DWHServer ds = dss.getDWHServerPort();

ArrayList<OrganizationParameters> pl17 = new ArrayList<OrganizationParameters>();
OrganizationParameters op170 = new OrganizationParameters();
op170.setKfsChartCode("UC");
op170.setKfsOrgCode("9999");
OrganizationParameters op171 = new OrganizationParameters();
op171.setKfsChartCode("IR");
op171.setKfsOrgCode("9999");
OrganizationParameters op172 = new OrganizationParameters();
op172.setKfsChartCode("MC");
op172.setKfsOrgCode("9999");
OrganizationParameters op173 = new OrganizationParameters();
op173.setKfsChartCode("XX");
op173.setKfsOrgCode("0000");
pl17.add(op170);
pl17.add(op171);
pl17.add(op172);
pl17.add(op173);
List<OrganizationValidation> resultList17 = ds.isValidKFSOrganizations(pl17);
if (resultList17 != null) {
	for (Iterator i = resultList17.iterator(); i.hasNext();) {
		OrganizationValidation element = (OrganizationValidation) i.next();
		System.out.println("\t" + element.getKfsChartCode() + "/" + element.getKfsOrgCode() + " : " + element.isValid());
	}
} else {
	System.out.println("something bad happened...please check your query");
}

getValidKFSOrganizations(List of (kfsOrgCode, kfsChartCode))

This service is used retrieve valid KFS organizations and related attributes. Returns an XML result set with a list of organizations

Input Specifications

Index	Parameter	Description	Required?	Data Type (max length)	Example
0	kfsChartCode	KFS Chart Code	Yes	String(2)	IR
1	kfsOrgCode	KFS Organization Code	Yes	String(4)	9052

DB Query

Code Block

SELECT 
FIN_COA_CD, 
ORG_CD, 
ORG_MGR_UNVL_ID, 
ORG_NM, 
RC_CD,
ORG_PHYS_CMP_CD,
ORG_TYP_CD,
ORG_DFLT_ACCT_NBR,
ORG_LN1_ADDR,
ORG_LN2_ADDR,
ORG_CITY_NM,
ORG_STATE_CD,
ORG_ZIP_CD,
ORG_CNTRY_CD,
ORG_BEGIN_DT,
ORG_END_DT,
RPTS_TO_FIN_COA_CD,
RPTS_TO_ORG_CD,
ORG_ACTIVE_CD,
ORG_PLNT_ACCT_NBR,
CMP_PLNT_ACCT_NBR,
ORG_PLNT_COA_CD,
CMP_PLNT_COA_CD 
FROM CA_ORG_T a WHERE a.ORG_ACTIVE_CD <> 'N' AND 
(
(a.ORG_CD='9052' AND a.FIN_COA_CD='IR') OR 
(a.ORG_CD='9053' AND a.FIN_COA_CD='IR') OR 
(a.ORG_CD='1111' AND a.FIN_COA_CD='IR') OR
(a.ORG_CD='9054' AND a.FIN_COA_CD='XX')
);

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

DB Parameter	Java Parameter	Description	Data Type	Example
FIN_COA_CD	kfsChartCode	KFS Chart Code	String (2)	IR
ORG_CD	kfsOrgCode	KFS Organization Code	String (4)	1234
ORG_MGR_UNVL_ID	kfsOrgManagerId	KFS Organization Manager ID	String
ORG_NM	kfsOrgName	KFS Organization Name	String
RC_CD	kfsRCCode	KFS Responsibility Center Code	String
ORG_PHYS_CMP_CD	kfsOrgCampusCode	KFS Organization Physical Campus Code	String
ORG_TYP_CD	kfsOrgTypeCode	KFS Organization Type Code	String
ORG_DFLT_ACCT_NBR	kfsOrgDefaultAcctNumber	KFS Default Account Number	String
ORG_LN1_ADDR	kfsOrgAddr1	KFS Address Line 1	String
ORG_LN2_ADDR	kfsOrgAddr2	KFS Address Line 2	String
ORG_CITY_NM	kfsOrgCity	KFS Organization City Name	String
ORG_STATE_CD	kfsOrgState	KFS Organization State Code	String
ORG_ZIP_CD	kfsOrgZip	KFS Organization Zip Code	String
ORG_CNTRY_CD	kfsOrgCountryCode	KFS Organization Country Code	String
ORG_BEGIN_DT	kfsOrgBeginDate	KFS Organization Begin Date	String
ORG_END_DT	kfsOrgEndDate	KFS Organization End Date	String
RPTS_TO_FIN_COA_CD	kfsReportToChartCode	KFS Reports To Chart Code	String
RPTS_TO_ORG_CD	kfsReportToOrgCode	KFS Reports To Organization Code	String
ORG_ACTIVE_CD	kfsOrgActiveCode	KFS Organization Active Code	String
ORG_PLNT_ACCT_NBR	kfsOrgPlantAcctNumber	KFS Organization Plant Account Number	String
CMP_PLNT_ACCT_NBR	kfsCampusPlantAcctNumber	KFS Campus Plant Account Number	String
ORG_PLNT_COA_CD	kfsOrgPlantChartCode	KFS Organization Plant Chart Code	String
CMP_PLNT_COA_CD	kfsCampusPlantChartCode	KFS Campus Plant Chart Code	String

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:getValidKFSOrganizations>
         <kfsOrganizationList>
            <kfsChartCode>UC</kfsChartCode>
            <kfsOrgCode>9999</kfsOrgCode>
         </kfsOrganizationList>
         <kfsOrganizationList>
            <kfsChartCode>IR</kfsChartCode>
            <kfsOrgCode>9999</kfsOrgCode>
         </kfsOrganizationList>
         <kfsOrganizationList>
            <kfsChartCode>MC</kfsChartCode>
            <kfsOrgCode>9999</kfsOrgCode>
         </kfsOrganizationList>
         <kfsOrganizationList>
            <kfsChartCode>XX</kfsChartCode>
            <kfsOrgCode>0000</kfsOrgCode>
         </kfsOrganizationList>
      </adc:getValidKFSOrganizations>
   </soapenv:Body>
</soapenv:Envelope>

Response

Code Block

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns2:getValidKFSOrganizationsResponse xmlns:ns2="http://www.adcom.uci.edu">
         <return>
            <kfsChartCode>UC</kfsChartCode>
            <kfsOrgActiveCode>Y</kfsOrgActiveCode>
            <kfsOrgAddr1>Campus Drive</kfsOrgAddr1>
            <kfsOrgBeginDate>2010-07-01</kfsOrgBeginDate>
            <kfsOrgCampusCode>IR</kfsOrgCampusCode>
            <kfsOrgCity>Irvine</kfsOrgCity>
            <kfsOrgCode>9999</kfsOrgCode>
            <kfsOrgCountryCode>US</kfsOrgCountryCode>
            <kfsOrgManagerId>admin</kfsOrgManagerId>
            <kfsOrgName>Converted Org</kfsOrgName>
            <kfsOrgState>CA</kfsOrgState>
            <kfsOrgTypeCode>S</kfsOrgTypeCode>
            <kfsOrgZip>92697</kfsOrgZip>
            <kfsRCCode>90</kfsRCCode>
            <kfsReportToChartCode>UC</kfsReportToChartCode>
            <kfsReportToOrgCode>UNIV</kfsReportToOrgCode>
         </return>
         <return>
            <kfsChartCode>IR</kfsChartCode>
            <kfsOrgActiveCode>Y</kfsOrgActiveCode>
            <kfsOrgAddr1>Campus Drive</kfsOrgAddr1>
            <kfsOrgBeginDate>2010-07-01</kfsOrgBeginDate>
            <kfsOrgCampusCode>IR</kfsOrgCampusCode>
            <kfsOrgCity>Irvine</kfsOrgCity>
            <kfsOrgCode>9999</kfsOrgCode>
            <kfsOrgCountryCode>US</kfsOrgCountryCode>
            <kfsOrgDefaultAcctNumber>Z006411</kfsOrgDefaultAcctNumber>
            <kfsOrgManagerId>admin</kfsOrgManagerId>
            <kfsOrgName>Converted Org</kfsOrgName>
            <kfsOrgState>CA</kfsOrgState>
            <kfsOrgTypeCode>S</kfsOrgTypeCode>
            <kfsOrgZip>92697</kfsOrgZip>
            <kfsRCCode>90</kfsRCCode>
            <kfsReportToChartCode>UC</kfsReportToChartCode>
            <kfsReportToOrgCode>UNIV</kfsReportToOrgCode>
         </return>
         <return>
            <kfsChartCode>MC</kfsChartCode>
            <kfsOrgActiveCode>Y</kfsOrgActiveCode>
            <kfsOrgAddr1>Campus Drive</kfsOrgAddr1>
            <kfsOrgBeginDate>2010-07-01</kfsOrgBeginDate>
            <kfsOrgCampusCode>IR</kfsOrgCampusCode>
            <kfsOrgCity>Irvine</kfsOrgCity>
            <kfsOrgCode>9999</kfsOrgCode>
            <kfsOrgCountryCode>US</kfsOrgCountryCode>
            <kfsOrgDefaultAcctNumber>1004000</kfsOrgDefaultAcctNumber>
            <kfsOrgManagerId>admin</kfsOrgManagerId>
            <kfsOrgName>Converted Org</kfsOrgName>
            <kfsOrgState>CA</kfsOrgState>
            <kfsOrgTypeCode>S</kfsOrgTypeCode>
            <kfsOrgZip>92697</kfsOrgZip>
            <kfsRCCode>90</kfsRCCode>
            <kfsReportToChartCode>UC</kfsReportToChartCode>
            <kfsReportToOrgCode>UNIV</kfsReportToOrgCode>
         </return>
      </ns2:getValidKFSOrganizationsResponse>
   </soap:Body>
</soap:Envelope>

Java Client Example

Code Block

DWHServerService dss = new DWHServerService();
DWHServer ds = dss.getDWHServerPort();

ArrayList<OrganizationParameters> pl17 = new ArrayList<OrganizationParameters>();
OrganizationParameters op170 = new OrganizationParameters();
op170.setKfsChartCode("UC");
op170.setKfsOrgCode("9999");
OrganizationParameters op171 = new OrganizationParameters();
op171.setKfsChartCode("IR");
op171.setKfsOrgCode("9999");
OrganizationParameters op172 = new OrganizationParameters();
op172.setKfsChartCode("MC");
op172.setKfsOrgCode("9999");
OrganizationParameters op173 = new OrganizationParameters();
op173.setKfsChartCode("XX");
op173.setKfsOrgCode("0000");
pl17.add(op170);
pl17.add(op171);
pl17.add(op172);
pl17.add(op173);
 
List<OrganizationDetails> resultList18 = ds.getValidKFSOrganizations(pl17);
if (resultList18 != null) {
	for (Iterator i = resultList18.iterator(); i.hasNext();) {
		OrganizationDetails element = (OrganizationDetails) i.next();
		System.out.println("\t" + element.getKfsChartCode() + "/" + element.getKfsOrgCode() + " : " + element.getKfsOrgName());
	}
} else {
	System.out.println("something bad happened...please check your query");
}

getKFSChildOrganizations(kfsOrgCode, kfsChartCode)

This service is used retrieve valid KFS child organizations with its flattened out org structure for reference. Returns an XML result set with a list of organizations

Input Specifications

Index	Parameter	Description	Required?	Data Type (max length)	Example
0	kfsChartCode	KFS Chart Code	Yes	String(2)	IR
1	kfsOrgCode	KFS Organization Code	Yes	String(4)	9052

DB Query

Code Block

 
   WITH ChildOrgList As (
      SELECT 1 as OrgLevel,
ChildOrg.[CHART_CD],ChildOrg.[ORG_UC_LEVEL_CD], ChildOrg.[ORG_CD],ChildOrg.[ORG_NM],
ChildOrg.[ORG_PARENT_ORG_CD], ChildOrg.[ORG_ROLLUP_LEVEL01_CD], ChildOrg.[ORG_ROLLUP_LEVEL02_CD], 
ChildOrg.[ORG_ROLLUP_LEVEL03_CD], ChildOrg.[ORG_ROLLUP_LEVEL04_CD], ChildOrg.[ORG_ROLLUP_LEVEL05_CD], 
ChildOrg.[ORG_ROLLUP_LEVEL06_CD]
            FROM [dss_kfs].[dbo].[kfs_d_org] as ChildOrg WHERE
ChildOrg.CHART_CD = <kfsChartCode>
and ChildOrg.ORG_CD = <kfsOrgCode>
       UNION ALL
       SELECT Child.OrgLevel+1 as OrgLevel,
ParentOrg.[CHART_CD],ParentOrg.[ORG_UC_LEVEL_CD], ParentOrg.[ORG_CD],ParentOrg.[ORG_NM],
ParentOrg.[ORG_PARENT_ORG_CD], ParentOrg.[ORG_ROLLUP_LEVEL01_CD], ParentOrg.[ORG_ROLLUP_LEVEL02_CD], 
ParentOrg.[ORG_ROLLUP_LEVEL03_CD], ParentOrg.[ORG_ROLLUP_LEVEL04_CD], ParentOrg.[ORG_ROLLUP_LEVEL05_CD], 
ParentOrg.[ORG_ROLLUP_LEVEL06_CD]
            FROM [dss_kfs].[dbo].[kfs_d_org] as ParentOrg
              INNER JOIN ChildOrgList as Child
               ON Child.[ORG_PARENT_ORG_CD] = ParentOrg.ORG_CD
            /*WHERE  ParentOrg.ORG_CD  <> 'UNIV'*/  )
    SELECT ML.MLv-L.OrgLevel+1 OrgLevNo, L.[ORG_UC_LEVEL_CD], L.[CHART_CD], L.[ORG_CD],
L.[ORG_NM], L.[ORG_PARENT_ORG_CD], L.[ORG_ROLLUP_LEVEL01_CD], L.[ORG_ROLLUP_LEVEL02_CD], 
L.[ORG_ROLLUP_LEVEL03_CD], L.[ORG_ROLLUP_LEVEL04_CD], L.[ORG_ROLLUP_LEVEL05_CD], 
L.[ORG_ROLLUP_LEVEL06_CD] 
from ChildOrgList L
    INNER JOIN
    (SELECT  [CHART_CD], MAX(OrgLevel) MLv from ChildOrgList     group
by [CHART_CD]) ML
 ON L.CHART_CD = ML.CHART_CD order by 1

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

DB Parameter	Java Parameter	Description	Data Type	Example
FIN_COA_CD	kfsChartCode	KFS Chart Code	String (2)	IR
ORG_CD	kfsOrgCode	KFS Organization Code	String (4)	1234
ORG_NM	kfsOrgName	KFS Organization Name	String (4)
	kfsOrgCategory	KFS Organization Category	String (4)	Denotes the org level category designated by the budget office: 'U' , 'C', 'S', 'D'
	kfsOrgRollupLevel1	KFS Organization Rollup Level 1	String (4)
	kfsOrgRollupLevel2	KFS Organization Rollup Level 2	String (4)
	kfsOrgRollupLevel3	KFS Organization Rollup Level 3	String (4)
	kfsOrgRollupLevel4	KFS Organization Rollup Level 4	String (4)
	kfsOrgRollupLevel5	KFS Organization Rollup Level 5	String (4)
	kfsOrgRollupLevel6	KFS Organization Rollup Level 6	String (4)

WS Example

Request

Code Block

Response

Code Block

Java Client Example

getAllKFSOrganizations()

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

DB Query

Code Block

SELECT 
FIN_COA_CD, 
ORG_CD, 
ORG_MGR_UNVL_ID, 
ORG_NM, 
RC_CD,
ORG_PHYS_CMP_CD,
ORG_TYP_CD,
ORG_DFLT_ACCT_NBR,
ORG_LN1_ADDR,
ORG_LN2_ADDR,
ORG_CITY_NM,
ORG_STATE_CD,
ORG_ZIP_CD,
ORG_CNTRY_CD,
ORG_BEGIN_DT,
ORG_END_DT,
RPTS_TO_FIN_COA_CD,
RPTS_TO_ORG_CD,
ORG_ACTIVE_CD,
ORG_PLNT_ACCT_NBR,
CMP_PLNT_ACCT_NBR,
ORG_PLNT_COA_CD,
CMP_PLNT_COA_CD 
FROM CA_ORG_T WHERE ORG_ACTIVE_CD <> 'N';

Result Schema: SAME as getValidKFSOrganizations

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:getAllKFSOrganizations/>
   </soapenv:Body>
</soapenv:Envelope>

Response

Code Block

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns2:getAllKFSOrganizationsResponse xmlns:ns2="http://www.adcom.uci.edu">
         <return>
            <kfsChartCode>IR</kfsChartCode>
            <kfsOrgActiveCode>Y</kfsOrgActiveCode>
            <kfsOrgAddr1>Campus Drive</kfsOrgAddr1>
            <kfsOrgCampusCode>IR</kfsOrgCampusCode>
            <kfsOrgCity>Irvine</kfsOrgCity>
            <kfsOrgCode>9052</kfsOrgCode>
            <kfsOrgCountryCode>US</kfsOrgCountryCode>
            <kfsOrgManagerId>000000076676</kfsOrgManagerId>
            <kfsOrgName>PRIMARY CARE MEDICAL GROUP</kfsOrgName>
            <kfsOrgState>CA</kfsOrgState>
            <kfsOrgTypeCode>A</kfsOrgTypeCode>
            <kfsOrgZip>92697</kfsOrgZip>
            <kfsRCCode>10</kfsRCCode>
            <kfsReportToChartCode>IR</kfsReportToChartCode>
            <kfsReportToOrgCode>9821</kfsReportToOrgCode>
         </return>
         <return>
            <kfsChartCode>IR</kfsChartCode>
            <kfsOrgActiveCode>Y</kfsOrgActiveCode>
            <kfsOrgAddr1>Campus Drive</kfsOrgAddr1>
            <kfsOrgCampusCode>IR</kfsOrgCampusCode>
            <kfsOrgCity>Irvine</kfsOrgCity>
            <kfsOrgCode>9053</kfsOrgCode>
            <kfsOrgCountryCode>US</kfsOrgCountryCode>
            <kfsOrgManagerId>000000076676</kfsOrgManagerId>
            <kfsOrgName>HOSPITALIST PROGRAM</kfsOrgName>
            <kfsOrgState>CA</kfsOrgState>
            <kfsOrgTypeCode>A</kfsOrgTypeCode>
            <kfsOrgZip>92697</kfsOrgZip>
            <kfsRCCode>10</kfsRCCode>
            <kfsReportToChartCode>IR</kfsReportToChartCode>
            <kfsReportToOrgCode>9821</kfsReportToOrgCode>
         </return>
	 ...
	 ...
      </ns2:getAllKFSOrganizationsResponse>
   </soap:Body>
</soap:Envelope>

Java Client Example

Code Block

DWHServerService dss = new DWHServerService();
DWHServer ds = dss.getDWHServerPort();

List<OrganizationDetails> resultList14 = ds.getAllKFSOrganizations();
if (resultList14 != null) {
	//for (Iterator i = resultList14.iterator(); i.hasNext();) {
	//	OrganizationDetails element = (OrganizationDetails)i.next();
	//}
	System.out.println("total size: " + resultList14.size());
	System.out.println("the 1st item ChartCode / OrgCode: OrgName" + ((OrganizationDetails)resultList14.get(0)).getKfsChartCode() + " / " + ((OrganizationDetails)resultList14.get(0)).getKfsOrgCode() + " : " + ((OrganizationDetails)resultList14.get(0)).getKfsOrgName()); 
} else {
	System.out.println("something bad happened...please check your query");
}

translateFSOrganizations(List of (fsLocationCode, fsHierarchyCode))

This service is used to validate KFS organization. Returns an XML result set with a value of true or false for each organization.

Input Specifications

Index	Parameter	Description	Required?	Data Type (max length)	Example
0	fsLocationCode	FS Location Code	Yes	String(1)	9
1	fsHierarchyCode	FS Organization Code	No	String(4)	2000

DB Query

Code Block

SELECT 
FIN_COA_CD, 
ORG_CD, 
UC_LOC_CD, 
UC_HIERARCHY_CD, 
UC_HIERARCHY_TYPE_CD 
FROM UCI_CA_ORG_XW_T 
WHERE UC_HIERARCHY_TYPE_CD='O' AND 
(
(UC_LOC_CD='9' AND UC_HIERARCHY_CD='2000') OR 
(UC_LOC_CD='9' AND UC_HIERARCHY_CD='3000') OR 
(UC_LOC_CD='0' AND UC_HIERARCHY_CD='0000') 
);

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

Parameter	Description	Data Type	Example
kfsChartCode	KFS Chart Code	String(2)	IR
kfsOrgCode	KFS Organization Code	String(4)	9022
fsHierarchyType	FS Hierarchy Type	String	O
fsLocationCode	FS Location Code	String	9
fsHierarchyCode	FS Hierarchy Code	String	2000

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:translateFSOrganizations>
         <fsOrganizationList>
            <fsHierarchyCode>2000</fsHierarchyCode>
            <fsLocationCode>9</fsLocationCode>
         </fsOrganizationList>
         <fsOrganizationList>
            <fsHierarchyCode>3000</fsHierarchyCode>
            <fsLocationCode>9</fsLocationCode>
         </fsOrganizationList>
         <fsOrganizationList>
            <fsHierarchyCode>0000</fsHierarchyCode>
            <fsLocationCode>0</fsLocationCode>
         </fsOrganizationList>
      </adc:translateFSOrganizations>
   </soapenv:Body>
</soapenv:Envelope>

Response

Code Block

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns2:translateFSOrganizationsResponse xmlns:ns2="http://www.adcom.uci.edu">
         <return>
            <fsHierarchyCode>2000</fsHierarchyCode>
            <fsHierarchyType>O</fsHierarchyType>
            <fsLocationCode>9</fsLocationCode>
            <kfsChartCode>IR</kfsChartCode>
            <kfsOrgCode>9022</kfsOrgCode>
         </return>
         <return>
            <fsHierarchyCode>3000</fsHierarchyCode>
            <fsHierarchyType>O</fsHierarchyType>
            <fsLocationCode>9</fsLocationCode>
            <kfsChartCode>IR</kfsChartCode>
            <kfsOrgCode>9002</kfsOrgCode>
         </return>
      </ns2:translateFSOrganizationsResponse>
   </soap:Body>
</soap:Envelope>

Java Client Example

Code Block

DWHServerService dss = new DWHServerService();
DWHServer ds = dss.getDWHServerPort();

ArrayList<OrganizationTranslateParameters> pl20 = new ArrayList<OrganizationTranslateParameters>();
OrganizationTranslateParameters otp200 = new OrganizationTranslateParameters();
otp200.setFsHierarchyCode("2000");
otp200.setFsLocationCode("9");
OrganizationTranslateParameters otp201 = new OrganizationTranslateParameters();
otp201.setFsHierarchyCode("3000");
otp201.setFsLocationCode("9");
OrganizationTranslateParameters otp202 = new OrganizationTranslateParameters();
otp202.setFsHierarchyCode("0000");
otp202.setFsLocationCode("0");
pl20.add(otp200);
pl20.add(otp201);
pl20.add(otp202);
List<Fs2KFSOrganizationDetails> resultList20 = ds.translateFSOrganizations(pl20);
if (resultList20 != null) {
	for (Iterator i = resultList20.iterator(); i.hasNext();) {
		Fs2KFSOrganizationDetails element = (Fs2KFSOrganizationDetails) i.next();
		System.out.println("\t" + element.getFsLocationCode() + "/" + element.getFsHierarchyCode() + "/" + element.getFsHierarchyType() + " : " + element.getKfsChartCode() + "/" + element.getKfsOrgCode()); }
} else {
	System.out.println("something bad happened...please check your query");
}

translateFSDivisions(List of (fsLocationCode, fsHierarchyCode))

This service is used to validate KFS organization. Returns an XML result set with a value of true or false for each organization.

Input Specifications

Index	Parameter	Description	Required?	Data Type (max length)	Example
0	fsLocationCode	FS Location Code	Yes	String(1)	9
1	fsHierarchyCode	FS Division Code	Yes	String(4)	1015

DB Query

Code Block

SELECT 
FIN_COA_CD, 
ORG_CD, 
UC_LOC_CD, 
UC_HIERARCHY_CD, 
UC_HIERARCHY_TYPE_CD 
FROM UCI_CA_ORG_XW_T 
WHERE UC_HIERARCHY_TYPE_CD='V' AND 
(
(UC_LOC_CD='9' AND UC_HIERARCHY_CD='1015') OR 
(UC_LOC_CD='9' AND UC_HIERARCHY_CD='1100') OR 
(UC_LOC_CD='0' AND UC_HIERARCHY_CD='0000')
);

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

Parameter	Description	Data Type	Example
kfsChartCode	KFS Chart Code	String(2)	IR
kfsOrgCode	KFS Organization Code	String(4)	9006
fsHierarchyType	FS Hierarchy Type	String	V
fsLocationCode	FS Location Code	String	9
fsHierarchyCode	FS Hierarchy Code	String	1015

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:translateFSDivisions>
         <fsOrganizationList>
            <fsHierarchyCode>1015</fsHierarchyCode>
            <fsLocationCode>9</fsLocationCode>
         </fsOrganizationList>
         <fsOrganizationList>
            <fsHierarchyCode>1100</fsHierarchyCode>
            <fsLocationCode>9</fsLocationCode>
         </fsOrganizationList>
         <fsOrganizationList>
            <fsHierarchyCode>0000</fsHierarchyCode>
            <fsLocationCode>0</fsLocationCode>
         </fsOrganizationList>
      </adc:translateFSDivisions>
   </soapenv:Body>
</soapenv:Envelope>

Response

Code Block

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns2:translateFSDivisionsResponse xmlns:ns2="http://www.adcom.uci.edu">
         <return>
            <fsHierarchyCode>1015</fsHierarchyCode>
            <fsHierarchyType>V</fsHierarchyType>
            <fsLocationCode>9</fsLocationCode>
            <kfsChartCode>IR</kfsChartCode>
            <kfsOrgCode>9006</kfsOrgCode>
         </return>
         <return>
            <fsHierarchyCode>1100</fsHierarchyCode>
            <fsHierarchyType>V</fsHierarchyType>
            <fsLocationCode>9</fsLocationCode>
            <kfsChartCode>IR</kfsChartCode>
            <kfsOrgCode>9012</kfsOrgCode>
         </return>
      </ns2:translateFSDivisionsResponse>
   </soap:Body>
</soap:Envelope>

Java Client Example

Code Block

DWHServerService dss = new DWHServerService();
DWHServer ds = dss.getDWHServerPort();

ArrayList<OrganizationTranslateParameters> pl21 = new ArrayList<OrganizationTranslateParameters>();
OrganizationTranslateParameters otp210 = new OrganizationTranslateParameters();
otp210.setFsHierarchyCode("1015");
otp210.setFsLocationCode("9");
OrganizationTranslateParameters otp211 = new OrganizationTranslateParameters();
otp211.setFsHierarchyCode("1100");
otp211.setFsLocationCode("9");
OrganizationTranslateParameters otp212 = new OrganizationTranslateParameters();
otp212.setFsHierarchyCode("0000");
otp212.setFsLocationCode("0");
pl21.add(otp210);
pl21.add(otp211);
pl21.add(otp212);
List<Fs2KFSOrganizationDetails> resultList21 = ds.translateFSDivisions(pl21);
if (resultList21 != null) {
	for (Iterator i = resultList21.iterator(); i.hasNext();) {
		Fs2KFSOrganizationDetails element = (Fs2KFSOrganizationDetails) i.next();
		System.out.println("\t" + element.getFsLocationCode() + "/" + element.getFsHierarchyCode() + "/" + element.getFsHierarchyType() + " : " + element.getKfsChartCode() + "/" + element.getKfsOrgCode()); }
} else {
	System.out.println("something bad happened...please check your query");
}

translateFSSubDivisions(List of (fsLocationCode,fsHierarchyCode))

This service is used to validate KFS organization. Returns an XML result set with a value of true or false for each organization.

Input Specifications

Index	Parameter	Description	Required?	Data Type (max length)	Example
0	fsLocationCode	FS Location Code	Yes	String(1)	9
1	fsHierarchyCode	FS SubDivisionCode	Yes	String(4)	1300

DB Query

Code Block

SELECT 
FIN_COA_CD, 
ORG_CD, 
UC_LOC_CD, 
UC_HIERARCHY_CD, 
UC_HIERARCHY_TYPE_CD 
FROM UCI_CA_ORG_XW_T 
WHERE UC_HIERARCHY_TYPE_CD='S' AND 
(
(UC_LOC_CD='9' AND UC_HIERARCHY_CD='1300') OR
(UC_LOC_CD='9' AND UC_HIERARCHY_CD='1350') OR
(UC_LOC_CD='0' AND UC_HIERARCHY_CD='0000')
);

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

Parameter	Description	Data Type	Example
kfsChartCode	KFS Chart Code	String(2)	IR
kfsOrgCode	KFS Organization Code	String(4)	9004
fsHierarchyType	FS Hierarchy Type	String	S
fsLocationCode	FS Location Code	String	9
fsHierarchyCode	FS Hierarchy Code	String	1300

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:translateFSSubDivisions>
         <fsOrganizationList>
            <fsHierarchyCode>1300</fsHierarchyCode>
            <fsLocationCode>9</fsLocationCode>
         </fsOrganizationList>
         <fsOrganizationList>
            <fsHierarchyCode>1350</fsHierarchyCode>
            <fsLocationCode>9</fsLocationCode>
         </fsOrganizationList>
         <fsOrganizationList>
            <fsHierarchyCode>0000</fsHierarchyCode>
            <fsLocationCode>0</fsLocationCode>
         </fsOrganizationList>
      </adc:translateFSSubDivisions>
   </soapenv:Body>
</soapenv:Envelope>

Response

Code Block

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns2:translateFSSubDivisionsResponse xmlns:ns2="http://www.adcom.uci.edu">
         <return>
            <fsHierarchyCode>1300</fsHierarchyCode>
            <fsHierarchyType>S</fsHierarchyType>
            <fsLocationCode>9</fsLocationCode>
            <kfsChartCode>IR</kfsChartCode>
            <kfsOrgCode>9004</kfsOrgCode>
         </return>
         <return>
            <fsHierarchyCode>1350</fsHierarchyCode>
            <fsHierarchyType>S</fsHierarchyType>
            <fsLocationCode>9</fsLocationCode>
            <kfsChartCode>IR</kfsChartCode>
            <kfsOrgCode>9010</kfsOrgCode>
         </return>
      </ns2:translateFSSubDivisionsResponse>
   </soap:Body>
</soap:Envelope>

Java Client Example

Code Block

DWHServerService dss = new DWHServerService();
DWHServer ds = dss.getDWHServerPort();

ArrayList<OrganizationTranslateParameters> pl22 = new ArrayList<OrganizationTranslateParameters>();
OrganizationTranslateParameters otp220 = new OrganizationTranslateParameters();
otp220.setFsHierarchyCode("1300");
otp220.setFsLocationCode("9");
OrganizationTranslateParameters otp221 = new OrganizationTranslateParameters();
otp221.setFsHierarchyCode("1350");
otp221.setFsLocationCode("9");
OrganizationTranslateParameters otp222 = new OrganizationTranslateParameters();
otp222.setFsHierarchyCode("0000");
otp222.setFsLocationCode("0");
pl22.add(otp220);
pl22.add(otp221);
pl22.add(otp222);
List<Fs2KFSOrganizationDetails> resultList22 = ds.translateFSSubDivisions(pl22);
if (resultList22 != null) {
	for (Iterator i = resultList22.iterator(); i.hasNext();) {
		Fs2KFSOrganizationDetails element = (Fs2KFSOrganizationDetails) i.next();
		System.out.println("\t" + element.getFsLocationCode() + "/" + element.getFsHierarchyCode() + "/" + element.getFsHierarchyType() + " : " + element.getKfsChartCode() + "/" + element.getKfsOrgCode()); 
	}
} else {
	System.out.println("something bad happened...please check your query");
}

translateFSDepartments(List of (fsLocationCode, fsHierarchyCode))

This service is used to validate KFS organization. Returns an XML result set with a value of true or false for each organization.

Input Specifications

Index	Parameter	Description	Required?	Data Type (max length)	Example
0	fsLocationCode	FS Location Code	Yes	String(1)	9
1	fsHierarchyCode	FS DepartmentCode	Yes	String(4)	0302

DB Query

Code Block

SELECT 
FIN_COA_CD, 
ORG_CD, 
UC_LOC_CD, 
UC_HIERARCHY_CD, 
UC_HIERARCHY_TYPE_CD 
FROM UCI_CA_ORG_XW_T 
WHERE UC_HIERARCHY_TYPE_CD='D' AND 
(
(UC_LOC_CD='9' AND UC_HIERARCHY_CD='0302') OR
(UC_LOC_CD='9' AND UC_HIERARCHY_CD='0003') OR
(UC_LOC_CD='0' AND UC_HIERARCHY_CD='0000')
);

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

Parameter	Description	Data Type	Example
kfsChartCode	KFS Chart Code	String(2)	IR
kfsOrgCode	KFS Organization Code	String(4)	0302
fsHierarchyType	FS Hierarchy Type	String	D
fsLocationCode	FS Location Code	String	9
fsHierarchyCode	FS Hierarchy Code	String	0302

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:translateFSDepartments>
         <fsOrganizationList>
            <fsHierarchyCode>0003</fsHierarchyCode>
            <fsLocationCode>9</fsLocationCode>
         </fsOrganizationList>
         <fsOrganizationList>
            <fsHierarchyCode>0302</fsHierarchyCode>
            <fsLocationCode>9</fsLocationCode>
         </fsOrganizationList>
         <fsOrganizationList>
            <fsHierarchyCode>0000</fsHierarchyCode>
            <fsLocationCode>0</fsLocationCode>
         </fsOrganizationList>
      </adc:translateFSDepartments>
   </soapenv:Body>
</soapenv:Envelope>

Response

Code Block

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns2:translateFSDepartmentsResponse xmlns:ns2="http://www.adcom.uci.edu">
         <return>
            <fsHierarchyCode>0003</fsHierarchyCode>
            <fsHierarchyType>D</fsHierarchyType>
            <fsLocationCode>9</fsLocationCode>
            <kfsChartCode>IR</kfsChartCode>
            <kfsOrgCode>9027</kfsOrgCode>
         </return>
         <return>
            <fsHierarchyCode>0302</fsHierarchyCode>
            <fsHierarchyType>D</fsHierarchyType>
            <fsLocationCode>9</fsLocationCode>
            <kfsChartCode>IR</kfsChartCode>
            <kfsOrgCode>8075</kfsOrgCode>
         </return>
      </ns2:translateFSDepartmentsResponse>
   </soap:Body>
</soap:Envelope>

Java Client Example

Code Block

DWHServerService dss = new DWHServerService();
DWHServer ds = dss.getDWHServerPort();
 
ArrayList<OrganizationTranslateParameters> pl23 = new ArrayList<OrganizationTranslateParameters>();
OrganizationTranslateParameters otp230 = new OrganizationTranslateParameters();
otp230.setFsHierarchyCode("0003");
otp230.setFsLocationCode("9");
OrganizationTranslateParameters otp231 = new OrganizationTranslateParameters();
otp231.setFsHierarchyCode("0302");
otp231.setFsLocationCode("9");
OrganizationTranslateParameters otp232 = new OrganizationTranslateParameters();
otp232.setFsHierarchyCode("0000");
otp232.setFsLocationCode("0");
pl23.add(otp230);
pl23.add(otp231);
pl23.add(otp232);
List<Fs2KFSOrganizationDetails> resultList23 = ds.translateFSDepartments(pl23);
if (resultList23 != null) {
	for (Iterator i = resultList23.iterator(); i.hasNext();) {
		Fs2KFSOrganizationDetails element = (Fs2KFSOrganizationDetails) i.next();
		System.out.println("\t" + element.getFsLocationCode() + "/" + element.getFsHierarchyCode() + "/" + element.getFsHierarchyType() + " : " + element.getKfsChartCode() + "/" + element.getKfsOrgCode());
	}
} else {
	System.out.println("something bad happened...please check your query");
}

Version	Old Version 28	New Version 29
Changes made by	vjones (Unlicensed)	vjones (Unlicensed)
Saved on	Nov 07, 2012	Nov 07, 2012

Page Comparison

Versions Compared

Key

Table of Contents

isValidKFSOrganizations(List of (kfsOrgCode, kfsChartCode))

Input Specifications

DB Query

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

WS Example

Request

Response

Java Client Example

getValidKFSOrganizations(List of (kfsOrgCode, kfsChartCode))

Input Specifications

DB Query

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

WS Example

Request

Response

Java Client Example

getKFSChildOrganizations(kfsOrgCode, kfsChartCode)

Input Specifications

DB Query

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

WS Example

Request

Response

Java Client Example

getAllKFSOrganizations()

DB Query

Result Schema: SAME as getValidKFSOrganizations

WS Example

Request

Response

Java Client Example

translateFSOrganizations(List of (fsLocationCode, fsHierarchyCode))

Input Specifications

DB Query

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

WS Example

Request

Response

Java Client Example

translateFSDivisions(List of (fsLocationCode, fsHierarchyCode))

Input Specifications

DB Query

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

WS Example

Request

Response

Java Client Example

translateFSSubDivisions(List of (fsLocationCode,fsHierarchyCode))

Input Specifications

DB Query

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

WS Example

Request

Response

Java Client Example

translateFSDepartments(List of (fsLocationCode, fsHierarchyCode))

Input Specifications

DB Query

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

WS Example

Request

Response

Java Client Example