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

Inheritance diagram for Lusid.Sdk.Api.IPersonsApiSync:

[legend]

Public Member Functions
DeletedEntityResponse	DeletePerson (string idTypeScope, string idTypeCode, string code, int operationIndex=0)
	[EARLY ACCESS] DeletePerson: Delete person More...

ApiResponse< DeletedEntityResponse >	DeletePersonWithHttpInfo (string idTypeScope, string idTypeCode, string code, int operationIndex=0)
	[EARLY ACCESS] DeletePerson: Delete person 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 More...

ApiResponse< DeletedEntityResponse >	DeletePersonAccessMetadataWithHttpInfo (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 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 More...

ApiResponse< DeletedEntityResponse >	DeletePersonIdentifiersWithHttpInfo (string idTypeScope, string idTypeCode, string code, List< string > propertyKeys, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
	[EARLY ACCESS] DeletePersonIdentifiers: Delete Person Identifiers 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 More...

ApiResponse< DeletedEntityResponse >	DeletePersonPropertiesWithHttpInfo (string idTypeScope, string idTypeCode, string code, List< string > propertyKeys, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
	[EARLY ACCESS] DeletePersonProperties: Delete Person Properties 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 More...

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 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 More...

ApiResponse< Person >	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)
	[EARLY ACCESS] GetPerson: Get Person More...

List< AccessMetadataValue >	GetPersonAccessMetadataByKey (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 More...

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 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 More...

ApiResponse< ResourceListOfPropertyInterval >	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)
	[EARLY ACCESS] GetPersonPropertyTimeSeries: Get Person Property Time Series 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 More...

ApiResponse< ResourceListOfRelation >	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)
	[EARLY ACCESS] GetPersonRelations: Get Relations for 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 More...

ApiResponse< ResourceListOfRelationship >	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)
	[EARLY ACCESS] GetPersonRelationships: Get Relationships for 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 More...

ApiResponse< ResourceListOfPerson >	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)
	[EARLY ACCESS] ListAllPersons: List All Persons 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 More...

ApiResponse< PagedResourceListOfPerson >	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)
	[EARLY ACCESS] ListPersons: List Persons 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. More...

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. More...

Person	SetPersonIdentifiers (string idTypeScope, string idTypeCode, string code, SetPersonIdentifiersRequest setPersonIdentifiersRequest, int operationIndex=0)
	[EARLY ACCESS] SetPersonIdentifiers: Set Person Identifiers More...

ApiResponse< Person >	SetPersonIdentifiersWithHttpInfo (string idTypeScope, string idTypeCode, string code, SetPersonIdentifiersRequest setPersonIdentifiersRequest, int operationIndex=0)
	[EARLY ACCESS] SetPersonIdentifiers: Set Person Identifiers More...

Person	SetPersonProperties (string idTypeScope, string idTypeCode, string code, SetPersonPropertiesRequest setPersonPropertiesRequest, int operationIndex=0)
	[EARLY ACCESS] SetPersonProperties: Set Person Properties More...

ApiResponse< Person >	SetPersonPropertiesWithHttpInfo (string idTypeScope, string idTypeCode, string code, SetPersonPropertiesRequest setPersonPropertiesRequest, int operationIndex=0)
	[EARLY ACCESS] SetPersonProperties: Set Person Properties More...

Person	UpsertPerson (UpsertPersonRequest upsertPersonRequest, int operationIndex=0)
	[EARLY ACCESS] UpsertPerson: Upsert Person More...

ApiResponse< Person >	UpsertPersonWithHttpInfo (UpsertPersonRequest upsertPersonRequest, int operationIndex=0)
	[EARLY ACCESS] UpsertPerson: Upsert Person 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. More...

