GET api/CompanyInfo
Returns the list of company_contact with filter applied.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id_id | integer |
None. |
|
name | string |
None. |
|
desc | string |
None. |
|
address | string |
None. |
|
city | string |
None. |
|
country | string |
None. |
|
responsible | integer |
None. |
|
disabled | boolean |
None. |
|
is_client | boolean |
None. |
|
is_vendor | boolean |
None. |
|
is_private_person | boolean |
None. |
|
assigned_categories | Collection of integer |
None. |
|
excluded_categories | Collection of integer |
None. |
|
string |
None. |
||
phone | string |
None. |
|
registration | string |
None. |
|
sort |
Possible sorting - "id", "id_desc", "name", "name_desc". Default is "id_desc". |
string |
None. |
skip |
Sets the SKIP number of records returned |
integer |
None. |
take |
Sets the TAKE number records returned |
integer |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of ApiCompanyContactInfoName | Description | Type | Additional information |
---|---|---|---|
id | integer |
None. |
|
id_contact | integer |
None. |
|
type | integer |
None. |
|
additional_type | integer |
None. |
|
data_string | string |
None. |
|
data_numeric | string |
None. |
|
is_subscribed | boolean |
None. |
|
id_company | integer |
None. |
Response Formats
application/json, text/json
Sample:
[ { "id": 1, "id_contact": 1, "type": 2, "additional_type": 3, "data_string": "sample string 4", "data_numeric": "sample string 5", "is_subscribed": true, "id_company": 1 }, { "id": 1, "id_contact": 1, "type": 2, "additional_type": 3, "data_string": "sample string 4", "data_numeric": "sample string 5", "is_subscribed": true, "id_company": 1 } ]
application/xml, text/xml
Sample:
<ArrayOfApiCompanyContactInfo xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ApiCompanyContactInfo> <id>1</id> <id_contact>1</id_contact> <type>2</type> <additional_type>3</additional_type> <data_string>sample string 4</data_string> <data_numeric>sample string 5</data_numeric> <is_subscribed>true</is_subscribed> <id_company>1</id_company> </ApiCompanyContactInfo> <ApiCompanyContactInfo> <id>1</id> <id_contact>1</id_contact> <type>2</type> <additional_type>3</additional_type> <data_string>sample string 4</data_string> <data_numeric>sample string 5</data_numeric> <is_subscribed>true</is_subscribed> <id_company>1</id_company> </ApiCompanyContactInfo> </ArrayOfApiCompanyContactInfo>