Page Comparison

...

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)	90529999

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='90529999' AND a.FIN_COA_CD='IRUC') OR 
(a.ORG_CD='90539999' AND a.FIN_COA_CD='IR') OR 
(a.ORG_CD='11119999' AND a.FIN_COA_CD='IRMC') OR
(a.ORG_CD='90540000' AND a.FIN_COA_CD='XX')
);

...

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

...

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

...

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>IR<<kfsChartCode>MC</kfsChartCode>
            <kfsOrgCode>9053<<kfsOrgCode>9999</kfsOrgCode>
            <valid>true</valid>
         </return>
         <return>
            <kfsChartCode>XX<<kfsChartCode>IR</kfsChartCode>
            <kfsOrgCode>9054<<kfsOrgCode>9999</kfsOrgCode>
            <valid>false<<valid>true</valid>
         </return>
         <return>
            <kfsChartCode>IR<<kfsChartCode>UC</kfsChartCode>
            <kfsOrgCode>1234<<kfsOrgCode>9999</kfsOrgCode>
            <valid>false<<valid>true</valid>
         </return>
         <return>
            <kfsChartCode>IR<<kfsChartCode>XX</kfsChartCode>
            <kfsOrgCode>9052<<kfsOrgCode>0000</kfsOrgCode>
            <valid>true<<valid>false</valid>
         </return>
      </ns2:isValidKFSOrganizationsResponse>
   </soap:Body>
</soap:Envelope>

...

Code Block

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

ArrayList<OrganizationParameters> pl17 
StringArray sa120= new ArrayList<OrganizationParameters>();
OrganizationParameters op170 = new StringArrayOrganizationParameters();
sa120op170.getItemsetKfsChartCode().add("IRUC");
sa120.getItem().addop170.setKfsOrgCode("90529999");
OrganizationParameters 
StringArray sa121op171 = new StringArrayOrganizationParameters();
sa121op171.getItemsetKfsChartCode().add("IR");
sa121op171.getItemsetKfsOrgCode().add("90539999");
OrganizationParameters 
StringArrayop172 sa122 = new StringArrayOrganizationParameters();
sa122.getItem().addop172.setKfsChartCode("IRMC");
sa122op172.getItemsetKfsOrgCode().add("11119999");
		
StringArray sa123OrganizationParameters op173 = new StringArrayOrganizationParameters();
sa123op173.getItemsetKfsChartCode("XX");
op173.addsetKfsOrgCode("XX0000");
sa123pl17.getItemadd(op170);
pl17.add("9054"op171);
		pl17.add(op172);
pl17.add(op173);
List<OrganizationValidation> resultList12resultList17 = ds.isValidKFSOrganizations(Arrays.asList(sa120, sa121, sa122, sa123)pl17);
if (resultList12resultList17 != null) {
	for (Iterator i = resultList12resultList17.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");
}

...

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)	90528282

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')
);

DB Query

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

...

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

...

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>IR<<kfsChartCode>UC</kfsChartCode>
            <kfsOrgActiveCode>Y</kfsOrgActiveCode>
            <kfsOrgAddr1>Campus Drive</kfsOrgAddr1>
            <kfsOrgCampusCode>IR</kfsOrgCampusCode><kfsOrgBeginDate>2010-07-01</kfsOrgBeginDate>
            <kfsOrgCity>Irvine<<kfsOrgCampusCode>IR</kfsOrgCity>kfsOrgCampusCode>
            <kfsOrgCode>9052</<kfsOrgCity>Irvine</kfsOrgCity>
            <kfsOrgCode>9999</kfsOrgCode>
            <kfsOrgCountryCode>US</kfsOrgCountryCode>
            <kfsOrgManagerId>000000076676<<kfsOrgManagerId>admin</kfsOrgManagerId>
            <kfsOrgName>PRIMARY CARE MEDICAL GROUP<<kfsOrgName>Converted Org</kfsOrgName>
            <kfsOrgState>CA</kfsOrgState>
            <kfsOrgTypeCode>A<<kfsOrgTypeCode>S</kfsOrgTypeCode>
            <kfsOrgZip>92697</kfsOrgZip>
            <kfsRCCode>10<<kfsRCCode>90</kfsRCCode>
            <kfsReportToChartCode>IR<<kfsReportToChartCode>UC</kfsReportToChartCode>
            <kfsReportToOrgCode>9821<<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>9053<<kfsOrgCode>9999</kfsOrgCode>
            <kfsOrgCountryCode>US</kfsOrgCountryCode>
            <kfsOrgDefaultAcctNumber>Z006411</kfsOrgDefaultAcctNumber>
            <kfsOrgManagerId>000000076676<<kfsOrgManagerId>admin</kfsOrgManagerId>
            <kfsOrgName>HOSPITALIST<kfsOrgName>Converted PROGRAM<Org</kfsOrgName>
            <kfsOrgState>CA</kfsOrgState>
            <kfsOrgTypeCode>A<<kfsOrgTypeCode>S</kfsOrgTypeCode>
            <kfsOrgZip>92697</kfsOrgZip>
            <kfsRCCode>10<<kfsRCCode>90</kfsRCCode>
            <kfsReportToChartCode>IR<<kfsReportToChartCode>UC</kfsReportToChartCode>
            <kfsReportToOrgCode>9821<<kfsReportToOrgCode>UNIV</kfsReportToOrgCode>
         </return>
      </ns2:getValidKFSOrganizationsResponse>   <return>
