BusinessApi

<back to all web services

DeleteProfileRequest

Business
Requires Authentication
Required role:Business
The following routes are available for this service:
POST/profile/delete
DeleteProfileRequest Parameters:
NameParameterData TypeRequiredDescription
UserHasConfirmedbodyboolNo
DeleteProfileResponse Parameters:
NameParameterData TypeRequiredDescription
UserThatWasDeletedformBusinessUserDtoYes
BusinessUserDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
EmailformstringNo
FirstNameformstringNo
LastNameformstringNo
MobilePhoneformstringYes
LegalIdentityVerifiedformboolNo
LocaleformLocaleNo
Locale Enum:
EnUs
NbNo

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 /profile/delete HTTP/1.1 
Host: business-api.brovs.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DeleteProfileRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessApi.Dto">
  <UserHasConfirmed>false</UserHasConfirmed>
</DeleteProfileRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DeleteProfileResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessApi.Dto">
  <UserThatWasDeleted>
    <Email>String</Email>
    <FirstName>String</FirstName>
    <Id>0</Id>
    <LastName>String</LastName>
    <LegalIdentityVerified>false</LegalIdentityVerified>
    <Locale>EnUs</Locale>
    <MobilePhone>String</MobilePhone>
  </UserThatWasDeleted>
</DeleteProfileResponse>