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 »Press Release

Web Services

Overview

The methods of this web service make queries to the VA Press Release database. Each method is available in four versions. The first of these versions will return the result set in an array. The second will return it as a ColdFusion query object while the third version returns the result set as a ColdFusion structure and an XML packet respectively. The last version of each method returns the result set in a WDDX packet.

return to top

Demonstration

Use the links below to view a visual representation of the data return from the web service.

Demo the getPress_array method where STARTDATE = 01/22/2002 AND ENDDATE = 01/24/2002 AND MAXRECORDS = '1'
Demo the getPress_query method where STARTDATE = 01/22/2002 AND ENDDATE = 01/24/2002 AND MAXRECORDS = '1'
Demo the getPress_xml method where STARTDATE = 01/22/2002 AND ENDDATE = 01/24/2002 AND MAXRECORDS = '2'
Demo the getPress_xmlString method where STARTDATE = 01/22/2002 AND ENDDATE = 01/24/2002 AND MAXRECORDS = '2'
Demo the getPress_wddx method where STARTDATE = 01/22/2002 AND ENDDATE = 01/24/2002 AND MAXRECORDS = '5'
Demo the getPressDetail_array method where PRESS_ID=383
Demo the getPressDetail_query method where PRESS_ID=383
Demo the getPressDetail_xml method where PRESS_ID=383
Demo the getPressDetail_xmlString method where PRESS_ID=383
Demo the getPressDetail_wddx method where PRESS_ID=383

return to top

Samples

The methods in this web service can be used to collect and display Hey VA and VA Press Releases on your web page. Below are a two samples:

