TBS Apps API

<back to all web services

CloseClientAccountRequest

Requires Authentication
The following routes are available for this service:
POST/CloseClientAccountCloses a client account. Closes a client account.
CloseClientAccountRequest Parameters:
NameParameterData TypeRequiredDescription
PasswordbodystringNoPassword
AccountStatusReasonIdbodyshort?NoAccount status reason id
ReasonNotesbodystringNoFree text reason notes if required. Nullable
ResponseDataBase Parameters:
NameParameterData TypeRequiredDescription
ErrorNoformintNo
MessageformstringNo
Identityformlong?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /CloseClientAccount HTTP/1.1 
Host: ios-api.betright.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CloseClientAccountRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TBS.Frontend.RequestLayer.RequestFunctions">
  <AccountStatusReasonId>0</AccountStatusReasonId>
  <Password>String</Password>
  <ReasonNotes>String</ReasonNotes>
</CloseClientAccountRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CloseClientAccountResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TBS.Frontend.RequestLayer.RequestFunctions">
  <ErrorNo xmlns="http://schemas.datacontract.org/2004/07/TBS.Frontend.Messaging.DataContracts">0</ErrorNo>
  <Identity xmlns="http://schemas.datacontract.org/2004/07/TBS.Frontend.Messaging.DataContracts">0</Identity>
  <Message xmlns="http://schemas.datacontract.org/2004/07/TBS.Frontend.Messaging.DataContracts">String</Message>
</CloseClientAccountResponse>