Account Cancel

Description

This call allows you to cancel an account created by you in the OGF system. If you did not create the account, you will not be able to cancel the account.

Version

2011-02-02

URI

REST URI [GET]:
/v11.02/Account.svc/Cancel?emailAddress={emailAddress}&refund=[true|false]&SessionId={SessionId}

Example

Request GET
http://wsdev.onegreatfamily.com/v11.02/Account.svc/Cancel?emailAddress=address@email.com&refund=false&SessionId=gl4q23cwofpshi55sg1dvc3o
Success Response Payload
<CancelAccountResult xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<Confirmation>12345-12345</Confirmation> 
	<ErrorCode>0</ErrorCode> 
	<Message></Message> 
	<Status>SUCCESS</Status> 
</CancelAccountResult>
 Failed Response Payload 
<CancelAccountResult xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<Confirmation></Confirmation> 
	<ErrorCode>19407</ErrorCode> 
	<Message>Account not found.</Message> 
	<Status>ERROR</Status> 
</CancelAccountResult>
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

emailAddress

The account Email address

Type: String

Default: None

Constraints: Must be a valid email address of an exising account. Must be less than 100 characters and of the format user@host.domain

Yes

refund

Will the user recieve a refund

Type: boolean

Default: false

Constraints: Must be true or false.

Yes

SessionId

The current session Id

Type: string

Default: None

Yes

Response Elements

Name Description

CancelAccountResult

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

Type: CancelAccountResult

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.