{"openapi":"3.0.4","info":{"title":"Get Person","description":"Retrieve the definition of a person.","version":"0.0.1"},"servers":[{"url":"https://fbn-prd.lusid.com/api"}],"paths":{"/api/persons/{idTypeScope}/{idTypeCode}/{code}":{"get":{"tags":["Persons"],"summary":"Get Person","description":"Retrieve the definition of a person.","operationId":"GetPerson","parameters":[{"name":"idTypeScope","in":"path","description":"Scope of the person identifier type.","required":true,"schema":{"type":"string","readOnly":true}},{"name":"idTypeCode","in":"path","description":"Code of the person identifier type.","required":true,"schema":{"type":"string"}},{"name":"code","in":"path","description":"Code of the person under specified scope and code. This together with stated identifier type uniquely\r\n            identifies the person.","required":true,"schema":{"maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_]+$","type":"string"}},{"name":"propertyKeys","in":"query","description":"A list of property keys from the \"Person\" domain to decorate onto the person, \r\n            or from any domain that supports relationships to decorate onto related entities.\r\n            These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".","schema":{"type":"array","items":{"type":"string","description":"The key that uniquely identifies the property. It has the format {domain}/{scope}/{code}."}},"x-nullable":true},{"name":"effectiveAt","in":"query","description":"The effective datetime or cut label at which to retrieve the person. Defaults to the current LUSID system datetime if not specified.","schema":{"type":"string","format":"dateorcutlabel"}},{"name":"asAt","in":"query","description":"The asAt datetime at which to retrieve the person. Defaults to return the latest version of the person if not specified.","schema":{"type":"string","format":"date-time"},"x-nullable":true},{"name":"relationshipDefinitionIds","in":"query","description":"A list of relationship definitions that are used to decorate related entities\r\n            onto the person in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.","schema":{"type":"array","items":{"type":"string","description":"Identifiers of an entity"}},"x-nullable":true}],"responses":{"200":{"description":"The requested person definition","content":{"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/Person"},"example":{"displayName":"Person1DisplayName","description":"Person1Description","href":"https://example.com","lusidPersonId":"LUID_00003D4V","identifiers":{"Person/HrSystem1/InternalId":{"key":"Person/HrSystem1/InternalId","value":{"labelValue":"XY10001111"}},"Person/PayrollSystem1/Id":{"key":"Person/PayrollSystem1/Id","value":{"labelValue":"HSI3453456"}},"Person/CompanyIntranet/LoginId":{"key":"Person/CompanyIntranet/LoginId","value":{"labelValue":"johnsmith001"}}},"properties":{"Person/PersonalDetails/Name":{"key":"Person/PersonalDetails/Name","value":{"labelValue":"John Smith"}},"Person/CompanyDetails/Role":{"key":"Person/CompanyDetails/Role","value":{"labelValueSet":{"values":["SalesRepresentative","CustomerServiceRepresentative"]}},"effectiveFrom":"2016-07-01T00:00:00.0000000+00:00"}},"relationships":[],"version":{"effectiveFrom":"2019-01-01T12:00:00.0000000+00:00","asAtDate":"2019-01-01T12:00:00.0100000+00:00","asAtCreated":"2019-01-01T12:00:00.0100000+00:00","userIdCreated":"UserId1","requestIdCreated":"RequestId1","reasonCreated":"","asAtModified":"2019-01-01T12:00:00.0100000+00:00","userIdModified":"UserId1","requestIdModified":"RequestId2","reasonModified":"","asAtVersionNumber":1,"entityUniqueId":"67cd5403-60d3-4744-8455-c4522a3886cb"}}},"text/plain":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/Person"},"example":{"displayName":"Person1DisplayName","description":"Person1Description","href":"https://example.com","lusidPersonId":"LUID_00003D4V","identifiers":{"Person/HrSystem1/InternalId":{"key":"Person/HrSystem1/InternalId","value":{"labelValue":"XY10001111"}},"Person/PayrollSystem1/Id":{"key":"Person/PayrollSystem1/Id","value":{"labelValue":"HSI3453456"}},"Person/CompanyIntranet/LoginId":{"key":"Person/CompanyIntranet/LoginId","value":{"labelValue":"johnsmith001"}}},"properties":{"Person/PersonalDetails/Name":{"key":"Person/PersonalDetails/Name","value":{"labelValue":"John Smith"}},"Person/CompanyDetails/Role":{"key":"Person/CompanyDetails/Role","value":{"labelValueSet":{"values":["SalesRepresentative","CustomerServiceRepresentative"]}},"effectiveFrom":"2016-07-01T00:00:00.0000000+00:00"}},"relationships":[],"version":{"effectiveFrom":"2019-01-01T12:00:00.0000000+00:00","asAtDate":"2019-01-01T12:00:00.0100000+00:00","asAtCreated":"2019-01-01T12:00:00.0100000+00:00","userIdCreated":"UserId1","requestIdCreated":"RequestId1","reasonCreated":"","asAtModified":"2019-01-01T12:00:00.0100000+00:00","userIdModified":"UserId1","requestIdModified":"RequestId2","reasonModified":"","asAtVersionNumber":1,"entityUniqueId":"67cd5403-60d3-4744-8455-c4522a3886cb"}}},"text/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/Person"},"example":{"displayName":"Person1DisplayName","description":"Person1Description","href":"https://example.com","lusidPersonId":"LUID_00003D4V","identifiers":{"Person/HrSystem1/InternalId":{"key":"Person/HrSystem1/InternalId","value":{"labelValue":"XY10001111"}},"Person/PayrollSystem1/Id":{"key":"Person/PayrollSystem1/Id","value":{"labelValue":"HSI3453456"}},"Person/CompanyIntranet/LoginId":{"key":"Person/CompanyIntranet/LoginId","value":{"labelValue":"johnsmith001"}}},"properties":{"Person/PersonalDetails/Name":{"key":"Person/PersonalDetails/Name","value":{"labelValue":"John Smith"}},"Person/CompanyDetails/Role":{"key":"Person/CompanyDetails/Role","value":{"labelValueSet":{"values":["SalesRepresentative","CustomerServiceRepresentative"]}},"effectiveFrom":"2016-07-01T00:00:00.0000000+00:00"}},"relationships":[],"version":{"effectiveFrom":"2019-01-01T12:00:00.0000000+00:00","asAtDate":"2019-01-01T12:00:00.0100000+00:00","asAtCreated":"2019-01-01T12:00:00.0100000+00:00","userIdCreated":"UserId1","requestIdCreated":"RequestId1","reasonCreated":"","asAtModified":"2019-01-01T12:00:00.0100000+00:00","userIdModified":"UserId1","requestIdModified":"RequestId2","reasonModified":"","asAtVersionNumber":1,"entityUniqueId":"67cd5403-60d3-4744-8455-c4522a3886cb"}}}}},"400":{"description":"The details of the input related failure","content":{"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/LusidValidationProblemDetails"}},"text/plain":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/LusidValidationProblemDetails"}},"text/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/LusidValidationProblemDetails"}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/LusidProblemDetails"}}}}},"security":[{"BearerAuth":[]}],"x-fbn-apistatus":"EarlyAccess"}}},"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}}}