ApiResponse< ResourceListOfAccessMetadataValueOf >	UpsertPersonAccessMetadataWithHttpInfo (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. More...

Public Member Functions inherited from Lusid.Sdk.Client.IApiAccessor
string	GetBasePath ()
	Gets the base path of the API client. More...

Additional Inherited Members
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

Member Function Documentation

◆ DeletePerson()

DeletedEntityResponse Lusid.Sdk.Api.IPersonsApiSync.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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

idTypeScope	The scope of the person identifier type.
idTypeCode	The code of the person identifier type.
code	Code of the person under specified identifier type scope and code. This together with defined identifier type uniquely identifies the person to delete.
operationIndex	Index associated with the operation.

Returns: DeletedEntityResponse

Implemented in Lusid.Sdk.Api.PersonsApi.

◆ DeletePersonAccessMetadata()

DeletedEntityResponse Lusid.Sdk.Api.IPersonsApiSync.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).

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

idTypeScope	Scope of the person identifier.
idTypeCode	Code of the person identifier.
code	Code of the person under specified identifier type's scope and code.
metadataKey	Key of the metadata entry to retrieve
effectiveAt	The effective date to delete at, if this is not supplied, it will delete all data found (optional)
effectiveUntil	The effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional)
operationIndex	Index associated with the operation.

Returns: DeletedEntityResponse

Implemented in Lusid.Sdk.Api.PersonsApi.

◆ DeletePersonAccessMetadataWithHttpInfo()

ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IPersonsApiSync.DeletePersonAccessMetadataWithHttpInfo	(	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).

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

idTypeScope	Scope of the person identifier.
idTypeCode	Code of the person identifier.
code	Code of the person under specified identifier type's scope and code.
metadataKey	Key of the metadata entry to retrieve
effectiveAt	The effective date to delete at, if this is not supplied, it will delete all data found (optional)
effectiveUntil	The effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.PersonsApi.

◆ DeletePersonIdentifiers()

DeletedEntityResponse Lusid.Sdk.Api.IPersonsApiSync.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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

idTypeScope	Scope of the person identifier type.
idTypeCode	Code of the person identifier type.
code	Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.
propertyKeys	The property keys of the identifiers to delete. These take the format {domain}/{scope}/{code} e.g. "Person/CompanyDetails/Role". Each property must be from the "Person" domain. Identifiers or identifiers not specified in request will not be changed.
effectiveAt	The 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)
operationIndex	Index associated with the operation.

Returns: DeletedEntityResponse

Implemented in Lusid.Sdk.Api.PersonsApi.

◆ DeletePersonIdentifiersWithHttpInfo()

ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IPersonsApiSync.DeletePersonIdentifiersWithHttpInfo	(	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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

idTypeScope	Scope of the person identifier type.
idTypeCode	Code of the person identifier type.
code	Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.
propertyKeys	The property keys of the identifiers to delete. These take the format {domain}/{scope}/{code} e.g. "Person/CompanyDetails/Role". Each property must be from the "Person" domain. Identifiers or identifiers not specified in request will not be changed.
effectiveAt	The 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)
operationIndex	Index associated with the operation.

Returns: ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.PersonsApi.

◆ DeletePersonProperties()

DeletedEntityResponse Lusid.Sdk.Api.IPersonsApiSync.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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

idTypeScope	Scope of the person identifier type.
idTypeCode	Code of the person identifier type.
code	Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.
propertyKeys	The property keys of the person's properties to delete. These take the format {domain}/{scope}/{code} e.g. "Person/CompanyDetails/Role". Each property must be from the "Person" domain. Properties or identifiers not specified in request will not be changed.
effectiveAt	The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' 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)
operationIndex	Index associated with the operation.

Returns: DeletedEntityResponse

Implemented in Lusid.Sdk.Api.PersonsApi.

