Personal Center Query Company List - ListApplicantCompany
Overview
Personal Center Query Company List
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is ListApplicantCompany . | 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 | Total Quantity | Yes |
CompanySet | array[ApplicantCompany] | Company List | Yes |
Data Model
ApplicantCompany
Field Name | Type | Description Information | Required |
---|---|---|---|
CompanyRegion | string | Province | Yes |
CompanyID | int | Company ID | Yes |
CompanyName | string | Company Name | Yes |
CompanyCountry | string | Country Code | Yes |
CompanyCity | string | City | Yes |
CompanyAddress | string | Detailed Address | Yes |
CompanyPhone | string | Telephone | Yes |
CompanyPostalCode | string | Postal Code | Yes |
CompanyDivision | string | Department | Yes |
CompanyCode | string | Company Number | Yes |
CompanyCodeType | string | Company Number Type | Yes |
CompanyType | string | Company Type | Yes |
Example
Request Example
https://api.surfercloud.com/?Action=ListApplicantCompany
&TopOrganizationID=56543
Response Example
{
"Action": "ListApplicantCompanyResponse",
"CompanySet": [
{
"CompanyAddress": "",
"CompanyCity": "",
"CompanyCode": "",
"CompanyCodeType": "",
"CompanyCountry": "",
"CompanyDivision": "",
"CompanyID": "",
"CompanyName": "",
"CompanyPhone": "",
"CompanyPostalCode": "",
"CompanyRegion": "",
"CompanyType": ""
},
{
"CompanyAddress": "",
"CompanyCity": "",
"CompanyCode": "",
"CompanyCodeType": "",
"CompanyCountry": "",
"CompanyDivision": "",
"CompanyID": "",
"CompanyName": "",
"CompanyPhone": "",
"CompanyPostalCode": "",
"CompanyRegion": "",
"CompanyType": ""
}
],
"RetCode": 0,
"TotalCount": 2
}