SOAP API – MakeUserAsUnbrandedOwner

MakeUserAsUnbrandedOwner( username, ownerLevelType, ownerParentAccountBillingType) : Void

Since: EngageIP v25.2

This will make supplied user an Unbranded Owner

For more details about owners please see the Configuring Branded and Unbranded Owners article.

Parameters:

username (String) - The username for the user that will become and unbranded owner. An exception will be thrown if the username does not exist.
ownerLevelType (String) - Sets permission for viewing accounts in the owner tree. An exception will be thrown if not one of the two possible configurations:
- All Users below: able to see all accounts at or below the owner's level
- Only my Users:able to see only account belonging directly to the owner
ownerParentAccountBillingType (String) Setshow An exception will be thrown if not one of the configurations below:
- Bill Accounts: a typical owner structure where every account receives their own invoice
- Bill Owner Using Account Taxes: rolls up all transactions for all accounts under an unbranded owner and generates a single invoice at the unbranded owner level, taxing based on the tax configuration setup at the account level
- Bill Owner Using Owner Taxes: rolls up all transactions for all accounts under an unbranded owner and generates a single invoice at the unbranded owner level, taxing based on the tax configuration setup at the owner level
- Bill Top Owner Using Account Taxes: rolls up all transactions for all unbranded owners and accounts under the unbranded owners and generates a single invoice at the top owner level, taxing based on the tax configuration setup at the account level
- Bill Top Owner Using Owner Taxes: rolls up all transactions for all unbranded owners and accounts under the unbranded owners and generates a single invoice at the top owner level, taxing based on the tax configuration setup at the owner level

Possible Exceptions:

INVALID USERNAME
INVALID LEVEL TYPE
INVALID BILLING TYPE

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /BOSS/WebService.asmx HTTP/1.1
Host: localhost
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <AuthHeader xmlns="Logisense_EngageIP">
      <Username>string</Username>
      <Password>string</Password>
    </AuthHeader>
  </soap12:Header>
  <soap12:Body>
    <MakeUserAsUnbrandedOwner xmlns="Logisense_EngageIP">
      <userName>string</userName>
      <ownerLevelType>string</ownerLevelType>
      <ownerParentAccountBillingType>string</ownerParentAccountBillingType>
    </MakeUserAsUnbrandedOwner>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <MakeUserAsUnbrandedOwnerResponse xmlns="Logisense_EngageIP" />
  </soap12:Body>
</soap12:Envelope>

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /BOSS/WebService.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "Logisense_EngageIP/MakeUserAsUnbrandedOwner"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthHeader xmlns="Logisense_EngageIP">
      <Username>string</Username>
      <Password>string</Password>
    </AuthHeader>
  </soap:Header>
  <soap:Body>
    <MakeUserAsUnbrandedOwner xmlns="Logisense_EngageIP">
      <userName>string</userName>
      <ownerLevelType>string</ownerLevelType>
      <ownerParentAccountBillingType>string</ownerParentAccountBillingType>
    </MakeUserAsUnbrandedOwner>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <MakeUserAsUnbrandedOwnerResponse xmlns="Logisense_EngageIP" />
  </soap:Body>
</soap:Envelope>