◆ DeletePersonPropertiesWithHttpInfo()

ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IPersonsApiSync.DeletePersonPropertiesWithHttpInfo	(	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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

idTypeScope	Scope of the person identifier type.
idTypeCode	Code of the person identifier type.
code	Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.
propertyKeys	The property keys of the person's properties to delete. These take the format {domain}/{scope}/{code} e.g. "Person/CompanyDetails/Role". Each property must be from the "Person" domain. Properties or identifiers not specified in request will not be changed.
effectiveAt	The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' 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)
operationIndex	Index associated with the operation.

Returns: ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.PersonsApi.

◆ DeletePersonWithHttpInfo()

ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IPersonsApiSync.DeletePersonWithHttpInfo	(	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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

idTypeScope	The scope of the person identifier type.
idTypeCode	The code of the person identifier type.
code	Code of the person under specified identifier type scope and code. This together with defined identifier type uniquely identifies the person to delete.
operationIndex	Index associated with the operation.

Returns: ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.PersonsApi.

◆ GetAllPersonAccessMetadata()

Dictionary<string, List<AccessMetadataValue> > Lusid.Sdk.Api.IPersonsApiSync.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

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

idTypeScope	Scope of the person identifier.
idTypeCode	Code of the person identifier.
code	Code of the person under specified identifier type's scope and code.
effectiveAt	The effectiveAt datetime at which to retrieve the Access Metadata (optional)
asAt	The asAt datetime at which to retrieve the Access Metadata (optional)
operationIndex	Index associated with the operation.

Returns: Dictionary<string, List<AccessMetadataValue>>

Implemented in Lusid.Sdk.Api.PersonsApi.

◆ GetAllPersonAccessMetadataWithHttpInfo()

ApiResponse<Dictionary<string, List<AccessMetadataValue> > > Lusid.Sdk.Api.IPersonsApiSync.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

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

idTypeScope	Scope of the person identifier.
idTypeCode	Code of the person identifier.
code	Code of the person under specified identifier type's scope and code.
effectiveAt	The effectiveAt datetime at which to retrieve the Access Metadata (optional)
asAt	The asAt datetime at which to retrieve the Access Metadata (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of Dictionary<string, List<AccessMetadataValue>>

Implemented in Lusid.Sdk.Api.PersonsApi.

◆ GetPerson()

Person Lusid.Sdk.Api.IPersonsApiSync.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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

idTypeScope	Scope of the person identifier type.
idTypeCode	Code of the person identifier type.
code	Code of the person under specified scope and code. This together with stated identifier type uniquely identifies the person.
propertyKeys	A list of property keys from the "Person" 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. "Person/ContactDetails/Address". (optional)
effectiveAt	The effective datetime or cut label at which to retrieve the person. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the person. Defaults to return the latest version of the person if not specified. (optional)
relationshipDefinitionIds	A 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)
operationIndex	Index associated with the operation.

Returns: Person

Implemented in Lusid.Sdk.Api.PersonsApi.

◆ GetPersonAccessMetadataByKey()

List<AccessMetadataValue> Lusid.Sdk.Api.IPersonsApiSync.GetPersonAccessMetadataByKey	(	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

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

idTypeScope	Scope of the person identifier.
idTypeCode	Code of the person identifier.
code	Code of the person under specified identifier type's scope and code.
metadataKey	Key of the metadata entry to retrieve
effectiveAt	The effectiveAt datetime at which to retrieve the Access Metadata (optional)
asAt	The asAt datetime at which to retrieve the Access Metadata (optional)
operationIndex	Index associated with the operation.

Returns: List<AccessMetadataValue>

Implemented in Lusid.Sdk.Api.PersonsApi.

◆ GetPersonAccessMetadataByKeyWithHttpInfo()

ApiResponse<List<AccessMetadataValue> > Lusid.Sdk.Api.IPersonsApiSync.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

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

idTypeScope	Scope of the person identifier.
idTypeCode	Code of the person identifier.
code	Code of the person under specified identifier type's scope and code.
metadataKey	Key of the metadata entry to retrieve
effectiveAt	The effectiveAt datetime at which to retrieve the Access Metadata (optional)
asAt	The asAt datetime at which to retrieve the Access Metadata (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of List<AccessMetadataValue>

Implemented in Lusid.Sdk.Api.PersonsApi.

◆ GetPersonPropertyTimeSeries()

ResourceListOfPropertyInterval Lusid.Sdk.Api.IPersonsApiSync.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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

idTypeScope	Scope of the person identifier type.
idTypeCode	Code of the person identifier type.
code	Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.
propertyKey	The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. "Person/CompanyDetails/Role". Each property must be from the "Person" domain.
asAt	The asAt datetime at which to list the person's property history. Defaults to return the current datetime if not supplied. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
page	The 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)
limit	When paginating, limit the number of returned results to this many. (optional)
operationIndex	Index associated with the operation.

Returns: ResourceListOfPropertyInterval

Implemented in Lusid.Sdk.Api.PersonsApi.

◆ GetPersonPropertyTimeSeriesWithHttpInfo()

ApiResponse<ResourceListOfPropertyInterval> Lusid.Sdk.Api.IPersonsApiSync.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`
	)

[EARLY ACCESS] GetPersonPropertyTimeSeries: Get Person Property Time Series

List the complete time series of a person property.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

idTypeScope	Scope of the person identifier type.
idTypeCode	Code of the person identifier type.
code	Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.
propertyKey	The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. "Person/CompanyDetails/Role". Each property must be from the "Person" domain.
asAt	The asAt datetime at which to list the person's property history. Defaults to return the current datetime if not supplied. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
page	The 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)
limit	When paginating, limit the number of returned results to this many. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of ResourceListOfPropertyInterval

Implemented in Lusid.Sdk.Api.PersonsApi.

◆ GetPersonRelations()

ResourceListOfRelation Lusid.Sdk.Api.IPersonsApiSync.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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

idTypeScope	Scope of the person identifier type.
idTypeCode	Code of the person identifier type.
code	Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.
effectiveAt	The effective datetime or cut label at which to get relations. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the person's relations. Defaults to return the latest LUSID AsAt time if not specified. (optional)
filter	Expression to filter the relations. Users should provide null or empty string for this field until further notice. (optional)
identifierTypes	Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. "Person/CompanyDetails/Role". They must be from the "Person" or "LegalEntity" domain. Only identifier types stated will be used to look up relevant entities in relations. If not applicable, provide an empty array. (optional)
operationIndex	Index associated with the operation.

Returns: ResourceListOfRelation

Implemented in Lusid.Sdk.Api.PersonsApi.

◆ GetPersonRelationships()

ResourceListOfRelationship Lusid.Sdk.Api.IPersonsApiSync.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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

idTypeScope	Scope of the person's identifier type.
idTypeCode	Code of the person's identifier type.
code	Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.
effectiveAt	The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified. (optional)
filter	Expression to filter relationships. Users should provide null or empty string for this field until further notice. (optional)
identifierTypes	Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities. (optional)
operationIndex	Index associated with the operation.

Returns: ResourceListOfRelationship

Implemented in Lusid.Sdk.Api.PersonsApi.

◆ GetPersonRelationshipsWithHttpInfo()

ApiResponse<ResourceListOfRelationship> Lusid.Sdk.Api.IPersonsApiSync.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`
	)

[EARLY ACCESS] GetPersonRelationships: Get Relationships for Person

Get relationships for the specified person.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

idTypeScope	Scope of the person's identifier type.
idTypeCode	Code of the person's identifier type.
code	Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.
effectiveAt	The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified. (optional)
filter	Expression to filter relationships. Users should provide null or empty string for this field until further notice. (optional)
identifierTypes	Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of ResourceListOfRelationship

Implemented in Lusid.Sdk.Api.PersonsApi.

◆ GetPersonRelationsWithHttpInfo()

ApiResponse<ResourceListOfRelation> Lusid.Sdk.Api.IPersonsApiSync.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`
	)

[EARLY ACCESS] GetPersonRelations: Get Relations for Person

Get relations for the specified person.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

idTypeScope	Scope of the person identifier type.
idTypeCode	Code of the person identifier type.
code	Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.
effectiveAt	The effective datetime or cut label at which to get relations. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the person's relations. Defaults to return the latest LUSID AsAt time if not specified. (optional)
filter	Expression to filter the relations. Users should provide null or empty string for this field until further notice. (optional)
identifierTypes	Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. "Person/CompanyDetails/Role". They must be from the "Person" or "LegalEntity" domain. Only identifier types stated will be used to look up relevant entities in relations. If not applicable, provide an empty array. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of ResourceListOfRelation

Implemented in Lusid.Sdk.Api.PersonsApi.

◆ GetPersonWithHttpInfo()

ApiResponse<Person> Lusid.Sdk.Api.IPersonsApiSync.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`
	)

[EARLY ACCESS] GetPerson: Get Person

Retrieve the definition of a person.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

idTypeScope	Scope of the person identifier type.
idTypeCode	Code of the person identifier type.
code	Code of the person under specified scope and code. This together with stated identifier type uniquely identifies the person.
propertyKeys	A list of property keys from the "Person" 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. "Person/ContactDetails/Address". (optional)
effectiveAt	The effective datetime or cut label at which to retrieve the person. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the person. Defaults to return the latest version of the person if not specified. (optional)
relationshipDefinitionIds	A 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)
operationIndex	Index associated with the operation.