</soap:Body> </soap:Envelope>

Java Client Example

Code Block

DWHServerService dss = new DWHServerService(); DWHServer ds = dss.getDWHServerPortCustom();  StringArray sa130<kfsChartCode>MC</kfsChartCode>
= new StringArray(); sa130.getItem().add("IR"); sa130.getItem().add("9052");   StringArray sa131 = new StringArray();
sa131.getItem().add("IR");
sa131.getItem().add("9053"); <kfsOrgActiveCode>Y</kfsOrgActiveCode>
   StringArray sa132 = new StringArray(); sa132.getItem().add("IR");
sa132.getItem().add("1111");


StringArray sa133 = new StringArray();
sa133.getItem().add("XX");
sa133.getItem().add("9054");
		
List<OrganizationDetails> resultList13 = ds.getValidKFSOrganizations(Arrays.asList(sa130, sa131,sa132,sa133));
if (resultList13 != null) {
	for (Iterator i = resultList13.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");
}

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">    <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>
         <return>             <kfsChartCode>IR</kfsChartCode><kfsRCCode>90</kfsRCCode>
            <kfsOrgActiveCode>Y<<kfsReportToChartCode>UC</kfsOrgActiveCode>kfsReportToChartCode>
            <kfsOrgAddr1>Campus Drive<<kfsReportToOrgCode>UNIV</kfsOrgAddr1>kfsReportToOrgCode>
            <kfsOrgCampusCode>IR</kfsOrgCampusCode></return>
      </ns2:getValidKFSOrganizationsResponse>
     <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.getDWHServerPortCustom();

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");
}</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	K

Code Block

WITH ChildOrgList As (
	SELECT
		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 [dwhs_ods].[dbo].[kfs_d_org] as ChildOrg
	WHERE ChildOrg.CHART_CD = 'IR' and ChildOrg.ORG_CD = '9023'
	UNION ALL
	SELECT
		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 [dwhs_ods].[dbo].[kfs_d_org] as ChildOrg
	INNER JOIN ChildOrgList as Child ON ChildOrg.[ORG_PARENT_ORG_CD] = Child.ORG_CD
		AND ChildOrg.[ORG_PARENT_CHART_CD] = Child.CHART_CD
	WHERE ChildOrg.CHART_CD = 'IR'
)
SELECT
	CASE
		WHEN LEN(L.[ORG_ROLLUP_LEVEL06_CD]) = 4 THEN 6
		WHEN LEN(L.[ORG_ROLLUP_LEVEL05_CD]) = 4 THEN 5
		WHEN LEN(L.[ORG_ROLLUP_LEVEL04_CD]) = 4 THEN 4
		WHEN LEN(L.[ORG_ROLLUP_LEVEL03_CD]) = 4 THEN 3
		WHEN LEN(L.[ORG_ROLLUP_LEVEL02_CD]) = 4 THEN 2
		WHEN LEN(L.[ORG_ROLLUP_LEVEL01_CD]) = 4 THEN 1
	END as ORG_LEVEL,
	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
ORDER BY 1

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

Java Parameter	Description	Data Type	Example
kfsChartCode	KFS Chart Code	String	IR
kfsOrgCode	KFS Organization Code	String	8060
kfsOrgName	KFS Organization Name	String	Chemistry
kfsParentOrgCode	KFS Parent Organization Code	String	9023
kfsOrgLevel	KFS Organization Level	String	4
kfsOrgCategory	KFS Organization Category	String	Denotes the org level category designated by the budget office: 'U' , 'C', 'S', 'D'
kfsOrgRollupLevel1	KFS Organization Rollup Level 1	String	-
kfsOrgRollupLevel2	KFS Organization Rollup Level 2	String	-
kfsOrgRollupLevel3	KFS Organization Rollup Level 3	String	9023
kfsOrgRollupLevel4	KFS Organization Rollup Level 4	String	8060
kfsOrgRollupLevel5	KFS Organization Rollup Level 5	String	-
kfsOrgRollupLevel6	KFS Organization Rollup Level 6	String	-

