User Cancel

Description

This call allows you to cancel a user created by your developer id in the OGF system. If you did not create the account, you will not be able to cancel the account. Cancelling an account means a user will no longer have subscriber access after their subscription runs it's period. This call will have no effect if the user does not have a current subscription.

URI

REST URI [GET]:
/v11.02/User.svc/Cancel?SessionId={sessionId}&emailAddress={emailAddress}&Refund={refund}&UserOgfn={userOgfn}

Example

Request GET

http://wsdev.onegreatfamily.com/v11.02/User.svc/Cancel?SessionId=gl4q23cwofpshi55sg1dvc3o&emailAddress=address@email.com&Refund=true&UserOgfn=123456

Success Response Payload

<Result xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<Code>0</Code>
	<Message>Success</Message>
	<Value i:type="a:string">123456-7890123</Value>
</Result>

Failed Response Payload

<Result xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<Code>19407</Code>
	<Message>The user could not be found</Message>
</Result>

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 existing account. Must be less than 100 characters and of the format user@host.domain	Yes
Refund	Indicates if the user recieved a refund. Type: string Default: None Constraints: Must be true or false. True if the user recieved a refund false if not.	Yes
UserOgfn	The users Identifier/Ogfn. Type: Int64 Default: None Constraints: Must be a valid user Ogfn	No
SessionId	The current session Id Type: string Default: None	Yes

Response Elements

Name	Description
`Result`	This operation returns a Result Entity Type: Result
`Result.Value`	Result.Value will be a confirmation result for the cancellation on success Type: String
`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` entity. Retrieve the RestFault from the Webexception response property.