Attention A T users. To access the menus on this page please perform the following steps. 1. Please switch auto forms mode to off. 2. Hit enter to expand a main menu option (Health, Benefits, etc). 3. To enter and activate the submenu links, hit the down arrow. You will now be able to tab or arrow up or down through the submenu options to access/activate the submenu links.

Locator

Contact

Ask a Question

Toll Free Numbers

Locator

Hospitals and Clinics

Vet Centers

Regional Benefits Offices

Regional Loan Centers

Cemetery Locations

Locations

VA » Web Services »VA Facilities

Web Services

Overview

The facilities web service provides VA facility information. You can retrieve summary information about VA facilities by passing parameters such as Reg_id, State, and Fac_id. You can retrieve detailed or general VA facilities information by passing a fac_id or comma delimited fac_id list. In addition, the facilities web service provides method to retrieve summary and detail VA facility information by passing Reg_id and/or fac_type_id.

The GetFacsSummary_array method returns basic facility information in an array.
The GetFacsSummary_query method returns basic facility information in a ColdFusion query.
The GetFacsSummary_wddx method returns basic facility information in a string containing a WDDX packet.
The GetFacsSummary_xml method returns basic facility information in a WDDX packet containing an XML packet.
The GetFacsSummary_xmlString method returns basic facility information in a string containing an XML packet.

The GetFacsDetailByByFacID_array method returns detailed facility information in an array.
The GetFacsDetailByFacID_query method returns detailed facility information in a ColdFusion query.
The GetFacsDetailByFacID_wddx method returns detailed facility information in a string containing a WDDX packet.
The GetFacsDetailByFacID_xml method returns detailed facility informationin a string containing an XML packet.
The GetFacsDetailByFacID_xmlString method returns detailed facility information in a string containing an XML packet.

**Please note that the GetFacsDetailByFacID_xml and GetFacsDetailByFacID_xmlString methods may not render special charactors correctly**

The Facility_byRegionIDandType_summary_array method returns basic facility information in an array .
The Facility_byRegionIDandType_summary_query method returns basic facility information in a ColdFusion query.
The Facility_byRegionIDandType_summary_wddx method returns basic facility information in a string containing a WDDX packet.
The Facility_byRegionIDandType_summary_xmlString method returns basic facility information in a string containing an XML packet.

The Facility_byRegionIDandType_detail_array method returns detailed facility information in an array.
The Facility_byRegionIDandType_detail_query method returns detailed facility information in a ColdFusion query.
The Facility_byRegionIDandType_detail_wddx method returns detailed facility information in a string containing a WDDX packet.
The Facility_byRegionIDandType_detail_xmlString method returns detailed facility information in a string containing an XML packet.

**Please note that you can pass empty string to either reg_id or fac_type_id for method Facility_byRegionIDandType_summary or Facility_byRegionIDandType_detail to retrieve all types of facilities within the specific region(s) or specific types of facilities.**

The GetFacsDescriptionByByFacID_array method returns general facility information in an array.
The GetFacsDescriptionByFacID_query method returns general facility information in a ColdFusion query.
The GetFacsDescriptionByFacID_wddx method returns general facility information in a string containing a WDDX packet.
The GetFacsDescriptionByFacID_xml method returns general facility information in a WDDX packet containing an XML packet.
The GetFacsDescriptionByFacID_xmlString method returns general facility information in a string containing an XML packet.

The getSPCs_xml method returns Suicide Prevention Coordinator(SPC) information in a WDDX packet containing an XML packet.
The getSPCs_xmlstring method returns Suicide Prevention Coordinator(SPC) information in a string containing an XML packet.

return to top

Demonstration

Use the links below to view a visual representation of the data return from the web service.
Demo the GetFacsSummary_array method where reg_ID=5,7,10
Demo the GetFacsSummary_query method where state=MD
Demo the GetFacsSummary_wddx method where fac_ID=1001,50
Demo the GetFacsSummary_xml method where reg_ID=8,23
Demo the GetFacsSummary_xmlString method where reg_ID=8,23

Demo the GetFacsDetailByFacID_array method where fac_ID=3
Demo the GetFacsDetailByFacID_query method where fac_ID=1,2
Demo the GetFacsDetailByFacID_wddx method where fac_ID=1001
Demo the GetFacsDetailByFacID_xml method where fac_ID=7
Demo the GetFacsDetailByFacID_xmlString method where fac_ID=7