WS Example

Request

Code Block

<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
	<S:Body>
		<ns2:getKFSChildOrganizations xmlns:ns2="http://www.adcom.uci.edu">
			<kfsOrganization>
				<kfsChartCode>IR</kfsChartCode>
				<kfsOrgCode>9023</kfsOrgCode>
			</kfsOrganization>
		</ns2:getKFSChildOrganizations>
	</S:Body>
</S:Envelope>

Response

Code Block

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
	<soap:Body>
		<ns2:getKFSChildOrganizationsResponse xmlns:ns2="http://www.adcom.uci.edu">
			<return>
				<kfsChartCode>IR</kfsChartCode>
				<kfsOrgCategory>S</kfsOrgCategory>
				<kfsOrgCode>9023</kfsOrgCode>
				<kfsOrgLevel>3</kfsOrgLevel>
				<kfsOrgName>SCHOOL OF PHYSICAL SCIENCES</kfsOrgName>
				<kfsParentOrgCode>IRVN</kfsParentOrgCode>
				<kfskfsOrgRollupLevel1>-</kfskfsOrgRollupLevel1>
				<kfskfsOrgRollupLevel2>-</kfskfsOrgRollupLevel2>
				<kfskfsOrgRollupLevel3>9023</kfskfsOrgRollupLevel3>
				<kfskfsOrgRollupLevel4>-</kfskfsOrgRollupLevel4>
				<kfskfsOrgRollupLevel5>-</kfskfsOrgRollupLevel5>
				<kfskfsOrgRollupLevel6>-</kfskfsOrgRollupLevel6>
			</return>
			<return>
				<kfsChartCode>IR</kfsChartCode>
				<kfsOrgCategory>D</kfsOrgCategory>
				<kfsOrgCode>8110</kfsOrgCode>
				<kfsOrgLevel>4</kfsOrgLevel>
				<kfsOrgName>EARTH SYSTEM SCIENCE</kfsOrgName>
				<kfsParentOrgCode>9023</kfsParentOrgCode>
				<kfskfsOrgRollupLevel1>-</kfskfsOrgRollupLevel1>
				<kfskfsOrgRollupLevel2>-</kfskfsOrgRollupLevel2>
				<kfskfsOrgRollupLevel3>9023</kfskfsOrgRollupLevel3>
				<kfskfsOrgRollupLevel4>8110</kfskfsOrgRollupLevel4>
				<kfskfsOrgRollupLevel5>-</kfskfsOrgRollupLevel5>
				<kfskfsOrgRollupLevel6>-</kfskfsOrgRollupLevel6>
			</return>
			<return>
				<kfsChartCode>IR</kfsChartCode>
				<kfsOrgCategory>D</kfsOrgCategory>
				<kfsOrgCode>8094</kfsOrgCode>
				<kfsOrgLevel>4</kfsOrgLevel>
				<kfsOrgName>DEANS OFFICE</kfsOrgName>
				<kfsParentOrgCode>9023</kfsParentOrgCode>
				<kfskfsOrgRollupLevel1>-</kfskfsOrgRollupLevel1>
				<kfskfsOrgRollupLevel2>-</kfskfsOrgRollupLevel2>
				<kfskfsOrgRollupLevel3>9023</kfskfsOrgRollupLevel3>
				<kfskfsOrgRollupLevel4>8094</kfskfsOrgRollupLevel4>
				<kfskfsOrgRollupLevel5>-</kfskfsOrgRollupLevel5>
				<kfskfsOrgRollupLevel6>-</kfskfsOrgRollupLevel6>
			</return>
			<return>
				<kfsChartCode>IR</kfsChartCode>
				<kfsOrgCategory>D</kfsOrgCategory>
				<kfsOrgCode>8060</kfsOrgCode>
				<kfsOrgLevel>4</kfsOrgLevel>
				<kfsOrgName>CHEMISTRY</kfsOrgName>
				<kfsParentOrgCode>9023</kfsParentOrgCode>
				<kfskfsOrgRollupLevel1>-</kfskfsOrgRollupLevel1>
				<kfskfsOrgRollupLevel2>-</kfskfsOrgRollupLevel2>
				<kfskfsOrgRollupLevel3>9023</kfskfsOrgRollupLevel3>
				<kfskfsOrgRollupLevel4>8060</kfskfsOrgRollupLevel4>
				<kfskfsOrgRollupLevel5>-</kfskfsOrgRollupLevel5>
				<kfskfsOrgRollupLevel6>-</kfskfsOrgRollupLevel6>
			</return>
			<return>
				<kfsChartCode>IR</kfsChartCode>
				<kfsOrgCategory>D</kfsOrgCategory>
				<kfsOrgCode>8172</kfsOrgCode>
				<kfsOrgLevel>4</kfsOrgLevel>
				<kfsOrgName>MATHEMATICS</kfsOrgName>
				<kfsParentOrgCode>9023</kfsParentOrgCode>
				<kfskfsOrgRollupLevel1>-</kfskfsOrgRollupLevel1>
				<kfskfsOrgRollupLevel2>-</kfskfsOrgRollupLevel2>
				<kfskfsOrgRollupLevel3>9023</kfskfsOrgRollupLevel3>
				<kfskfsOrgRollupLevel4>8172</kfskfsOrgRollupLevel4>
				<kfskfsOrgRollupLevel5>-</kfskfsOrgRollupLevel5>
				<kfskfsOrgRollupLevel6>-</kfskfsOrgRollupLevel6>
			</return>
			<return>
				<kfsChartCode>IR</kfsChartCode>
				<kfsOrgCategory>D</kfsOrgCategory>
				<kfsOrgCode>8203</kfsOrgCode>
				<kfsOrgLevel>4</kfsOrgLevel>
				<kfsOrgName>PHYSICS AND ASTRONOMY</kfsOrgName>
				<kfsParentOrgCode>9023</kfsParentOrgCode>
				<kfskfsOrgRollupLevel1>-</kfskfsOrgRollupLevel1>
				<kfskfsOrgRollupLevel2>-</kfskfsOrgRollupLevel2>
				<kfskfsOrgRollupLevel3>9023</kfskfsOrgRollupLevel3>
				<kfskfsOrgRollupLevel4>8203</kfskfsOrgRollupLevel4>
				<kfskfsOrgRollupLevel5>-</kfskfsOrgRollupLevel5>
				<kfskfsOrgRollupLevel6>-</kfskfsOrgRollupLevel6>
			</return>
		</ns2:getKFSChildOrganizationsResponse>
	</soap:Body>
