| POST | /crm/companies/get | Retrieve a list of Companies. The Filter can be used to narrow results. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Filter | form | TypeFilter | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Page | form | int | No | |
| PageSize | form | int | No | |
| Conditions | form | List<TypeCondition> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Order | form | int | No | |
| StatementLeft | form | string | No | |
| StatementOperation | form | string | No | |
| StatementRight | form | string | No | |
| LogicOperator | form | string | No | |
| ConditionTyping | form | ConditionTyping | No | |
| ConditionParameterType | form | ConditionParameterType | No |
| STRING | |
| INT | |
| BOOLEAN | |
| DATETIME |
| CONDITION | |
| CHILDCONDITION | |
| CUSTOMFIELDCONDITION | |
| ORDERBY | |
| FIELDS | |
| COLUMNS |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Result | form | Object | No | |
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /crm/companies/get HTTP/1.1
Host: n3tapi.palmettovdc.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
filter:
{
page: 0,
pageSize: 0,
conditions:
[
{
order: 0,
statementLeft: String,
statementOperation: String,
statementRight: String,
logicOperator: String,
conditionTyping: STRING,
conditionParameterType: CONDITION
}
]
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
result: {},
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}