Returns: ApiResponse of Person

Implemented in Lusid.Sdk.Api.PersonsApi.

◆ ListAllPersons()

ResourceListOfPerson Lusid.Sdk.Api.IPersonsApiSync.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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

effectiveAt	The effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified. (optional)
page	The 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)
limit	When paginating, limit the number of returned results to this many. Defaults to 5000 if not specified. (optional)
filter	Expression to filter the result set. For example, to filter on the display name, use "displayName eq 'John'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeys	A list of property keys from the "Person" 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. "Person/ContactDetails/Address". (optional)
relationshipDefinitionIds	A 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)
operationIndex	Index associated with the operation.

Returns: ResourceListOfPerson

Implemented in Lusid.Sdk.Api.PersonsApi.

◆ ListAllPersonsWithHttpInfo()

ApiResponse<ResourceListOfPerson> Lusid.Sdk.Api.IPersonsApiSync.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`
	)

[EARLY ACCESS] ListAllPersons: List All Persons

List all persons which the user is entitled to see.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

effectiveAt	The effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified. (optional)
page	The 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)
limit	When paginating, limit the number of returned results to this many. Defaults to 5000 if not specified. (optional)
filter	Expression to filter the result set. For example, to filter on the display name, use "displayName eq 'John'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeys	A list of property keys from the "Person" 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. "Person/ContactDetails/Address". (optional)
relationshipDefinitionIds	A 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)
operationIndex	Index associated with the operation.

Returns: ApiResponse of ResourceListOfPerson

Implemented in Lusid.Sdk.Api.PersonsApi.

◆ ListPersons()

PagedResourceListOfPerson Lusid.Sdk.Api.IPersonsApiSync.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's scope and code, and satisfies filter criteria.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

idTypeScope	Scope of the person identifier type.
idTypeCode	Code of the person identifier type.
effectiveAt	The effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified. (optional)
page	The 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)
limit	When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
filter	Expression to filter the result set. For example, to filter on the LUPID, use "lusidPersonId eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeys	A list of property keys from the "Person" 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. "Person/ContactDetails/Address". (optional)
relationshipDefinitionIds	A 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)
operationIndex	Index associated with the operation.

Returns: PagedResourceListOfPerson

Implemented in Lusid.Sdk.Api.PersonsApi.

◆ ListPersonsWithHttpInfo()

ApiResponse<PagedResourceListOfPerson> Lusid.Sdk.Api.IPersonsApiSync.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`
	)