</soap:Envelope>

Java Client Example

Code Block

DWHServerService service = new DWHServerService();
DWHServer server = service.getDWHServerPort();
		
OrganizationParameters orgParameters = new OrganizationParameters();
orgParameters.setKfsChartCode("IR");
orgParameters.setKfsOrgCode("9023");

List<ChildOrganizationDetails> childOrgDetails = server.getKFSChildOrganizations(orgParameters);

if (childOrgDetails != null) {
	for (ChildOrganizationDetails cod : childOrgDetails) {
		System.out.println("kfsChartCode:    " + cod.getKfsChartCode());
		System.out.println("kfsOrgCode:      " + cod.getKfsOrgCode());
		System.out.println("kfsOrgName:      " + cod.getKfsOrgName());
		System.out.println("kfsParentOrgCode:" + cod.getKfsParentOrgCode());
		System.out.println("kfsOrgLevel:     " + cod.getKfsOrgLevel());
		System.out.println("kfsOrgCategory:  " + cod.getKfsOrgCategory());
		System.out.println("kfsOrgLevel1     " + cod.getKfskfsOrgRollupLevel1());
		System.out.println("kfsOrgLevel2     " + cod.getKfskfsOrgRollupLevel2());
		System.out.println("kfsOrgLevel3     " + cod.getKfskfsOrgRollupLevel3());
		System.out.println("kfsOrgLevel4     " + cod.getKfskfsOrgRollupLevel4());
		System.out.println("kfsOrgLevel5     " + cod.getKfskfsOrgRollupLevel5());
		System.out.println("kfsOrgLevel6     " + cod.getKfskfsOrgRollupLevel6());
		System.out.println("------------------------------");
	}
}

...

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");
}

...

getKFSAccountManagersByOrg(String kfsChartCode, String kfsOrgCode, boolean traverseAllChildOrgs)

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)	9017
2	traverseAllChildOrgs	Traverse children of KFS Organization provided in parameter	Yes	boolean	false

DB Query

Code Block