Demo the Facility_byRegionIDandType_Summary_array method where reg_ID=1 and Fac_Type_ID=13
Demo the Facility_byRegionIDandType_Summary_query method where reg_ID=1,2 and Fac_Type_ID=13
Demo the Facility_byRegionIDandType_Summary_wddx method where reg_ID=999
Demo the Facility_byRegionIDandType_Summary_xmlString method where reg_ID=1 and Fac_Type_ID=2

Demo the Facility_byRegionIDandType_detail_array method where reg_id=1 and Fac_Type_ID=13
Demo the Facility_byRegionIDandType_detail_query method where reg_ID=1,2 and Fac_Type_ID=13
Demo the Facility_byRegionIDandType_detail_wddx method where reg_ID=999
Demo the Facility_byRegionIDandType_detail_xmlString method where reg_ID=1 and Fac_Type_ID=2

Demo the GetFacsDescriptionByFacID_array method where fac_ID=3
Demo the GetFacsDescriptionByFacID_query method where fac_ID=1,2
Demo the GetFacsDescriptionByFacID_wddx method where fac_ID=1001
Demo the GetFacsDescriptionByFacID_xml method where fac_ID=7
Demo the GetFacsDescriptionByFacID_xmlString method where fac_ID=7

Demo the getSPCs_xml method where state=VA
Demo the getSPCs_xmlstring method where state=VA

You can also get return data in Json by using the following format:
http://www.va.gov/webservices/fandl/facilities.cfc?method=GetFacsSummary_array&fac_fld=reg_id&fac_val=5,7&license=YOUR LICENSE KEY&ReturnFormat=JSON
Demo the getFacsSummary_array method where reg_ID=5,7 (JSON)

http://www.va.gov/webservices/fandl/facilities.cfc?method=GetFacsSummary_query&fac_fld=reg_id&fac_val=5,7&license=YOUR LICENSE KEY&ReturnFormat=JSON
Demo the getFacsSummary_query method where reg_ID=5,7 (JSON)

return to top

Samples

There currently are no samples available for this web service.

return to top

Summary

Below is a high-level look at the web service and the methods it has to offer for public consumption.

Hierarchy:

webservices.FandL.facilities

Location:

https://www.va.gov/webservices/fandl/facilities.cfc

WSDL:

https://www.va.gov/webservices/fandl/facilities.cfc?wsdl

Methods:

Output:

aFacs structure, qFacs structure, wFacs structure, xFacs XML packet, aFacG structure, qFacG structure, wFacG structure, xFacG XML packet, aFacD structure, qFacD structure, wFacD structure, xFacD XML packet, xSPC XML packet

Status:

Definitions are available for each of the possible web service result status codes

Facility Type LookUp:

References are available for facility type.

Region LookUp:

References are available for facility region.

Version:

1.0

return to top

Interface Details

Below is a detail look at the methods contained in this web service, the output format provided by those methods and the possible status conditions that can result from consuming this web service.

Methods

GetFacsSummary_array


                            remote struct GetFacsSummary_array (required string fac_fld, required string fac_val, required string license)

This method returns summary information from facility records that match the search criteria passed in. The results field of the data structure returned contains an array of facility records.

Input:

fac_fld: [string, required] - Name of the field to search on. Possible values are: Reg_id; Fac_ID; State
fac_val: [string, required] - The value of the field for the record you are searching for. You can also provide a comma delimited list.
license: [string, required] - The license key issued by the VA Web Solutions Office that is required to use this service.

Output:

aFacS array structure

GetFacsSummary_query


                            remote struct GetFacsSummary_query (required string fac_fld, required string fac_val, required string license)

This method returns summary information from facility records that match the search criteria passed in. The results field of the data structure returned contains a ColdFusion query of facility records.

Input:

Output:

qFacS ColdFusion query structure

GetFacsSummary_wddx


                            remote string GetFacsSummary_wddx (required string fac_fld, required string fac_val, required string license)

This method returns summary information from facility records that match the search criteria passed in. The results field of the data structure returned contains a WDDX packet.

Input:

Output:

wFacS WDDX structure

GetFacsSummary_xml


                            remote string GetFacsSummary_xml (required string fac_fld, required string fac_val, required string license)

This method returns summary information from facility records that match the search criteria passed in. The results are returned in a WDDX packet that contains the XML packet string.

Input:

Output:

xFacS XML packet (returned as a string encapsulated in a WDDX packet)

