Lusid.Sdk.Model.TypedResourceId Class Reference

Represents the user-defined identifier for a Legal Entity or Person. Users can define their own, scoped identifiers for Legal Entities and Persons using identifier properties. For example, when used to identify a Person, the identifier defined by Person/myScope/username would be represented as { "idTypeScope": "myScope", "idTypeCode": "username", "code": "john_doe_001" } More...

Inheritance diagram for Lusid.Sdk.Model.TypedResourceId:

Public Member Functions
	TypedResourceId (string idTypeScope=default(string), string idTypeCode=default(string), string code=default(string))
	Initializes a new instance of the TypedResourceId class. More...
override string	ToString ()
	Returns the string presentation of the object More...
virtual string	ToJson ()
	Returns the JSON string presentation of the object More...
override bool	Equals (object input)
	Returns true if objects are equal More...
bool	Equals (TypedResourceId input)
	Returns true if TypedResourceId instances are equal More...
override int	GetHashCode ()
	Gets the hash code More...

Protected Member Functions
	TypedResourceId ()
	Initializes a new instance of the TypedResourceId class. More...

Properties
string	IdTypeScope [get, set]
	The scope of the identifier's (property) definition. More...
string	IdTypeCode [get, set]
	The code of identifier's (property) definition. This describes what the identifier represents. For a Person this might be a username, nationalInsuranceNumber or similar. For a Legal Entity, this might be a registeredCompanyNumber or LEI. More...
string	Code [get, set]
	The value of the user-defined identifier in respect of the entity. More...

Detailed Description

Represents the user-defined identifier for a Legal Entity or Person. Users can define their own, scoped identifiers for Legal Entities and Persons using identifier properties. For example, when used to identify a Person, the identifier defined by Person/myScope/username would be represented as { "idTypeScope": "myScope", "idTypeCode": "username", "code": "john_doe_001" }

Constructor & Destructor Documentation

TypedResourceId() [1/2]

Lusid.Sdk.Model.TypedResourceId.TypedResourceId ( )

inlineprotected

Initializes a new instance of the TypedResourceId class.

TypedResourceId() [2/2]

Lusid.Sdk.Model.TypedResourceId.TypedResourceId ( string  idTypeScope = default(string), string  idTypeCode = default(string), string  code = default(string)  )

inline

Initializes a new instance of the TypedResourceId class.

Parameters

idTypeScope	The scope of the identifier's (property) definition. (required).
idTypeCode	The code of identifier's (property) definition. This describes what the identifier represents. For a Person this might be a username, nationalInsuranceNumber or similar. For a Legal Entity, this might be a registeredCompanyNumber or LEI. (required).
code	The value of the user-defined identifier in respect of the entity. (required).

Member Function Documentation

Equals() [1/2]

override bool Lusid.Sdk.Model.TypedResourceId.Equals ( object  input )

inline

Returns true if objects are equal

Parameters

input

Object to be compared

Returns

Boolean

Equals() [2/2]

bool Lusid.Sdk.Model.TypedResourceId.Equals ( TypedResourceId  input )

inline

Returns true if TypedResourceId instances are equal

Parameters

input

Instance of TypedResourceId to be compared

Returns

Boolean

GetHashCode()

override int Lusid.Sdk.Model.TypedResourceId.GetHashCode ( )

inline

Gets the hash code

Returns

Hash code

ToJson()

virtual string Lusid.Sdk.Model.TypedResourceId.ToJson ( )

inlinevirtual

Returns the JSON string presentation of the object

Returns

JSON string presentation of the object

ToString()

override string Lusid.Sdk.Model.TypedResourceId.ToString ( )

inline

Returns the string presentation of the object

Returns

String presentation of the object

Property Documentation

Code

string Lusid.Sdk.Model.TypedResourceId.Code

getset

The value of the user-defined identifier in respect of the entity.

The value of the user-defined identifier in respect of the entity.

IdTypeCode

string Lusid.Sdk.Model.TypedResourceId.IdTypeCode

getset

The code of identifier's (property) definition. This describes what the identifier represents. For a Person this might be a username, nationalInsuranceNumber or similar. For a Legal Entity, this might be a registeredCompanyNumber or LEI.

The code of identifier's (property) definition. This describes what the identifier represents. For a Person this might be a username, nationalInsuranceNumber or similar. For a Legal Entity, this might be a registeredCompanyNumber or LEI.

IdTypeScope

string Lusid.Sdk.Model.TypedResourceId.IdTypeScope

getset

The scope of the identifier's (property) definition.

The scope of the identifier's (property) definition.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Model/TypedResourceId.cs