GET Contact/{id}/Simple

• 4 minutes to read

GET /api/v1/Contact/{id}/Simple

A simple Contact object.

This is a simpler, smaller variation of the full ContactEntity. Calls the Contact agent service GetContact.

Path Part	Type	Description
id	int32	The id of the Contact to return. Required

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:

ContactEntity found.

Response	Description
200	ContactEntity found.
404	Not Found.

Response body: Contact

Property Name	Type	Description
ContactId	int32	Primary key
Name	string	Contact name
OrgNr	string	VAT number or similar
Department	string	Department
URL	string	The internet address to this contact
City	string	City corresponding to zip code
DirectPhone	string	The contacts phone
AssociateId	int32	Our contact
CountryId	int32	Country
EmailAddress	string	The contact email address
Kananame	string	Contact kana name, used in Japanese versions only
EmailAddressName	string	Visible field
URLName	string	Visible field
AssociateFullName	string	The associate's culture formatted fullname (firstname, middleName and lastname)
BusinessName	string	The business list item name
CategoryName	string	The category list item name
CountryName	string	Name of country in installed language
Address	Address	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.
FormattedAddress	string	The contact's address, formatted with linebreaks and spaces into a single string.
FullName	string
IsOwnerContact	bool	Is the contact an owner contact. This means that all persons on this contact can on only be internal users and not external users.
ActiveErpLinks	int32	The number of active erp links
Number1	string	Alphanumeric user field
Number2	string	Alphanumeric user field
TableRight	TableRight	The carrier's table right
FieldProperties	object	Field property dictionary mapping field names to field access rights.

Sample request

GET /api/v1/Contact/{id}/Simple
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en

Sample response

HTTP/1.1 200 ContactEntity found.
Content-Type: application/json; charset=utf-8

{
  "ContactId": 90,
  "Name": "Runolfsdottir-Blick",
  "OrgNr": "839112",
  "Department": "",
  "URL": "http://www.example.com/",
  "City": "eaque",
  "DirectPhone": "608.990.3235",
  "AssociateId": 652,
  "CountryId": 689,
  "EmailAddress": "hope_rodriguez@durgan.info",
  "Kananame": "blanditiis",
  "EmailAddressName": "whitney_leannon@bernhard.ca",
  "URLName": "http://www.example.com/",
  "AssociateFullName": "Mrs. Vance Haag II",
  "BusinessName": "Information Technology",
  "CategoryName": "VIP Customer",
  "CountryName": "Sokovia",
  "Address": null,
  "FormattedAddress": "eius",
  "FullName": "Toy Kemmer",
  "IsOwnerContact": true,
  "ActiveErpLinks": 586,
  "Number1": "889146",
  "Number2": "911521",
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 226
    }
  }
}