Date Parse

Description

The DateParse operation allows building a  Date aggregate by parsing a Date string

Version

2011-02-02

URI

REST URI [GET]:
 /v11.02/Date.svc/Parse/{date}?SessionId={SessionId}

Example

Request GET
http://wsdev.onegreatfamily.com/v11.02/Date.svc/Parse/31+Jan+2000?SessionId=113434515134543151134 
Success Response Payload 
<Date xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data" 
  <BC>false</BC>
  <DateType>DATE_EXACT</DateType>
  <Day>31</Day>
  <JulianDay>2451575</JulianDay>
  <Month>1</Month>
  <RangeBeginBC>false</RangeBeginBC>
  <RangeBeginDay>0</RangeBeginDay>
  <RangeBeginMonth>0</RangeBeginMonth>
  <RangeBeginYear>0</RangeBeginYear>
  <RangeEndBC>false</RangeEndBC>
  <RangeEndDay>0</RangeEndDay>
  <RangeEndMonth>0</RangeEndMonth>
  <RangeEndYear>0</RangeEndYear>
  <RequestedDate>31 JAN 2000</RequestedDate>
  <StandardizedDate>31 JAN 2000</StandardizedDate>
  <Year>2000</Year>
</Date> 
 Fault Response Payload 
<RestFault xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<ErrorCode>551</ErrorCode>
	<FaultMessage>An unhandled exception has occurred</FaultMessage>
</RestFault>

Query String Parameters

Name Description Required
Date

A date to be parsed.

Type: Type: String

Default: None

Constraints: Must be a valid date string.

Yes

SessionId

The current session Id

Type: string

Default: None

Yes

Response Elements

Name Description

Date

This operation returns a  Date aggregate upon success. Otherwise an error is returned.

Type: Date

HTTP Status Code

The Web Server returns a status code which indicates if the operation was successful. Anything other than 200 should be regarded as a failure.

HTTP Status Code of 417

The Web Server threw an exception and contains a RestFault aggregate. Retrieve the RestFault from the Webexception response property.