[EARLY ACCESS] ListPersons: List Persons

List persons which have identifiers of a specific identifier type's scope and code, and satisfies filter criteria.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

idTypeScope	Scope of the person identifier type.
idTypeCode	Code of the person identifier type.
effectiveAt	The effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified. (optional)
page	The 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)
limit	When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
filter	Expression to filter the result set. For example, to filter on the LUPID, use "lusidPersonId eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeys	A list of property keys from the "Person" 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. "Person/ContactDetails/Address". (optional)
relationshipDefinitionIds	A 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)
operationIndex	Index associated with the operation.

Returns: ApiResponse of PagedResourceListOfPerson

Implemented in Lusid.Sdk.Api.PersonsApi.

◆ PatchPersonAccessMetadata()

Dictionary<string, List<AccessMetadataValue> > Lusid.Sdk.Api.IPersonsApiSync.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 'add' 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.ApiException Thrown when fails to make API call

Parameters

idTypeScope	Scope of the person identifier.
idTypeCode	Code of the person identifier.
code	Code of the person under specified identifier type's scope and code.
accessMetadataOperation	The Json Patch document
effectiveAt	The effectiveAt datetime at which to upsert the Access Metadata (optional)
effectiveUntil	The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata (optional)
operationIndex	Index associated with the operation.

