LUSID C# SDK
Public Member Functions | Properties | List of all members
Lusid.Sdk.Api.PersonsApi Class Reference

Represents a collection of functions to interact with the API endpoints More...

Inheritance diagram for Lusid.Sdk.Api.PersonsApi:
Inheritance graph
[legend]

Public Member Functions

 PersonsApi ()
 Initializes a new instance of the PersonsApi class. More...
 
 PersonsApi (string basePath)
 Initializes a new instance of the PersonsApi class. More...
 
 PersonsApi (Lusid.Sdk.Client.Configuration configuration)
 Initializes a new instance of the PersonsApi class using Configuration object More...
 
 PersonsApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
 Initializes a new instance of the PersonsApi class using a Configuration object and client instance. More...
 
string GetBasePath ()
 Gets the base path of the API client. More...
 
DeletedEntityResponse DeletePerson (string idTypeScope, string idTypeCode, string code, int operationIndex=0)
 [EARLY ACCESS] DeletePerson: Delete person Delete a person. Deletion will be valid from the person's creation datetime. This means that the person will no longer exist at any effective datetime from the asAt datetime of deletion. More...
 
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponseDeletePersonWithHttpInfo (string idTypeScope, string idTypeCode, string code, int operationIndex=0)
 [EARLY ACCESS] DeletePerson: Delete person Delete a person. Deletion will be valid from the person&#39;s creation datetime. This means that the person will no longer exist at any effective datetime from the asAt datetime of deletion. More...
 
async System.Threading.Tasks.Task< DeletedEntityResponseDeletePersonAsync (string idTypeScope, string idTypeCode, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] DeletePerson: Delete person Delete a person. Deletion will be valid from the person&#39;s creation datetime. This means that the person will no longer exist at any effective datetime from the asAt datetime of deletion. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > > DeletePersonWithHttpInfoAsync (string idTypeScope, string idTypeCode, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] DeletePerson: Delete person Delete a person. Deletion will be valid from the person&#39;s creation datetime. This means that the person will no longer exist at any effective datetime from the asAt datetime of deletion. More...
 
DeletedEntityResponse DeletePersonAccessMetadata (string idTypeScope, string idTypeCode, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] DeletePersonAccessMetadata: Delete a Person Access Metadata entry Deletes the Person Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure). More...
 
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponseDeletePersonAccessMetadataWithHttpInfo (string idTypeScope, string idTypeCode, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] DeletePersonAccessMetadata: Delete a Person Access Metadata entry Deletes the Person Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure). More...
 
async System.Threading.Tasks.Task< DeletedEntityResponseDeletePersonAccessMetadataAsync (string idTypeScope, string idTypeCode, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] DeletePersonAccessMetadata: Delete a Person Access Metadata entry Deletes the Person Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure). More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > > DeletePersonAccessMetadataWithHttpInfoAsync (string idTypeScope, string idTypeCode, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] DeletePersonAccessMetadata: Delete a Person Access Metadata entry Deletes the Person Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure). More...
 
