Web Services - KFS Organization

Usage

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

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

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

DB Query

SELECT FIN_COA_CD, ORG_CD, ORG_ACTIVE_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 (OrganizationValidation.java)

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

WS Example

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adc="http://www.adcom.uci.edu">
   <soapenv:Header/>
   <soapenv:Body>
      <adc:isValidKFSOrganizations>
         <kfsOrganizationCodeList>
            <item>IR</item>
            <item>9052</item>
         </kfsOrganizationCodeList>
         <kfsOrganizationCodeList>
            <item>IR</item>
            <item>9053</item>
         </kfsOrganizationCodeList>
         <kfsOrganizationCodeList>
            <item>IR</item>
            <item>1234</item>
         </kfsOrganizationCodeList>
         <kfsOrganizationCodeList>
            <item>XX</item>
            <item>9054</item>
         </kfsOrganizationCodeList>
      </adc:isValidKFSOrganizations>
   </soapenv:Body>
</soapenv:Envelope>

Response

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

Java Client Example

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


StringArray sa120 = new StringArray();
sa120.getItem().add("IR");
sa120.getItem().add("9052");


StringArray sa121 = new StringArray();
sa121.getItem().add("IR");
sa121.getItem().add("9053");


StringArray sa122 = new StringArray();
sa122.getItem().add("IR");
sa122.getItem().add("1111");
		
StringArray sa123 = new StringArray();
sa123.getItem().add("XX");
sa123.getItem().add("9054");
		
List<OrganizationValidation> resultList12 = ds.isValidKFSOrganizations(Arrays.asList(sa120, sa121, sa122, sa123));
if (resultList12 != null) {
	for (Iterator i = resultList12.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

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adc="http://www.adcom.uci.edu">
   <soapenv:Header/>
   <soapenv:Body>
      <adc:getValidKFSOrganizations>
         <kfsOrganizationCodeList>
            <item>IR</item>
            <item>9052</item>
         </kfsOrganizationCodeList>
         <kfsOrganizationCodeList>
            <item>IR</item>
            <item>9053</item>
         </kfsOrganizationCodeList>
         <kfsOrganizationCodeList>
            <item>IR</item>
            <item>1234</item>
         </kfsOrganizationCodeList>
         <kfsOrganizationCodeList>
            <item>XX</item>
            <item>9054</item>
         </kfsOrganizationCodeList>
      </adc:getValidKFSOrganizations>
   </soapenv:Body>
</soapenv:Envelope>

Response

<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>
            <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:getValidKFSOrganizationsResponse>
   </soap:Body>
</soap:Envelope>

Java Client Example

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


StringArray sa130 = new StringArray();
sa130.getItem().add("IR");
sa130.getItem().add("9052");


StringArray sa131 = new StringArray();
sa131.getItem().add("IR");
sa131.getItem().add("9053");


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

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

<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

<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

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

translateFSOrganizations(List of (fsLocationCode, fsOrganizationCode, fsDivsionCode, fsSubDivisionCode, fsDepartmentCode))

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	fsOrganizationCode	FS Organization Code	No	String(4)	1000

DB Query

select FIN_COA_CD, ORG_CD from UCI_CA_ORG_XW_T where uc_loc_cd = '9' and uc_hierarchy_cd = '0302' and uc_hierarchy_type_cd = 'O'

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

WS Example

translateFSDivisions(List of (fsLocationCode, fsDivsionCode))

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	fsDivsionCode	FS Division Code	Yes	String(4)	1200

DB Query

select FIN_COA_CD, ORG_CD from UCI_CA_ORG_XW_T where uc_loc_cd = '9' and uc_hierarchy_cd = '0302' and uc_hierarchy_type_cd = 'V'

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

WS Example

translateFSSubDivisions(List of (fsLocationCode, fsSubDivisionCode))

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	fsSubDivisionCode	FS SubDivisionCode	No	String(4)	1250

DB Query

select FIN_COA_CD, ORG_CD from UCI_CA_ORG_XW_T where uc_loc_cd = '9' and uc_hierarchy_cd = '0302' and uc_hierarchy_type_cd = 'S'

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

WS Example

translateFSDepartments(List of (fsLocationCode, fsDepartmentCode))

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	fsDepartmentCode	FS DepartmentCode	No	String(4)	0302

DB Query

select FIN_COA_CD, ORG_CD from UCI_CA_ORG_XW_T where uc_loc_cd = '9' and uc_hierarchy_cd = '0302' and uc_hierarchy_type_cd = 'D'

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