Unassign Partners from an Attribute REST API

A Sponsor Administrator or LOB representative can unassign partners from an attribute. Using this API, LOB representatives can remove an attribute from the partners that are assigned to the same division as that of the LOB representative.

The Unassign Partners from an Attribute REST API is a POST call and one REST call allows a maximum of 100 partners to be unassigned from an attribute.

Keys

The Partner Key is available to unassign partners from an attribute.

URL for access

The following URL pattern is used to access the API:
https://<hostname>:<port>/mrmws/sponsors/<sponsor-context>/attributeType/<attributeTypeName>/attributeValue/<attributeValue>/action/unassign
Where:
  • <sponsor-context> is the sponsor context URI (short name to identify the company).
  • <attributeTypeName> is the attribute type name to which the attribute value belongs.
  • <attributeValue> is the value of the attribute from which the partner must be unassigned.
Note: The URL can be different based on your deployment option. For more details about the URL, see URL for accessing IBM PEM and APIs.

Input

This API takes Partner Key as input.

Headers

The headers for the API are as follows:
Content-Type: application/xml
Authorization: [Basic Auth data]

Request data

The request data for the API is as follows: 
<update>
            <partners>
              <partner partnerKey = "<partnerkey>"/>
            </partners>
</update>

Sample response data

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><success/>

Error response data

The error response data for the API is similar to the following example: 
<error code="400 | ..." description="error text"/>
The API returns an error in the following situations:
  • A partner has a Partner Key that is blank, null, or does not exist.
  • An attribute type name is invalid, blank, or null.
  • An attribute value is invalid, blank, or null.

Processing

When all the validation checks are passed, the API unassigns partners from the attribute value.

The REST API is protected with Basic Authentication.