DeletedEntityResponse DeletePersonIdentifiers (string idTypeScope, string idTypeCode, string code, List< string > propertyKeys, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 [EARLY ACCESS] DeletePersonIdentifiers: Delete Person Identifiers Delete identifiers that belong to the given property keys of the person. More...
 
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponseDeletePersonIdentifiersWithHttpInfo (string idTypeScope, string idTypeCode, string code, List< string > propertyKeys, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 [EARLY ACCESS] DeletePersonIdentifiers: Delete Person Identifiers Delete identifiers that belong to the given property keys of the person. More...
 
async System.Threading.Tasks.Task< DeletedEntityResponseDeletePersonIdentifiersAsync (string idTypeScope, string idTypeCode, string code, List< string > propertyKeys, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] DeletePersonIdentifiers: Delete Person Identifiers Delete identifiers that belong to the given property keys of the person. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > > DeletePersonIdentifiersWithHttpInfoAsync (string idTypeScope, string idTypeCode, string code, List< string > propertyKeys, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] DeletePersonIdentifiers: Delete Person Identifiers Delete identifiers that belong to the given property keys of the person. More...
 
DeletedEntityResponse DeletePersonProperties (string idTypeScope, string idTypeCode, string code, List< string > propertyKeys, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 [EARLY ACCESS] DeletePersonProperties: Delete Person Properties Delete all properties that belong to the given property keys of the person. More...
 
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponseDeletePersonPropertiesWithHttpInfo (string idTypeScope, string idTypeCode, string code, List< string > propertyKeys, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 [EARLY ACCESS] DeletePersonProperties: Delete Person Properties Delete all properties that belong to the given property keys of the person. More...
 
async System.Threading.Tasks.Task< DeletedEntityResponseDeletePersonPropertiesAsync (string idTypeScope, string idTypeCode, string code, List< string > propertyKeys, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] DeletePersonProperties: Delete Person Properties Delete all properties that belong to the given property keys of the person. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > > DeletePersonPropertiesWithHttpInfoAsync (string idTypeScope, string idTypeCode, string code, List< string > propertyKeys, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] DeletePersonProperties: Delete Person Properties Delete all properties that belong to the given property keys of the person. More...
 
Dictionary< string, List< AccessMetadataValue > > GetAllPersonAccessMetadata (string idTypeScope, string idTypeCode, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] GetAllPersonAccessMetadata: Get Access Metadata rules for a Person Pass the Scope and Code of the Person identifier along with the person code parameter to retrieve the associated Access Metadata More...
 
Lusid.Sdk.Client.ApiResponse< Dictionary< string, List< AccessMetadataValue > > > GetAllPersonAccessMetadataWithHttpInfo (string idTypeScope, string idTypeCode, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] GetAllPersonAccessMetadata: Get Access Metadata rules for a Person Pass the Scope and Code of the Person identifier along with the person code parameter to retrieve the associated Access Metadata More...
 
async System.Threading.Tasks.Task< Dictionary< string, List< AccessMetadataValue > > > GetAllPersonAccessMetadataAsync (string idTypeScope, string idTypeCode, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] GetAllPersonAccessMetadata: Get Access Metadata rules for a Person Pass the Scope and Code of the Person identifier along with the person code parameter to retrieve the associated Access Metadata More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< Dictionary< string, List< AccessMetadataValue > > > > GetAllPersonAccessMetadataWithHttpInfoAsync (string idTypeScope, string idTypeCode, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] GetAllPersonAccessMetadata: Get Access Metadata rules for a Person Pass the Scope and Code of the Person identifier along with the person code parameter to retrieve the associated Access Metadata More...
 
Person GetPerson (string idTypeScope, string idTypeCode, string code, List< string >? propertyKeys=default(List< string >?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0)
 [EARLY ACCESS] GetPerson: Get Person Retrieve the definition of a person. More...
 
Lusid.Sdk.Client.ApiResponse< PersonGetPersonWithHttpInfo (string idTypeScope, string idTypeCode, string code, List< string >? propertyKeys=default(List< string >?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0)
 [EARLY ACCESS] GetPerson: Get Person Retrieve the definition of a person. More...
 
async System.Threading.Tasks.Task< PersonGetPersonAsync (string idTypeScope, string idTypeCode, string code, List< string >? propertyKeys=default(List< string >?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] GetPerson: Get Person Retrieve the definition of a person. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< Person > > GetPersonWithHttpInfoAsync (string idTypeScope, string idTypeCode, string code, List< string >? propertyKeys=default(List< string >?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] GetPerson: Get Person Retrieve the definition of a person. More...
 
List< AccessMetadataValueGetPersonAccessMetadataByKey (string idTypeScope, string idTypeCode, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] GetPersonAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Person Get a specific Person Access Metadata by specifying the corresponding identifier parts and Person code No matching will be performed through this endpoint. To retrieve an entry, it is necessary to specify, exactly, the identifier of the entry More...
 
Lusid.Sdk.Client.ApiResponse< List< AccessMetadataValue > > GetPersonAccessMetadataByKeyWithHttpInfo (string idTypeScope, string idTypeCode, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] GetPersonAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Person Get a specific Person Access Metadata by specifying the corresponding identifier parts and Person code No matching will be performed through this endpoint. To retrieve an entry, it is necessary to specify, exactly, the identifier of the entry More...
 
async System.Threading.Tasks.Task< List< AccessMetadataValue > > GetPersonAccessMetadataByKeyAsync (string idTypeScope, string idTypeCode, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] GetPersonAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Person Get a specific Person Access Metadata by specifying the corresponding identifier parts and Person code No matching will be performed through this endpoint. To retrieve an entry, it is necessary to specify, exactly, the identifier of the entry More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< List< AccessMetadataValue > > > GetPersonAccessMetadataByKeyWithHttpInfoAsync (string idTypeScope, string idTypeCode, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] GetPersonAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Person Get a specific Person Access Metadata by specifying the corresponding identifier parts and Person code No matching will be performed through this endpoint. To retrieve an entry, it is necessary to specify, exactly, the identifier of the entry More...
 
ResourceListOfPropertyInterval GetPersonPropertyTimeSeries (string idTypeScope, string idTypeCode, string code, string propertyKey, DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), string? page=default(string?), int? limit=default(int?), int operationIndex=0)
 [EARLY ACCESS] GetPersonPropertyTimeSeries: Get Person Property Time Series List the complete time series of a person property. More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfPropertyIntervalGetPersonPropertyTimeSeriesWithHttpInfo (string idTypeScope, string idTypeCode, string code, string propertyKey, DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), string? page=default(string?), int? limit=default(int?), int operationIndex=0)
 [EARLY ACCESS] GetPersonPropertyTimeSeries: Get Person Property Time Series List the complete time series of a person property. More...
 
async System.Threading.Tasks.Task< ResourceListOfPropertyIntervalGetPersonPropertyTimeSeriesAsync (string idTypeScope, string idTypeCode, string code, string propertyKey, DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), string? page=default(string?), int? limit=default(int?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] GetPersonPropertyTimeSeries: Get Person Property Time Series List the complete time series of a person property. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfPropertyInterval > > GetPersonPropertyTimeSeriesWithHttpInfoAsync (string idTypeScope, string idTypeCode, string code, string propertyKey, DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), string? page=default(string?), int? limit=default(int?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] GetPersonPropertyTimeSeries: Get Person Property Time Series List the complete time series of a person property. More...
 
ResourceListOfRelation GetPersonRelations (string idTypeScope, string idTypeCode, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0)
 [EARLY ACCESS] GetPersonRelations: Get Relations for Person Get relations for the specified person. More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfRelationGetPersonRelationsWithHttpInfo (string idTypeScope, string idTypeCode, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0)
 [EARLY ACCESS] GetPersonRelations: Get Relations for Person Get relations for the specified person. More...
 
async System.Threading.Tasks.Task< ResourceListOfRelationGetPersonRelationsAsync (string idTypeScope, string idTypeCode, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] GetPersonRelations: Get Relations for Person Get relations for the specified person. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfRelation > > GetPersonRelationsWithHttpInfoAsync (string idTypeScope, string idTypeCode, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] GetPersonRelations: Get Relations for Person Get relations for the specified person. More...
 
ResourceListOfRelationship GetPersonRelationships (string idTypeScope, string idTypeCode, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0)
 [EARLY ACCESS] GetPersonRelationships: Get Relationships for Person Get relationships for the specified person. More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfRelationshipGetPersonRelationshipsWithHttpInfo (string idTypeScope, string idTypeCode, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0)
 [EARLY ACCESS] GetPersonRelationships: Get Relationships for Person Get relationships for the specified person. More...
 
async System.Threading.Tasks.Task< ResourceListOfRelationshipGetPersonRelationshipsAsync (string idTypeScope, string idTypeCode, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] GetPersonRelationships: Get Relationships for Person Get relationships for the specified person. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfRelationship > > GetPersonRelationshipsWithHttpInfoAsync (string idTypeScope, string idTypeCode, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] GetPersonRelationships: Get Relationships for Person Get relationships for the specified person. More...
 
ResourceListOfPerson ListAllPersons (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0)
 [EARLY ACCESS] ListAllPersons: List All Persons List all persons which the user is entitled to see. More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfPersonListAllPersonsWithHttpInfo (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0)
 [EARLY ACCESS] ListAllPersons: List All Persons List all persons which the user is entitled to see. More...
 
async System.Threading.Tasks.Task< ResourceListOfPersonListAllPersonsAsync (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] ListAllPersons: List All Persons List all persons which the user is entitled to see. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfPerson > > ListAllPersonsWithHttpInfoAsync (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] ListAllPersons: List All Persons List all persons which the user is entitled to see. More...
 
PagedResourceListOfPerson ListPersons (string idTypeScope, string idTypeCode, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0)
 [EARLY ACCESS] ListPersons: List Persons List persons which have identifiers of a specific identifier type&#39;s scope and code, and satisfies filter criteria. More...
 
Lusid.Sdk.Client.ApiResponse< PagedResourceListOfPersonListPersonsWithHttpInfo (string idTypeScope, string idTypeCode, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0)
 [EARLY ACCESS] ListPersons: List Persons List persons which have identifiers of a specific identifier type&#39;s scope and code, and satisfies filter criteria. More...
 
async System.Threading.Tasks.Task< PagedResourceListOfPersonListPersonsAsync (string idTypeScope, string idTypeCode, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] ListPersons: List Persons List persons which have identifiers of a specific identifier type&#39;s scope and code, and satisfies filter criteria. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfPerson > > ListPersonsWithHttpInfoAsync (string idTypeScope, string idTypeCode, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] ListPersons: List Persons List persons which have identifiers of a specific identifier type&#39;s scope and code, and satisfies filter criteria. More...
 
Dictionary< string, List< AccessMetadataValue > > PatchPersonAccessMetadata (string idTypeScope, string idTypeCode, string code, List< AccessMetadataOperation > accessMetadataOperation, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] PatchPersonAccessMetadata: Patch Access Metadata rules for a Person. Patch Person Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only &#39;add&#39; is a supported operation on the patch document. Currently only valid metadata keys are supported paths on the patch document. The response will return any affected Person Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. More...
 
Lusid.Sdk.Client.ApiResponse< Dictionary< string, List< AccessMetadataValue > > > PatchPersonAccessMetadataWithHttpInfo (string idTypeScope, string idTypeCode, string code, List< AccessMetadataOperation > accessMetadataOperation, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] PatchPersonAccessMetadata: Patch Access Metadata rules for a Person. Patch Person Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only &#39;add&#39; is a supported operation on the patch document. Currently only valid metadata keys are supported paths on the patch document. The response will return any affected Person Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. More...
 
async System.Threading.Tasks.Task< Dictionary< string, List< AccessMetadataValue > > > PatchPersonAccessMetadataAsync (string idTypeScope, string idTypeCode, string code, List< AccessMetadataOperation > accessMetadataOperation, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] PatchPersonAccessMetadata: Patch Access Metadata rules for a Person. Patch Person Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only &#39;add&#39; is a supported operation on the patch document. Currently only valid metadata keys are supported paths on the patch document. The response will return any affected Person Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< Dictionary< string, List< AccessMetadataValue > > > > PatchPersonAccessMetadataWithHttpInfoAsync (string idTypeScope, string idTypeCode, string code, List< AccessMetadataOperation > accessMetadataOperation, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] PatchPersonAccessMetadata: Patch Access Metadata rules for a Person. Patch Person Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only &#39;add&#39; is a supported operation on the patch document. Currently only valid metadata keys are supported paths on the patch document. The response will return any affected Person Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. More...
 
Person SetPersonIdentifiers (string idTypeScope, string idTypeCode, string code, SetPersonIdentifiersRequest setPersonIdentifiersRequest, int operationIndex=0)
 [EARLY ACCESS] SetPersonIdentifiers: Set Person Identifiers Set identifiers of the person. More...
 
Lusid.Sdk.Client.ApiResponse< PersonSetPersonIdentifiersWithHttpInfo (string idTypeScope, string idTypeCode, string code, SetPersonIdentifiersRequest setPersonIdentifiersRequest, int operationIndex=0)
 [EARLY ACCESS] SetPersonIdentifiers: Set Person Identifiers Set identifiers of the person. More...
 
async System.Threading.Tasks.Task< PersonSetPersonIdentifiersAsync (string idTypeScope, string idTypeCode, string code, SetPersonIdentifiersRequest setPersonIdentifiersRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] SetPersonIdentifiers: Set Person Identifiers Set identifiers of the person. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< Person > > SetPersonIdentifiersWithHttpInfoAsync (string idTypeScope, string idTypeCode, string code, SetPersonIdentifiersRequest setPersonIdentifiersRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] SetPersonIdentifiers: Set Person Identifiers Set identifiers of the person. More...
 
Person SetPersonProperties (string idTypeScope, string idTypeCode, string code, SetPersonPropertiesRequest setPersonPropertiesRequest, int operationIndex=0)
 [EARLY ACCESS] SetPersonProperties: Set Person Properties Set properties of the person. More...
 
Lusid.Sdk.Client.ApiResponse< PersonSetPersonPropertiesWithHttpInfo (string idTypeScope, string idTypeCode, string code, SetPersonPropertiesRequest setPersonPropertiesRequest, int operationIndex=0)
 [EARLY ACCESS] SetPersonProperties: Set Person Properties Set properties of the person. More...
 
async System.Threading.Tasks.Task< PersonSetPersonPropertiesAsync (string idTypeScope, string idTypeCode, string code, SetPersonPropertiesRequest setPersonPropertiesRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] SetPersonProperties: Set Person Properties Set properties of the person. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< Person > > SetPersonPropertiesWithHttpInfoAsync (string idTypeScope, string idTypeCode, string code, SetPersonPropertiesRequest setPersonPropertiesRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] SetPersonProperties: Set Person Properties Set properties of the person. More...
 
Person UpsertPerson (UpsertPersonRequest upsertPersonRequest, int operationIndex=0)
 [EARLY ACCESS] UpsertPerson: Upsert Person Create or update a new person under the specified scope. More...
 
Lusid.Sdk.Client.ApiResponse< PersonUpsertPersonWithHttpInfo (UpsertPersonRequest upsertPersonRequest, int operationIndex=0)
 [EARLY ACCESS] UpsertPerson: Upsert Person Create or update a new person under the specified scope. More...
 
async System.Threading.Tasks.Task< PersonUpsertPersonAsync (UpsertPersonRequest upsertPersonRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] UpsertPerson: Upsert Person Create or update a new person under the specified scope. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< Person > > UpsertPersonWithHttpInfoAsync (UpsertPersonRequest upsertPersonRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] UpsertPerson: Upsert Person Create or update a new person under the specified scope. More...
 
ResourceListOfAccessMetadataValueOf UpsertPersonAccessMetadata (string idTypeScope, string idTypeCode, string code, string metadataKey, UpsertPersonAccessMetadataRequest upsertPersonAccessMetadataRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] UpsertPersonAccessMetadata: Upsert a Person Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. Update or insert one Person Access Metadata entry in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Person Access Metadata rule or failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfAccessMetadataValueOfUpsertPersonAccessMetadataWithHttpInfo (string idTypeScope, string idTypeCode, string code, string metadataKey, UpsertPersonAccessMetadataRequest upsertPersonAccessMetadataRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] UpsertPersonAccessMetadata: Upsert a Person Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. Update or insert one Person Access Metadata entry in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Person Access Metadata rule or failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. More...
 
async System.Threading.Tasks.Task< ResourceListOfAccessMetadataValueOfUpsertPersonAccessMetadataAsync (string idTypeScope, string idTypeCode, string code, string metadataKey, UpsertPersonAccessMetadataRequest upsertPersonAccessMetadataRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] UpsertPersonAccessMetadata: Upsert a Person Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. Update or insert one Person Access Metadata entry in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Person Access Metadata rule or failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfAccessMetadataValueOf > > UpsertPersonAccessMetadataWithHttpInfoAsync (string idTypeScope, string idTypeCode, string code, string metadataKey, UpsertPersonAccessMetadataRequest upsertPersonAccessMetadataRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] UpsertPersonAccessMetadata: Upsert a Person Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. Update or insert one Person Access Metadata entry in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Person Access Metadata rule or failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. More...
 
UpsertPersonsResponse UpsertPersons (string successMode, Dictionary< string, UpsertPersonRequest > requestBody, int operationIndex=0)
 [EARLY ACCESS] UpsertPersons: Pluralised Upsert of Persons Create or updates a collection of person(s). More...
 
Lusid.Sdk.Client.ApiResponse< UpsertPersonsResponseUpsertPersonsWithHttpInfo (string successMode, Dictionary< string, UpsertPersonRequest > requestBody, int operationIndex=0)
 [EARLY ACCESS] UpsertPersons: Pluralised Upsert of Persons Create or updates a collection of person(s). More...
 
async System.Threading.Tasks.Task< UpsertPersonsResponseUpsertPersonsAsync (string successMode, Dictionary< string, UpsertPersonRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] UpsertPersons: Pluralised Upsert of Persons Create or updates a collection of person(s). More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< UpsertPersonsResponse > > UpsertPersonsWithHttpInfoAsync (string successMode, Dictionary< string, UpsertPersonRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] UpsertPersons: Pluralised Upsert of Persons Create or updates a collection of person(s). More...
 

Properties

Lusid.Sdk.Client.IAsynchronousClient AsynchronousClient [get, set]
 The client for accessing this underlying API asynchronously. More...
 
Lusid.Sdk.Client.ISynchronousClient Client [get, set]
 The client for accessing this underlying API synchronously. More...
 
Lusid.Sdk.Client.IReadableConfiguration Configuration [get, set]
 Gets or sets the configuration object More...
 
Lusid.Sdk.Client.ExceptionFactory ExceptionFactory [get, set]
 Provides a factory method hook for the creation of exceptions. More...
 
- Properties inherited from Lusid.Sdk.Client.IApiAccessor
IReadableConfiguration Configuration [get, set]
 Gets or sets the configuration object More...
 
ExceptionFactory ExceptionFactory [get, set]
 Provides a factory method hook for the creation of exceptions. More...
 

Detailed Description

Represents a collection of functions to interact with the API endpoints

Constructor & Destructor Documentation

◆ PersonsApi() [1/4]

Lusid.Sdk.Api.PersonsApi.PersonsApi ( )
inline

Initializes a new instance of the PersonsApi class.

Returns

◆ PersonsApi() [2/4]

Lusid.Sdk.Api.PersonsApi.PersonsApi ( string  basePath)
inline

Initializes a new instance of the PersonsApi class.

Returns

◆ PersonsApi() [3/4]

Lusid.Sdk.Api.PersonsApi.PersonsApi ( Lusid.Sdk.Client.Configuration  configuration)
inline

Initializes a new instance of the PersonsApi class using Configuration object

Parameters
configurationAn instance of Configuration
Returns

◆ PersonsApi() [4/4]

Lusid.Sdk.Api.PersonsApi.PersonsApi ( Lusid.Sdk.Client.ISynchronousClient  client,
Lusid.Sdk.Client.IAsynchronousClient  asyncClient,
Lusid.Sdk.Client.IReadableConfiguration  configuration 
)
inline

Initializes a new instance of the PersonsApi class using a Configuration object and client instance.

Parameters
clientThe client interface for synchronous API access.
asyncClientThe client interface for asynchronous API access.
configurationThe configuration object.

Member Function Documentation

◆ DeletePerson()

DeletedEntityResponse Lusid.Sdk.Api.PersonsApi.DeletePerson ( string  idTypeScope,
string  idTypeCode,
string  code,
int  operationIndex = 0 
)
inline

[EARLY ACCESS] DeletePerson: Delete person Delete a person. Deletion will be valid from the person&#39;s creation datetime. This means that the person will no longer exist at any effective datetime from the asAt datetime of deletion.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeThe scope of the person identifier type.
idTypeCodeThe code of the person identifier type.
codeCode of the person under specified identifier type scope and code. This together with defined identifier type uniquely identifies the person to delete.
operationIndexIndex associated with the operation.
Returns
DeletedEntityResponse

Implements Lusid.Sdk.Api.IPersonsApiSync.

◆ DeletePersonAccessMetadata()

DeletedEntityResponse Lusid.Sdk.Api.PersonsApi.DeletePersonAccessMetadata ( string  idTypeScope,
string  idTypeCode,
string  code,
string  metadataKey,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] DeletePersonAccessMetadata: Delete a Person Access Metadata entry Deletes the Person Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure).

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier.
idTypeCodeCode of the person identifier.
codeCode of the person under specified identifier type&#39;s scope and code.
metadataKeyKey of the metadata entry to retrieve
effectiveAtThe effective date to delete at, if this is not supplied, it will delete all data found (optional)
effectiveUntilThe effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; date of the Access Metadata (optional)
operationIndexIndex associated with the operation.
Returns
DeletedEntityResponse

Implements Lusid.Sdk.Api.IPersonsApiSync.

◆ DeletePersonAccessMetadataAsync()

async System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.PersonsApi.DeletePersonAccessMetadataAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
string  metadataKey,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] DeletePersonAccessMetadata: Delete a Person Access Metadata entry Deletes the Person Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure).

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier.
idTypeCodeCode of the person identifier.
codeCode of the person under specified identifier type&#39;s scope and code.
metadataKeyKey of the metadata entry to retrieve
effectiveAtThe effective date to delete at, if this is not supplied, it will delete all data found (optional)
effectiveUntilThe effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; date of the Access Metadata (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of DeletedEntityResponse

Implements Lusid.Sdk.Api.IPersonsApiAsync.

◆ DeletePersonAccessMetadataWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.PersonsApi.DeletePersonAccessMetadataWithHttpInfo ( string  idTypeScope,
string  idTypeCode,
string  code,
string  metadataKey,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] DeletePersonAccessMetadata: Delete a Person Access Metadata entry Deletes the Person Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure).

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier.
idTypeCodeCode of the person identifier.
codeCode of the person under specified identifier type&#39;s scope and code.
metadataKeyKey of the metadata entry to retrieve
effectiveAtThe effective date to delete at, if this is not supplied, it will delete all data found (optional)
effectiveUntilThe effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; date of the Access Metadata (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.IPersonsApiSync.

◆ DeletePersonAccessMetadataWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.PersonsApi.DeletePersonAccessMetadataWithHttpInfoAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
string  metadataKey,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] DeletePersonAccessMetadata: Delete a Person Access Metadata entry Deletes the Person Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure).

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier.
idTypeCodeCode of the person identifier.
codeCode of the person under specified identifier type&#39;s scope and code.
metadataKeyKey of the metadata entry to retrieve
effectiveAtThe effective date to delete at, if this is not supplied, it will delete all data found (optional)
effectiveUntilThe effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; date of the Access Metadata (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (DeletedEntityResponse)

Implements Lusid.Sdk.Api.IPersonsApiAsync.

◆ DeletePersonAsync()

async System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.PersonsApi.DeletePersonAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] DeletePerson: Delete person Delete a person. Deletion will be valid from the person&#39;s creation datetime. This means that the person will no longer exist at any effective datetime from the asAt datetime of deletion.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeThe scope of the person identifier type.
idTypeCodeThe code of the person identifier type.
codeCode of the person under specified identifier type scope and code. This together with defined identifier type uniquely identifies the person to delete.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of DeletedEntityResponse

Implements Lusid.Sdk.Api.IPersonsApiAsync.

◆ DeletePersonIdentifiers()

DeletedEntityResponse Lusid.Sdk.Api.PersonsApi.DeletePersonIdentifiers ( string  idTypeScope,
string  idTypeCode,
string  code,
List< string >  propertyKeys,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] DeletePersonIdentifiers: Delete Person Identifiers Delete identifiers that belong to the given property keys of the person.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier type.
idTypeCodeCode of the person identifier type.
codeCode of the person under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the person.
propertyKeysThe property keys of the identifiers to delete. These take the format {domain}/{scope}/{code} e.g. &quot;Person/CompanyDetails/Role&quot;. Each property must be from the &quot;Person&quot; domain. Identifiers or identifiers not specified in request will not be changed.
effectiveAtThe effective datetime or cut label at which to delete the identifiers. Defaults to the current LUSID system datetime if not specified. Must not include an effective datetime if identifiers are perpetual. (optional)
operationIndexIndex associated with the operation.
Returns
DeletedEntityResponse

Implements Lusid.Sdk.Api.IPersonsApiSync.

◆ DeletePersonIdentifiersAsync()

async System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.PersonsApi.DeletePersonIdentifiersAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
List< string >  propertyKeys,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] DeletePersonIdentifiers: Delete Person Identifiers Delete identifiers that belong to the given property keys of the person.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier type.
idTypeCodeCode of the person identifier type.
codeCode of the person under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the person.
propertyKeysThe property keys of the identifiers to delete. These take the format {domain}/{scope}/{code} e.g. &quot;Person/CompanyDetails/Role&quot;. Each property must be from the &quot;Person&quot; domain. Identifiers or identifiers not specified in request will not be changed.
effectiveAtThe effective datetime or cut label at which to delete the identifiers. Defaults to the current LUSID system datetime if not specified. Must not include an effective datetime if identifiers are perpetual. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of DeletedEntityResponse

Implements Lusid.Sdk.Api.IPersonsApiAsync.

◆ DeletePersonIdentifiersWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.PersonsApi.DeletePersonIdentifiersWithHttpInfo ( string  idTypeScope,
string  idTypeCode,
string  code,
List< string >  propertyKeys,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] DeletePersonIdentifiers: Delete Person Identifiers Delete identifiers that belong to the given property keys of the person.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier type.
idTypeCodeCode of the person identifier type.
codeCode of the person under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the person.
propertyKeysThe property keys of the identifiers to delete. These take the format {domain}/{scope}/{code} e.g. &quot;Person/CompanyDetails/Role&quot;. Each property must be from the &quot;Person&quot; domain. Identifiers or identifiers not specified in request will not be changed.
effectiveAtThe effective datetime or cut label at which to delete the identifiers. Defaults to the current LUSID system datetime if not specified. Must not include an effective datetime if identifiers are perpetual. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.IPersonsApiSync.

◆ DeletePersonIdentifiersWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.PersonsApi.DeletePersonIdentifiersWithHttpInfoAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
List< string >  propertyKeys,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] DeletePersonIdentifiers: Delete Person Identifiers Delete identifiers that belong to the given property keys of the person.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier type.
idTypeCodeCode of the person identifier type.
codeCode of the person under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the person.
propertyKeysThe property keys of the identifiers to delete. These take the format {domain}/{scope}/{code} e.g. &quot;Person/CompanyDetails/Role&quot;. Each property must be from the &quot;Person&quot; domain. Identifiers or identifiers not specified in request will not be changed.
effectiveAtThe effective datetime or cut label at which to delete the identifiers. Defaults to the current LUSID system datetime if not specified. Must not include an effective datetime if identifiers are perpetual. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (DeletedEntityResponse)

