BPAPI Methods

BPAPI method Customer/DelegateRight


Delegate rights from one customer to another.

Authorization required: Yes

HTTP methods allowed: GET, POST

Syntax: Customer/DelegateRight/{recipient}/  Details 

Syntax: Customer/DelegateRight/{recipient}/{right}/  Details 

Syntax: Customer/DelegateRight/{recipient}/{right}/{delegator}/  Details 

Delegate rights from one customer to another.
Parameter {recipient} (delegate) refers to the customer object being given delegated rights while parameter {delegator} refers to the customer object whose rights are delegated.

Note that delegation of rights may extend indefinitely in both directions with a delegator customer being the recipient (delegate) customer in another sub-ordinated delegation and likewise, with a recipient (delegate) customer being the delegator customer in another super-ordinated delegation.

If only one parameter is specified it is taken as the recipient (delegate) parameter. Rights being delegated will then be "Change" and the delegator will be derived from the credentials used for authorization.

The credentials used for authorization must contain the right to change properties of the delegator (no rights are needed for the recipient (delegate)).
The easiest way to accomplish this is to just authorize the method call with the delegators credentials and not supplying the delegator-parameter.

See also Customer/AddChild

Note that syntax-wise multiple recipients and / or multiple delegators may be specified but this is not supported internally as of January 2015.

The delegation of rights is seen from the perspective of the delegator API wise (syntax wise) but the delegated rights shows up as RelationDelegateDelegator-properties of both the delegator and recipient (delegate).
In addition the delegated rights will show up in the JSON-data as ReadRights and ChangeRights for the delegate and asReadDelegates and ChangeDelegates for the delegator.

Popularity: 60 (number of times method has been accessed)

Documentation and tests automatically generated from source-code 2020-04-09 21:17