/
REST Objects Contact

REST Objects Contact

5.0.0

The Contact object is part of the ServiceBroker Location object, in the following location:

Contact objects are used to represent a contact and their contact details that are associated with a Work Item's Location.

Contact Object Format

JSON Format
{
	"ContactPoint": [
    	{
    		"Mode": "Email, Phone, Mobile, FaceTime",
	        "Value": ""
    	},
    	{
    		"Mode": "Email, Phone, Mobile, FaceTime",
	        "Value": ""
    	},
		...
	],
    "ContactType": "",
    "FirstName": "",
    "LastName": "",
    "PreferredName": ""
}

Contact Object Properties


PropertyTypeRequired?Description

Field Mappings

ServiceDispatchServiceMobilityServiceScheduling
ContactPointarrayNo

An array of objects, each representing a method for getting in touch with the contact.

Each object consists of two properties:







PropertyTypeRequired?Description





ModestringYes

The type of contact method. One of:

  • Email
  • Phone
  • Mobile
  • FaceTime






ValuestringYesThe value for the contact method (e.g. the email address, phone number, etc.)

ConsumerInfo:Phone

ConsumerInfo:CellPhone

ConsumerInfo:WorkPhone

ConsumerInfo:WorkPhoneExtn

ConsumerInfo:Email

Email/Phones

customer.phoneNum[0]

customer.phoneNum[1]

ContactTypestringNoDefines if the contact is the primary contact for the associated Location.

/Location/Contacts/IsPrimary


FirstNamestringNoThe contact's first name.ConsumerInfo:FirstName

/Location/Contacts/FirstName

customer.contactName split(' ')[1]
LastNamestringNoThe contact's last name.ConsumerInfo:LastName/Location/Contacts/LastNamecustomer.contactName split(' ')[0]
PreferredNamestringNoThe name by which the contact would prefer to be addressed.


Related content

REST Objects Location
REST Objects Location
More like this
REST Objects Address
REST Objects Address
More like this
ContactPoint Object
ContactPoint Object
More like this
Account Location Related Objects Contact Object
Account Location Related Objects Contact Object
More like this
REST Objects Providers
REST Objects Providers
More like this
UpdateConsumerInfo RESTified API
UpdateConsumerInfo RESTified API
More like this