GetFacsSummary_xmlString


                            remote string GetFacsSummary_xmlString (required string fac_fld, required string fac_val, required string license)

This method returns summary information from facility records that match the search criteria passed in. The results are returned in a string containing an XML packet.

Input:

Output:

xFacS XML packet (returned as a string)

GetFacsDescriptionByFacID_array


                            remote struct GetFacsDescriptionByFacID_array (required string fac_id, required string license)

This method returns description information from facility records that match the search criteria passed in. The results field of the data structure returned contains an array of facility records.

Input:

fac_id: [string, required] - Name of the field to search on. You can also provide a comma delimited fac_id list.
license: [string, required] - The license key issued by the VA Web Solutions Office that is required to use this service.

Output:

aFacG array structure

GetFacsDescriptionByFacID_query


                            remote struct GetFacsDescriptionByFacID_query (required string fac_id, required	string license)

This method returns description information from facility records that match the search criteria passed in. The results field of the data structure returned contains a ColdFusion query of facility records.

Input:

Output:

qFacG ColdFusion query structure

GetFacsDescriptionByFacID_wddx


                            remote string GetFacsDescriptionByFacID_wddx (required	string fac_id, required string license)

This method returns description information from facility records that match the search criteria passed in. The results field of the data structure returned contains a WDDX packet.

Input:

Output:

wFacG WDDX packet

GetFacsDescriptionByFacID_xml


                            remote string GetFacsDescriptionByFacID_xml (required string fac_id, required string license)

This method returns description information from facility records that match the search criteria passed in. The results are returned in a WDDX packet that contains the XML packet string.

Input:

Output:

xFacG XML packet (returned as a string encapsulated in a WDDX packet)

GetFacsDescriptionByFacID_xmlString


                            remote string GetFacsDescriptionByFacID_xmlString (required string fac_id, required string license)

This method returns description information from facility records that match the search criteria passed in. The results are returned in a string containing an XML packet.

Input:

Output:

xFacG XML packet (returned as a string)

GetFacsDetailByFacID_array


                            remote struct GetFacsDetailByFacID_array (required	string fac_id, required string license)

This method returns detailed information from facility records that match the search criteria passed in. The results field of the data structure returned contains an array of facility records.

Input:

Output:

aFacD array structure

GetFacsDetailByFacID_query


                            remote struct GetFacsDetailByFacID_query (required string fac_id, required string license)

This method returns detailed information from facility records that match the search criteria passed in. The results field of the data structure returned contains a ColdFusion query of facility records.

Input:

Output:

qFacD ColdFusion query structure

GetFacsDetailByFacID_wddx


                            remote string GetFacsDetailByFacID_wddx (required string fac_id, required string license)

This method returns detailed information from facility records that match the search criteria passed in. The results field of the data structure returned contains a WDDX packet.

Input:

Output:

wFacD WDDX packet

GetFacsDetailByFacID_xml


                            remote string GetFacsDetailByFacID_xml (required string fac_id, required string license)

This method returns detailed information from facility records that match the search criteria passed in. The results are returned in a WDDX packet that contains the XML packet string.

Input:

Output:

xFacD XML packet (returned as a string encapsulated in a WDDX packet)

GetFacsDetailByFacID_xmlString


                            remote string GetFacsDetailByFacID_xmlString (required	string fac_id, required string license)

This method returns detailed information from facility records that match the search criteria passed in. The results are returned in a string containing an XML packet.

Input:

Output:

xFacD XML packet (returned as a string)

Facility_byRegionIDandType_Summary_array


                            remote struct Facility_byRegionIDandType_Summary_array (required string Reg_id, required string Fac_Type_ID, required string license)

This method returns summary information from facility records that match the search criteria passed in. The results field of the data structure returned contains an array of facility records.

Input:

Reg_id: [string, required] - Facility Region to search on. You can also provide a comma delimited list.
Fac_Type_ID: [string, required] - Facility type to search on. You can also provide a comma delimited list.
license: [string, required] - The license key issued by the VA Web Solutions Office that is required to use this service.

Output:

aFacS array structure

Facility_byRegionIDandType_Summary_query


                            remote struct Facility_byRegionIDandType_Summary_query (required string Reg_id, required string Fac_Type_ID, required string license)

Input:

Output:

qFacS ColdFusion query structure

