Get a List of Contact Person
Returns a list of contact persons recorded for a contact.
Query String Parameters
Name | Type | Description | Required |
---|---|---|---|
Action | String | ContactListPerson | Required |
ContactId | Int | The unique identifier of the contact which can be retrieved using Contact List. | Required |
ContactRef | String | The internal reference of the contact. | Optional - See Tip |
DisplayMainUser | Bool | Request additional field IsMainUser is included in the Response Displays Yes or No depending on whether the user is a main user or not. | Optional |
Response Codes
Code | Message | Information |
---|---|---|
0 | Response Data | See 'Response' example tab |
2 | contactId or contactRef parameters required | Mandatory parameter was not supplied |
2 | invalid parameter - contactId | Integer value is invalid or was not specified (when required) |
2 | No matching contact | No record found using the specified parameters |
2 | Cannot find persons at Contact | No record found using the specified parameters |
2 | misc_noRight | You do not have the permissions to view contacts. |
Example
- Request
- Response
Request URL
https://webservice.bigchange.com/v01/services.ashx?action=ContactListPerson&ContactRef=ABC0001&CountStatus=2
Response Data
{ "Code": 0, "Result": { "DataCount": 6, "DataResult": [ { "Id": "b247aba9-8564-426a-8504-474701c28d7d", "Title": "", "Name": ",hhjkhjkhjk", "Email": "", "Position": "", "Department": "", "Phone": "", "Landline": "", "LandlineExtension": "", "Flags": [] }, { "Id": "7728cfd9-2697-4d73-8336-8fb12e424b83", "Title": "", "Name": "Test", "Email": "", "Position": "", "Department": "", "Phone": "+123456789012345", "Landline": "", "LandlineExtension": "", "Flags": [] } ] } }