WITH ChildOrgList AS ( 
SELECT ChildOrg.ORG_CD, ChildOrg.FIN_COA_CD, ChildOrg.ORG_NM, 0 AS ORG_LEVEL 
FROM CA_ORG_T AS ChildOrg 
WHERE ChildOrg.FIN_COA_CD = 'IR' AND ChildOrg.ORG_CD = '9017'
UNION ALL 
SELECT ChildOrg.ORG_CD, ChildOrg.FIN_COA_CD, ChildOrg.ORG_NM, ORG_LEVEL + 1 AS ORG_LEVEL 
FROM CA_ORG_T AS ChildOrg 
INNER JOIN ChildOrgList AS Child ON ChildOrg.RPTS_TO_FIN_COA_CD = Child.FIN_COA_CD and ChildOrg.RPTS_TO_ORG_CD = Child.ORG_CD 
) 
SELECT distinct o.*, a.ACCOUNT_NBR, a.ACCOUNT_NM, e.ucinetid, e.first_name, e.last_name, e.primary_title_code, e.primary_title, e.ph_title, e.phone, 
       p.postalAddress line_address, p.l as city, p.st as state, p.postalCode as zip, p.uciZotCode 
FROM ChildOrgList o 
INNER JOIN CA_ACCOUNT_T a on (a.FIN_COA_CD = o.FIN_COA_CD and a.ORG_CD = o.ORG_CD) 
INNER JOIN dwhs_ppscurr..employee_basic e on (a.ACCT_MGR_UNVL_ID = e.CAMPUS_ID) 
INNER JOIN dwhs_ppscurr..ldap_people p on (p.uid = e.ucinetid) 
where o.ORG_LEVEL = 0

Result Schema: SAME as getValidKFSOrganizations

WS Example

Request

Code Block

<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
	<S:Body>
		<ns2:getKFSAccountManagersByOrg xmlns:ns2="http://www.adcom.uci.edu">
			<kfsChartCode>IR</kfsChartCode>
			<kfsOrgCode>9017</kfsOrgCode>
			<traverseAllChildOrgs>false</traverseAllChildOrgs>
		</ns2:getKFSAccountManagersByOrg>
	</S:Body>
</S:Envelope>

Response

Code Block

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
	<soap:Body>
		<ns2:getKFSAccountManagersByOrgResponse xmlns:ns2="http://www.adcom.uci.edu">
			<return>
				<acctMgrCity>Irvine</acctMgrCity>
				<acctMgrFirstNme>FIRST</acctMgrFirstNme>
				<acctMgrLastName>LAST</acctMgrLastName>
				<acctMgrLineAddress>1400 Biological Sciences III</acctMgrLineAddress>
				<acctMgrPhTitle>Director Accounting Systems</acctMgrPhTitle>
				<acctMgrPhone>(949) 824-1234</acctMgrPhone>
				<acctMgrPrimaryTitle>DIR</acctMgrPrimaryTitle>
				<acctMgrPrimaryTitleCode>0245</acctMgrPrimaryTitleCode>
				<acctMgrState>CA</acctMgrState>
				<acctMgrUciZotCode>1050</acctMgrUciZotCode>
				<acctMgrZip>92697</acctMgrZip>
				<acctName>407618-19906 ACADEMIC COMPUTING</acctName>
				<acctNumber>GF11482</acctNumber>
				<orgChartCode>IR</orgChartCode>
				<orgCode>9017</orgCode>
				<orgName>OFFICE OF INFORMATION TECHNOLOGY</orgName>
			</return>
			...
		</ns2:getKFSAccountManagersByOrgResponse>
	</soap:Body>
</soap:Envelope>

Java Client Example

DWHServerService service = new DWHServerService();
DWHServer server = service.getDWHServerPort();

List<AccountManagerDetails> resultList = server.getKFSAccountManagersByOrg("IR", "9017", false);

if (resultList != null) {
for (AccountManagerDetails amd : resultList) {
System.out.println("Account Manager Details" + amd);
}
}
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	fsOrganizationCodefsHierarchyCode	FS Organization Code	No	String(4)	90302000

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='90302000') OR 
(UC_LOC_CD='9' AND UC_HIERARCHY_CD='90403000') OR 
(UC_LOC_CD='0' AND UC_HIERARCHY_CD='0000') 
);