Facility_byRegionIDandType_Summary_wddx


                            remote struct Facility_byRegionIDandType_Summary_wddx (required string Reg_id, required string Fac_Type_ID, required string license)

This method returns summary information from facility records that match the search criteria passed in. The results field of the data structure returned contains a WDDX packet.

Input:

Output:

wFacS WDDX packet

Facility_byRegionIDandType_Summary_xmlString


                            remote struct Facility_byRegionIDandType_Summary_xmlString (required string Reg_id, required string Fac_Type_ID, required string license)

This method returns summary information from facility records that match the search criteria passed in. The results field of the data structure returned as a string containing a XML packet of facility summary information.

Input:

Output:

xFacS XML packet (returned as a string)

Facility_byRegionIDandType_Detail_array


                            remote struct Facility_byRegionIDandType_Detail_array (required string Reg_id, required string Fac_Type_ID, required string license)

This method returns detailed information from facility records that match the search criteria passed in. The results field of the data structure returned contains an array of facility records.

Input:

Output:

aFacD array structure

Facility_byRegionIDandType_Detail_query


                            remote struct Facility_byRegionIDandType_Detail_query (required string Reg_id, required string Fac_Type_ID, required string license)

Input:

Output:

qFacD ColdFusion query structure

Facility_byRegionIDandType_Detail_wddx


                            remote struct Facility_byRegionIDandType_Detail_wddx (required string Reg_id, required string Fac_Type_ID, required string license)

This method returns detailed information from facility records that match the search criteria passed in. The results field of the data structure returned contains a WDDX packet.

Input:

Output:

wFacD WDDX packet

Facility_byRegionIDandType_Detail_xmlString


                            remote struct Facility_byRegionIDandType_Detail_xmlString (required string Reg_id, required string Fac_Type_ID, required string license)

This method returns detailed information from facility records that match the search criteria passed in. The results field of the data structure returned as a string containing a XML packet of facility detailed information.

Input:

Output:

xFacD XML packet (returned as a string)

getSPCs_xml


                            remote string getSPCs_xml (required string state, required string license)

This method returns Suicide Prevention Coordinator(SPC) information from facility records that match the search criteria passed in. The results from the web service are returned in a WDDX packet that contains the XML packet string of SPC information. If searching SPC data for all the states, pass an empty string as the value for parameter called "state" otherwise pass the state abbreviation for the state the SPC data is being searched on.

Input:

state: [string, required]
license: [string, required]

Output:

xSPC XML packet (returned as a string encapsulated in a WDDX packet)

getSPCs_xmlstring


                            remote string getSPCs_xmlstring (required string state, required string license)

This method returns Suicide Prevention Coordinator(SPC) information from facility records that match the search criteria passed in. The results from the web service are returned as a string containing a XML packet of SPC information. If searching SPC data for all the states, pass an empty string as the value for parameter called "state" otherwise pass the state abbreviation for the state the SPC data is being searched on.

Input:

state: [string, required]
license: [string, required]

Output:

xSPC XML packet (returned as a string)

return to top

Output Format

FacS structure

FacS.fac_id: string - The database record ID
FacS.fac_name: string - The facility's name
FacS.reg_id: string - The database record ID of the region in which the facility located
FacS.state: string - The location of the facility
FacS.fac_type: string - The type of the facility

FacG structure

FacG.fac_id: string - The database record ID
FacG.fac_name: string - The facility's name
FacG.description: string - The general information about a facility

FacD structure

FacD.fac_name: string - Name of the facility
FacD.stationID: string - The facility's station number
FacD.div_name: string - The organization name
FacD.reg_name: string - The name of the regional office
FacD.address: string - The address of the facility
FacD.city: string - The city in where the facility is located
FacD.state: string - The state in where the facility is located
FacD.zip: string - Zip code of the facility
FacD.type_desc: string - The facility type
FacD.phone_number: string - The phone number of the facility
FacD.fax: string - The fax number of the facility
FacD.FandL_Url: string - The URL to the Facility & Leadership Directory web page with more information on the facility
FacD.fac_InternetUrl: string - The Interent address for a facility
FacD.fac_IntranetUrl: string - The Intranet address for a facility
FacD.latitude: string - Geographic coordinates
FacD.longitude: string - Geographic coordinates
FacD.fac_id: string - The database record ID
FacD.showphoto: string - The facility picture is available
FacD.showmap: string - The facility map is valid

aFacS structure

