GET Person/{id}
Some tooltip text!
• 15 minutes to read
• 15 minutes to read
GET /api/v1/Person/{id}
Gets a PersonEntity object.
Calls the Person agent service GetPersonEntity.
| Path Part | Type | Description |
|---|---|---|
| id | int32 | The id of the PersonEntity to return. Required |
Query String Parameters
| Parameter Name | Type | Description |
|---|---|---|
| $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. |
| fk | bool | Load foreign keys on this entity into the ExtraFields property as 'app.device.keyname'='123' pairs. |
GET /api/v1/Person/{id}?$select=name,department,category/id
GET /api/v1/Person/{id}?fk=False
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:
PersonEntity found.
| Response | Description |
|---|---|
| 200 | PersonEntity found. |
| 304 | PersonEntity has not changed since the requested If-Modified-Since date. |
| 404 | Not Found. |
Response body: PersonEntityWithLinks
| 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. |
| _Links | object |
Sample request
GET /api/v1/Person/{id}
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Sample response
HTTP/1.1 200 PersonEntity found.
Content-Type: application/json; charset=utf-8
Last-Modified: Sat, 12 Nov 2011 17:54:08 G11T
{
"PersonId": 546,
"Firstname": "Cheyenne",
"MiddleName": "Wehner, Brakus and Trantow",
"Lastname": "Kulas",
"Mrmrs": "iste",
"Title": "sunt",
"UpdatedDate": "2011-11-12T17:54:08.2887055+01:00",
"CreatedDate": "2010-02-28T17:54:08.2887055+01:00",
"BirthDate": "1998-10-19T17:54:08.2887055+02:00",
"CreatedBy": null,
"Emails": [
{
"Value": "assumenda",
"StrippedValue": "nihil",
"Description": "Re-engineered next generation frame",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.String",
"FieldLength": 871
}
}
},
{
"Value": "assumenda",
"StrippedValue": "nihil",
"Description": "Re-engineered next generation frame",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.String",
"FieldLength": 871
}
}
}
],
"Description": "Customizable incremental flexibility",
"IsAssociate": false,
"PrivatePhones": [
{
"Value": "sequi",
"StrippedValue": "voluptate",
"Description": "Self-enabling transitional paradigm",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 567
}
}
},
{
"Value": "sequi",
"StrippedValue": "voluptate",
"Description": "Self-enabling transitional paradigm",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 567
}
}
}
],
"Faxes": [
{
"Value": "sed",
"StrippedValue": "in",
"Description": "Automated exuding alliance",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 937
}
}
},
{
"Value": "sed",
"StrippedValue": "in",
"Description": "Automated exuding alliance",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 937
}
}
}
],
"MobilePhones": [
{
"Value": "perferendis",
"StrippedValue": "magnam",
"Description": "Versatile systemic process improvement",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 728
}
}
},
{
"Value": "perferendis",
"StrippedValue": "magnam",
"Description": "Versatile systemic process improvement",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 728
}
}
}
],
"OfficePhones": [
{
"Value": "aut",
"StrippedValue": "modi",
"Description": "Fully-configurable radical conglomeration",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 126
}
}
},
{
"Value": "aut",
"StrippedValue": "modi",
"Description": "Fully-configurable radical conglomeration",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 126
}
}
}
],
"OtherPhones": [
{
"Value": "id",
"StrippedValue": "atque",
"Description": "Persistent assymetric approach",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.String",
"FieldLength": 217
}
}
},
{
"Value": "id",
"StrippedValue": "atque",
"Description": "Persistent assymetric approach",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.String",
"FieldLength": 217
}
}
}
],
"Position": null,
"UpdatedBy": null,
"Contact": null,
"Country": null,
"Interests": [
{
"Id": 953,
"Name": "Zieme-Vandervort",
"ToolTip": "Nisi quia omnis in totam.",
"Deleted": false,
"Rank": 108,
"Type": "dignissimos",
"ColorBlock": 785,
"IconHint": "et",
"Selected": true,
"LastChanged": "2022-10-24T17:54:08.2887055+02:00",
"ChildItems": [
{},
{}
],
"ExtraInfo": "aut",
"StyleHint": "iusto",
"Hidden": false,
"FullName": "Kurtis Windler",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 115
}
}
}
],
"PersonNumber": "629998",
"FullName": "Bailey Bashirian",
"NoMailing": false,
"UsePersonAddress": false,
"Retired": false,
"Urls": [
{
"Value": "quidem",
"StrippedValue": "quasi",
"Description": "Function-based 4th generation installation",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 506
}
}
},
{
"Value": "quidem",
"StrippedValue": "quasi",
"Description": "Function-based 4th generation installation",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 506
}
}
}
],
"FormalName": "Swift Group",
"Address": null,
"Post3": "magni",
"Post2": "facilis",
"Post1": "doloremque",
"Kanalname": "nihil",
"Kanafname": "earum",
"CorrespondingAssociate": null,
"Category": null,
"Business": null,
"Associate": null,
"Salutation": "reprehenderit",
"ActiveInterests": 97,
"SupportAssociate": null,
"TicketPriority": null,
"CustomerLanguage": null,
"DbiAgentId": 324,
"DbiKey": "voluptate",
"DbiLastModified": "2015-10-26T17:54:08.2887055+01:00",
"DbiLastSyncronized": "2024-04-24T17:54:08.2887055+02:00",
"SentInfo": 789,
"ShowContactTickets": 544,
"UserInfo": null,
"ChatEmails": [
{
"Value": "voluptas",
"StrippedValue": "laborum",
"Description": "Down-sized 3rd generation portal",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.String",
"FieldLength": 285
}
}
},
{
"Value": "voluptas",
"StrippedValue": "laborum",
"Description": "Down-sized 3rd generation portal",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.String",
"FieldLength": 285
}
}
}
],
"InternetPhones": [
{
"Value": "ipsum",
"StrippedValue": "numquam",
"Description": "Quality-focused zero defect portal",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.String",
"FieldLength": 503
}
}
},
{
"Value": "ipsum",
"StrippedValue": "numquam",
"Description": "Quality-focused zero defect portal",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.String",
"FieldLength": 503
}
}
}
],
"Source": 628,
"ActiveErpLinks": 620,
"ShipmentTypes": [
{
"Id": 796,
"Name": "Stroman Inc and Sons",
"ToolTip": "Iste occaecati eius beatae rerum.",
"Deleted": true,
"Rank": 502,
"Type": "voluptatum",
"ColorBlock": 188,
"IconHint": "nihil",
"Selected": false,
"LastChanged": "2006-03-17T17:54:08.2887055+01:00",
"ChildItems": [
{},
{}
],
"ExtraInfo": "qui",
"StyleHint": "voluptates",
"Hidden": true,
"FullName": "Zola McDermott",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 96
}
}
}
],
"Consents": [
{
"ConsentPersonId": 26,
"Comment": "quod",
"Registered": "2017-08-15T17:54:08.2887055+02:00",
"RegisteredAssociateId": 212,
"Updated": "2022-09-27T17:54:08.2887055+02:00",
"UpdatedAssociateId": 1000,
"LegalBaseId": 388,
"LegalBaseKey": "et",
"LegalBaseName": "Balistreri Group",
"ConsentPurposeId": 240,
"ConsentPurposeKey": "cupiditate",
"ConsentPurposeName": "Goldner-Bode",
"ConsentSourceId": 922,
"ConsentSourceKey": "voluptate",
"ConsentSourceName": "Hackett-Murray",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 128
}
}
}
],
"BounceEmails": [
"savion@cartwright.us",
"isobel@block.info"
],
"ActiveStatusMonitorId": 591,
"CreatedByFormId": 412,
"UserDefinedFields": {
"SuperOffice:1": "Mr. Heather Lesch",
"SuperOffice:2": "765142434"
},
"ExtraFields": {
"ExtraFields1": "voluptatum",
"ExtraFields2": "sequi"
},
"CustomFields": {
"CustomFields1": "ut",
"CustomFields2": "eius"
},
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 846
}
},
"_Links": {
"Self": "https://www.example.com/api/v1/project/321",
"Archive": "https://www.example.com/api/v1/project"
}
}