...

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

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>
            <item>9<<fsHierarchyCode>2000</item>fsHierarchyCode>
            <item>9030<<fsLocationCode>9</item>fsLocationCode>
         </fsOrganizationList>
         <fsOrganizationList>
            <item>9<<fsHierarchyCode>3000</item>fsHierarchyCode>
            <item>9040<<fsLocationCode>9</item>fsLocationCode>
         </fsOrganizationList>
         <fsOrganizationList>
            <item>0<<fsHierarchyCode>0000</item>fsHierarchyCode>
            <item>0000<<fsLocationCode>0</item>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>9030<<fsHierarchyCode>2000</fsHierarchyCode>
            <fsHierarchyType>O</fsHierarchyType>
            <fsLocationCode>9</fsLocationCode>
            <kfsChartCode>IR</kfsChartCode>
            <kfsOrgCode>9903<<kfsOrgCode>9022</kfsOrgCode>
         </return>
         <return>
            <fsHierarchyCode>9040<<fsHierarchyCode>3000</fsHierarchyCode>
            <fsHierarchyType>O</fsHierarchyType>
            <fsLocationCode>9</fsLocationCode>
            <kfsChartCode>IR</kfsChartCode>
            <kfsOrgCode>9904<<kfsOrgCode>9002</kfsOrgCode>
         </return>
      </ns2:translateFSOrganizationsResponse>
   </soap:Body>
</soap:Envelope>

Java Client Example

Code Block

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

 
System.out.println("\nWSClient-translateFSOrganizations()");
StringArray sa180ArrayList<OrganizationTranslateParameters> pl20 = new ArrayList<OrganizationTranslateParameters>();
OrganizationTranslateParameters otp200 = new StringArrayOrganizationTranslateParameters();
sa180otp200.getItemsetFsHierarchyCode().add("92000");
sa180otp200.getItemsetFsLocationCode().add("90309");
StringArrayOrganizationTranslateParameters sa181otp201 = new StringArrayOrganizationTranslateParameters();
sa181otp201.getItemsetFsHierarchyCode().add("93000");
sa181.getItem().addotp201.setFsLocationCode("90409");
StringArrayOrganizationTranslateParameters sa182otp202 = new StringArrayOrganizationTranslateParameters();
sa182otp202.getItemsetFsHierarchyCode("0000");
otp202.addsetFsLocationCode("0");
pl20.add(otp200);
sa182pl20.getItemadd(otp201);
pl20.add("0000"otp202);
List<Fs2KFSOrganizationDetails> resultList18resultList20 = ds.translateFSOrganizations(Arrays.asList(sa180,sa181,sa182)pl20);
if (resultList18resultList20 != null) {
	for (Iterator i = resultList18resultList20.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	fsDivsionCodefsHierarchyCode	FS Division Code	Yes	String(4)	10031015

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='10031015') OR 
(UC_LOC_CD='9' AND UC_HIERARCHY_CD='10051100') OR 
(UC_LOC_CD='0' AND UC_HIERARCHY_CD='0000')
);

...

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

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>
            <item>9<<fsHierarchyCode>1015</item>fsHierarchyCode>
            <item>1003<<fsLocationCode>9</item>fsLocationCode>
         </fsOrganizationList>
         <fsOrganizationList>
            <item>9<<fsHierarchyCode>1100</item>fsHierarchyCode>
            <item>1005<<fsLocationCode>9</item>fsLocationCode>
         </fsOrganizationList>
         <fsOrganizationList>
            <item>0<<fsHierarchyCode>0000</item>fsHierarchyCode>
            <item>0000<<fsLocationCode>0</item>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>1003<<fsHierarchyCode>1015</fsHierarchyCode>
            <fsHierarchyType>V</fsHierarchyType>
            <fsLocationCode>9</fsLocationCode>
            <kfsChartCode>IR</kfsChartCode>
            <kfsOrgCode>9801<<kfsOrgCode>9006</kfsOrgCode>
         </return>
         <return>
            <fsHierarchyCode>1005<<fsHierarchyCode>1100</fsHierarchyCode>
            <fsHierarchyType>V</fsHierarchyType>
            <fsLocationCode>9</fsLocationCode>
            <kfsChartCode>IR</kfsChartCode>
            <kfsOrgCode>9802<<kfsOrgCode>9012</kfsOrgCode>
         </return>
      </ns2:translateFSDivisionsResponse>
   </soap:Body>
</soap:Envelope>

Java Client Example

Code Block

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

