AbstractSession.SendAuthorizationRequest Method (Request, Identity, CorrelationID, String)

AbstractSessionSendAuthorizationRequest Method (Request, Identity, CorrelationID, String)

Sends the specified authorizationRequest and update the specified identity with the results.

Namespace: Bloomberglp.Blpapi
Assembly: Bloomberglp.Blpapi (in Bloomberglp.Blpapi.dll) Version: 3.24.7.1

Syntax

public CorrelationID SendAuthorizationRequest(
	Request authorizationRequest,
	Identity identity,
	CorrelationID correlationId,
	string requestLabel
)

Public Function SendAuthorizationRequest ( 
	authorizationRequest As Request,
	identity As Identity,
	correlationId As CorrelationID,
	requestLabel As String
) As CorrelationID

public:
virtual CorrelationID^ SendAuthorizationRequest(
	Request^ authorizationRequest, 
	Identity^ identity, 
	CorrelationID^ correlationId, 
	String^ requestLabel
) sealed

abstract SendAuthorizationRequest : 
        authorizationRequest : Request * 
        identity : Identity * 
        correlationId : CorrelationID * 
        requestLabel : string -> CorrelationID 
override SendAuthorizationRequest : 
        authorizationRequest : Request * 
        identity : Identity * 
        correlationId : CorrelationID * 
        requestLabel : string -> CorrelationID

Parameters

authorizationRequest: Type: Bloomberglp.BlpapiRequest
A filled in authorization request that needs to be sent to the authorization service.
identity: Type: Bloomberglp.BlpapiIdentity
A handle to identify the user that is being authorized.
correlationId: Type: Bloomberglp.BlpapiCorrelationID
A correlator to be used for correlating the response to this request.
requestLabel: Type: SystemString
A label that defines a string which will be recorded along with any diagnostics for this operation.

Return Value

Type: CorrelationID
An internally generated CorrelationID if the specified correlationId is null or return the specified correlationId.

Implements

IAbstractSessionSendAuthorizationRequest(Request, Identity, CorrelationID, String)

Exceptions

Exception	Condition
InvalidOperationException	The session is not started.
InvalidRequestException	The request is not compliant with the schema for the request.
DuplicateCorrelationIDException	The specified correlationId is already active for this Session.
ArgumentException	The specified Identity was not created through this Session or it is the session identity.

Remarks

Same as calling SendAuthorizationRequest(authorizationRequest, identity, null, correlationId, requestLabel)

Reference

AbstractSession Class

SendAuthorizationRequest Overload

Bloomberglp.Blpapi Namespace