GET 3dCartWebAPI/v1/CRM/department
Get all CRM Departments
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
limit |
Maximum number of items that can be returned |
integer |
Default value is 10 |
offset |
Starting point for the return data |
integer |
Default value is 1 |
countonly |
Count the number of rows only |
integer |
Default value is 0 |
Body Parameters
None.
Sample Request |
|
Response Information
Resource Description
Collection of CrmDepartmentName | Description | Type | Additional information |
---|---|---|---|
DepartmentId |
Primary key. Auto-incremented. database reference = CRM_Department.id |
integer |
None. |
Name |
database reference = CRM_Department.department |
string |
String length: inclusive between 0 and 255 |
Visible |
database reference = CRM_Department.visible |
boolean |
None. |
Response Formats
application/json, text/json
Sample:
[ { "DepartmentId": 1, "Name": "sample string 1", "Visible": true }, { "DepartmentId": 1, "Name": "sample string 1", "Visible": true } ]
application/xml, text/xml
Sample:
<ArrayOfCrmDepartment xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <CrmDepartment> <DepartmentId>1</DepartmentId> <Name>sample string 1</Name> <Visible>true</Visible> </CrmDepartment> <CrmDepartment> <DepartmentId>1</DepartmentId> <Name>sample string 1</Name> <Visible>true</Visible> </CrmDepartment> </ArrayOfCrmDepartment>