Returns: Dictionary<string, List<AccessMetadataValue>>

Implemented in Lusid.Sdk.Api.PersonsApi.

◆ PatchPersonAccessMetadataWithHttpInfo()

ApiResponse<Dictionary<string, List<AccessMetadataValue> > > Lusid.Sdk.Api.IPersonsApiSync.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 'add' 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.ApiException Thrown when fails to make API call

Parameters

idTypeScope	Scope of the person identifier.
idTypeCode	Code of the person identifier.
code	Code of the person under specified identifier type's scope and code.
accessMetadataOperation	The Json Patch document
effectiveAt	The effectiveAt datetime at which to upsert the Access Metadata (optional)
effectiveUntil	The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of Dictionary<string, List<AccessMetadataValue>>

Implemented in Lusid.Sdk.Api.PersonsApi.

◆ SetPersonIdentifiers()

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

[EARLY ACCESS] SetPersonIdentifiers: Set Person Identifiers

Set identifiers of the person.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

idTypeScope	Scope of the person identifier type.
idTypeCode	Code of the person identifier type.
code	Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.
setPersonIdentifiersRequest	Request containing identifiers to set for the person. Identifiers not specified in request will not be changed.
operationIndex	Index associated with the operation.

Returns: Person

Implemented in Lusid.Sdk.Api.PersonsApi.

◆ SetPersonIdentifiersWithHttpInfo()

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

[EARLY ACCESS] SetPersonIdentifiers: Set Person Identifiers

Set identifiers of the person.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

idTypeScope	Scope of the person identifier type.
idTypeCode	Code of the person identifier type.
code	Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.
setPersonIdentifiersRequest	Request containing identifiers to set for the person. Identifiers not specified in request will not be changed.
operationIndex	Index associated with the operation.

Returns: ApiResponse of Person

Implemented in Lusid.Sdk.Api.PersonsApi.

◆ SetPersonProperties()

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

[EARLY ACCESS] SetPersonProperties: Set Person Properties

Set properties of the person.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

idTypeScope	Scope of the person identifier type.
idTypeCode	Code of the person identifier type.
code	Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.
setPersonPropertiesRequest	Request containing properties to set for the person. Properties not specified in request will not be changed.
operationIndex	Index associated with the operation.

Returns: Person

Implemented in Lusid.Sdk.Api.PersonsApi.

◆ SetPersonPropertiesWithHttpInfo()

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

[EARLY ACCESS] SetPersonProperties: Set Person Properties

Set properties of the person.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

idTypeScope	Scope of the person identifier type.
idTypeCode	Code of the person identifier type.
code	Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.
setPersonPropertiesRequest	Request containing properties to set for the person. Properties not specified in request will not be changed.
operationIndex	Index associated with the operation.

Returns: ApiResponse of Person

Implemented in Lusid.Sdk.Api.PersonsApi.

◆ UpsertPerson()

Person Lusid.Sdk.Api.IPersonsApiSync.UpsertPerson	(	UpsertPersonRequest	upsertPersonRequest,
		int	operationIndex = `0`
	)

[EARLY ACCESS] UpsertPerson: Upsert Person

