POST Agents/Contact/CreateDefaultPreviewContact

• 2 minutes to read
 • 2 minutes to read 
POST /api/v1/Agents/Contact/CreateDefaultPreviewContact

Set default values into a new PreviewContact.

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: PreviewContact

Property Name Type Description
ContactId int32 Primary key
Name string Contact name
Department string Department
CountryId int32 Country
Number2 string Alphanumeric user field
DirectPhone string The contacts phone
URL string The internet address to this contact
EmailAddress string The contact email address
BusinessName string The business list item name
CategoryName string The category list item name
AssociateFullName string The associate's culture formatted fullname (firstname, middleName and lastname)
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.

Sample request

POST /api/v1/Agents/Contact/CreateDefaultPreviewContact
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

{
  "ContactId": 934,
  "Name": "Funk LLC",
  "Department": "",
  "CountryId": 815,
  "Number2": "633467",
  "DirectPhone": "1-975-097-3476 x64293",
  "URL": "http://www.example.com/",
  "EmailAddress": "lyric@bartonschumm.ca",
  "BusinessName": "Information Technology",
  "CategoryName": "VIP Customer",
  "AssociateFullName": "Meaghan Wisozk",
  "Address": null
}