> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SuperOffice.WebApi.Data.Person

# <a id="SuperOffice_WebApi_Data_Person" /> Class Person

Namespace: [SuperOffice.WebApi.Data](SuperOffice.WebApi.Data.md)\
Assembly: SuperOffice.WebApi.dll

Carrier object for Person.

```csharp theme={null}
public class Person : Carrier
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Carrier](SuperOffice.WebApi.Data.Carrier.md) ←
[Person](SuperOffice.WebApi.Data.Person.md)

#### Inherited Members

[Carrier.TableRight](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_TableRight),
[Carrier.FieldProperties](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_FieldProperties),
[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring),
[object.Equals(object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object\)),
[object.Equals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object-system-object\)),
[object.ReferenceEquals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone)

## Examples

Get Person 123 using the WebApi client:
<pre><code class="lang-csharp">var configuration = new WebApiConfiguration(url);
var agent = new PersonAgent(configuration);
var person = agent.GetPerson( 123 );</code></pre>

## Constructors

### <a id="SuperOffice_WebApi_Data_Person__ctor" /> Person()

Default constructor - defaults any enum props to 0.

```csharp theme={null}
public Person()
```

## Properties

### <a id="SuperOffice_WebApi_Data_Person_ActiveErpLinks" /> ActiveErpLinks

How many active ERP links are there for this person?

```csharp theme={null}
public virtual int ActiveErpLinks { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_Person_ActiveInterests" /> ActiveInterests

Number of records in pintr table; select count(\*) from pintr pi where pi.person\_id = this.person\_id == activeInterests is always true

```csharp theme={null}
public virtual short ActiveInterests { get; set; }
```

#### Property Value

[short](https://learn.microsoft.com/dotnet/api/system.int16)

### <a id="SuperOffice_WebApi_Data_Person_AssociateId" /> AssociateId

Id of the item's owner (Associate id)

```csharp theme={null}
public virtual int AssociateId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_Person_AssociateName" /> AssociateName

Name of the person's owner

```csharp theme={null}
public virtual string AssociateName { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_Person_CategoryName" /> CategoryName

The category list item name

```csharp theme={null}
public virtual string CategoryName { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_Person_ContactCountryId" /> ContactCountryId

The persons contact country id

```csharp theme={null}
public virtual int ContactCountryId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_Person_ContactDepartment" /> ContactDepartment

The persons contact department

```csharp theme={null}
public virtual string ContactDepartment { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_Person_ContactFax" /> ContactFax

Actual phone number as eneterd by the user

```csharp theme={null}
public virtual string ContactFax { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_Person_ContactFullName" /> ContactFullName

Company full name + department

```csharp theme={null}
public virtual string ContactFullName { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_Person_ContactId" /> ContactId

Owning contact ID

```csharp theme={null}
public virtual int ContactId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_Person_ContactName" /> ContactName

The persons company name

```csharp theme={null}
public virtual string ContactName { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_Person_ContactOrgNr" /> ContactOrgNr

The persons contact organization number

```csharp theme={null}
public virtual string ContactOrgNr { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_Person_ContactPhone" /> ContactPhone

Returns the direct phone that belong to the persons contact.

```csharp theme={null}
public virtual string ContactPhone { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_Person_CountryId" /> CountryId

Country

```csharp theme={null}
public virtual int CountryId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_Person_Description" /> Description

Info text/description on person.

```csharp theme={null}
public virtual string Description { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_Person_DirectPhone" /> DirectPhone

Returns the direct phone that belong to the contact person.

```csharp theme={null}
public virtual string DirectPhone { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_Person_Email" /> Email

First email on contact person.

```csharp theme={null}
public virtual string Email { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_Person_EmailName" /> EmailName

E-mail description

```csharp theme={null}
public virtual string EmailName { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_Person_FaxPhone" /> FaxPhone

Returns the fax phone that belong to the contact person.

```csharp theme={null}
public virtual string FaxPhone { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_Person_Firstname" /> Firstname

First name

```csharp theme={null}
public virtual string Firstname { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_Person_FormalName" /> FormalName

Get formal name for a person, as used in labels. (Full name + person title + academic title)

```csharp theme={null}
public virtual string FormalName { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_Person_FullName" /> FullName

Get the persons full name (internal name used in clients for employees).

```csharp theme={null}
public virtual string FullName { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_Person_Kanafname" /> Kanafname

Kana first name, used in Japanese versions only

```csharp theme={null}
public virtual string Kanafname { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_Person_Kanalname" /> Kanalname

Kana last name, used in Japanese versions only

```csharp theme={null}
public virtual string Kanalname { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_Person_Lastname" /> Lastname

Last name

```csharp theme={null}
public virtual string Lastname { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_Person_MiddleName" /> MiddleName

Middle name or 'van' etc.

```csharp theme={null}
public virtual string MiddleName { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_Person_MobilePhone" /> MobilePhone

Returns the mobile phone that belong to the contact person.

```csharp theme={null}
public virtual string MobilePhone { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_Person_Mrmrs" /> Mrmrs

e.g. Mrs   sex\_title

```csharp theme={null}
public virtual string Mrmrs { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_Person_PersonId" /> PersonId

Primary key

```csharp theme={null}
public virtual int PersonId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_Person_PersonNumber" /> PersonNumber

Alphanumeric user field

```csharp theme={null}
public virtual string PersonNumber { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_Person_Position" /> Position

The position. This is a predefined SuperOffice value, different from Title

```csharp theme={null}
public virtual string Position { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_Person_Post1" /> Post1

Postal address, used in Japanese versions only

```csharp theme={null}
public virtual string Post1 { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_Person_Post2" /> Post2

Postal address, used in Japanese versions only

```csharp theme={null}
public virtual string Post2 { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_Person_Post3" /> Post3

Postal address, used in Japanese versions only

```csharp theme={null}
public virtual string Post3 { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_Person_Rank" /> Rank

Display sort sequence for default sort order

```csharp theme={null}
public virtual short Rank { get; set; }
```

#### Property Value

[short](https://learn.microsoft.com/dotnet/api/system.int16)

### <a id="SuperOffice_WebApi_Data_Person_Retired" /> Retired

1 = the user is retired and should have no rights, not appear in lists, etc.

```csharp theme={null}
public virtual short Retired { get; set; }
```

#### Property Value

[short](https://learn.microsoft.com/dotnet/api/system.int16)

### <a id="SuperOffice_WebApi_Data_Person_SupportAssociateId" /> SupportAssociateId

Our support contact for this person

```csharp theme={null}
public virtual int SupportAssociateId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_Person_SupportLanguageId" /> SupportLanguageId

Support priority ID

```csharp theme={null}
public virtual int SupportLanguageId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_Person_TicketPriorityId" /> TicketPriorityId

Ticket priority ID

```csharp theme={null}
public virtual int TicketPriorityId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_Person_Title" /> Title

Title

```csharp theme={null}
public virtual string Title { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_Person_UsePersonAddress" /> UsePersonAddress

If 1, use person's address for mailing instead of company address

```csharp theme={null}
public virtual bool UsePersonAddress { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

## See Also

[PersonAgent](SuperOffice.WebApi.Agents.PersonAgent.md)


## Related topics

- [SuperOffice.WebApi.Data.PersonEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.PersonEntity.md)
- [SuperOffice.WebApi.Data.PersonImage](/en/api/reference/webapi/SuperOffice.WebApi.Data.PersonImage.md)
- [SuperOffice.WebApi.Agents.AIAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.AIAgent.md)
- [SuperOffice.WebApi.Agents.IAIAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IAIAgent.md)
- [SuperOffice.WebApi.Data.PersonSummary](/en/api/reference/webapi/SuperOffice.WebApi.Data.PersonSummary.md)
- [SuperOffice.WebApi.Data.Person ResolvePersonFromInfoRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Person_ResolvePersonFromInfoRequest.md)