Shifts

Operations to perform against shifts in a department

APIDescription
GET api/v3/Shifts/GetShifts

Get's all the shifts in a department

GET api/v3/Shifts/GetShift?id={id}

Get's all the shifts in a department

GET api/v3/Shifts/GetShiftDay?id={id}

Get's all the shifts in a department

POST api/v3/Shifts/SignupForShiftDay

No documentation available.

Security

Operations to perform against the security sub-system

APIDescription
GET api/v3/Security/GetCurrentUsersRights

Gets the current users department rights

Operations to perform against the security sub-system

APIDescription
GET api/v3/Links/GetActiveDepartmentLinks

Gets the current active department links for this department where data is bring shared to it

GET api/v3/Links/GetActiveCallsForLink?linkId={linkId}

Returns all the active calls for a specific department link

GET api/v3/Links/GetUnitStatusesForLink?linkId={linkId}

Get's all the units for a department link and their current status information

GET api/v3/Links/GetPersonnelStatusesForLink?linkId={linkId}

Get's all the personnel in a department link and their current status and staffing information

GET api/v3/Links/GetAllLinkedCallMapMarkers

Returns all the map markers for all active links

GET api/v3/Links/GetAllActiveCallsForLinks

Returns all the active calls for a specific department link

UnitLocation

Operations to perform against units in a department

APIDescription
POST api/v3/UnitLocation/SetUnitLocation

Sets the location of a unit

Department

General department level options

APIDescription
GET api/v3/Department/GetRespondingOptions

Returns all the available responding options (Calls/Stations) for the department

DepartmentStatus

General department level options

APIDescription
GET api/v3/DepartmentStatus/GetDepartmentStatus

No documentation available.

Devices

Operations to perform against devices for personnel

APIDescription
POST api/v3/Devices/RegisterDevice

Register a device to recieve push notificaiton from the Resgrid system

DELETE api/v3/Devices/UnRegisterDevice?Did={Did}&Pid={Pid}

Removed a Push Notification support by PushUriId.

POST api/v3/Devices/RegisterUnitDevice

Register a unit device to receive push notificaiton from the Resgrid system

DELETE api/v3/Devices/UnRegisterUnitDevice?Did={Did}&Pid={Pid}

Removed a Unit Push Notification support by PushUriId.

Staffing

Operations to perform against user statuses and their actions

APIDescription
GET api/v3/Staffing/GetCurrentStaffing

Gets the current staffing level (state) for the user

POST api/v3/Staffing/SetStaffing

Sets the staffing level (state) for the current user.

PUT api/v3/Staffing/SetStaffingForUser

Sets the staffing level (state) for the UserId specificed in the input data.

Avatars

Used to interact with the user avatars (profile pictures) in the Resgrid system. The authentication header isn't required to access this method.

APIDescription
GET api/v3/Avatars/Get?id={id}&HasValue={HasValue}&Value={Value}

Get a users avatar from the Resgrid system based on their ID

POST api/v3/Avatars/Upload?id={id}&HasValue={HasValue}&Value={Value}

No documentation available.

PUT api/v3/Avatars/Crop

No documentation available.

Chat

Operations to be performed against the chat system

APIDescription
GET api/v3/Chat/GetResponderChatSettings

Returns the data needed to initiate a responder class chat system

Units

Operations to perform against units in a department

APIDescription
GET api/v3/Units/GetUnitStatuses

Get's all the units in a department and their current status information

GET api/v3/Units/GetUnitStatuses?activeFilter={activeFilter}

Get's all the units in a department and their current status information

StaffingSchedules

Operations to perform against user statuses and their actions

APIDescription
GET api/v3/StaffingSchedules/GetStaffingSchedules

Gets the current staffing level (state) for the user

PUT api/v3/StaffingSchedules/ToggleStaffingSchedule

Toggles and Scheduled Staffing Level Change (Enabling or Disabling It)

POST api/v3/StaffingSchedules/CreateStaffingSchedule

Toggles and Scheduled Staffing Level Change (Enabling or Disabling It)

DELETE api/v3/StaffingSchedules/DeleteStaffingSchedule?staffingSecheduleId={staffingSecheduleId}

No documentation available.

Status

Operations to perform against user statuses and their actions

APIDescription
GET api/v3/Status/GetCurrentUserStatus

Gets the status/action for the current user. User credentials are supplied via the Auth header.

POST api/v3/Status/SetCurrentStatus

Sets the status/action for the current user.

PUT api/v3/Status/SetStatusForUser

Sets the status/action for the UserId passed into the data posted

UnitState

Operations to perform against unit statuses

APIDescription
POST api/v3/UnitState/SetUnitState