aFacS.matches: integer - The number of matches found in the Facility and Leadership database
aFacS.status: integer - The result status of the web service call
aFacS.criteria: string - The search criteria that was passed in to the method
aFacS.order: string - The sort order that was passed in to the method
aFacS.results: array containing FacS structure records

qFacS structure

qFacS.matches: integer - The number of matches found in the Facility and Leadership database
qFacS.status: integer - The result status of the web service call
qFacS.criteria: string - The search criteria that was passed in to the method
qFacS.order: string - The sort order that was passed in to the method
qFacS.results: query containing FacS structure records

wFacS WDDX packet

wFacS.matches: integer - The number of matches found in the Facility and Leadership database
wFacS.status: integer - The result status of the web service call
wFacS.criteria: string - The search criteria that was passed in to the method
wFacS.order: string - The sort order that was passed in to the method
wFacS.results: record set containing 0 or more FacS structure records

xFacS XML packet

View the xFacS Document Type Declaration (DTD)

aFacG structure

aFacG.matches: integer - The number of matches found in the Facility and Leadership database
aFacG.status: integer - The result status of the web service call
aFacG.criteria: string - The search criteria that was passed in to the method
aFacG.order: string - The sort order that was passed in to the method
aFacG.results: array containing FacG structure records

qFacG structure

qFacG.matches: integer - The number of matches found in the Facility and Leadership database
qFacG.status: integer - The result status of the web service call
qFacG.criteria: string - The search criteria that was passed in to the method
qFacG.order: string - The sort order that was passed in to the method
qFacG.results: query containing FacG structure records

wFacG WDDX packet

wFacG.matches: integer - The number of matches found in the Facility and Leadership database
wFacG.status: integer - The result status of the web service call
wFacG.criteria: string - The search criteria that was passed in to the method
wFacG.order: string - The sort order that was passed in to the method
wFacG.results: record set containing 0 or more FacG structure records

xFacG XML packet

View the xFacG Document Type Declaration (DTD)

aFacD structure

aFacD.matches: integer - The number of matches found in the Facility and Leadership database
aFacD.status: integer - The result status of the web service call
aFacD.criteria: string - The search criteria that was passed in to the method
aFacD.order: string - The sort order that was passed in to the method
aFacD.results: array containing FacD structure records

qFacD structure

qFacD.matches: integer - The number of matches found in the Facility and Leadership database
qFacD.status: integer - The result status of the web service call
qFacD.criteria: string - The search criteria that was passed in to the method
qFacD.order: string - The sort order that was passed in to the method
qFacD.results: query containing FacD structure records

wFacD WDDX packet

wFacD.matches: integer - The number of matches found in the Facility and Leadership database
wFacD.status: integer - The result status of the web service call
wFacD.criteria: string - The search criteria that was passed in to the method
wFacD.order: string - The sort order that was passed in to the method
wFacD.results: record set containing 0 or more FacD structure records

xFacD XML packet

View the xFacD Document Type Declaration (DTD)

xSPC XML packet

View the xSPC Document Type Declaration (DTD)

return to top

Status Conditions

Code	Definition
0	Web service method executed successfully
-1	The value of fac_fld must be one of the following: Reg_ID; Fac_ID; State
-2	When searching for a facility with fac_fld set to Fac_ID or Reg_ID then fac_val or each value in the list must be numeric.
-3	The paramter of reg_id or Fac_Type_ID must be supplied.
-4	When searching facility by reg_id or/and Fac_Type_ID then each value in the list must be numeric.
-998	Currently unable to validate license
-999	Invalid license

return to top

Facility Type LookUp

Fac_type_id	Description
0	All Types
15	VA Central Offices
8, 9	Benefits Office
6, 18	Cemetery
2, 7, 10, 11, 13, 14	Medical Facilities (ALL)
2, 7	Outpatient Clinic
14	VISN Office
10, 11	Hospitals
13	Vet Center

return to top

Region LookUp

Reg_id	Description
1, 2, 4, 5, 6, 7, 8, 9, 10, 12, 15, 16, 17, 19, 20, 21, 22, 23	VISN
36	NCA: Continental District
37	NCA: North Atlantic District
38	NCA: Southeast District
46	NCA: Midwest District
47	NCA: Pacific District
50	VBA: North Atlantic District
51	VBA: Southeast District
52	VBA: Midwest District
53	VBA: Continental District
54	VBA: Pacific District
999	VA Central Offices

return to top