Posttraumatic Stress Disorder (PTSD) Programs
Overview
The PTSD web service provides PTSD Program information from Facilities and Leadership Directory database.
- The PTSD_Program_Locator_array method returns PTSD Program information in an array .
- The PTSD_Program_Locator_query method returns PTSD Program information in a ColdFusion query.
- The PTSD_Program_Locator_wddx method returns PTSD Program information in a string containing a WDDX packet.
- The PTSD_Program_Locator_xmlstring method returns PTSD Program information in a string containing an XML packet.
Demonstration
Use the links below to view a visual representation of the data return from the web service.
Demo the PTSD_Program_Locator_array method
Demo the PTSD_Program_Locator_query method
Demo the PTSD_Program_Locator_wddx method
Demo the PTSD_Program_Locator_xmlString method
Samples
The methods in this web service can be used for a variety of purposes. Below are a few samples:
- PTSD Programs - You can use one of the PTSD_Program_Locator methods to find PTSD Programs. This demo uses the PTSD_Program_Locator_query method to create a PTSD Program page. ( Source code - ColdFusion template that uses CFINVOKE to consume the web service. )
Summary
Below is a high-level look at the web service and the methods it has to offer for public consumption.
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 |
remote struct PTSD_Program_Locator_array (required string license )
This method returns PTSD Program data from facility record by passing fac_id. The results field of the data structure returned contains an array of PTSD program records.
Input:
license: [string, required] - The license key issued by the VA Web Solutions Office that is required to use this service.
Output:
|
remote struct PTSD_Program_Locator_query (required string license)
This method returns PTSD program data from facility record by passing facility ID. The results field of the
data structure returned contains a ColdFusion query of PTSD program records.
Input:
license: [string, required] - The license key issued by the VA Web Solutions Office that is required to use this service.
Output:
|
remote string PTSD_Program_Locator_wddx (required string license)
This method returns PTSD program data from facility record by passing facility ID. The results field of the data structure returned contains a WDDX packet.
Input:
license: [string, required] - The license key issued by the VA Web Solutions Office that is required to use this service.
Output:
|
remote void PTSD_Program_Locator_xmlString (required string license )
This method returns PTSD Program information from facility records by passing facility ID. The results are returned in a string containing an XML packet.
Input:
license: [string, required] - The license key issued by the VA Web Solutions Office that is required to use this service.
Output:
|
|
Output Format |
Programs.fac_name: string - The facility’s name
Programs.address: string - The facility’s address
Programs.city: string - The facility’s city address
Programs.state: string - The facility’s state address
Programs.zip: string - The facility’s zip code address
Programs.program: string - The The facility’s Program
|
aPrograms.matches: integer - The number of matches found in the Facility and Leadership database
aPrograms.status: integer - The result status of the web service call
aPrograms.criteria: string - The search criteria that was passed in to the method
aPrograms.order: string - The sort order that was passed in to the method
aPrograms.results: array containing Programs structure records
|
qPrograms.matches: integer - The number of matches found in the Facility and Leadership database
qPrograms.status: integer - The result status of the web service call
qPrograms.criteria: string - The search criteria that was passed in to the method
qPrograms.order: string - The sort order that was passed in to the method
qPrograms.results: query containing Programs structure records
|
wPrograms.matches: integer - The number of matches found in the Facility and Leadership database
wPrograms.status: integer - The result status of the web service call
wPrograms.criteria: string - The search criteria that was passed in to the method
wPrograms.order: string - The sort order that was passed in to the method
wPrograms.results: record set containing 0 or more Programs structure records
|
View the xPrograms Document Type Declaration (DTD)
|
|
Status Conditions |
Code
|
Definition
|
0 |
Web service method executed successfully |
-1 |
The value of fac_id must be supplied. |
-2 |
When searching ptsd information by fac_id then fac_id or each value in the list must be numeric. |
-998 |
Currently unable to validate license |
-999 |
Invalid license |
|