Query Contacts - ListApplicantContact
Overview
Query Contacts
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is ListApplicantContact . | Yes |
PublicKey | string | The user's public key can be obtained from Console (opens in a new tab) | Yes |
Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
Parameter Name | Type | Description Information | Required |
---|
Response Field
Field Name | Type | Description Information | Required |
---|---|---|---|
RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
Action | string | Operation command name. | Yes |
Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
TotalCount | int | Queried Quantity | Yes |
ContactSet | array[ApplicantContact] | Contact List | Yes |
Data Model
ApplicantContact
Field Name | Type | Description Information | Required |
---|---|---|---|
ContactID | int | Contact ID | Yes |
ContactName | string | Name | Yes |
ContactPhone | string | Telephone | Yes |
ContactEmail | string | Yes | |
ContactAddress | string | Contact Address | Yes |
ContactPostalCode | string | Postal Code | Yes |
ContactTitle | string | Position | No |
Example
Request Example
https://api.surfercloud.com/?Action=ListApplicantContact
&TopOrganizationID=323423
Response Example
{
"Action": "ListApplicantContactResponse",
"ContactSet": [
{
"ContactAddress": "",
"ContactEmail": "",
"ContactID": "",
"ContactName": "",
"ContactPhone": "",
"ContactPostalCode": "",
"ContactTitle": ""
},
{
"ContactAddress": "",
"ContactEmail": "",
"ContactID": "",
"ContactName": "",
"ContactPhone": "",
"ContactPostalCode": "",
"ContactTitle": ""
}
],
"RetCode": 0,
"TotalCount": 2
}