POST Agents/Person/CreateDefaultPersonEntity

Some tooltip text!

• 14 minutes to read

 • 14 minutes to read

POST /api/v1/Agents/Person/CreateDefaultPersonEntity

Set default values into a new PersonEntity.

NetServer calculates default values on the entity, which is required when creating/storing a new instance

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/CreateDefaultPersonEntity
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: *

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "PersonId": 72,
  "Firstname": "Kelly",
  "MiddleName": "Zboncak, Ernser and Mertz",
  "Lastname": "Fisher",
  "Mrmrs": "et",
  "Title": "occaecati",
  "UpdatedDate": "2003-10-23T03:45:23.654826+02:00",
  "CreatedDate": "2002-05-29T03:45:23.654826+02:00",
  "BirthDate": "1999-10-16T03:45:23.654826+02:00",
  "CreatedBy": null,
  "Emails": [
    {
      "Value": "id",
      "StrippedValue": "ipsum",
      "Description": "Self-enabling zero tolerance open architecture",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 693
        }
      }
    },
    {
      "Value": "id",
      "StrippedValue": "ipsum",
      "Description": "Self-enabling zero tolerance open architecture",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 693
        }
      }
    }
  ],
  "Description": "Networked local superstructure",
  "IsAssociate": false,
  "PrivatePhones": [
    {
      "Value": "tempore",
      "StrippedValue": "corporis",
      "Description": "Adaptive logistical flexibility",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 612
        }
      }
    },
    {
      "Value": "tempore",
      "StrippedValue": "corporis",
      "Description": "Adaptive logistical flexibility",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 612
        }
      }
    }
  ],
  "Faxes": [
    {
      "Value": "alias",
      "StrippedValue": "recusandae",
      "Description": "Enterprise-wide assymetric architecture",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.String",
          "FieldLength": 998
        }
      }
    },
    {
      "Value": "alias",
      "StrippedValue": "recusandae",
      "Description": "Enterprise-wide assymetric architecture",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.String",
          "FieldLength": 998
        }
      }
    }
  ],
  "MobilePhones": [
    {
      "Value": "quia",
      "StrippedValue": "facere",
      "Description": "Multi-layered clear-thinking budgetary management",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 899
        }
      }
    },
    {
      "Value": "quia",
      "StrippedValue": "facere",
      "Description": "Multi-layered clear-thinking budgetary management",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 899
        }
      }
    }
  ],
  "OfficePhones": [
    {
      "Value": "a",
      "StrippedValue": "natus",
      "Description": "Robust bifurcated challenge",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.String",
          "FieldLength": 668
        }
      }
    },
    {
      "Value": "a",
      "StrippedValue": "natus",
      "Description": "Robust bifurcated challenge",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.String",
          "FieldLength": 668
        }
      }
    }
  ],
  "OtherPhones": [
    {
      "Value": "molestiae",
      "StrippedValue": "incidunt",
      "Description": "Fully-configurable local standardization",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 634
        }
      }
    },
    {
      "Value": "molestiae",
      "StrippedValue": "incidunt",
      "Description": "Fully-configurable local standardization",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 634
        }
      }
    }
  ],
  "Position": null,
  "UpdatedBy": null,
  "Contact": null,
  "Country": null,
  "Interests": [
    {
      "Id": 487,
      "Name": "Stark LLC",
      "ToolTip": "Recusandae ipsum itaque a est.",
      "Deleted": false,
      "Rank": 574,
      "Type": "eligendi",
      "ColorBlock": 179,
      "IconHint": "est",
      "Selected": false,
      "LastChanged": "2010-06-25T03:45:23.654826+02:00",
      "ChildItems": [
        {},
        {}
      ],
      "ExtraInfo": "nesciunt",
      "StyleHint": "libero",
      "Hidden": false,
      "FullName": "Miss Ariel Alejandrin Haley",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 736
        }
      }
    }
  ],
  "PersonNumber": "1053822",
  "FullName": "Sam Keeling",
  "NoMailing": false,
  "UsePersonAddress": false,
  "Retired": false,
  "Urls": [
    {
      "Value": "nulla",
      "StrippedValue": "et",
      "Description": "Open-architected actuating projection",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 723
        }
      }
    },
    {
      "Value": "nulla",
      "StrippedValue": "et",
      "Description": "Open-architected actuating projection",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 723
        }
      }
    }
  ],
  "FormalName": "Ortiz Inc and Sons",
  "Address": null,
  "Post3": "tenetur",
  "Post2": "ut",
  "Post1": "possimus",
  "Kanalname": "autem",
  "Kanafname": "omnis",
  "CorrespondingAssociate": null,
  "Category": null,
  "Business": null,
  "Associate": null,
  "Salutation": "in",
  "ActiveInterests": 138,
  "SupportAssociate": null,
  "TicketPriority": null,
  "CustomerLanguage": null,
  "DbiAgentId": 612,
  "DbiKey": "quia",
  "DbiLastModified": "2023-05-18T03:45:23.654826+02:00",
  "DbiLastSyncronized": "2022-03-07T03:45:23.654826+01:00",
  "SentInfo": 419,
  "ShowContactTickets": 960,
  "UserInfo": null,
  "ChatEmails": [
    {
      "Value": "et",
      "StrippedValue": "deleniti",
      "Description": "Decentralized coherent hardware",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 559
        }
      }
    },
    {
      "Value": "et",
      "StrippedValue": "deleniti",
      "Description": "Decentralized coherent hardware",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 559
        }
      }
    }
  ],
  "InternetPhones": [
    {
      "Value": "vero",
      "StrippedValue": "aut",
      "Description": "Versatile solution-oriented info-mediaries",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 643
        }
      }
    },
    {
      "Value": "vero",
      "StrippedValue": "aut",
      "Description": "Versatile solution-oriented info-mediaries",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 643
        }
      }
    }
  ],
  "Source": 290,
  "ActiveErpLinks": 938,
  "ShipmentTypes": [
    {
      "Id": 550,
      "Name": "Bartoletti-Heaney",
      "ToolTip": "Placeat maiores aliquam in.",
      "Deleted": true,
      "Rank": 403,
      "Type": "impedit",
      "ColorBlock": 380,
      "IconHint": "quaerat",
      "Selected": true,
      "LastChanged": "1999-02-10T03:45:23.654826+01:00",
      "ChildItems": [
        {},
        {}
      ],
      "ExtraInfo": "repudiandae",
      "StyleHint": "corrupti",
      "Hidden": false,
      "FullName": "Emelia Lubowitz",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 89
        }
      }
    }
  ],
  "Consents": [
    {
      "ConsentPersonId": 728,
      "Comment": "iusto",
      "Registered": "2023-06-17T03:45:23.654826+02:00",
      "RegisteredAssociateId": 374,
      "Updated": "2012-11-05T03:45:23.654826+01:00",
      "UpdatedAssociateId": 94,
      "LegalBaseId": 656,
      "LegalBaseKey": "nam",
      "LegalBaseName": "Ritchie-Kunde",
      "ConsentPurposeId": 515,
      "ConsentPurposeKey": "nisi",
      "ConsentPurposeName": "Jacobs Inc and Sons",
      "ConsentSourceId": 777,
      "ConsentSourceKey": "repellat",
      "ConsentSourceName": "Wyman Inc and Sons",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 829
        }
      }
    }
  ],
  "BounceEmails": [
    "izabella@feest.uk",
    "alexandrine@bernhard.com"
  ],
  "ActiveStatusMonitorId": 984,
  "CreatedByFormId": 85,
  "UserDefinedFields": {
    "SuperOffice:1": "1709612100",
    "SuperOffice:2": "False"
  },
  "ExtraFields": {
    "ExtraFields1": "officiis",
    "ExtraFields2": "explicabo"
  },
  "CustomFields": {
    "CustomFields1": "similique",
    "CustomFields2": "ea"
  },
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.String",
      "FieldLength": 434
    }
  }
}