GET api/Department/List
Gets a list of all departments
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
JsonResponseModelOfListOfDepartment| Name | Description | Type | Mandatory when |
|---|---|---|---|
| ResponseCode | integer | ||
| ResponseMessage | string | ||
| Data | Collection of Department |
Response Formats
application/json, text/json
Sample:
{
"ResponseCode": 200,
"ResponseMessage": "Departments for customer 1000.",
"Data": [
{
"Id": 1,
"Name": "Finance",
"Description": "Financial division",
"DepartmentManagerAbbreviation": "CFO",
"MemberAbbreviations": [
"ACC",
"BA",
"CFO"
]
},
{
"Id": 2,
"Name": "Area Managers",
"Description": "",
"DepartmentManagerAbbreviation": "",
"MemberAbbreviations": [
"AM-1",
"AM-2"
]
}
]
}
text/xml
Sample:
<JsonResponseModelOfArrayOfDepartmentCyyWUdKo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RGS.API.Models">
<Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/QAP.API.ModelsForClient">
<d2p1:Department>
<d2p1:DepartmentManagerAbbreviation>CFO</d2p1:DepartmentManagerAbbreviation>
<d2p1:Description>Financial division</d2p1:Description>
<d2p1:Id>1</d2p1:Id>
<d2p1:MemberAbbreviations xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>ACC</d4p1:string>
<d4p1:string>BA</d4p1:string>
<d4p1:string>CFO</d4p1:string>
</d2p1:MemberAbbreviations>
<d2p1:Name>Finance</d2p1:Name>
</d2p1:Department>
<d2p1:Department>
<d2p1:DepartmentManagerAbbreviation></d2p1:DepartmentManagerAbbreviation>
<d2p1:Description></d2p1:Description>
<d2p1:Id>2</d2p1:Id>
<d2p1:MemberAbbreviations xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>AM-1</d4p1:string>
<d4p1:string>AM-2</d4p1:string>
</d2p1:MemberAbbreviations>
<d2p1:Name>Area Managers</d2p1:Name>
</d2p1:Department>
</Data>
<ResponseCode>200</ResponseCode>
<ResponseMessage>Departments for customer 1000.</ResponseMessage>
</JsonResponseModelOfArrayOfDepartmentCyyWUdKo>
Error Response Causes
- Invalid API credentials