Implements Lusid.Sdk.Api.IPersonsApiAsync.

◆ DeletePersonProperties()

DeletedEntityResponse Lusid.Sdk.Api.PersonsApi.DeletePersonProperties ( string  idTypeScope,
string  idTypeCode,
string  code,
List< string >  propertyKeys,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] DeletePersonProperties: Delete Person Properties Delete all properties that belong to the given property keys of the person.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier type.
idTypeCodeCode of the person identifier type.
codeCode of the person under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the person.
propertyKeysThe property keys of the person&#39;s properties to delete. These take the format {domain}/{scope}/{code} e.g. &quot;Person/CompanyDetails/Role&quot;. Each property must be from the &quot;Person&quot; domain. Properties or identifiers not specified in request will not be changed.
effectiveAtThe effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified &#39;effectiveAt&#39; datetime. If the &#39;effectiveAt&#39; is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual. (optional)
operationIndexIndex associated with the operation.
Returns
DeletedEntityResponse

Implements Lusid.Sdk.Api.IPersonsApiSync.

◆ DeletePersonPropertiesAsync()

async System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.PersonsApi.DeletePersonPropertiesAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
List< string >  propertyKeys,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] DeletePersonProperties: Delete Person Properties Delete all properties that belong to the given property keys of the person.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier type.
idTypeCodeCode of the person identifier type.
codeCode of the person under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the person.
propertyKeysThe property keys of the person&#39;s properties to delete. These take the format {domain}/{scope}/{code} e.g. &quot;Person/CompanyDetails/Role&quot;. Each property must be from the &quot;Person&quot; domain. Properties or identifiers not specified in request will not be changed.
effectiveAtThe effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified &#39;effectiveAt&#39; datetime. If the &#39;effectiveAt&#39; is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of DeletedEntityResponse