VA Press Release - This demo uses the getPress_query method and coldfusion to display current VA Press Releases. This demo has been modified to only show the press releases from February, 2004. ( Source code - ColdFusion template that uses a CFSCRIPT to consume the 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.press.releases

location:

https://www.va.gov/webservices/press/releases.cfc

wsdl:

https://www.va.gov/webservices/press/releases.cfc?wsdl

properties:

None

methods:

getPress_array, getPress_query, getPress_xml, getPress_xmlString, getPress_wddx, getPressDetail_array, getPressDetail_query, getPressDetail_xml, getPressDetail_xmlString, getPressDetail_wddx

output:

getPress_array, getPress_query, getPress_xml, getPress_wddx, getPressDetail_array, getPressDetail_query, getPressDetail_xml, getPressDetail_wddx

status:

Definitions for each of the two possible web service result status codes are listed below.

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

getPress_array


                            remote struct getPress_array (required string StartDate="", required string EndDate="", required string MaxRecords="", required string license="")

This function returns a Structure containing an array of the Dates, IDs and Titles of the recent VA Press Releases. This function takes StartDate, EndDate and MaxRecords as required arguments. If valid start and end date range is supplied then the function returns records between the supplied range. If a Max Record argument, which defaults to five, is supplied then the function returns a maximum of the supplied number of records. Supply null values to return the latest five releases.

Input:

StartDate: [string, required] - Supply the Start Date Range in MM/DD/YYYY format.
EndDate: [string, required] - Supply the End Date Range in MM/DD/YYYY format.
MaxRecords: [string, required] - Maximum number of records to return - Supply a positive Integer
license: [string, required] - The license key issued by the VA Web Solutions Office that is required to use the web service.

Ouput:

aPress array structure

getPress_query


                            remote struct getPress_query (required string StartDate="", required string EndDate="", required string MaxRecords="", required string license="")

This function returns a Coldfusion query containing the Date, ID, and Title text of the VA Press Releases. Query columns returned are press_date, press_id, and press_title. This function takes StartDate, EndDate and MaxRecords as required arguments. If valid start and end date range is supplied then the function returns records between the supplied range. If a Max Record argument, which defaults to five, is supplied then the function returns a maximum of the supplied number of records. Supply null values to return the latest five Hey VA releases.

Input:

Output:

qPress ColdFusion query structure

getPress_xml


                            remote string getPress_xml (required string StartDate="", required string EndDate="", required string MaxRecords="", required string license="")

This function returns a string containing an XML packet (encapsulated in a WDDX packet) with the Date, ID, Title and HTML text of the VA Press Releases. This function takes StartDate, EndDate and MaxRecords as required arguments. If valid start and end date range is supplied then the function returns records between the supplied range. If a Max Record argument, which defaults to five, is supplied then the function returns a maximum of the supplied number of records. Supply null values to return the latest five Hey VA releases.

Input:

Output:

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

getPress_xmlString


                            remote string getPress_xmlString (required string StartDate="", required string EndDate="", required string MaxRecords="", required string license="")

This function returns a string containing an XML packet with the Date, ID, Title and HTML text of the VA Press Releases. This function takes StartDate, EndDate and MaxRecords as required arguments. If valid start and end date range is supplied then the function returns records between the supplied range. If a Max Record argument, which defaults to five, is supplied then the function returns a maximum of the supplied number of records. Supply null values to return the latest five Hey VA releases.

Output: status, matches and results

View the XML Schema
Input:

Output:

xPress XML Packet (returned as a string)

getPress_wddx


                            remote string getPress_wddx (required string StartDate="", required string EndDate="", required string MaxRecords="", required string license="")

This function returns a string containing a WDDX packet with the Date, ID, Title and HTML text of the VA Press Releases. This function takes StartDate, EndDate and MaxRecords as required arguments. If valid start and end date range is supplied then the function returns records between the supplied range. If a Max Record argument, which defaults to five, is supplied then the function returns a maximum of the supplied number of records. Supply null values to return the latest five Hey VA releases.

Input:

Output:

wPress WDDX packet

getPressDetail_array


                                remote struct getPressDetail_array  (required string press_id="", required string license="")

This function returns a Structure containing an array record of the Date, ID, Title and HTML Text of the VA Press Releases corrosponding to press_id passed. This function takes press_id as a required argument. If valid press_id is supplied then the function returns a record containg the Date, ID, Title and HTML Text of the press release.

Input:

press_id: [string, required] - Supply a Valid press_id obtained by calling getPress_array, getPress_query, getPress_wddx or getPress_xml methods.
license: [string, required] - The license key issued by the VA Web Solutions Office that is required to use the web service.

Output:

aPressDetails array structure

getPressDetail_query


                                remote struct getPressDetail_query  (required string press_id="", required string license="")

This function returns a coldfusion query record containing Date, ID, Title and HTML Text of the VA Press Releases corrosponding to press_id passed. This function takes press_id as a required argument. If valid press_id is supplied then the function returns a record containg the Date, ID, Title and HTML Text of the press release.

Input:

Output:

qPressDetails ColdFusion query structure

getPressDetail_xml


                                remote string getPressDetail_xml  (required string press_id="", required string license="")

This function returns a string containing an XML packet (encapsulated in a WDDX packet) with the Date, ID, Title and HTML Text of the VA Press Releases corrosponding to press_id passed. This function takes press_id as a required argument. If valid press_id is supplied then the function returns a record containg the Date, ID, Title and HTML Text of the press release.

Input:

Output:

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

getPressDetail_xmlString


                                remote string getPressDetail_xmlString  (required string press_id="", required string license="")

This function returns a string containing an XML packet with the Date, ID, Title and HTML Text of the VA Press Releases corrosponding to press_id passed. This function takes press_id as a required argument. If valid press_id is supplied then the function returns a record containg the Date, ID, Title and HTML Text of the press release.

Input:

Output:

xPressDetails XML packet (returned as a string)

getPressDetail_wddx


                                remote string getPressDetail_wddx  (required string press_id="", required string license="")

This function returns a string containing a WDDX packet with the Date, ID, Title and HTML Text of the VA Press Releases corrosponding to press_id passed. This function takes press_id as a required argument. If valid press_id is supplied then the function returns a record containg the Date, ID, Title and HTML Text of the press release.

Input:

press_id: string, required, Valid press_id - Supply a Valid press_id obtained by calling getPress_array, getPress_query, getPress_wddx or getPress_xml methods.
license: string, required, The license key issued by the VA Web Solutions Office that is required to use the web service.

Output:

wPressDetails WDDX packet

return to top

Output Format

PressSummary structure

PressSummary.press_date: string - The data the press release was issued
PressSummary.press_id: string - The database record ID
PressSummary.press_title: string - The title of the press release

PressDetails structure

PressDetails.press_date: string - The data the press release was issued
PressDetails.press_id: string - The database record ID
PressDetails.press_text: string - The content of the press release
PressDetails.press_title: string - The title of the press release

aPress array structure

aPress.criteria: string - The search criteria that was passed in to the method
aPress.matches: integer - The number of matches found
aPress.order: string - The search criteria that was passed in to the method
aPress.results: array containing PressSummary structure records
aPress.status: integer - The result status of the web service call

qPress ColdFusion query structure

qPress.criteria: string - The search criteria that was passed in to the method
qPress.matches: integer - The number of matches found
qPress.order: string - The search criteria that was passed in to the method
qPress.results: query containing PressSummary structure records
qPress.status: integer - The result status of the web service call

xPress XML packet

View the xPress Document Type Declaration (DTD)

wPress WDDX packet

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

aPressDetails array structure

aPressDetails.criteria: string - The search criteria that was passed in to the method
aPressDetails.matches: integer - The number of matches found
aPressDetails.order: string - The search criteria that was passed in to the method
aPressDetails.results: array containing PressDetails structure records
aPressDetails.status: integer - The result status of the web service call

qPressDetails ColdFusion query structure

qPressDetails.criteria: string - The search criteria that was passed in to the method
qPressDetails.matches: integer - The number of matches found
qPressDetails.order: string - The search criteria that was passed in to the method
qPressDetails.results: query containing PressDetails structure records
qPressDetails.status: integer - The result status of the web service call

xPressDetails XML packet

View the xPressDetails Document Type Declaration (DTD)

wPressDetails WDDX packet

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

return to top

Status Conditions

Code	Definition
0	Web service method executed successfully
-1	Web service was unable to Process the Request. Check the returned results object for any error messages.
-998	Currently unable to validate license
-999	Invalid license

return to top