GET api/v3/Department/GetDepartmentOptions?departmentId={departmentId}

Returns basic high level department information for the request department

Request Information

URI Parameters

NameDescriptionTypeAdditional information
departmentId

integer

Required

Body Parameters

None.

Response Information

Resource Description

Array of DepartmentResult objects with the department data populated

Collection of DepartmentOptionResult
NameDescriptionTypeAdditional information
DepartmentId

Department Id for the options

integer

None.

EmailFormatType

Format type used for import call emails

integer

None.

Response Formats

application/json

Sample:
[
  {
    "DepartmentId": 1,
    "EmailFormatType": 2
  },
  {
    "DepartmentId": 1,
    "EmailFormatType": 2
  }
]

application/xml, text/xml

Sample:
<ArrayOfDepartmentOptionResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Resgrid.Web.Services.Controllers.Version3.Models.Departments">
  <DepartmentOptionResult>
    <DepartmentId>1</DepartmentId>
    <EmailFormatType>2</EmailFormatType>
  </DepartmentOptionResult>
  <DepartmentOptionResult>
    <DepartmentId>1</DepartmentId>
    <EmailFormatType>2</EmailFormatType>
  </DepartmentOptionResult>
</ArrayOfDepartmentOptionResult>