Create or update a new person under the specified scope.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

upsertPersonRequest	Request to create or update a person.
operationIndex	Index associated with the operation.

Returns: Person

Implemented in Lusid.Sdk.Api.PersonsApi.

◆ UpsertPersonAccessMetadata()

ResourceListOfAccessMetadataValueOf Lusid.Sdk.Api.IPersonsApiSync.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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

idTypeScope	Scope of the person identifier.
idTypeCode	Code of the person identifier.
code	Code of the person under specified identifier type's scope and code.
metadataKey	Key of the metadata entry to retrieve
upsertPersonAccessMetadataRequest	The Person Access Metadata entry to upsert
effectiveAt	The effectiveAt datetime at which to upsert the Access Metadata (optional)
effectiveUntil	The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata (optional)
operationIndex	Index associated with the operation.

Returns: ResourceListOfAccessMetadataValueOf

Implemented in Lusid.Sdk.Api.PersonsApi.

◆ UpsertPersonAccessMetadataWithHttpInfo()

ApiResponse<ResourceListOfAccessMetadataValueOf> Lusid.Sdk.Api.IPersonsApiSync.UpsertPersonAccessMetadataWithHttpInfo	(	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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

idTypeScope	Scope of the person identifier.
idTypeCode	Code of the person identifier.
code	Code of the person under specified identifier type's scope and code.
metadataKey	Key of the metadata entry to retrieve
upsertPersonAccessMetadataRequest	The Person Access Metadata entry to upsert
effectiveAt	The effectiveAt datetime at which to upsert the Access Metadata (optional)
effectiveUntil	The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of ResourceListOfAccessMetadataValueOf

Implemented in Lusid.Sdk.Api.PersonsApi.

◆ UpsertPersonWithHttpInfo()

ApiResponse<Person> Lusid.Sdk.Api.IPersonsApiSync.UpsertPersonWithHttpInfo	(	UpsertPersonRequest	upsertPersonRequest,
		int	operationIndex = `0`
	)

[EARLY ACCESS] UpsertPerson: Upsert Person

Create or update a new person under the specified scope.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

upsertPersonRequest	Request to create or update a person.
operationIndex	Index associated with the operation.

Returns: ApiResponse of Person

Implemented in Lusid.Sdk.Api.PersonsApi.

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

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Api/PersonsApi.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DeletePerson()

◆ DeletePersonAccessMetadata()

◆ DeletePersonAccessMetadataWithHttpInfo()

◆ DeletePersonIdentifiers()

◆ DeletePersonIdentifiersWithHttpInfo()

◆ DeletePersonProperties()

◆ DeletePersonPropertiesWithHttpInfo()

◆ DeletePersonWithHttpInfo()

◆ GetAllPersonAccessMetadata()

◆ GetAllPersonAccessMetadataWithHttpInfo()

◆ GetPerson()

◆ GetPersonAccessMetadataByKey()

◆ GetPersonAccessMetadataByKeyWithHttpInfo()

◆ GetPersonPropertyTimeSeries()

◆ GetPersonPropertyTimeSeriesWithHttpInfo()

◆ GetPersonRelations()

◆ GetPersonRelationships()

◆ GetPersonRelationshipsWithHttpInfo()

◆ GetPersonRelationsWithHttpInfo()

◆ GetPersonWithHttpInfo()

◆ ListAllPersons()

◆ ListAllPersonsWithHttpInfo()

◆ ListPersons()

◆ ListPersonsWithHttpInfo()

◆ PatchPersonAccessMetadata()

◆ PatchPersonAccessMetadataWithHttpInfo()

◆ SetPersonIdentifiers()

◆ SetPersonIdentifiersWithHttpInfo()

◆ SetPersonProperties()

◆ SetPersonPropertiesWithHttpInfo()

◆ UpsertPerson()

◆ UpsertPersonAccessMetadata()

◆ UpsertPersonAccessMetadataWithHttpInfo()

◆ UpsertPersonWithHttpInfo()