ArrayList<OrganizationTranslateParameters> pl21 =  
System.out.println("\nWSClient-translateFSDivisionsnew ArrayList<OrganizationTranslateParameters>()");
StringArrayOrganizationTranslateParameters sa190otp210 = new StringArrayOrganizationTranslateParameters();
sa190otp210.getItemsetFsHierarchyCode().add("91015");
sa190otp210.getItemsetFsLocationCode().add("10039");
StringArrayOrganizationTranslateParameters sa191otp211 = new StringArrayOrganizationTranslateParameters();
sa191.getItem().addotp211.setFsHierarchyCode("91100");
sa191.getItem().addotp211.setFsLocationCode("10059");
StringArrayOrganizationTranslateParameters sa192otp212 = new StringArrayOrganizationTranslateParameters();
sa192otp212.getItemsetFsHierarchyCode("0000");
otp212.addsetFsLocationCode("0");
pl21.add(otp210);
sa192pl21.getItemadd(otp211);
pl21.add("0000"otp212);
List<Fs2KFSOrganizationDetails> resultList19resultList21 = ds.translateFSDivisions(Arrays.asList(sa190,sa191,sa192))pl21);
if (resultList19resultList21 != null) {
	for (Iterator i = resultList19resultList21.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	fsSubDivisionCodefsHierarchyCode	FS SubDivisionCode	NoYes	String(4)	10031300

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='10031300') OR
(UC_LOC_CD='9' AND UC_HIERARCHY_CD='10051350') OR
(UC_LOC_CD='0' AND UC_HIERARCHY_CD='0000')
);

...

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

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>
            <item>9<<fsHierarchyCode>1300</item>fsHierarchyCode>
            <item>1003<<fsLocationCode>9</item>fsLocationCode>
         </fsOrganizationList>
         <fsOrganizationList>
            <item>9<<fsHierarchyCode>1350</item>fsHierarchyCode>
            <item>1005<<fsLocationCode>9</item>fsLocationCode>
         </fsOrganizationList>
         <fsOrganizationList>
            <item>0<<fsHierarchyCode>0000</item>fsHierarchyCode>
            <item>0000<<fsLocationCode>0</item>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>1003<<fsHierarchyCode>1300</fsHierarchyCode>
            <fsHierarchyType>S</fsHierarchyType>
            <fsLocationCode>9</fsLocationCode>
            <kfsChartCode>IR</kfsChartCode>
            <kfsOrgCode>9001<<kfsOrgCode>9004</kfsOrgCode>
         </return>
         <return>
            <fsHierarchyCode>1005<<fsHierarchyCode>1350</fsHierarchyCode>
            <fsHierarchyType>S</fsHierarchyType>
            <fsLocationCode>9</fsLocationCode>
            <kfsChartCode>IR</kfsChartCode>
            <kfsOrgCode>9002<<kfsOrgCode>9010</kfsOrgCode>
         </return>
      </ns2:translateFSSubDivisionsResponse>
   </soap:Body>
</soap:Envelope>

Java Client Example

Code Block

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

ArrayList<OrganizationTranslateParameters> pl22  
System.out.println("\nWSClient-translateFSSubDivisions()"= new ArrayList<OrganizationTranslateParameters>();
StringArrayOrganizationTranslateParameters sa200otp220 = new StringArrayOrganizationTranslateParameters();
sa200otp220.getItemsetFsHierarchyCode().add("91300");
sa200.getItem().addotp220.setFsLocationCode("10039");
StringArrayOrganizationTranslateParameters sa201otp221 = new StringArrayOrganizationTranslateParameters();
sa201otp221.getItemsetFsHierarchyCode().add("91350");
sa201otp221.getItemsetFsLocationCode().add("10059");
StringArrayOrganizationTranslateParameters sa202otp222 = new StringArray(OrganizationTranslateParameters();
otp222.setFsHierarchyCode("0000");
sa202otp222.getItemsetFsLocationCode("0");
pl22.add("0"otp220);
sa202pl22.getItemadd(otp221);
pl22.add("0000"otp222);
List<Fs2KFSOrganizationDetails> resultList20resultList22 = ds.translateFSSubDivisions(Arrays.asList(sa200,sa201,sa202))pl22);
if (resultList20resultList22 != null) {
	for (Iterator i = resultList20resultList22.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	fsDepartmentCodefsHierarchyCode	FS DepartmentCode	NoYes	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')
);

...

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adc="http://www.adcom.uci.edu"> <soapenv:Header/> <soapenv:Body>

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

Response

Code Block

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

Response

Code Block

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

Java Client Example

Code Block

DWHServerService dss = new DWHServerService();
DWHServer ds = dss.getDWHServerPortCustom();
 
System.out.println("\nWSClient-translateFSDepartments()");
StringArray sa210 = new StringArray();
sa210.getItem().add("9");
sa210.getItem().add("0003");
StringArray sa211 = new StringArray();
sa211.getItem().add("9");
sa211.getItem().add("0302");
StringArray sa212 = new StringArray();
sa212.getItem().add("0");
sa212.getItem().add("0000");
List<Fs2KFSOrganizationDetails> resultList21 = ds.translateFSDepartments(Arrays.asList(sa210,sa211,sa212));
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());
	}</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");
}

