SuperOffice

Links

    SuperOffice API

    Getting access, Developing, Testing

    Back to SuperOffice

    Creates a new PersonEntity

    Calls the Person agent service SavePersonEntity.

    Input

    type: object properties: parameters: type: object properties: newEntity: description: The PersonEntity to be saved. type: object properties: PersonId: format: int32 description: Primary key type: integer Firstname: description: First name type: string MiddleName: description: Middle name or 'van' etc. type: string Lastname: description: Last name type: string Mrmrs: description: "e.g. Mrs sex_title \r\n<para>Use MDO List name \"mrmrs\" to get list items.</para>" type: string Title: description: Title type: string UpdatedDate: format: date-time description: Last updated date in UTC. type: string CreatedDate: format: date-time description: Registered date in UTC. type: string BirthDate: format: date-time description: >- The Person birth date as UTC Date. Year 1 = Null. Year 2 = unknown year. type: string CreatedBy: description: The user that created the person object type: object properties: AssociateId: format: int32 description: Primary key type: integer Name: description: Initials, also login name, possibly database user name type: string PersonId: format: int32 description: "Owning person record \r\n<para>Use MDO List name \"person\" to get list items.</para>" type: integer Rank: format: int32 description: Rank order type: integer Tooltip: description: Tooltip or other description type: string Type: description: >- User type - 1 = internal user, 2 = resource, 3 = external user, 4 = anonymous, 5 = system enum: - Unknown - InternalAssociate - ResourceAssociate - ExternalAssociate - AnonymousAssociate - SystemAssociate type: string GroupIdx: format: int32 description: >- Primary group membership, see UserGroupLink for secondary memberships type: integer FullName: description: >- The associate's culture formatted fullname (firstname, middleName and lastname) type: string FormalName: description: >- The associate's culture formatted formalname (firstname, middleName and lastname, title, mrmrs) type: string Deleted: description: >- If true, the user is retired and should have no rights, not appear in lists, etc. type: boolean EjUserId: format: int32 description: >- ID of the ej user record corresponding to this associate; 0 for associates that are not ej users type: integer UserName: description: User name type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer Emails: description: A collection of the person's emails type: array items: description: "Generic carrier object for entity elements such as Phone, EntityElement, Url. These elements do not have id and rank. These values are changed on each save, and should not be depended on. When used in a list or array the rank is the ascending list order.\r\n<para />\r\nCarrier object for EntityElement." type: object properties: Value: description: >- The Element FullName. This is a value that is intended to be shown to the user. type: string StrippedValue: description: >- The Element FullName. This is a value that can be parsed and used by systems. type: string Description: description: The Element Description type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer Description: description: >- The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases type: string IsAssociate: description: >- Checks if the person object is an associate. The property is read-only. type: boolean PrivatePhones: description: >- Returns a collection of phone numbers that belong to the contact person. type: array items: description: "Generic carrier object for entity elements such as Phone, EntityElement, Url. These elements do not have id and rank. These values are changed on each save, and should not be depended on. When used in a list or array the rank is the ascending list order.\r\n<para />\r\nCarrier object for EntityElement." type: object properties: Value: description: >- The Element FullName. This is a value that is intended to be shown to the user. type: string StrippedValue: description: >- The Element FullName. This is a value that can be parsed and used by systems. type: string Description: description: The Element Description type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer Faxes: description: >- Returns a collection of fax numbers that belong to the contact person. type: array items: description: "Generic carrier object for entity elements such as Phone, EntityElement, Url. These elements do not have id and rank. These values are changed on each save, and should not be depended on. When used in a list or array the rank is the ascending list order.\r\n<para />\r\nCarrier object for EntityElement." type: object properties: Value: description: >- The Element FullName. This is a value that is intended to be shown to the user. type: string StrippedValue: description: >- The Element FullName. This is a value that can be parsed and used by systems. type: string Description: description: The Element Description type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer MobilePhones: description: >- Returns a collection of mobile phone numbers that belong to the contact person. type: array items: description: "Generic carrier object for entity elements such as Phone, EntityElement, Url. These elements do not have id and rank. These values are changed on each save, and should not be depended on. When used in a list or array the rank is the ascending list order.\r\n<para />\r\nCarrier object for EntityElement." type: object properties: Value: description: >- The Element FullName. This is a value that is intended to be shown to the user. type: string StrippedValue: description: >- The Element FullName. This is a value that can be parsed and used by systems. type: string Description: description: The Element Description type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer OfficePhones: description: >- Returns a collection of office phone numbers that belong to the contact person. type: array items: description: "Generic carrier object for entity elements such as Phone, EntityElement, Url. These elements do not have id and rank. These values are changed on each save, and should not be depended on. When used in a list or array the rank is the ascending list order.\r\n<para />\r\nCarrier object for EntityElement." type: object properties: Value: description: >- The Element FullName. This is a value that is intended to be shown to the user. type: string StrippedValue: description: >- The Element FullName. This is a value that can be parsed and used by systems. type: string Description: description: The Element Description type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer OtherPhones: description: Returns a collection of pagers that belong to the contact person. type: array items: description: "Generic carrier object for entity elements such as Phone, EntityElement, Url. These elements do not have id and rank. These values are changed on each save, and should not be depended on. When used in a list or array the rank is the ascending list order.\r\n<para />\r\nCarrier object for EntityElement." type: object properties: Value: description: >- The Element FullName. This is a value that is intended to be shown to the user. type: string StrippedValue: description: >- The Element FullName. This is a value that can be parsed and used by systems. type: string Description: description: The Element Description type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer Position: description: "The position. This is a predefined SuperOffice value, different from Title \r\n<para>Use MDO List name \"perspos\" to get list items.</para>" type: object properties: Id: format: int32 description: The List Item Id type: integer Value: description: The List Item Value type: string Tooltip: description: The List Item Tooltip type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer UpdatedBy: description: The person that last updated the person object type: object properties: AssociateId: format: int32 description: Primary key type: integer Name: description: Initials, also login name, possibly database user name type: string PersonId: format: int32 description: "Owning person record \r\n<para>Use MDO List name \"person\" to get list items.</para>" type: integer Rank: format: int32 description: Rank order type: integer Tooltip: description: Tooltip or other description type: string Type: description: >- User type - 1 = internal user, 2 = resource, 3 = external user, 4 = anonymous, 5 = system enum: - Unknown - InternalAssociate - ResourceAssociate - ExternalAssociate - AnonymousAssociate - SystemAssociate type: string GroupIdx: format: int32 description: >- Primary group membership, see UserGroupLink for secondary memberships type: integer FullName: description: >- The associate's culture formatted fullname (firstname, middleName and lastname) type: string FormalName: description: >- The associate's culture formatted formalname (firstname, middleName and lastname, title, mrmrs) type: string Deleted: description: >- If true, the user is retired and should have no rights, not appear in lists, etc. type: boolean EjUserId: format: int32 description: >- ID of the ej user record corresponding to this associate; 0 for associates that are not ej users type: integer UserName: description: User name type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer Contact: description: "The contact the contact person is registered on. This is required unless the 'MandatoryContactOnPerson' preference is set. \r\n<para>Use MDO List name \"contact_new\" to get list items.</para>" type: object properties: ContactId: format: int32 description: Primary key type: integer Name: description: Contact name type: string OrgNr: description: VAT number or similar type: string Department: description: Department type: string URL: description: The internet address to this contact type: string City: description: City corresponding to zip code type: string DirectPhone: description: The contacts phone type: string AssociateId: format: int32 description: Our contact type: integer CountryId: format: int32 description: Country type: integer EmailAddress: description: The contact email address type: string Kananame: description: Contact kana name, used in Japanese versions only type: string EmailAddressName: description: Visible field type: string URLName: description: Visible field type: string AssociateFullName: description: >- The associate's culture formatted fullname (firstname, middleName and lastname) type: string BusinessName: description: The business list item name type: string CategoryName: description: The category list item name type: string CountryName: description: Name of country in installed language type: string Address: description: >- Contact address as a list of LocalizedFieldList objects. Used to store localized information such as formatted address data. Suitable for passing to an address control for display. type: object properties: Wgs84Latitude: format: double description: >- Latitude (that's north/south), decimal degrees, relative to WGS 84 ellipsoid. SuperOffice ASA is at 59.91892. This value needs no further grid reference or other qualifying information. type: number Wgs84Longitude: format: double description: >- Longitude (that's East/west), decimal degrees, relative to WGS 84 ellipsoid. SuperOffice ASA is at 10.73159. This value needs no further grid reference or other qualifying information. type: number LocalizedAddress: description: >- LocalizedFieldArray is a list of LocalizedFieldList objects. Used to store localized information such as formatted address data. type: array items: type: array items: description: "LocalizedField is used to store localized information such as formatted address data, a formatted phone number, etc.\r\n<para />\r\nCarrier object for LocalizedField." type: object properties: Name: description: Name of the value field type: string Value: description: The field's value type: string Tooltip: description: The tooltip type: string Label: description: The label of the field type: string ValueLength: format: int32 description: Database length of the value type: integer AddressType: description: '' type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer Street: description: >- Street address (company street, person address, delivery address). LocalizedAddress changes override this property, so you do not have to change both Localized and this. type: object properties: AtypeIdx: description: >- Bit mask, combines address type (EAddressType) and owner type (EOwnerType) enum: - Unknown - ContactPostalAddress - ContactStreetAddress - PersonPrivateAddress - QuoteBillingAddress - QuoteShippingAddress type: string Address1: description: Address line 1 type: string Address2: description: Address line 2 type: string Address3: description: Address line 3 type: string City: description: City corresponding to zip code type: string County: description: County (not country) type: string State: description: State type: string Zipcode: description: Zip code, alphanumeric type: string Formatted: description: >- Read-only formatted address multi-line string. e.g.: &lt;c&gt;"Brugata 123,\n1234 OSLO\n"&lt;/c&gt; or &lt;c&gt;"Bridgelane 123,\nWest Tooting,\nThe Shire ES2 W31\n"&lt;/c&gt;. type: string Postal: description: >- Postal address (company postal, billing address). LocalizedAddress changes override this property, so you do not have to change both Localized and this. type: object properties: AtypeIdx: description: >- Bit mask, combines address type (EAddressType) and owner type (EOwnerType) enum: - Unknown - ContactPostalAddress - ContactStreetAddress - PersonPrivateAddress - QuoteBillingAddress - QuoteShippingAddress type: string Address1: description: Address line 1 type: string Address2: description: Address line 2 type: string Address3: description: Address line 3 type: string City: description: City corresponding to zip code type: string County: description: County (not country) type: string State: description: State type: string Zipcode: description: Zip code, alphanumeric type: string Formatted: description: >- Read-only formatted address multi-line string. e.g.: &lt;c&gt;"Brugata 123,\n1234 OSLO\n"&lt;/c&gt; or &lt;c&gt;"Bridgelane 123,\nWest Tooting,\nThe Shire ES2 W31\n"&lt;/c&gt;. type: string Formatted: description: >- Read-only formatted address multi-line string. Combines street and postal into one string. e.g.: &lt;c&gt;"Postboks 123,\nBrugata 123,\n1234 OSLO\n"&lt;/c&gt; or &lt;c&gt;"Postbox 123,\nBridgelane 123,\nWest Tooting,\nEast Shire ES2 W31\n"&lt;/c&gt;. type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer FormattedAddress: description: >- The contact's address, formatted with linebreaks and spaces into a single string. type: string FullName: description: '' type: string IsOwnerContact: description: >- Is the contact an owner contact. This means that all persons on this contact can on only be internal users and not external users. type: boolean ActiveErpLinks: format: int32 description: The number of active erp links type: integer Number1: description: Alphanumeric user field type: string Number2: description: Alphanumeric user field type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer Country: description: "The country this contact person is located in. \r\n<para>Use MDO List name \"country\" to get list items.</para>" type: object properties: CountryId: format: int32 description: Primary key type: integer Name: description: Name of country in installed language type: string CurrencyId: format: int32 description: Default currency for this country type: integer EnglishName: description: Name of country in english type: string TwoLetterISOCountry: description: Two-letter country-code according to ISO3166 type: string ThreeLetterISOCountry: description: Three-letter country-code according to ISO3166 type: string ImageDescription: description: >- Description of the country's flag image. (This is the country flag that is displayed in the CRM client) type: string OrgNrText: description: Lead text for organisation field type: string InterAreaPrefix: description: International prefix type: string DialInPrefix: description: Dial in prefix type: string ZipPrefix: description: Post prefix type: string DomainName: description: Domain name of the country type: string AddressLayoutId: format: int32 description: Address layout of the country type: integer DomesticAddressLayoutId: format: int32 description: Domestic address layout of the country type: integer ForeignAddressLayoutId: format: int32 description: Foreign address layout of the country type: integer Rank: format: int32 description: The rank of the country type: integer Tooltip: description: The tooltip of the country type: string Deleted: description: true if the country is deleted type: boolean TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer Interests: description: "The person's available and selected interests. \r\n<para>Use MDO List name \"persint\" to get list items.</para>" type: array items: description: "Carrier object for SelectableMDOListItem.\r\nServices for the SelectableMDOListItem Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IMDOAgent\">MDO Agent</see>." type: object properties: Id: format: int32 description: The Id of the ListItem type: integer Name: description: The name of the ListItem type: string ToolTip: description: The tooltip of the ListItem type: string Deleted: description: The deleted status of the ListItem type: boolean Rank: format: int32 description: The rank of the ListItem type: integer Type: description: The type of the ListItem. Custom field. type: string ColorBlock: format: int32 description: The color indicator of the ListItem color block type: integer IconHint: description: The Icon hint of the ListItem. Custom field. type: string Selected: description: True if the ListItem is selected type: boolean LastChanged: format: date-time description: Time of last change. type: string ChildItems: description: The child items of the SelectableMDOListItem type: array ExtraInfo: description: >- Extra information added to the ListItem. Could be information such as sort order etc or other meta data. Custom field. type: string StyleHint: description: >- Style hint indicating, information such as background color etc. Custom field. type: string Hidden: description: True if the ListItem is hidden type: boolean FullName: description: The name of the ListItem in its context type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer PersonNumber: description: Alphanumeric user field type: string FullName: description: >- The person's full name localized to the current culture/country. (internal name used in clients for employees) type: string NoMailing: description: Spam filter. Indicates if this person should retrieve advertising. type: boolean UsePersonAddress: description: >- True if the person's address should be used as mailing address, instead of the contact's address. type: boolean Retired: description: >- True if the user is retired and should have no rights, not appear in lists, etc. type: boolean Urls: description: The urls related to this person. type: array items: description: "Generic carrier object for entity elements such as Phone, EntityElement, Url. These elements do not have id and rank. These values are changed on each save, and should not be depended on. When used in a list or array the rank is the ascending list order.\r\n<para />\r\nCarrier object for EntityElement." type: object properties: Value: description: >- The Element FullName. This is a value that is intended to be shown to the user. type: string StrippedValue: description: >- The Element FullName. This is a value that can be parsed and used by systems. type: string Description: description: The Element Description type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer FormalName: description: >- Get formal name for a person, as used in labels. (Full name + person title + academic title) type: string Address: description: >- Structure holding formatted address data. The layout of the array structure indicates the layout of the localized address. type: object properties: Wgs84Latitude: format: double description: >- Latitude (that's north/south), decimal degrees, relative to WGS 84 ellipsoid. SuperOffice ASA is at 59.91892. This value needs no further grid reference or other qualifying information. type: number Wgs84Longitude: format: double description: >- Longitude (that's East/west), decimal degrees, relative to WGS 84 ellipsoid. SuperOffice ASA is at 10.73159. This value needs no further grid reference or other qualifying information. type: number LocalizedAddress: description: >- LocalizedFieldArray is a list of LocalizedFieldList objects. Used to store localized information such as formatted address data. type: array items: type: array items: description: "LocalizedField is used to store localized information such as formatted address data, a formatted phone number, etc.\r\n<para />\r\nCarrier object for LocalizedField." type: object properties: Name: description: Name of the value field type: string Value: description: The field's value type: string Tooltip: description: The tooltip type: string Label: description: The label of the field type: string ValueLength: format: int32 description: Database length of the value type: integer AddressType: description: '' type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer Street: description: >- Street address (company street, person address, delivery address). LocalizedAddress changes override this property, so you do not have to change both Localized and this. type: object properties: AtypeIdx: description: >- Bit mask, combines address type (EAddressType) and owner type (EOwnerType) enum: - Unknown - ContactPostalAddress - ContactStreetAddress - PersonPrivateAddress - QuoteBillingAddress - QuoteShippingAddress type: string Address1: description: Address line 1 type: string Address2: description: Address line 2 type: string Address3: description: Address line 3 type: string City: description: City corresponding to zip code type: string County: description: County (not country) type: string State: description: State type: string Zipcode: description: Zip code, alphanumeric type: string Formatted: description: >- Read-only formatted address multi-line string. e.g.: &lt;c&gt;"Brugata 123,\n1234 OSLO\n"&lt;/c&gt; or &lt;c&gt;"Bridgelane 123,\nWest Tooting,\nThe Shire ES2 W31\n"&lt;/c&gt;. type: string Postal: description: >- Postal address (company postal, billing address). LocalizedAddress changes override this property, so you do not have to change both Localized and this. type: object properties: AtypeIdx: description: >- Bit mask, combines address type (EAddressType) and owner type (EOwnerType) enum: - Unknown - ContactPostalAddress - ContactStreetAddress - PersonPrivateAddress - QuoteBillingAddress - QuoteShippingAddress type: string Address1: description: Address line 1 type: string Address2: description: Address line 2 type: string Address3: description: Address line 3 type: string City: description: City corresponding to zip code type: string County: description: County (not country) type: string State: description: State type: string Zipcode: description: Zip code, alphanumeric type: string Formatted: description: >- Read-only formatted address multi-line string. e.g.: &lt;c&gt;"Brugata 123,\n1234 OSLO\n"&lt;/c&gt; or &lt;c&gt;"Bridgelane 123,\nWest Tooting,\nThe Shire ES2 W31\n"&lt;/c&gt;. type: string Formatted: description: >- Read-only formatted address multi-line string. Combines street and postal into one string. e.g.: &lt;c&gt;"Postboks 123,\nBrugata 123,\n1234 OSLO\n"&lt;/c&gt; or &lt;c&gt;"Postbox 123,\nBridgelane 123,\nWest Tooting,\nEast Shire ES2 W31\n"&lt;/c&gt;. type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer Post3: description: Postal address, used in Japanese versions only type: string Post2: description: Postal address, used in Japanese versions only type: string Post1: description: Postal address, used in Japanese versions only type: string Kanalname: description: Kana last name, used in Japanese versions only type: string Kanafname: description: Kana first name, used in Japanese versions only type: string CorrespondingAssociate: description: >- The associate corresponding to this person. Will be empty if the person is not a user (internal associate user, external user). type: object properties: AssociateId: format: int32 description: Primary key type: integer Name: description: Initials, also login name, possibly database user name type: string PersonId: format: int32 description: "Owning person record \r\n<para>Use MDO List name \"person\" to get list items.</para>" type: integer Rank: format: int32 description: Rank order type: integer Tooltip: description: Tooltip or other description type: string Type: description: >- User type - 1 = internal user, 2 = resource, 3 = external user, 4 = anonymous, 5 = system enum: - Unknown - InternalAssociate - ResourceAssociate - ExternalAssociate - AnonymousAssociate - SystemAssociate type: string GroupIdx: format: int32 description: >- Primary group membership, see UserGroupLink for secondary memberships type: integer FullName: description: >- The associate's culture formatted fullname (firstname, middleName and lastname) type: string FormalName: description: >- The associate's culture formatted formalname (firstname, middleName and lastname, title, mrmrs) type: string Deleted: description: >- If true, the user is retired and should have no rights, not appear in lists, etc. type: boolean EjUserId: format: int32 description: >- ID of the ej user record corresponding to this associate; 0 for associates that are not ej users type: integer UserName: description: User name type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer Category: description: "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) \r\n<para>Use MDO List name \"category\" to get list items.</para>" type: object properties: Id: format: int32 description: The List Item Id type: integer Value: description: The List Item Value type: string Tooltip: description: The List Item Tooltip type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer Business: description: "Person's business - usually blank. Use Contact.Business instead. Intended for use when individual persons are created. (i.e. when Person.Contact is blank) \r\n<para>Use MDO List name \"business\" to get list items.</para>" type: object properties: Id: format: int32 description: The List Item Id type: integer Value: description: The List Item Value type: string Tooltip: description: The List Item Tooltip type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer Associate: description: "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) \r\n<para>Use MDO List name \"associate\" to get list items.</para>" type: object properties: AssociateId: format: int32 description: Primary key type: integer Name: description: Initials, also login name, possibly database user name type: string PersonId: format: int32 description: "Owning person record \r\n<para>Use MDO List name \"person\" to get list items.</para>" type: integer Rank: format: int32 description: Rank order type: integer Tooltip: description: Tooltip or other description type: string Type: description: >- User type - 1 = internal user, 2 = resource, 3 = external user, 4 = anonymous, 5 = system enum: - Unknown - InternalAssociate - ResourceAssociate - ExternalAssociate - AnonymousAssociate - SystemAssociate type: string GroupIdx: format: int32 description: >- Primary group membership, see UserGroupLink for secondary memberships type: integer FullName: description: >- The associate's culture formatted fullname (firstname, middleName and lastname) type: string FormalName: description: >- The associate's culture formatted formalname (firstname, middleName and lastname, title, mrmrs) type: string Deleted: description: >- If true, the user is retired and should have no rights, not appear in lists, etc. type: boolean EjUserId: format: int32 description: >- ID of the ej user record corresponding to this associate; 0 for associates that are not ej users type: integer UserName: description: User name type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer Salutation: description: "Academic title, populated from Salutation list but can be overwritten with anything at all \r\n<para>Use MDO List name \"salutation\" to get list items.</para>" type: string ActiveInterests: format: int32 description: The number of active interests. type: integer SupportAssociate: description: <para>Use MDO List name "associate" to get list items.</para> type: object properties: AssociateId: format: int32 description: Primary key type: integer Name: description: Initials, also login name, possibly database user name type: string PersonId: format: int32 description: "Owning person record \r\n<para>Use MDO List name \"person\" to get list items.</para>" type: integer Rank: format: int32 description: Rank order type: integer Tooltip: description: Tooltip or other description type: string Type: description: >- User type - 1 = internal user, 2 = resource, 3 = external user, 4 = anonymous, 5 = system enum: - Unknown - InternalAssociate - ResourceAssociate - ExternalAssociate - AnonymousAssociate - SystemAssociate type: string GroupIdx: format: int32 description: >- Primary group membership, see UserGroupLink for secondary memberships type: integer FullName: description: >- The associate's culture formatted fullname (firstname, middleName and lastname) type: string FormalName: description: >- The associate's culture formatted formalname (firstname, middleName and lastname, title, mrmrs) type: string Deleted: description: >- If true, the user is retired and should have no rights, not appear in lists, etc. type: boolean EjUserId: format: int32 description: >- ID of the ej user record corresponding to this associate; 0 for associates that are not ej users type: integer UserName: description: User name type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer TicketPriority: description: <para>Use MDO List name "ticketpriority" to get list items.</para> type: object properties: Id: format: int32 description: The List Item Id type: integer Value: description: The List Item Value type: string Tooltip: description: The List Item Tooltip type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer CustomerLanguage: description: >- <para>Use MDO List name "customerlanguage" to get list items.</para> type: object properties: Id: format: int32 description: The List Item Id type: integer Value: description: The List Item Value type: string Tooltip: description: The List Item Tooltip type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer DbiAgentId: format: int32 description: Integration agent (eJournal) type: integer DbiKey: description: >- The primary key for the integrated entry in the external datasource. type: string DbiLastModified: format: date-time description: When the entry was last modified. type: string DbiLastSyncronized: format: date-time description: Last external syncronization. type: string SentInfo: format: int32 description: Has information on username/password been sent (ejournal) type: integer ShowContactTickets: format: int32 description: Should tickets related to the company be shown to this person type: integer UserInfo: description: >- Information about the user if this person is a user. If IsAssociate (e.g. is user is true) the UserInfo will be provided. type: object properties: Deleted: description: >- If true, the user is retired and should have no rights, not appear in lists, etc. type: boolean UserInfoId: format: int32 description: Primary key type: integer UserName: description: Initials, also login name, possibly database user name type: string PersonId: format: int32 description: Owning person record type: integer Rank: format: int32 description: Rank order type: integer Tooltip: description: Tooltip or other description type: string UserGroupId: format: int32 description: >- Primary group membership, see UserGroupLink for secondary memberships type: integer EjUserId: format: int32 description: >- ID of the ej user record corresponding to this associate; 0 for associates that are not ej users type: integer UserType: description: '' enum: - Unknown - InternalAssociate - ResourceAssociate - ExternalAssociate - AnonymousAssociate - SystemAssociate type: string GrantedLicenses: description: '' type: array items: type: string CanLogon: description: '' type: boolean RoleName: description: '' type: string RoleTooltip: description: '' type: string UserGroupName: description: '' type: string UserGroupTooltip: description: '' type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer ChatEmails: description: '' type: array items: description: "Generic carrier object for entity elements such as Phone, EntityElement, Url. These elements do not have id and rank. These values are changed on each save, and should not be depended on. When used in a list or array the rank is the ascending list order.\r\n<para />\r\nCarrier object for EntityElement." type: object properties: Value: description: >- The Element FullName. This is a value that is intended to be shown to the user. type: string StrippedValue: description: >- The Element FullName. This is a value that can be parsed and used by systems. type: string Description: description: The Element Description type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer InternetPhones: description: '' type: array items: description: "Generic carrier object for entity elements such as Phone, EntityElement, Url. These elements do not have id and rank. These values are changed on each save, and should not be depended on. When used in a list or array the rank is the ascending list order.\r\n<para />\r\nCarrier object for EntityElement." type: object properties: Value: description: >- The Element FullName. This is a value that is intended to be shown to the user. type: string StrippedValue: description: >- The Element FullName. This is a value that can be parsed and used by systems. type: string Description: description: The Element Description type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer Source: format: int32 description: How did we get this person? For future integration needs type: integer ActiveErpLinks: format: int32 description: How many active ERP links are there for this person? type: integer ShipmentTypes: description: The person's available and selected shipment types. type: array items: description: "Carrier object for SelectableMDOListItem.\r\nServices for the SelectableMDOListItem Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IMDOAgent\">MDO Agent</see>." type: object properties: Id: format: int32 description: The Id of the ListItem type: integer Name: description: The name of the ListItem type: string ToolTip: description: The tooltip of the ListItem type: string Deleted: description: The deleted status of the ListItem type: boolean Rank: format: int32 description: The rank of the ListItem type: integer Type: description: The type of the ListItem. Custom field. type: string ColorBlock: format: int32 description: The color indicator of the ListItem color block type: integer IconHint: description: The Icon hint of the ListItem. Custom field. type: string Selected: description: True if the ListItem is selected type: boolean LastChanged: format: date-time description: Time of last change. type: string ChildItems: description: The child items of the SelectableMDOListItem type: array ExtraInfo: description: >- Extra information added to the ListItem. Could be information such as sort order etc or other meta data. Custom field. type: string StyleHint: description: >- Style hint indicating, information such as background color etc. Custom field. type: string Hidden: description: True if the ListItem is hidden type: boolean FullName: description: The name of the ListItem in its context type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer Consents: description: >- The person's available consent information. Missing consents are not deleted. To remove a consent, mark its legalbase as 'WITHDRAWN' type: array items: description: "Consent information for a give person. Consents are for a particular Purpose, and may be withdrawn (see LegalBase).\r\n<para />\r\nCarrier object for ConsentInfo.\r\nServices for the ConsentInfo Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IPersonAgent\">Person Agent</see>." type: object properties: ConsentPersonId: format: int32 description: Primary key type: integer Comment: description: Comment regarding this specific consent type: string Registered: format: date-time description: When this consent record was created in UTC. type: string RegisteredAssociateId: format: int32 description: The ID of the associate who created this record type: integer Updated: format: date-time description: When this consent record was last updated in UTC. type: string UpdatedAssociateId: format: int32 description: The ID of the associate who last updated this record type: integer LegalBaseId: format: int32 description: Primary key for the LegalBase associated with this consent type: integer LegalBaseKey: description: Key for the LegalBase associated with this consent type: string LegalBaseName: description: Name of the LegalBase associated with this consent type: string ConsentPurposeId: format: int32 description: >- Primary key for the ConsentPurpose associated with this consent type: integer ConsentPurposeKey: description: Key of the ConsentPurpose associated with this consent type: string ConsentPurposeName: description: Name of the ConsentPurpose associated with this consent type: string ConsentSourceId: format: int32 description: >- Primary key for the ConsentSource associated with this consent type: integer ConsentSourceKey: description: Key of the ConsentSource associated with this consent type: string ConsentSourceName: description: Name of the ConsentSource associated with this consent type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer BounceEmails: description: Email addresses with a positive bounce counter. type: array items: type: string ActiveStatusMonitorId: format: int32 description: Active status monitor identity with the lowest rank for person type: integer UserDefinedFields: description: "Deprecated: Use {SuperOffice.CRM.Services.PersonEntity.CustomFields} instead.\r\nDictionary of user defined field data.\r\nThe 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\"" type: object additionalProperties: type: string ExtraFields: description: "Deprecated: Use {SuperOffice.CRM.Services.PersonEntity.CustomFields} instead.\r\nExtra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc." type: object additionalProperties: type: string CustomFields: description: "Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin.\r\nCustom fields combines user defined fields and extra fields into one bucket. \r\nThe individual {SuperOffice.CRM.Services.PersonEntity.ExtraFields} and <see cref=\"P:SuperOffice.CRM.Services.PersonEntity.UserDefinedFields\">UserDefinedFields</see> properties are deprecated in favor of this\r\ncombined collection." type: object additionalProperties: type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer $select: type: string description: >- 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. Accept-Language: type: string description: >- Convert string references and multi-language values into a specified language (iso2) code. SO-Language: type: string description: >- Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value. SO-Culture: type: string description: >- Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set. SO-TimeZone: type: string description: >- Specify the timezone code that you would like date/time responses converted to. SO-AppToken: type: string description: >- The application token that identifies the partner app. Used when calling Online WebAPI from a server. required: - newEntity title: Parameters