Sets the status/action for the current user.

POST api/v3/UnitState/CommitUnitStates

Sets the status/action for the current user.

Stations

Operations that can be performed against resgrid recipients, usually for sending messages

APIDescription
GET api/v3/Stations/GetStationResources

Returns all the available responding options (Calls/Stations) for the department

Personnel

Operations to perform against personnel in a department

APIDescription
GET api/v3/Personnel/GetPersonnelStatuses

Get's all the personnel in a department and their current status and staffing information

GET api/v3/Personnel/GetPersonnelStatuses?activeFilter={activeFilter}

Get's all the personnel in a department and their current status and staffing information with a filter

GET api/v3/Personnel/GetPersonnelInfo?userId={userId}

Gets information about a specific person

GET api/v3/Personnel/GetTextValue?filter={filter}

No documentation available.

Calendar

Used to interact with the calendar system

APIDescription
GET api/v3/Calendar/GetDepartmentCalendarItems

No documentation available.

GET api/v3/Calendar/GetCalendarItem?id={id}

No documentation available.

GET api/v3/Calendar/GetDepartmentCalendarItemTypes

No documentation available.

POST api/v3/Calendar/SetCalendarAttendingStatus

No documentation available.

Messages

Collection of methods to perform operations against messages

APIDescription
GET api/v3/Messages/GetMessages

Returns all inbox messages for a user.

GET api/v3/Messages/GetOutboxMessages

Returns all the outbox messages for a user.

GET api/v3/Messages/GetMessage?messageId={messageId}

Gets a specific message by it's Id.

POST api/v3/Messages/SendMessage

Sends a new message to users in the system

PUT api/v3/Messages/RespondToMessage

Deletes a messsage from the system

DELETE api/v3/Messages/DeleteMessage?messageId={messageId}

Deletes a messsage from the system

Calls

Operations to be performed against calls

APIDescription
GET api/v3/Calls/GetActiveCalls

Returns all the active calls for the department

GET api/v3/Calls/GetCall?callId={callId}

Returns a specific call from the Resgrid System

POST api/v3/Calls/SaveCall

Saves a new call in the Resgrid system

PUT api/v3/Calls/CloseCall

Closes a Resgrid call

PUT api/v3/Calls/EditCall

Updates an existing Active Call in the Resgrid system

GET api/v3/Calls/GetCallNotes?callId={callId}

Get notes for a call

GET api/v3/Calls/GetFilesForCall?callId={callId}&includeData={includeData}&type={type}

Get the files for a call in the Resgrid System

GET api/v3/Calls/GetFile?departmentId={departmentId}&id={id}

Get a users avatar from the Resgrid system based on their ID

POST api/v3/Calls/UploadFile

Attaches a file to a call

POST api/v3/Calls/AddCallNote

Get notes for a call

Connect

Operations to perform against the connect sub-system. Connect allows the public to communicate with a department.

APIDescription
GET api/v3/Connect/ListDepartments?latitude={latitude}&longitude={longitude}

No documentation available.

GET api/v3/Connect/GetDepartment?profileId={profileId}&userId={userId}

No documentation available.

POST api/v3/Connect/Register

No documentation available.

GET api/v3/Connect/GetFollows?userId={userId}

No documentation available.

GET api/v3/Connect/GetFeed?userId={userId}

No documentation available.

POST api/v3/Connect/Follow

No documentation available.

POST api/v3/Connect/UnFollow

No documentation available.

Profile

Operations to perform against a logged in users (determined via the token) profile

APIDescription
GET api/v3/Profile/GetMobileCarriers

Gets the mobile carriers in the Resgrid system. If you need a mobile carrier added contact team@resgrid.com.

GET api/v3/Profile/GetTimeZones

Gets the time zones in the Resgrid system. If you need a time zone added or corrected contact team@resgrid.com.

GET api/v3/Profile/GetProfile

Gets the Resgrid user profile for the user

GET api/v3/Profile/ToggleCustomPushSounds?enableCustomPushSounds={enableCustomPushSounds}

Toggles a users profile to enable/disable custom push sounds when the app is backgrounded.

PUT api/v3/Profile/UpdateProfile

Updates a users profile

Auth

Service to generate an authentication token that is required to communicate with all other v3 services

APIDescription
POST api/v3/Auth/Validate

Generates a token that is then used for subsquent requests to the API.

Notes

Operations to perform against a departments notes

APIDescription
GET api/v3/Notes/GetAllNotes

Get's all the notes in a department

GET api/v3/Notes/GetNote?noteId={noteId}

Gets a specific note by it's Id.

POST api/v3/Notes/SaveNote

Get's all the notes in a department