Fetching work information list for a contact
The API provides feature to provide the list of positions or work information for a contact, in order to get the list of work information pass the contact Id as URL parameter.
Request Information
URI Parameters
In order to make a call integrate the below parameters into Url while calling the API from an integration.
Name | Description | Type | Additional information |
---|---|---|---|
contactId |
pass the contact id to get the list of work information. |
integer |
Required |
Body Parameters
Body parameters need to be integrated as json key value collection followed by valid object notations, below if the list of parameters can be sent as request body by an integrator.
pass the contactOrganizatioIdto get the specific work information.
Request Format
Below is the typical object of the request, in order to use the API for various requirement, refer the documentation.
1
Get the list
In order to get the list of work information for a contact pass a valid contact id as integer in URL
admin/contact/workinfo/9831292
Response Information
Resource Description
List of Work Information for this contact
Collection of WorkInformationName | Description | Type | Additional information |
---|---|---|---|
IsOrganizationContact |
Indicates if this Work-Information is added as an Organization Contact |
boolean |
None. |
OrganizationName |
The Name of this Organization |
string |
None. |
WebsiteUrl |
Website URL of the Organization |
string |
String length: inclusive between 0 and 510 |
NoOfEmployees |
No. of Employees in the Organization |
integer |
None. |
|
string |
None. |
|
Fax |
Fax |
string |
None. |
Phone |
Phone |
string |
None. |
State |
State Abbrevation |
string |
None. |
Zip |
Zip |
string |
None. |
AddressLine1 |
Address Line 1 |
string |
None. |
AddressLine2 | string |
None. |
|
AddressLine3 | string |
None. |
|
AddressLine4 | string |
None. |
|
City | string |
None. |
|
County |
County |
string |
None. |
Country |
Country |
string |
None. |
JobContact |
The JobTitle and Contact-For information of this contact |
JobContact |
Required |
WorksInThisOrganization |
Indicates if the Employee/Individual is currently working with the Current Organization (i.e. the Organization that is using this API). |
boolean |
None. |
AddOrganizationAsContact |
Gets or sets a value indicating whether [add organization as contact]. |
boolean |
None. |
Id | integer |
None. |
|
RelatedToId | integer |
None. |
|
MergedWith_Or_Secondary_Id | integer |
None. |
|
MergeType | string |
None. |
|
SortOrder | integer |
None. |
Response Formats
[ { "IsOrganizationContact": true, "OrganizationName": "String Parameter 2", "WebsiteUrl": "String Parameter 3", "NoOfEmployees": 1, "Email": "String Parameter 4", "Fax": "String Parameter 5", "Phone": "String Parameter 6", "State": "String Parameter 7", "Zip": "String Parameter 8", "AddressLine1": "String Parameter 9", "AddressLine2": "String Parameter 10", "AddressLine3": "String Parameter 11", "AddressLine4": "String Parameter 12", "City": "String Parameter 13", "County": "String Parameter 14", "Country": "String Parameter 15", "JobContact": { "JobTitle": "String Parameter 1", "ContactFor": "String Parameter 2" }, "WorksInThisOrganization": true, "AddOrganizationAsContact": true, "Id": 19, "RelatedToId": 1, "MergedWith_Or_Secondary_Id": 1, "MergeType": "String Parameter 20", "SortOrder": 1 }, { "IsOrganizationContact": true, "OrganizationName": "String Parameter 2", "WebsiteUrl": "String Parameter 3", "NoOfEmployees": 1, "Email": "String Parameter 4", "Fax": "String Parameter 5", "Phone": "String Parameter 6", "State": "String Parameter 7", "Zip": "String Parameter 8", "AddressLine1": "String Parameter 9", "AddressLine2": "String Parameter 10", "AddressLine3": "String Parameter 11", "AddressLine4": "String Parameter 12", "City": "String Parameter 13", "County": "String Parameter 14", "Country": "String Parameter 15", "JobContact": { "JobTitle": "String Parameter 1", "ContactFor": "String Parameter 2" }, "WorksInThisOrganization": true, "AddOrganizationAsContact": true, "Id": 19, "RelatedToId": 1, "MergedWith_Or_Secondary_Id": 1, "MergeType": "String Parameter 20", "SortOrder": 1 } ]