GET api/v3/Department/Get?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 DepartmentResult
NameDescriptionTypeAdditional information
Id

Id of the Department

integer

None.

Name

The Departments name

string

None.

ManagingUserId

The UserId of the main Admin or Managing Member

string

None.

AddressId

(Optional) Id of the departments main location or map center address

integer

None.

DepartmentType

The type of department

string

None.

TimeZone

Time zone of the department

string

None.

CreatedOn

When was the department created

date

None.

UpdatedOn

When were the departments high level settings last updated

date

None.

Use24HourTime

Is the department using 24 hour time?

boolean

None.

EmailCode

The Code used to import Department Wide (All-Call) dispatches

string

None.

AdminUsers

List of UserId's that are Department Admins

Collection of string

None.

Members

List of UserId's for all members in the Deaprtment

Collection of string

None.

Response Formats

application/json

Sample:
[
  {
    "Id": 1,
    "Name": "sample string 2",
    "ManagingUserId": "sample string 3",
    "AddressId": 1,
    "DepartmentType": "sample string 4",
    "TimeZone": "sample string 5",
    "CreatedOn": "2019-11-17T23:49:09.6476429+00:00",
    "UpdatedOn": "2019-11-17T23:49:09.6476429+00:00",
    "Use24HourTime": true,
    "EmailCode": "sample string 6",
    "AdminUsers": [
      "sample string 1",
      "sample string 2"
    ],
    "Members": [
      "sample string 1",
      "sample string 2"
    ]
  },
  {
    "Id": 1,
    "Name": "sample string 2",
    "ManagingUserId": "sample string 3",
    "AddressId": 1,
    "DepartmentType": "sample string 4",
    "TimeZone": "sample string 5",
    "CreatedOn": "2019-11-17T23:49:09.6476429+00:00",
    "UpdatedOn": "2019-11-17T23:49:09.6476429+00:00",
    "Use24HourTime": true,
    "EmailCode": "sample string 6",
    "AdminUsers": [
      "sample string 1",
      "sample string 2"
    ],
    "Members": [
      "sample string 1",
      "sample string 2"
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfDepartmentResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Resgrid.Web.Services.Controllers.Version3.Models.Departments">
  <DepartmentResult>
    <AddressId>1</AddressId>
    <AdminUsers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </AdminUsers>
    <CreatedOn>2019-11-17T23:49:09.6476429+00:00</CreatedOn>
    <DepartmentType>sample string 4</DepartmentType>
    <EmailCode>sample string 6</EmailCode>
    <Id>1</Id>
    <ManagingUserId>sample string 3</ManagingUserId>
    <Members xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Members>
    <Name>sample string 2</Name>
    <TimeZone>sample string 5</TimeZone>
    <UpdatedOn>2019-11-17T23:49:09.6476429+00:00</UpdatedOn>
    <Use24HourTime>true</Use24HourTime>
  </DepartmentResult>
  <DepartmentResult>
    <AddressId>1</AddressId>
    <AdminUsers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </AdminUsers>
    <CreatedOn>2019-11-17T23:49:09.6476429+00:00</CreatedOn>
    <DepartmentType>sample string 4</DepartmentType>
    <EmailCode>sample string 6</EmailCode>
    <Id>1</Id>
    <ManagingUserId>sample string 3</ManagingUserId>
    <Members xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Members>
    <Name>sample string 2</Name>
    <TimeZone>sample string 5</TimeZone>
    <UpdatedOn>2019-11-17T23:49:09.6476429+00:00</UpdatedOn>
    <Use24HourTime>true</Use24HourTime>
  </DepartmentResult>
</ArrayOfDepartmentResult>