POST Agents/Person/GetPersonEntity
Some tooltip text!
• 15 minutes to read
• 15 minutes to read
POST /api/v1/Agents/Person/GetPersonEntity
Gets a PersonEntity object.
Query String Parameters
| Parameter Name | Type | Description |
|---|---|---|
| personEntityId | int32 | Required The primary key. |
| $select | string | Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields. |
POST /api/v1/Agents/Person/GetPersonEntity?personEntityId=612
POST /api/v1/Agents/Person/GetPersonEntity?$select=name,department,category/id
Request Headers
| Parameter Name | Description |
|---|---|
| Authorization | Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type. |
| X-XSRF-TOKEN | If not using Authorization header, you must provide XSRF value from cookie or hidden input field |
| Accept | Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json |
| Accept-Language | Convert string references and multi-language values into a specified language (iso2) code. |
| SO-Language | Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value. |
| SO-Culture | Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set. |
| SO-TimeZone | Specify the timezone code that you would like date/time responses converted to. |
| SO-AppToken | The application token that identifies the partner app. Used when calling Online WebAPI from a server. |
Response:
OK
| Response | Description |
|---|---|
| 200 | OK |
Response body: PersonEntity
| Property Name | Type | Description |
|---|---|---|
| PersonId | int32 | Primary key |
| Firstname | string | First name |
| MiddleName | string | Middle name or 'van' etc. |
| Lastname | string | Last name |
| Mrmrs | string | e.g. Mrs sex_title Use MDO List name "mrmrs" to get list items. |
| Title | string | Title |
| UpdatedDate | date-time | Last updated date in UTC. |
| CreatedDate | date-time | Registered date in UTC. |
| BirthDate | date-time | The Person birth date as UTC Date. Year 1 = Null. Year 2 = unknown year. |
| CreatedBy | Associate | The user that created the person object |
| Emails | array | A collection of the person's emails |
| Description | string | The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases |
| IsAssociate | bool | Checks if the person object is an associate. The property is read-only. |
| PrivatePhones | array | Returns a collection of phone numbers that belong to the contact person. |
| Faxes | array | Returns a collection of fax numbers that belong to the contact person. |
| MobilePhones | array | Returns a collection of mobile phone numbers that belong to the contact person. |
| OfficePhones | array | Returns a collection of office phone numbers that belong to the contact person. |
| OtherPhones | array | Returns a collection of pagers that belong to the contact person. |
| Position | Position | The position. This is a predefined SuperOffice value, different from Title Use MDO List name "perspos" to get list items. |
| UpdatedBy | Associate | The person that last updated the person object |
| Contact | Contact | The contact the contact person is registered on. This is required unless the 'MandatoryContactOnPerson' preference is set. Use MDO List name "contact_new" to get list items. |
| Country | Country | The country this contact person is located in. Use MDO List name "country" to get list items. |
| Interests | array | The person's available and selected interests. Use MDO List name "persint" to get list items. |
| PersonNumber | string | Alphanumeric user field |
| FullName | string | The person's full name localized to the current culture/country. (internal name used in clients for employees) |
| NoMailing | bool | Spam filter. Indicates if this person should retrieve advertising. |
| UsePersonAddress | bool | True if the person's address should be used as mailing address, instead of the contact's address. |
| Retired | bool | True if the user is retired and should have no rights, not appear in lists, etc. |
| Urls | array | The urls related to this person. |
| FormalName | string | Get formal name for a person, as used in labels. (Full name + person title + academic title) |
| Address | Address | Structure holding formatted address data. The layout of the array structure indicates the layout of the localized address. |
| Post3 | string | Postal address, used in Japanese versions only |
| Post2 | string | Postal address, used in Japanese versions only |
| Post1 | string | Postal address, used in Japanese versions only |
| Kanalname | string | Kana last name, used in Japanese versions only |
| Kanafname | string | Kana first name, used in Japanese versions only |
| CorrespondingAssociate | Associate | The associate corresponding to this person. Will be empty if the person is not a user (internal associate user, external user). |
| Category | Category | Person's category. Usually null. Refer to the Contact.Category instead. Intended for use when individual persons are created. (i.e. when Person.Contact is blank) Use MDO List name "category" to get list items. |
| Business | Business | Person's business - usually blank. Use Contact.Business instead. Intended for use when individual persons are created. (i.e. when Person.Contact is blank) Use MDO List name "business" to get list items. |
| Associate | Associate | The associate owning this person (similar to contact.Associate) - usually blank. Use the Person.Contact.Associate instead. Intended for use when individual persons are created (i.e. when Person.Contact is blank) Use MDO List name "associate" to get list items. |
| Salutation | string | Academic title, populated from Salutation list but can be overwritten with anything at all Use MDO List name "salutation" to get list items. |
| ActiveInterests | int32 | The number of active interests. |
| SupportAssociate | Associate | Use MDO List name "associate" to get list items. |
| TicketPriority | TicketPriority | Use MDO List name "ticketpriority" to get list items. |
| CustomerLanguage | CustomerLanguage | Use MDO List name "customerlanguage" to get list items. |
| DbiAgentId | int32 | Integration agent (eJournal) |
| DbiKey | string | The primary key for the integrated entry in the external datasource. |
| DbiLastModified | date-time | When the entry was last modified. |
| DbiLastSyncronized | date-time | Last external syncronization. |
| SentInfo | int32 | Has information on username/password been sent (ejournal) |
| ShowContactTickets | int32 | Should tickets related to the company be shown to this person |
| UserInfo | UserInfo | Information about the user if this person is a user. If IsAssociate (e.g. is user is true) the UserInfo will be provided. |
| ChatEmails | array | |
| InternetPhones | array | |
| Source | int32 | How did we get this person? For future integration needs |
| ActiveErpLinks | int32 | How many active ERP links are there for this person? |
| ShipmentTypes | array | The person's available and selected shipment types. |
| Consents | array | The person's available consent information. Missing consents are not deleted. To remove a consent, mark its legalbase as 'WITHDRAWN' |
| BounceEmails | array | Email addresses with a positive bounce counter. |
| ActiveStatusMonitorId | int32 | Active status monitor identity with the lowest rank for person |
| CreatedByFormId | int32 | The form id of the form that created the person |
| UserDefinedFields | object | Deprecated: Use {SuperOffice.CRM.Services.PersonEntity.CustomFields} instead. Dictionary of user defined field data. The key string is the ProgId of the UdefField, or if the ProgId is empty it is a string of the format "SuperOffice:[UdefFieldIdentity]", e.g. "SuperOffice:1234" |
| ExtraFields | object | Deprecated: Use {SuperOffice.CRM.Services.PersonEntity.CustomFields} instead. Extra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc. |
| CustomFields | object | Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin. Custom fields combines user defined fields and extra fields into one bucket. The individual {SuperOffice.CRM.Services.PersonEntity.ExtraFields} and UserDefinedFields properties are deprecated in favor of this combined collection. |
| TableRight | TableRight | The carrier's table right |
| FieldProperties | object | Field property dictionary mapping field names to field access rights. |
Sample request
POST /api/v1/Agents/Person/GetPersonEntity
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: fr,de,ru,zh
Sample response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"PersonId": 936,
"Firstname": "Bernard",
"MiddleName": "Ryan Inc and Sons",
"Lastname": "Stokes",
"Mrmrs": "dolorem",
"Title": "consequatur",
"UpdatedDate": "2017-10-15T13:14:00.7668747+02:00",
"CreatedDate": "2004-03-06T13:14:00.7668747+01:00",
"BirthDate": "2009-10-18T13:14:00.7668747+02:00",
"CreatedBy": null,
"Emails": [
{
"Value": "reprehenderit",
"StrippedValue": "est",
"Description": "Polarised fault-tolerant emulation",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.String",
"FieldLength": 501
}
}
},
{
"Value": "reprehenderit",
"StrippedValue": "est",
"Description": "Polarised fault-tolerant emulation",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.String",
"FieldLength": 501
}
}
}
],
"Description": "Synchronised motivating project",
"IsAssociate": true,
"PrivatePhones": [
{
"Value": "commodi",
"StrippedValue": "aut",
"Description": "Cloned encompassing artificial intelligence",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 437
}
}
},
{
"Value": "commodi",
"StrippedValue": "aut",
"Description": "Cloned encompassing artificial intelligence",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 437
}
}
}
],
"Faxes": [
{
"Value": "quae",
"StrippedValue": "reprehenderit",
"Description": "Realigned interactive task-force",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 533
}
}
},
{
"Value": "quae",
"StrippedValue": "reprehenderit",
"Description": "Realigned interactive task-force",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 533
}
}
}
],
"MobilePhones": [
{
"Value": "eveniet",
"StrippedValue": "repudiandae",
"Description": "Streamlined value-added Graphic Interface",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.String",
"FieldLength": 300
}
}
},
{
"Value": "eveniet",
"StrippedValue": "repudiandae",
"Description": "Streamlined value-added Graphic Interface",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.String",
"FieldLength": 300
}
}
}
],
"OfficePhones": [
{
"Value": "rerum",
"StrippedValue": "nobis",
"Description": "Multi-tiered systemic throughput",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 73
}
}
},
{
"Value": "rerum",
"StrippedValue": "nobis",
"Description": "Multi-tiered systemic throughput",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 73
}
}
}
],
"OtherPhones": [
{
"Value": "ut",
"StrippedValue": "nesciunt",
"Description": "Centralized 24/7 core",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 919
}
}
},
{
"Value": "ut",
"StrippedValue": "nesciunt",
"Description": "Centralized 24/7 core",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 919
}
}
}
],
"Position": null,
"UpdatedBy": null,
"Contact": null,
"Country": null,
"Interests": [
{
"Id": 801,
"Name": "Roob-Kerluke",
"ToolTip": "A cum eius voluptatem sint nisi ad voluptatem.",
"Deleted": true,
"Rank": 303,
"Type": "enim",
"ColorBlock": 808,
"IconHint": "quaerat",
"Selected": true,
"LastChanged": "2014-09-08T13:14:00.7668747+02:00",
"ChildItems": [
{},
{}
],
"ExtraInfo": "quasi",
"StyleHint": "voluptatum",
"Hidden": false,
"FullName": "Dr. Sally Darrel Kreiger",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.String",
"FieldLength": 301
}
}
}
],
"PersonNumber": "637344",
"FullName": "Leonie Skiles",
"NoMailing": true,
"UsePersonAddress": false,
"Retired": true,
"Urls": [
{
"Value": "omnis",
"StrippedValue": "non",
"Description": "Profit-focused impactful middleware",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 522
}
}
},
{
"Value": "omnis",
"StrippedValue": "non",
"Description": "Profit-focused impactful middleware",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 522
}
}
}
],
"FormalName": "Rau Inc and Sons",
"Address": null,
"Post3": "dolor",
"Post2": "asperiores",
"Post1": "dolore",
"Kanalname": "ea",
"Kanafname": "velit",
"CorrespondingAssociate": null,
"Category": null,
"Business": null,
"Associate": null,
"Salutation": "sapiente",
"ActiveInterests": 199,
"SupportAssociate": null,
"TicketPriority": null,
"CustomerLanguage": null,
"DbiAgentId": 20,
"DbiKey": "sapiente",
"DbiLastModified": "2014-03-08T13:14:00.7668747+01:00",
"DbiLastSyncronized": "2016-09-07T13:14:00.7668747+02:00",
"SentInfo": 958,
"ShowContactTickets": 673,
"UserInfo": null,
"ChatEmails": [
{
"Value": "similique",
"StrippedValue": "nostrum",
"Description": "Extended dynamic policy",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 758
}
}
},
{
"Value": "similique",
"StrippedValue": "nostrum",
"Description": "Extended dynamic policy",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 758
}
}
}
],
"InternetPhones": [
{
"Value": "accusantium",
"StrippedValue": "quas",
"Description": "Inverse 3rd generation policy",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 194
}
}
},
{
"Value": "accusantium",
"StrippedValue": "quas",
"Description": "Inverse 3rd generation policy",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 194
}
}
}
],
"Source": 408,
"ActiveErpLinks": 323,
"ShipmentTypes": [
{
"Id": 546,
"Name": "Kuphal Group",
"ToolTip": "Voluptatem qui magnam.",
"Deleted": false,
"Rank": 463,
"Type": "quia",
"ColorBlock": 914,
"IconHint": "accusantium",
"Selected": true,
"LastChanged": "2008-09-06T13:14:00.7668747+02:00",
"ChildItems": [
{},
{}
],
"ExtraInfo": "voluptas",
"StyleHint": "nihil",
"Hidden": true,
"FullName": "Ms. Warren Lolita Boyle I",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 892
}
}
}
],
"Consents": [
{
"ConsentPersonId": 788,
"Comment": "hic",
"Registered": "2025-01-11T13:14:00.7668747+01:00",
"RegisteredAssociateId": 145,
"Updated": "2024-06-27T13:14:00.7668747+02:00",
"UpdatedAssociateId": 187,
"LegalBaseId": 247,
"LegalBaseKey": "optio",
"LegalBaseName": "Durgan, Marquardt and Lueilwitz",
"ConsentPurposeId": 797,
"ConsentPurposeKey": "asperiores",
"ConsentPurposeName": "Hilll-Kunde",
"ConsentSourceId": 202,
"ConsentSourceKey": "sapiente",
"ConsentSourceName": "Swift-Aufderhar",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 557
}
}
}
],
"BounceEmails": [
"retta@predovic.uk",
"alvena@braunkoch.uk"
],
"ActiveStatusMonitorId": 497,
"CreatedByFormId": 943,
"UserDefinedFields": {
"SuperOffice:1": "Josiah Hermiston",
"SuperOffice:2": "Prof. Roger Flatley III"
},
"ExtraFields": {
"ExtraFields1": "accusantium",
"ExtraFields2": "debitis"
},
"CustomFields": {
"CustomFields1": "a",
"CustomFields2": "consequatur"
},
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.String",
"FieldLength": 695
}
}
}