Implements Lusid.Sdk.Api.IPersonsApiAsync.

◆ DeletePersonPropertiesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.PersonsApi.DeletePersonPropertiesWithHttpInfo ( string  idTypeScope,
string  idTypeCode,
string  code,
List< string >  propertyKeys,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] DeletePersonProperties: Delete Person Properties Delete all properties that belong to the given property keys of the person.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier type.
idTypeCodeCode of the person identifier type.
codeCode of the person under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the person.
propertyKeysThe property keys of the person&#39;s properties to delete. These take the format {domain}/{scope}/{code} e.g. &quot;Person/CompanyDetails/Role&quot;. Each property must be from the &quot;Person&quot; domain. Properties or identifiers not specified in request will not be changed.
effectiveAtThe effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified &#39;effectiveAt&#39; datetime. If the &#39;effectiveAt&#39; is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.IPersonsApiSync.

◆ DeletePersonPropertiesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.PersonsApi.DeletePersonPropertiesWithHttpInfoAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
List< string >  propertyKeys,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] DeletePersonProperties: Delete Person Properties Delete all properties that belong to the given property keys of the person.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier type.
idTypeCodeCode of the person identifier type.
codeCode of the person under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the person.
propertyKeysThe property keys of the person&#39;s properties to delete. These take the format {domain}/{scope}/{code} e.g. &quot;Person/CompanyDetails/Role&quot;. Each property must be from the &quot;Person&quot; domain. Properties or identifiers not specified in request will not be changed.
effectiveAtThe effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified &#39;effectiveAt&#39; datetime. If the &#39;effectiveAt&#39; is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (DeletedEntityResponse)

Implements Lusid.Sdk.Api.IPersonsApiAsync.

◆ DeletePersonWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.PersonsApi.DeletePersonWithHttpInfo ( string  idTypeScope,
string  idTypeCode,
string  code,
int  operationIndex = 0 
)
inline

[EARLY ACCESS] DeletePerson: Delete person Delete a person. Deletion will be valid from the person&#39;s creation datetime. This means that the person will no longer exist at any effective datetime from the asAt datetime of deletion.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeThe scope of the person identifier type.
idTypeCodeThe code of the person identifier type.
codeCode of the person under specified identifier type scope and code. This together with defined identifier type uniquely identifies the person to delete.
operationIndexIndex associated with the operation.
Returns
ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.IPersonsApiSync.

◆ DeletePersonWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.PersonsApi.DeletePersonWithHttpInfoAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] DeletePerson: Delete person Delete a person. Deletion will be valid from the person&#39;s creation datetime. This means that the person will no longer exist at any effective datetime from the asAt datetime of deletion.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeThe scope of the person identifier type.
idTypeCodeThe code of the person identifier type.
codeCode of the person under specified identifier type scope and code. This together with defined identifier type uniquely identifies the person to delete.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (DeletedEntityResponse)

Implements Lusid.Sdk.Api.IPersonsApiAsync.

◆ GetAllPersonAccessMetadata()

Dictionary<string, List<AccessMetadataValue> > Lusid.Sdk.Api.PersonsApi.GetAllPersonAccessMetadata ( string  idTypeScope,
string  idTypeCode,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] GetAllPersonAccessMetadata: Get Access Metadata rules for a Person Pass the Scope and Code of the Person identifier along with the person code parameter to retrieve the associated Access Metadata

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier.
idTypeCodeCode of the person identifier.
codeCode of the person under specified identifier type&#39;s scope and code.
effectiveAtThe effectiveAt datetime at which to retrieve the Access Metadata (optional)
asAtThe asAt datetime at which to retrieve the Access Metadata (optional)
operationIndexIndex associated with the operation.
Returns
Dictionary<string, List<AccessMetadataValue>>

Implements Lusid.Sdk.Api.IPersonsApiSync.

◆ GetAllPersonAccessMetadataAsync()