...

translateMedCompKFSOrgToKFSAccount(kfsChartCode, kfsOrganizationCode)

This service is used to translate a KFS Organization to a KFS Account (used by Labor Ledger feed). Returns an XML result set with a KFS Account and KFS Chart if found.

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)	8282

DB Query

Code Block
SELECT KFS_COA_CD, KFS_ACCOUNT_NBR FROM UCI_LD_MED_COMP_XW_T WHERE PPS_COA_CD = 'IR' AND PPS_ORG_CD = '8282'

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

Parameter	Description	Data Type	Example
kfsChartCode	KFS Chart Code	String(2)	IR
kfsAcctNumber	KFS Account Number	String(4)	SS11574

WS Example

Request

Code Block

<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
	<S:Body>
		<ns2:translateMedCompKFSOrgToKFSAccount xmlns:ns2="http://www.adcom.uci.edu">
			<kfsOrganization>
				<kfsChartCode>IR</kfsChartCode>
				<kfsOrgCode>8282</kfsOrgCode>
			</kfsOrganization>
		</ns2:translateMedCompKFSOrgToKFSAccount>
	</S:Body>
</S:Envelope>

Response

Code Block

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
	<soap:Body>
		<ns2:translateMedCompKFSOrgToKFSAccountResponse xmlns:ns2="http://www.adcom.uci.edu">
			<return>
				<kfsAcctNumber>SS11574</kfsAcctNumber>
				<kfsChartCode>IR</kfsChartCode>
			</return>
		</ns2:translateMedCompKFSOrgToKFSAccountResponse>
	</soap:Body>
</soap:Envelope>

Java Client Example

Code Block

DWHServerService service = new DWHServerService();
DWHServer server = service.getDWHServerPort();
		
OrganizationParameters orgParam = new OrganizationParameters();
orgParam.setKfsChartCode("IR");
orgParam.setKfsOrgCode("8282");
MedCompAccount medCompAccount = server.translateMedCompKFSOrgToKFSAccount(orgParam);
if (medCompAccount != null) {
	System.out.println(medCompAccount.getKfsChartCode() + " " + medCompAccount.getKfsAcctNumber());
}
else {
	System.out.println("something bad happened...please check your query");
}

...

Version	Old Version 22	New Version Current
Changes made by	Adam Chang	Jarrod Lannan
Saved on	Sept 17, 2012	Sept 18, 2014

Page Comparison

Versions Compared

Key

DB Query

DB Query

DB Query

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

Java Client Example

getAllKFSOrganizations()

DB Query

Result Schema: SAME as getValidKFSOrganizations

WS Example

Request

Response

Java Client Example

Java Client Example

getKFSChildOrganizations(kfsOrgCode, kfsChartCode)

Input Specifications

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

WS Example

Request

Response

Java Client Example

getAllKFSOrganizations()

DB Query

Result Schema: SAME as getValidKFSOrganizations

WS Example

Request

Response

Java Client Example

getKFSAccountManagersByOrg(String kfsChartCode, String kfsOrgCode, boolean traverseAllChildOrgs)

Input Specifications

DB Query

Result Schema: SAME as getValidKFSOrganizations

WS Example

Request

Response

Java Client Example

translateFSOrganizations(List of (fsLocationCode,

fsHierarchyCode))

Input Specifications

DB Query

WS Example

Request

Response

Java Client Example

translateFSDivisions(List of (fsLocationCode,

fsHierarchyCode))

Input Specifications

DB Query

WS Example

Request

Response

Java Client Example

translateFSSubDivisions(List of (fsLocationCode,

fsHierarchyCode))

Input Specifications

DB Query

WS Example

Request

Response

Java Client Example

translateFSDepartments(List of (fsLocationCode,

fsHierarchyCode))

Input Specifications

DB Query

WS Example

Request

Response

Response

Java Client Example

Java Client Example

translateMedCompKFSOrgToKFSAccount(kfsChartCode, kfsOrganizationCode)

Input Specifications

DB Query

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

WS Example

Request

Response

Java Client Example