Document toolboxDocument toolbox

(v1) .Contact API Calls v2019.1

Non-LDAP Contacts can be easily updated or added to the system with the API.  This endpoint acts similarly to the Contacts Import for Primary Email and Primary Phone.

Below is the proper format for making a separate request.

Contact End point

http://DOMAIN/api/API_KEY/contact.OUTPUT

Available Fields

Field

Required

Data Type

Options

Default

Notes

department

noInteger

Department RECID that the Contact is assigned to.

customer_number

no*Integer

Customer Number assigned to the Contact. Conditionally Required if Contact is a CUSTOMER type

first_name

yesString

Contact's First Name.
last_nameyesString

Contact's Last Name.

contact_directory

yesIntegerNo = 0, Yes = 1
Is this Contact in the Directory?
contact_typesyesString
CONTACT_TYPE Lists 

What Type(s) of Contact is this? Example: "USER,CUSTOMER"
statusyesInteger
STATUS_TYPE Lists 

Stats of the Contact (Active/Inactive).
typenoStringEMAIL, ADDRESS, PHONE
What type of Contact information is being provided?
email_directoryyesIntegerNo = 0, Yes = 1
Should this Email show in the Directory.
emailyesString

New Primary Email for the Contact.

address_directory

noIntegerNo = 0, Yes = 1
Is this Address in the Directory?
address_typenostring
ADDRESS_TYPE Lists 

What Type of Address is it?
street_addressno*String

First Line of the Address.

*If any Address fields are sent, all become Required

address2noString

Second Line of the Address.
cityno*String

City the Address is in.

*If any Address fields are sent, all become Required

stateno*String

State the Address is in. Use standard 2 Letter Abbreviation.

*If any Address fields are sent, all become Required

zip_codeno*Integer

5 digit Postal Code assigned to the Address.

*If any Address fields are sent, all become Required

phone_directoryyesIntegerNo = 0, Yes = 1
Should this Phone Number show in the Directory.
phone_primaryyesIntegerNo = 0, Yes = 1
Is this the Primary Phone Number?
phone_typeyesString
PHONE_TYPE Lists 

What Type of Phone Number is this?
phone_numberyesInteger

Phone Number for the Contact.

Email Request

In addition to the main Contact fields, additional fields are available for creating or updating Email Information.

  • Requires "type = EMAIL"

Available Fields

Field

Required

Data Type

Options

Default

Notes

contact_recidyesInteger

RECID for the Contact
email_directoryyesIntegerNo = 0, Yes = 1
Should this Email show in the Directory.
emailyesString

New Primary Email for the Contact.


Email Request Example

Call:
POST DOMAIN/KEY/contact.json
Headers:

Key

Value

Content-Type

application/json

Pcr-Html-Encoded

TRUE

Body:

Key

Value

type

EMAIL

email

help@pcr.com

email_directory0
contact_Directory1
first_namePCR
last_nameSysAdmin
contact_typesUSER
status1
contact_recid1
Results

Address Request

In addition to the main Contact fields, additional fields are available for creating or updating Address Information.

  • Requires "type = ADDRESS"

Available Fields

Field

Required

Data Type

Options

Default

Notes

contact_recidyesInteger

RECID for the Contact

address_directory

noIntegerNo = 0, Yes = 1
Is this Address in the Directory?
address_typenostring
ADDRESS_TYPE Lists 

What Type of Address is it?
street_addressno*String

First Line of the Address.

*See Note below

address2noString

Second Line of the Address.
cityno*String

City the Address is in.

*See Note below

stateno*String

State the Address is in. Use standard 2 Letter Abbreviation.

*See Note below

zip_codeno*Integer

5 digit Postal Code assigned to the Address.

*See Note below

  • Note: If any Address fields are sent, all become Required


Address Request Example

Call:
POST DOMAIN/KEY/contact.json
Headers:

Key

Value

Content-Type

application/json

Pcr-Html-Encoded

TRUE

Body:

Key

Value

type

ADDRESS

address_directory

0

address_typeWarehouse
street_address1313 Mockingbird Lane
cityMockingbird Heights
stateCA
zip_code55555
contact_Directory1
first_namePCR
last_nameSysAdmin
contact_typesUSER
status1
contact_recid1
Results

Phone Request

In addition to the main Contact fields, additional fields are available for creating or updating Phone Information.

  • Requires "type = PHONE"

Available Fields

Field

Required

Data Type

Options

Default

Notes

contact_recidyesInteger

RECID for the Contact
phone_directoryyesIntegerNo = 0, Yes = 1
Should this Phone Number show in the Directory.
phone_primarynoIntegerNo = 0, Yes = 11Is this the Primary Phone Number?
phone_typeyesString
PHONE_TYPE Lists 

What Type of Phone Number is this.
phone_numberyesInteger

Phone Number for the Contact.


Phone Request Example

Call:
POST DOMAIN/KEY/contact.json
Headers:

Key

Value

Content-Type

application/json

Pcr-Html-Encoded

TRUE

Body:

Key

Value

type

PHONE

phone_directory

0

phone_primary0
phone_typeWork
phone_number5558675309
contact_Directory1
first_namePCR
last_nameSysAdmin
contact_typesUSER
status1
contact_recid1
Results


Locating Contact Data

To locate contact data navigate to Main > People > Workers / Contacts, to view the Workers / Contacts Grid.

All grids have the option to show the ROW ID column, which is also the RECID for that particular record.

Help Desk Portal - Email: help@pcr.com - Phone: 616.259.9242