async System.Threading.Tasks.Task<Dictionary<string, List<AccessMetadataValue> > > Lusid.Sdk.Api.PersonsApi.GetAllPersonAccessMetadataAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] GetAllPersonAccessMetadata: Get Access Metadata rules for a Person Pass the Scope and Code of the Person identifier along with the person code parameter to retrieve the associated Access Metadata

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier.
idTypeCodeCode of the person identifier.
codeCode of the person under specified identifier type&#39;s scope and code.
effectiveAtThe effectiveAt datetime at which to retrieve the Access Metadata (optional)
asAtThe asAt datetime at which to retrieve the Access Metadata (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of Dictionary<string, List<AccessMetadataValue>>

Implements Lusid.Sdk.Api.IPersonsApiAsync.

◆ GetAllPersonAccessMetadataWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<Dictionary<string, List<AccessMetadataValue> > > Lusid.Sdk.Api.PersonsApi.GetAllPersonAccessMetadataWithHttpInfo ( string  idTypeScope,
string  idTypeCode,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] GetAllPersonAccessMetadata: Get Access Metadata rules for a Person Pass the Scope and Code of the Person identifier along with the person code parameter to retrieve the associated Access Metadata

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier.
idTypeCodeCode of the person identifier.
codeCode of the person under specified identifier type&#39;s scope and code.
effectiveAtThe effectiveAt datetime at which to retrieve the Access Metadata (optional)
asAtThe asAt datetime at which to retrieve the Access Metadata (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of Dictionary<string, List<AccessMetadataValue>>

Implements Lusid.Sdk.Api.IPersonsApiSync.

◆ GetAllPersonAccessMetadataWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<Dictionary<string, List<AccessMetadataValue> > > > Lusid.Sdk.Api.PersonsApi.GetAllPersonAccessMetadataWithHttpInfoAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] GetAllPersonAccessMetadata: Get Access Metadata rules for a Person Pass the Scope and Code of the Person identifier along with the person code parameter to retrieve the associated Access Metadata

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier.
idTypeCodeCode of the person identifier.
codeCode of the person under specified identifier type&#39;s scope and code.
effectiveAtThe effectiveAt datetime at which to retrieve the Access Metadata (optional)
asAtThe asAt datetime at which to retrieve the Access Metadata (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (Dictionary<string, List<AccessMetadataValue>>)

Implements Lusid.Sdk.Api.IPersonsApiAsync.

◆ GetBasePath()

string Lusid.Sdk.Api.PersonsApi.GetBasePath ( )
inline

Gets the base path of the API client.

The base path

Implements Lusid.Sdk.Client.IApiAccessor.

◆ GetPerson()

Person Lusid.Sdk.Api.PersonsApi.GetPerson ( string  idTypeScope,
string  idTypeCode,
string  code,
List< string >?  propertyKeys = default(List<string>?),
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  relationshipDefinitionIds = default(List<string>?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] GetPerson: Get Person Retrieve the definition of a person.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier type.
idTypeCodeCode of the person identifier type.
codeCode of the person under specified scope and code. This together with stated identifier type uniquely identifies the person.
propertyKeysA list of property keys from the &quot;Person&quot; domain to decorate onto the person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. &quot;Person/ContactDetails/Address&quot;. (optional)
effectiveAtThe effective datetime or cut label at which to retrieve the person. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the person. Defaults to return the latest version of the person if not specified. (optional)
relationshipDefinitionIdsA list of relationship definitions that are used to decorate related entities onto the person in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndexIndex associated with the operation.
Returns
Person

Implements Lusid.Sdk.Api.IPersonsApiSync.

◆ GetPersonAccessMetadataByKey()

List<AccessMetadataValue> Lusid.Sdk.Api.PersonsApi.GetPersonAccessMetadataByKey ( string  idTypeScope,
string  idTypeCode,
string  code,
string  metadataKey,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] GetPersonAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Person Get a specific Person Access Metadata by specifying the corresponding identifier parts and Person code No matching will be performed through this endpoint. To retrieve an entry, it is necessary to specify, exactly, the identifier of the entry

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier.
idTypeCodeCode of the person identifier.
codeCode of the person under specified identifier type&#39;s scope and code.
metadataKeyKey of the metadata entry to retrieve
effectiveAtThe effectiveAt datetime at which to retrieve the Access Metadata (optional)
asAtThe asAt datetime at which to retrieve the Access Metadata (optional)
operationIndexIndex associated with the operation.
Returns
List<AccessMetadataValue>

Implements Lusid.Sdk.Api.IPersonsApiSync.

◆ GetPersonAccessMetadataByKeyAsync()

async System.Threading.Tasks.Task<List<AccessMetadataValue> > Lusid.Sdk.Api.PersonsApi.GetPersonAccessMetadataByKeyAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
string  metadataKey,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] GetPersonAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Person Get a specific Person Access Metadata by specifying the corresponding identifier parts and Person code No matching will be performed through this endpoint. To retrieve an entry, it is necessary to specify, exactly, the identifier of the entry

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier.
idTypeCodeCode of the person identifier.
codeCode of the person under specified identifier type&#39;s scope and code.
metadataKeyKey of the metadata entry to retrieve
effectiveAtThe effectiveAt datetime at which to retrieve the Access Metadata (optional)
asAtThe asAt datetime at which to retrieve the Access Metadata (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of List<AccessMetadataValue>

Implements Lusid.Sdk.Api.IPersonsApiAsync.

◆ GetPersonAccessMetadataByKeyWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<List<AccessMetadataValue> > Lusid.Sdk.Api.PersonsApi.GetPersonAccessMetadataByKeyWithHttpInfo ( string  idTypeScope,
string  idTypeCode,
string  code,
string  metadataKey,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] GetPersonAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Person Get a specific Person Access Metadata by specifying the corresponding identifier parts and Person code No matching will be performed through this endpoint. To retrieve an entry, it is necessary to specify, exactly, the identifier of the entry

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier.
idTypeCodeCode of the person identifier.
codeCode of the person under specified identifier type&#39;s scope and code.
metadataKeyKey of the metadata entry to retrieve
effectiveAtThe effectiveAt datetime at which to retrieve the Access Metadata (optional)
asAtThe asAt datetime at which to retrieve the Access Metadata (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of List<AccessMetadataValue>

Implements Lusid.Sdk.Api.IPersonsApiSync.

◆ GetPersonAccessMetadataByKeyWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<List<AccessMetadataValue> > > Lusid.Sdk.Api.PersonsApi.GetPersonAccessMetadataByKeyWithHttpInfoAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
string  metadataKey,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] GetPersonAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Person Get a specific Person Access Metadata by specifying the corresponding identifier parts and Person code No matching will be performed through this endpoint. To retrieve an entry, it is necessary to specify, exactly, the identifier of the entry

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier.
idTypeCodeCode of the person identifier.
codeCode of the person under specified identifier type&#39;s scope and code.
metadataKeyKey of the metadata entry to retrieve
effectiveAtThe effectiveAt datetime at which to retrieve the Access Metadata (optional)
asAtThe asAt datetime at which to retrieve the Access Metadata (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (List<AccessMetadataValue>)

Implements Lusid.Sdk.Api.IPersonsApiAsync.

◆ GetPersonAsync()

async System.Threading.Tasks.Task<Person> Lusid.Sdk.Api.PersonsApi.GetPersonAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
List< string >?  propertyKeys = default(List<string>?),
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  relationshipDefinitionIds = default(List<string>?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] GetPerson: Get Person Retrieve the definition of a person.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier type.
idTypeCodeCode of the person identifier type.
codeCode of the person under specified scope and code. This together with stated identifier type uniquely identifies the person.
propertyKeysA list of property keys from the &quot;Person&quot; domain to decorate onto the person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. &quot;Person/ContactDetails/Address&quot;. (optional)
effectiveAtThe effective datetime or cut label at which to retrieve the person. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the person. Defaults to return the latest version of the person if not specified. (optional)
relationshipDefinitionIdsA list of relationship definitions that are used to decorate related entities onto the person in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of Person

Implements Lusid.Sdk.Api.IPersonsApiAsync.

◆ GetPersonPropertyTimeSeries()

ResourceListOfPropertyInterval Lusid.Sdk.Api.PersonsApi.GetPersonPropertyTimeSeries ( string  idTypeScope,
string  idTypeCode,
string  code,
string  propertyKey,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
string?  page = default(string?),
int?  limit = default(int?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] GetPersonPropertyTimeSeries: Get Person Property Time Series List the complete time series of a person property.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier type.
idTypeCodeCode of the person identifier type.
codeCode of the person under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the person.
propertyKeyThe property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. &quot;Person/CompanyDetails/Role&quot;. Each property must be from the &quot;Person&quot; domain.
asAtThe asAt datetime at which to list the person&#39;s property history. Defaults to return the current datetime if not supplied. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
pageThe pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
operationIndexIndex associated with the operation.
Returns
ResourceListOfPropertyInterval

Implements Lusid.Sdk.Api.IPersonsApiSync.

◆ GetPersonPropertyTimeSeriesAsync()

async System.Threading.Tasks.Task<ResourceListOfPropertyInterval> Lusid.Sdk.Api.PersonsApi.GetPersonPropertyTimeSeriesAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
string  propertyKey,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
string?  page = default(string?),
int?  limit = default(int?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] GetPersonPropertyTimeSeries: Get Person Property Time Series List the complete time series of a person property.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier type.
idTypeCodeCode of the person identifier type.
codeCode of the person under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the person.
propertyKeyThe property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. &quot;Person/CompanyDetails/Role&quot;. Each property must be from the &quot;Person&quot; domain.
asAtThe asAt datetime at which to list the person&#39;s property history. Defaults to return the current datetime if not supplied. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
pageThe pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ResourceListOfPropertyInterval

Implements Lusid.Sdk.Api.IPersonsApiAsync.

◆ GetPersonPropertyTimeSeriesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfPropertyInterval> Lusid.Sdk.Api.PersonsApi.GetPersonPropertyTimeSeriesWithHttpInfo ( string  idTypeScope,
string  idTypeCode,
string  code,
string  propertyKey,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
string?  page = default(string?),
int?  limit = default(int?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] GetPersonPropertyTimeSeries: Get Person Property Time Series List the complete time series of a person property.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier type.
idTypeCodeCode of the person identifier type.
codeCode of the person under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the person.
propertyKeyThe property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. &quot;Person/CompanyDetails/Role&quot;. Each property must be from the &quot;Person&quot; domain.
asAtThe asAt datetime at which to list the person&#39;s property history. Defaults to return the current datetime if not supplied. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
pageThe pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfPropertyInterval

Implements Lusid.Sdk.Api.IPersonsApiSync.

◆ GetPersonPropertyTimeSeriesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfPropertyInterval> > Lusid.Sdk.Api.PersonsApi.GetPersonPropertyTimeSeriesWithHttpInfoAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
string  propertyKey,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
string?  page = default(string?),
int?  limit = default(int?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] GetPersonPropertyTimeSeries: Get Person Property Time Series List the complete time series of a person property.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier type.
idTypeCodeCode of the person identifier type.
codeCode of the person under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the person.
propertyKeyThe property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. &quot;Person/CompanyDetails/Role&quot;. Each property must be from the &quot;Person&quot; domain.
asAtThe asAt datetime at which to list the person&#39;s property history. Defaults to return the current datetime if not supplied. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
pageThe pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ResourceListOfPropertyInterval)

Implements Lusid.Sdk.Api.IPersonsApiAsync.

◆ GetPersonRelations()

ResourceListOfRelation Lusid.Sdk.Api.PersonsApi.GetPersonRelations ( string  idTypeScope,
string  idTypeCode,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
List< string >?  identifierTypes = default(List<string>?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] GetPersonRelations: Get Relations for Person Get relations for the specified person.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier type.
idTypeCodeCode of the person identifier type.
codeCode of the person under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the person.
effectiveAtThe effective datetime or cut label at which to get relations. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the person&#39;s relations. Defaults to return the latest LUSID AsAt time if not specified. (optional)
filterExpression to filter the relations. Users should provide null or empty string for this field until further notice. (optional)
identifierTypesIdentifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. &quot;Person/CompanyDetails/Role&quot;. They must be from the &quot;Person&quot; or &quot;LegalEntity&quot; domain. Only identifier types stated will be used to look up relevant entities in relations. If not applicable, provide an empty array. (optional)
operationIndexIndex associated with the operation.
Returns
ResourceListOfRelation

Implements Lusid.Sdk.Api.IPersonsApiSync.

◆ GetPersonRelationsAsync()

async System.Threading.Tasks.Task<ResourceListOfRelation> Lusid.Sdk.Api.PersonsApi.GetPersonRelationsAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
List< string >?  identifierTypes = default(List<string>?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] GetPersonRelations: Get Relations for Person Get relations for the specified person.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier type.
idTypeCodeCode of the person identifier type.
codeCode of the person under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the person.
effectiveAtThe effective datetime or cut label at which to get relations. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the person&#39;s relations. Defaults to return the latest LUSID AsAt time if not specified. (optional)
filterExpression to filter the relations. Users should provide null or empty string for this field until further notice. (optional)
identifierTypesIdentifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. &quot;Person/CompanyDetails/Role&quot;. They must be from the &quot;Person&quot; or &quot;LegalEntity&quot; domain. Only identifier types stated will be used to look up relevant entities in relations. If not applicable, provide an empty array. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ResourceListOfRelation

Implements Lusid.Sdk.Api.IPersonsApiAsync.

◆ GetPersonRelationships()

ResourceListOfRelationship Lusid.Sdk.Api.PersonsApi.GetPersonRelationships ( string  idTypeScope,
string  idTypeCode,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
List< string >?  identifierTypes = default(List<string>?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] GetPersonRelationships: Get Relationships for Person Get relationships for the specified person.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person&#39;s identifier type.
idTypeCodeCode of the person&#39;s identifier type.
codeCode of the person under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the person.
effectiveAtThe effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified. (optional)
filterExpression to filter relationships. Users should provide null or empty string for this field until further notice. (optional)
identifierTypesIdentifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the &#39;Person&#39; or &#39;LegalEntity&#39; domains and have the format {domain}/{scope}/{code}, for example &#39;Person/CompanyDetails/Role&#39;. An Empty array may be used to return all related Entities. (optional)
operationIndexIndex associated with the operation.
Returns
ResourceListOfRelationship

Implements Lusid.Sdk.Api.IPersonsApiSync.

◆ GetPersonRelationshipsAsync()

async System.Threading.Tasks.Task<ResourceListOfRelationship> Lusid.Sdk.Api.PersonsApi.GetPersonRelationshipsAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
List< string >?  identifierTypes = default(List<string>?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] GetPersonRelationships: Get Relationships for Person Get relationships for the specified person.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person&#39;s identifier type.
idTypeCodeCode of the person&#39;s identifier type.
codeCode of the person under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the person.
effectiveAtThe effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified. (optional)
filterExpression to filter relationships. Users should provide null or empty string for this field until further notice. (optional)
identifierTypesIdentifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the &#39;Person&#39; or &#39;LegalEntity&#39; domains and have the format {domain}/{scope}/{code}, for example &#39;Person/CompanyDetails/Role&#39;. An Empty array may be used to return all related Entities. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ResourceListOfRelationship

Implements Lusid.Sdk.Api.IPersonsApiAsync.

◆ GetPersonRelationshipsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfRelationship> Lusid.Sdk.Api.PersonsApi.GetPersonRelationshipsWithHttpInfo ( string  idTypeScope,
string  idTypeCode,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
List< string >?  identifierTypes = default(List<string>?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] GetPersonRelationships: Get Relationships for Person Get relationships for the specified person.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person&#39;s identifier type.
idTypeCodeCode of the person&#39;s identifier type.
codeCode of the person under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the person.
effectiveAtThe effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified. (optional)
filterExpression to filter relationships. Users should provide null or empty string for this field until further notice. (optional)
identifierTypesIdentifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the &#39;Person&#39; or &#39;LegalEntity&#39; domains and have the format {domain}/{scope}/{code}, for example &#39;Person/CompanyDetails/Role&#39;. An Empty array may be used to return all related Entities. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfRelationship

Implements Lusid.Sdk.Api.IPersonsApiSync.

◆ GetPersonRelationshipsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfRelationship> > Lusid.Sdk.Api.PersonsApi.GetPersonRelationshipsWithHttpInfoAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
List< string >?  identifierTypes = default(List<string>?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] GetPersonRelationships: Get Relationships for Person Get relationships for the specified person.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person&#39;s identifier type.
idTypeCodeCode of the person&#39;s identifier type.
codeCode of the person under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the person.
effectiveAtThe effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified. (optional)
filterExpression to filter relationships. Users should provide null or empty string for this field until further notice. (optional)
identifierTypesIdentifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the &#39;Person&#39; or &#39;LegalEntity&#39; domains and have the format {domain}/{scope}/{code}, for example &#39;Person/CompanyDetails/Role&#39;. An Empty array may be used to return all related Entities. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ResourceListOfRelationship)

Implements Lusid.Sdk.Api.IPersonsApiAsync.

◆ GetPersonRelationsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfRelation> Lusid.Sdk.Api.PersonsApi.GetPersonRelationsWithHttpInfo ( string  idTypeScope,
string  idTypeCode,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
List< string >?  identifierTypes = default(List<string>?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] GetPersonRelations: Get Relations for Person Get relations for the specified person.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier type.
idTypeCodeCode of the person identifier type.
codeCode of the person under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the person.
effectiveAtThe effective datetime or cut label at which to get relations. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the person&#39;s relations. Defaults to return the latest LUSID AsAt time if not specified. (optional)
filterExpression to filter the relations. Users should provide null or empty string for this field until further notice. (optional)
identifierTypesIdentifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. &quot;Person/CompanyDetails/Role&quot;. They must be from the &quot;Person&quot; or &quot;LegalEntity&quot; domain. Only identifier types stated will be used to look up relevant entities in relations. If not applicable, provide an empty array. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfRelation

Implements Lusid.Sdk.Api.IPersonsApiSync.

◆ GetPersonRelationsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfRelation> > Lusid.Sdk.Api.PersonsApi.GetPersonRelationsWithHttpInfoAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
List< string >?  identifierTypes = default(List<string>?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] GetPersonRelations: Get Relations for Person Get relations for the specified person.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier type.
idTypeCodeCode of the person identifier type.
codeCode of the person under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the person.
effectiveAtThe effective datetime or cut label at which to get relations. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the person&#39;s relations. Defaults to return the latest LUSID AsAt time if not specified. (optional)
filterExpression to filter the relations. Users should provide null or empty string for this field until further notice. (optional)
identifierTypesIdentifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. &quot;Person/CompanyDetails/Role&quot;. They must be from the &quot;Person&quot; or &quot;LegalEntity&quot; domain. Only identifier types stated will be used to look up relevant entities in relations. If not applicable, provide an empty array. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ResourceListOfRelation)

Implements Lusid.Sdk.Api.IPersonsApiAsync.

◆ GetPersonWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<Person> Lusid.Sdk.Api.PersonsApi.GetPersonWithHttpInfo ( string  idTypeScope,
string  idTypeCode,
string  code,
List< string >?  propertyKeys = default(List<string>?),
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  relationshipDefinitionIds = default(List<string>?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] GetPerson: Get Person Retrieve the definition of a person.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier type.
idTypeCodeCode of the person identifier type.
codeCode of the person under specified scope and code. This together with stated identifier type uniquely identifies the person.
propertyKeysA list of property keys from the &quot;Person&quot; domain to decorate onto the person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. &quot;Person/ContactDetails/Address&quot;. (optional)
effectiveAtThe effective datetime or cut label at which to retrieve the person. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the person. Defaults to return the latest version of the person if not specified. (optional)
relationshipDefinitionIdsA list of relationship definitions that are used to decorate related entities onto the person in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of Person

Implements Lusid.Sdk.Api.IPersonsApiSync.

◆ GetPersonWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<Person> > Lusid.Sdk.Api.PersonsApi.GetPersonWithHttpInfoAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
List< string >?  propertyKeys = default(List<string>?),
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  relationshipDefinitionIds = default(List<string>?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] GetPerson: Get Person Retrieve the definition of a person.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier type.
idTypeCodeCode of the person identifier type.
codeCode of the person under specified scope and code. This together with stated identifier type uniquely identifies the person.
propertyKeysA list of property keys from the &quot;Person&quot; domain to decorate onto the person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. &quot;Person/ContactDetails/Address&quot;. (optional)
effectiveAtThe effective datetime or cut label at which to retrieve the person. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the person. Defaults to return the latest version of the person if not specified. (optional)
relationshipDefinitionIdsA list of relationship definitions that are used to decorate related entities onto the person in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (Person)

Implements Lusid.Sdk.Api.IPersonsApiAsync.

◆ ListAllPersons()

ResourceListOfPerson Lusid.Sdk.Api.PersonsApi.ListAllPersons ( DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  propertyKeys = default(List<string>?),
List< string >?  relationshipDefinitionIds = default(List<string>?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] ListAllPersons: List All Persons List all persons which the user is entitled to see.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
effectiveAtThe effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified. (optional)
pageThe pagination token to use to continue listing persons from a previous call to list persons. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 5000 if not specified. (optional)
filterExpression to filter the result set. For example, to filter on the display name, use &quot;displayName eq &#39;John&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeysA list of property keys from the &quot;Person&quot; domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. &quot;Person/ContactDetails/Address&quot;. (optional)
relationshipDefinitionIdsA list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndexIndex associated with the operation.
Returns
ResourceListOfPerson

Implements Lusid.Sdk.Api.IPersonsApiSync.

◆ ListAllPersonsAsync()

async System.Threading.Tasks.Task<ResourceListOfPerson> Lusid.Sdk.Api.PersonsApi.ListAllPersonsAsync ( DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  propertyKeys = default(List<string>?),
List< string >?  relationshipDefinitionIds = default(List<string>?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] ListAllPersons: List All Persons List all persons which the user is entitled to see.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
effectiveAtThe effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified. (optional)
pageThe pagination token to use to continue listing persons from a previous call to list persons. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 5000 if not specified. (optional)
filterExpression to filter the result set. For example, to filter on the display name, use &quot;displayName eq &#39;John&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeysA list of property keys from the &quot;Person&quot; domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. &quot;Person/ContactDetails/Address&quot;. (optional)
relationshipDefinitionIdsA list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ResourceListOfPerson

Implements Lusid.Sdk.Api.IPersonsApiAsync.

◆ ListAllPersonsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfPerson> Lusid.Sdk.Api.PersonsApi.ListAllPersonsWithHttpInfo ( DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  propertyKeys = default(List<string>?),
List< string >?  relationshipDefinitionIds = default(List<string>?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] ListAllPersons: List All Persons List all persons which the user is entitled to see.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
effectiveAtThe effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified. (optional)
pageThe pagination token to use to continue listing persons from a previous call to list persons. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 5000 if not specified. (optional)
filterExpression to filter the result set. For example, to filter on the display name, use &quot;displayName eq &#39;John&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeysA list of property keys from the &quot;Person&quot; domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. &quot;Person/ContactDetails/Address&quot;. (optional)
relationshipDefinitionIdsA list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfPerson

Implements Lusid.Sdk.Api.IPersonsApiSync.

◆ ListAllPersonsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfPerson> > Lusid.Sdk.Api.PersonsApi.ListAllPersonsWithHttpInfoAsync ( DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  propertyKeys = default(List<string>?),
List< string >?  relationshipDefinitionIds = default(List<string>?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] ListAllPersons: List All Persons List all persons which the user is entitled to see.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
effectiveAtThe effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified. (optional)
pageThe pagination token to use to continue listing persons from a previous call to list persons. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 5000 if not specified. (optional)
filterExpression to filter the result set. For example, to filter on the display name, use &quot;displayName eq &#39;John&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeysA list of property keys from the &quot;Person&quot; domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. &quot;Person/ContactDetails/Address&quot;. (optional)
relationshipDefinitionIdsA list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ResourceListOfPerson)

Implements Lusid.Sdk.Api.IPersonsApiAsync.

◆ ListPersons()

PagedResourceListOfPerson Lusid.Sdk.Api.PersonsApi.ListPersons ( string  idTypeScope,
string  idTypeCode,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  propertyKeys = default(List<string>?),
List< string >?  relationshipDefinitionIds = default(List<string>?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] ListPersons: List Persons List persons which have identifiers of a specific identifier type&#39;s scope and code, and satisfies filter criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier type.
idTypeCodeCode of the person identifier type.
effectiveAtThe effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified. (optional)
pageThe pagination token to use to continue listing persons from a previous call to list persons. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
filterExpression to filter the result set. For example, to filter on the LUPID, use &quot;lusidPersonId eq &#39;string&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeysA list of property keys from the &quot;Person&quot; domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. &quot;Person/ContactDetails/Address&quot;. (optional)
relationshipDefinitionIdsA list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndexIndex associated with the operation.
Returns
PagedResourceListOfPerson

Implements Lusid.Sdk.Api.IPersonsApiSync.

◆ ListPersonsAsync()

async System.Threading.Tasks.Task<PagedResourceListOfPerson> Lusid.Sdk.Api.PersonsApi.ListPersonsAsync ( string  idTypeScope,
string  idTypeCode,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  propertyKeys = default(List<string>?),
List< string >?  relationshipDefinitionIds = default(List<string>?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] ListPersons: List Persons List persons which have identifiers of a specific identifier type&#39;s scope and code, and satisfies filter criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier type.
idTypeCodeCode of the person identifier type.
effectiveAtThe effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified. (optional)
pageThe pagination token to use to continue listing persons from a previous call to list persons. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
filterExpression to filter the result set. For example, to filter on the LUPID, use &quot;lusidPersonId eq &#39;string&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeysA list of property keys from the &quot;Person&quot; domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. &quot;Person/ContactDetails/Address&quot;. (optional)
relationshipDefinitionIdsA list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of PagedResourceListOfPerson

Implements Lusid.Sdk.Api.IPersonsApiAsync.

◆ ListPersonsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfPerson> Lusid.Sdk.Api.PersonsApi.ListPersonsWithHttpInfo ( string  idTypeScope,
string  idTypeCode,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  propertyKeys = default(List<string>?),
List< string >?  relationshipDefinitionIds = default(List<string>?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] ListPersons: List Persons List persons which have identifiers of a specific identifier type&#39;s scope and code, and satisfies filter criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier type.
idTypeCodeCode of the person identifier type.
effectiveAtThe effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified. (optional)
pageThe pagination token to use to continue listing persons from a previous call to list persons. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
filterExpression to filter the result set. For example, to filter on the LUPID, use &quot;lusidPersonId eq &#39;string&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeysA list of property keys from the &quot;Person&quot; domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. &quot;Person/ContactDetails/Address&quot;. (optional)
relationshipDefinitionIdsA list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of PagedResourceListOfPerson

Implements Lusid.Sdk.Api.IPersonsApiSync.

◆ ListPersonsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfPerson> > Lusid.Sdk.Api.PersonsApi.ListPersonsWithHttpInfoAsync ( string  idTypeScope,
string  idTypeCode,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  propertyKeys = default(List<string>?),
List< string >?  relationshipDefinitionIds = default(List<string>?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] ListPersons: List Persons List persons which have identifiers of a specific identifier type&#39;s scope and code, and satisfies filter criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier type.
idTypeCodeCode of the person identifier type.
effectiveAtThe effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified. (optional)
pageThe pagination token to use to continue listing persons from a previous call to list persons. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
filterExpression to filter the result set. For example, to filter on the LUPID, use &quot;lusidPersonId eq &#39;string&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeysA list of property keys from the &quot;Person&quot; domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. &quot;Person/ContactDetails/Address&quot;. (optional)
relationshipDefinitionIdsA list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (PagedResourceListOfPerson)

Implements Lusid.Sdk.Api.IPersonsApiAsync.

◆ PatchPersonAccessMetadata()

Dictionary<string, List<AccessMetadataValue> > Lusid.Sdk.Api.PersonsApi.PatchPersonAccessMetadata ( string  idTypeScope,
string  idTypeCode,
string  code,
List< AccessMetadataOperation accessMetadataOperation,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] PatchPersonAccessMetadata: Patch Access Metadata rules for a Person. Patch Person Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only &#39;add&#39; is a supported operation on the patch document. Currently only valid metadata keys are supported paths on the patch document. The response will return any affected Person Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier.
idTypeCodeCode of the person identifier.
codeCode of the person under specified identifier type&#39;s scope and code.
accessMetadataOperationThe Json Patch document
effectiveAtThe effectiveAt datetime at which to upsert the Access Metadata (optional)
effectiveUntilThe effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; datetime of the Access Metadata (optional)
operationIndexIndex associated with the operation.
Returns
Dictionary<string, List<AccessMetadataValue>>

Implements Lusid.Sdk.Api.IPersonsApiSync.

◆ PatchPersonAccessMetadataAsync()

async System.Threading.Tasks.Task<Dictionary<string, List<AccessMetadataValue> > > Lusid.Sdk.Api.PersonsApi.PatchPersonAccessMetadataAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
List< AccessMetadataOperation accessMetadataOperation,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] PatchPersonAccessMetadata: Patch Access Metadata rules for a Person. Patch Person Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only &#39;add&#39; is a supported operation on the patch document. Currently only valid metadata keys are supported paths on the patch document. The response will return any affected Person Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier.
idTypeCodeCode of the person identifier.
codeCode of the person under specified identifier type&#39;s scope and code.
accessMetadataOperationThe Json Patch document
effectiveAtThe effectiveAt datetime at which to upsert the Access Metadata (optional)
effectiveUntilThe effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; datetime of the Access Metadata (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of Dictionary<string, List<AccessMetadataValue>>

Implements Lusid.Sdk.Api.IPersonsApiAsync.

◆ PatchPersonAccessMetadataWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<Dictionary<string, List<AccessMetadataValue> > > Lusid.Sdk.Api.PersonsApi.PatchPersonAccessMetadataWithHttpInfo ( string  idTypeScope,
string  idTypeCode,
string  code,
List< AccessMetadataOperation accessMetadataOperation,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] PatchPersonAccessMetadata: Patch Access Metadata rules for a Person. Patch Person Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only &#39;add&#39; is a supported operation on the patch document. Currently only valid metadata keys are supported paths on the patch document. The response will return any affected Person Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier.
idTypeCodeCode of the person identifier.
codeCode of the person under specified identifier type&#39;s scope and code.
accessMetadataOperationThe Json Patch document
effectiveAtThe effectiveAt datetime at which to upsert the Access Metadata (optional)
effectiveUntilThe effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; datetime of the Access Metadata (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of Dictionary<string, List<AccessMetadataValue>>

Implements Lusid.Sdk.Api.IPersonsApiSync.

◆ PatchPersonAccessMetadataWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<Dictionary<string, List<AccessMetadataValue> > > > Lusid.Sdk.Api.PersonsApi.PatchPersonAccessMetadataWithHttpInfoAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
List< AccessMetadataOperation accessMetadataOperation,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] PatchPersonAccessMetadata: Patch Access Metadata rules for a Person. Patch Person Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only &#39;add&#39; is a supported operation on the patch document. Currently only valid metadata keys are supported paths on the patch document. The response will return any affected Person Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier.
idTypeCodeCode of the person identifier.
codeCode of the person under specified identifier type&#39;s scope and code.
accessMetadataOperationThe Json Patch document
effectiveAtThe effectiveAt datetime at which to upsert the Access Metadata (optional)
effectiveUntilThe effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; datetime of the Access Metadata (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (Dictionary<string, List<AccessMetadataValue>>)

Implements Lusid.Sdk.Api.IPersonsApiAsync.

◆ SetPersonIdentifiers()

Person Lusid.Sdk.Api.PersonsApi.SetPersonIdentifiers ( string  idTypeScope,
string  idTypeCode,
string  code,
SetPersonIdentifiersRequest  setPersonIdentifiersRequest,
int  operationIndex = 0 
)
inline

[EARLY ACCESS] SetPersonIdentifiers: Set Person Identifiers Set identifiers of the person.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier type.
idTypeCodeCode of the person identifier type.
codeCode of the person under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the person.
setPersonIdentifiersRequestRequest containing identifiers to set for the person. Identifiers not specified in request will not be changed.
operationIndexIndex associated with the operation.
Returns
Person

Implements Lusid.Sdk.Api.IPersonsApiSync.

◆ SetPersonIdentifiersAsync()

async System.Threading.Tasks.Task<Person> Lusid.Sdk.Api.PersonsApi.SetPersonIdentifiersAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
SetPersonIdentifiersRequest  setPersonIdentifiersRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] SetPersonIdentifiers: Set Person Identifiers Set identifiers of the person.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier type.
idTypeCodeCode of the person identifier type.
codeCode of the person under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the person.
setPersonIdentifiersRequestRequest containing identifiers to set for the person. Identifiers not specified in request will not be changed.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of Person

Implements Lusid.Sdk.Api.IPersonsApiAsync.

◆ SetPersonIdentifiersWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<Person> Lusid.Sdk.Api.PersonsApi.SetPersonIdentifiersWithHttpInfo ( string  idTypeScope,
string  idTypeCode,
string  code,
SetPersonIdentifiersRequest  setPersonIdentifiersRequest,
int  operationIndex = 0 
)
inline

[EARLY ACCESS] SetPersonIdentifiers: Set Person Identifiers Set identifiers of the person.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier type.
idTypeCodeCode of the person identifier type.
codeCode of the person under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the person.
setPersonIdentifiersRequestRequest containing identifiers to set for the person. Identifiers not specified in request will not be changed.
operationIndexIndex associated with the operation.
Returns
ApiResponse of Person

Implements Lusid.Sdk.Api.IPersonsApiSync.

◆ SetPersonIdentifiersWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<Person> > Lusid.Sdk.Api.PersonsApi.SetPersonIdentifiersWithHttpInfoAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
SetPersonIdentifiersRequest  setPersonIdentifiersRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] SetPersonIdentifiers: Set Person Identifiers Set identifiers of the person.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier type.
idTypeCodeCode of the person identifier type.
codeCode of the person under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the person.
setPersonIdentifiersRequestRequest containing identifiers to set for the person. Identifiers not specified in request will not be changed.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (Person)

Implements Lusid.Sdk.Api.IPersonsApiAsync.

◆ SetPersonProperties()

Person Lusid.Sdk.Api.PersonsApi.SetPersonProperties ( string  idTypeScope,
string  idTypeCode,
string  code,
SetPersonPropertiesRequest  setPersonPropertiesRequest,
int  operationIndex = 0 
)
inline

[EARLY ACCESS] SetPersonProperties: Set Person Properties Set properties of the person.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier type.
idTypeCodeCode of the person identifier type.
codeCode of the person under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the person.
setPersonPropertiesRequestRequest containing properties to set for the person. Properties not specified in request will not be changed.
operationIndexIndex associated with the operation.
Returns
Person

Implements Lusid.Sdk.Api.IPersonsApiSync.

◆ SetPersonPropertiesAsync()

async System.Threading.Tasks.Task<Person> Lusid.Sdk.Api.PersonsApi.SetPersonPropertiesAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
SetPersonPropertiesRequest  setPersonPropertiesRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] SetPersonProperties: Set Person Properties Set properties of the person.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier type.
idTypeCodeCode of the person identifier type.
codeCode of the person under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the person.
setPersonPropertiesRequestRequest containing properties to set for the person. Properties not specified in request will not be changed.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of Person

Implements Lusid.Sdk.Api.IPersonsApiAsync.

◆ SetPersonPropertiesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<Person> Lusid.Sdk.Api.PersonsApi.SetPersonPropertiesWithHttpInfo ( string  idTypeScope,
string  idTypeCode,
string  code,
SetPersonPropertiesRequest  setPersonPropertiesRequest,
int  operationIndex = 0 
)
inline

[EARLY ACCESS] SetPersonProperties: Set Person Properties Set properties of the person.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier type.
idTypeCodeCode of the person identifier type.
codeCode of the person under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the person.
setPersonPropertiesRequestRequest containing properties to set for the person. Properties not specified in request will not be changed.
operationIndexIndex associated with the operation.
Returns
ApiResponse of Person

Implements Lusid.Sdk.Api.IPersonsApiSync.

◆ SetPersonPropertiesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<Person> > Lusid.Sdk.Api.PersonsApi.SetPersonPropertiesWithHttpInfoAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
SetPersonPropertiesRequest  setPersonPropertiesRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] SetPersonProperties: Set Person Properties Set properties of the person.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier type.
idTypeCodeCode of the person identifier type.
codeCode of the person under specified identifier type&#39;s scope and code. This together with stated identifier type uniquely identifies the person.
setPersonPropertiesRequestRequest containing properties to set for the person. Properties not specified in request will not be changed.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (Person)

Implements Lusid.Sdk.Api.IPersonsApiAsync.

◆ UpsertPerson()

Person Lusid.Sdk.Api.PersonsApi.UpsertPerson ( UpsertPersonRequest  upsertPersonRequest,
int  operationIndex = 0 
)
inline

[EARLY ACCESS] UpsertPerson: Upsert Person Create or update a new person under the specified scope.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
upsertPersonRequestRequest to create or update a person.
operationIndexIndex associated with the operation.
Returns
Person

Implements Lusid.Sdk.Api.IPersonsApiSync.

◆ UpsertPersonAccessMetadata()

ResourceListOfAccessMetadataValueOf Lusid.Sdk.Api.PersonsApi.UpsertPersonAccessMetadata ( string  idTypeScope,
string  idTypeCode,
string  code,
string  metadataKey,
UpsertPersonAccessMetadataRequest  upsertPersonAccessMetadataRequest,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] UpsertPersonAccessMetadata: Upsert a Person Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. Update or insert one Person Access Metadata entry in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Person Access Metadata rule or failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier.
idTypeCodeCode of the person identifier.
codeCode of the person under specified identifier type&#39;s scope and code.
metadataKeyKey of the metadata entry to retrieve
upsertPersonAccessMetadataRequestThe Person Access Metadata entry to upsert
effectiveAtThe effectiveAt datetime at which to upsert the Access Metadata (optional)
effectiveUntilThe effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; datetime of the Access Metadata (optional)
operationIndexIndex associated with the operation.
Returns
ResourceListOfAccessMetadataValueOf

Implements Lusid.Sdk.Api.IPersonsApiSync.

◆ UpsertPersonAccessMetadataAsync()

async System.Threading.Tasks.Task<ResourceListOfAccessMetadataValueOf> Lusid.Sdk.Api.PersonsApi.UpsertPersonAccessMetadataAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
string  metadataKey,
UpsertPersonAccessMetadataRequest  upsertPersonAccessMetadataRequest,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] UpsertPersonAccessMetadata: Upsert a Person Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. Update or insert one Person Access Metadata entry in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Person Access Metadata rule or failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier.
idTypeCodeCode of the person identifier.
codeCode of the person under specified identifier type&#39;s scope and code.
metadataKeyKey of the metadata entry to retrieve
upsertPersonAccessMetadataRequestThe Person Access Metadata entry to upsert
effectiveAtThe effectiveAt datetime at which to upsert the Access Metadata (optional)
effectiveUntilThe effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; datetime of the Access Metadata (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ResourceListOfAccessMetadataValueOf

Implements Lusid.Sdk.Api.IPersonsApiAsync.

◆ UpsertPersonAccessMetadataWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfAccessMetadataValueOf> Lusid.Sdk.Api.PersonsApi.UpsertPersonAccessMetadataWithHttpInfo ( string  idTypeScope,
string  idTypeCode,
string  code,
string  metadataKey,
UpsertPersonAccessMetadataRequest  upsertPersonAccessMetadataRequest,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] UpsertPersonAccessMetadata: Upsert a Person Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. Update or insert one Person Access Metadata entry in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Person Access Metadata rule or failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier.
idTypeCodeCode of the person identifier.
codeCode of the person under specified identifier type&#39;s scope and code.
metadataKeyKey of the metadata entry to retrieve
upsertPersonAccessMetadataRequestThe Person Access Metadata entry to upsert
effectiveAtThe effectiveAt datetime at which to upsert the Access Metadata (optional)
effectiveUntilThe effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; datetime of the Access Metadata (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfAccessMetadataValueOf

Implements Lusid.Sdk.Api.IPersonsApiSync.

◆ UpsertPersonAccessMetadataWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfAccessMetadataValueOf> > Lusid.Sdk.Api.PersonsApi.UpsertPersonAccessMetadataWithHttpInfoAsync ( string  idTypeScope,
string  idTypeCode,
string  code,
string  metadataKey,
UpsertPersonAccessMetadataRequest  upsertPersonAccessMetadataRequest,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] UpsertPersonAccessMetadata: Upsert a Person Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. Update or insert one Person Access Metadata entry in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Person Access Metadata rule or failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
idTypeScopeScope of the person identifier.
idTypeCodeCode of the person identifier.
codeCode of the person under specified identifier type&#39;s scope and code.
metadataKeyKey of the metadata entry to retrieve
upsertPersonAccessMetadataRequestThe Person Access Metadata entry to upsert
effectiveAtThe effectiveAt datetime at which to upsert the Access Metadata (optional)
effectiveUntilThe effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; datetime of the Access Metadata (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ResourceListOfAccessMetadataValueOf)

Implements Lusid.Sdk.Api.IPersonsApiAsync.

◆ UpsertPersonAsync()

async System.Threading.Tasks.Task<Person> Lusid.Sdk.Api.PersonsApi.UpsertPersonAsync ( UpsertPersonRequest  upsertPersonRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] UpsertPerson: Upsert Person Create or update a new person under the specified scope.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
upsertPersonRequestRequest to create or update a person.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of Person

Implements Lusid.Sdk.Api.IPersonsApiAsync.

◆ UpsertPersons()

UpsertPersonsResponse Lusid.Sdk.Api.PersonsApi.UpsertPersons ( string  successMode,
Dictionary< string, UpsertPersonRequest requestBody,
int  operationIndex = 0 
)
inline

[EARLY ACCESS] UpsertPersons: Pluralised Upsert of Persons Create or updates a collection of person(s).

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
successModeWhether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial
requestBodyA collection of requests to create or update Person(s).
operationIndexIndex associated with the operation.
Returns
UpsertPersonsResponse

Implements Lusid.Sdk.Api.IPersonsApiSync.

◆ UpsertPersonsAsync()

async System.Threading.Tasks.Task<UpsertPersonsResponse> Lusid.Sdk.Api.PersonsApi.UpsertPersonsAsync ( string  successMode,
Dictionary< string, UpsertPersonRequest requestBody,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] UpsertPersons: Pluralised Upsert of Persons Create or updates a collection of person(s).

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
successModeWhether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial
requestBodyA collection of requests to create or update Person(s).
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of UpsertPersonsResponse

Implements Lusid.Sdk.Api.IPersonsApiAsync.

◆ UpsertPersonsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<UpsertPersonsResponse> Lusid.Sdk.Api.PersonsApi.UpsertPersonsWithHttpInfo ( string  successMode,
Dictionary< string, UpsertPersonRequest requestBody,
int  operationIndex = 0 
)
inline

[EARLY ACCESS] UpsertPersons: Pluralised Upsert of Persons Create or updates a collection of person(s).

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
successModeWhether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial
requestBodyA collection of requests to create or update Person(s).
operationIndexIndex associated with the operation.
Returns
ApiResponse of UpsertPersonsResponse

Implements Lusid.Sdk.Api.IPersonsApiSync.

◆ UpsertPersonsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<UpsertPersonsResponse> > Lusid.Sdk.Api.PersonsApi.UpsertPersonsWithHttpInfoAsync ( string  successMode,
Dictionary< string, UpsertPersonRequest requestBody,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] UpsertPersons: Pluralised Upsert of Persons Create or updates a collection of person(s).

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
successModeWhether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial
requestBodyA collection of requests to create or update Person(s).
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (UpsertPersonsResponse)

Implements Lusid.Sdk.Api.IPersonsApiAsync.

◆ UpsertPersonWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<Person> Lusid.Sdk.Api.PersonsApi.UpsertPersonWithHttpInfo ( UpsertPersonRequest  upsertPersonRequest,
int  operationIndex = 0 
)
inline

[EARLY ACCESS] UpsertPerson: Upsert Person Create or update a new person under the specified scope.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
upsertPersonRequestRequest to create or update a person.
operationIndexIndex associated with the operation.
Returns
ApiResponse of Person

Implements Lusid.Sdk.Api.IPersonsApiSync.

◆ UpsertPersonWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<Person> > Lusid.Sdk.Api.PersonsApi.UpsertPersonWithHttpInfoAsync ( UpsertPersonRequest  upsertPersonRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EARLY ACCESS] UpsertPerson: Upsert Person Create or update a new person under the specified scope.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
upsertPersonRequestRequest to create or update a person.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (Person)

Implements Lusid.Sdk.Api.IPersonsApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.PersonsApi.AsynchronousClient
getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.PersonsApi.Client
getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.PersonsApi.Configuration
getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.PersonsApi.ExceptionFactory
getset

Provides a factory method hook for the creation of exceptions.


The documentation for this class was generated from the following file: