GET api/v3/Commands/GetAllCommands

Gets all the command definitions for the department

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

AllCommandsResult object with a list of CommandResult's for each command

AllCommandsResult
NameDescriptionTypeAdditional information
Commmands

Collection of CommandResult

None.

Response Formats

application/json

Sample:
{
  "Commmands": [
    {
      "Id": 1,
      "CallTypeId": 1,
      "Timer": true,
      "TimerMinutes": 3,
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Assignments": [
        {
          "RoleId": 1,
          "CommandId": 2,
          "Name": "sample string 3",
          "Description": "sample string 4",
          "MinUnitPersonnel": 5,
          "MaxUnitPersonnel": 6,
          "MaxUnits": 7,
          "MinTimeInRole": 8,
          "MaxTimeInRole": 9,
          "ForceRequirements": true,
          "RequiredUnitTypes": [
            {
              "Id": 1,
              "RoleId": 2,
              "UnitTypeId": 3
            },
            {
              "Id": 1,
              "RoleId": 2,
              "UnitTypeId": 3
            }
          ],
          "RequiredCerts": [
            {
              "Id": 1,
              "RoleId": 2,
              "CertificationTypeId": 3
            },
            {
              "Id": 1,
              "RoleId": 2,
              "CertificationTypeId": 3
            }
          ],
          "RequiredRoles": [
            {
              "Id": 1,
              "RoleId": 2,
              "PersonnelRoleId": 3
            },
            {
              "Id": 1,
              "RoleId": 2,
              "PersonnelRoleId": 3
            }
          ]
        },
        {
          "RoleId": 1,
          "CommandId": 2,
          "Name": "sample string 3",
          "Description": "sample string 4",
          "MinUnitPersonnel": 5,
          "MaxUnitPersonnel": 6,
          "MaxUnits": 7,
          "MinTimeInRole": 8,
          "MaxTimeInRole": 9,
          "ForceRequirements": true,
          "RequiredUnitTypes": [
            {
              "Id": 1,
              "RoleId": 2,
              "UnitTypeId": 3
            },
            {
              "Id": 1,
              "RoleId": 2,
              "UnitTypeId": 3
            }
          ],
          "RequiredCerts": [
            {
              "Id": 1,
              "RoleId": 2,
              "CertificationTypeId": 3
            },
            {
              "Id": 1,
              "RoleId": 2,
              "CertificationTypeId": 3
            }
          ],
          "RequiredRoles": [
            {
              "Id": 1,
              "RoleId": 2,
              "PersonnelRoleId": 3
            },
            {
              "Id": 1,
              "RoleId": 2,
              "PersonnelRoleId": 3
            }
          ]
        }
      ]
    },
    {
      "Id": 1,
      "CallTypeId": 1,
      "Timer": true,
      "TimerMinutes": 3,
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Assignments": [
        {
          "RoleId": 1,
          "CommandId": 2,
          "Name": "sample string 3",
          "Description": "sample string 4",
          "MinUnitPersonnel": 5,
          "MaxUnitPersonnel": 6,
          "MaxUnits": 7,
          "MinTimeInRole": 8,
          "MaxTimeInRole": 9,
          "ForceRequirements": true,
          "RequiredUnitTypes": [
            {
              "Id": 1,
              "RoleId": 2,
              "UnitTypeId": 3
            },
            {
              "Id": 1,
              "RoleId": 2,
              "UnitTypeId": 3
            }
          ],
          "RequiredCerts": [
            {
              "Id": 1,
              "RoleId": 2,
              "CertificationTypeId": 3
            },
            {
              "Id": 1,
              "RoleId": 2,
              "CertificationTypeId": 3
            }
          ],
          "RequiredRoles": [
            {
              "Id": 1,
              "RoleId": 2,
              "PersonnelRoleId": 3
            },
            {
              "Id": 1,
              "RoleId": 2,
              "PersonnelRoleId": 3
            }
          ]
        },
        {
          "RoleId": 1,
          "CommandId": 2,
          "Name": "sample string 3",
          "Description": "sample string 4",
          "MinUnitPersonnel": 5,
          "MaxUnitPersonnel": 6,
          "MaxUnits": 7,
          "MinTimeInRole": 8,
          "MaxTimeInRole": 9,
          "ForceRequirements": true,
          "RequiredUnitTypes": [
            {
              "Id": 1,
              "RoleId": 2,
              "UnitTypeId": 3
            },
            {
              "Id": 1,
              "RoleId": 2,
              "UnitTypeId": 3
            }
          ],
          "RequiredCerts": [
            {
              "Id": 1,
              "RoleId": 2,
              "CertificationTypeId": 3
            },
            {
              "Id": 1,
              "RoleId": 2,
              "CertificationTypeId": 3
            }
          ],
          "RequiredRoles": [
            {
              "Id": 1,
              "RoleId": 2,
              "PersonnelRoleId": 3
            },
            {
              "Id": 1,
              "RoleId": 2,
              "PersonnelRoleId": 3
            }
          ]
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<AllCommandsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Resgrid.Web.Services.Controllers.Version3.Models.Commands">
  <Commmands>
    <CommandResult>
      <Assignments>
        <CommandAssignmentResult>
          <CommandId>2</CommandId>
          <Description>sample string 4</Description>
          <ForceRequirements>true</ForceRequirements>
          <MaxTimeInRole>9</MaxTimeInRole>
          <MaxUnitPersonnel>6</MaxUnitPersonnel>
          <MaxUnits>7</MaxUnits>
          <MinTimeInRole>8</MinTimeInRole>
          <MinUnitPersonnel>5</MinUnitPersonnel>
          <Name>sample string 3</Name>
          <RequiredCerts>
            <AssignmentCertResult>
              <CertificationTypeId>3</CertificationTypeId>
              <Id>1</Id>
              <RoleId>2</RoleId>
            </AssignmentCertResult>
            <AssignmentCertResult>
              <CertificationTypeId>3</CertificationTypeId>
              <Id>1</Id>
              <RoleId>2</RoleId>
            </AssignmentCertResult>
          </RequiredCerts>
          <RequiredRoles>
            <AssignmentPersonnelResult>
              <Id>1</Id>
              <PersonnelRoleId>3</PersonnelRoleId>
              <RoleId>2</RoleId>
            </AssignmentPersonnelResult>
            <AssignmentPersonnelResult>
              <Id>1</Id>
              <PersonnelRoleId>3</PersonnelRoleId>
              <RoleId>2</RoleId>
            </AssignmentPersonnelResult>
          </RequiredRoles>
          <RequiredUnitTypes>
            <AssignmentUnitTypeResult>
              <Id>1</Id>
              <RoleId>2</RoleId>
              <UnitTypeId>3</UnitTypeId>
            </AssignmentUnitTypeResult>
            <AssignmentUnitTypeResult>
              <Id>1</Id>
              <RoleId>2</RoleId>
              <UnitTypeId>3</UnitTypeId>
            </AssignmentUnitTypeResult>
          </RequiredUnitTypes>
          <RoleId>1</RoleId>
        </CommandAssignmentResult>
        <CommandAssignmentResult>
          <CommandId>2</CommandId>
          <Description>sample string 4</Description>
          <ForceRequirements>true</ForceRequirements>
          <MaxTimeInRole>9</MaxTimeInRole>
          <MaxUnitPersonnel>6</MaxUnitPersonnel>
          <MaxUnits>7</MaxUnits>
          <MinTimeInRole>8</MinTimeInRole>
          <MinUnitPersonnel>5</MinUnitPersonnel>
          <Name>sample string 3</Name>
          <RequiredCerts>
            <AssignmentCertResult>
              <CertificationTypeId>3</CertificationTypeId>
              <Id>1</Id>
              <RoleId>2</RoleId>
            </AssignmentCertResult>
            <AssignmentCertResult>
              <CertificationTypeId>3</CertificationTypeId>
              <Id>1</Id>
              <RoleId>2</RoleId>
            </AssignmentCertResult>
          </RequiredCerts>
          <RequiredRoles>
            <AssignmentPersonnelResult>
              <Id>1</Id>
              <PersonnelRoleId>3</PersonnelRoleId>
              <RoleId>2</RoleId>
            </AssignmentPersonnelResult>
            <AssignmentPersonnelResult>
              <Id>1</Id>
              <PersonnelRoleId>3</PersonnelRoleId>
              <RoleId>2</RoleId>
            </AssignmentPersonnelResult>
          </RequiredRoles>
          <RequiredUnitTypes>
            <AssignmentUnitTypeResult>
              <Id>1</Id>
              <RoleId>2</RoleId>
              <UnitTypeId>3</UnitTypeId>
            </AssignmentUnitTypeResult>
            <AssignmentUnitTypeResult>
              <Id>1</Id>
              <RoleId>2</RoleId>
              <UnitTypeId>3</UnitTypeId>
            </AssignmentUnitTypeResult>
          </RequiredUnitTypes>
          <RoleId>1</RoleId>
        </CommandAssignmentResult>
      </Assignments>
      <CallTypeId>1</CallTypeId>
      <Description>sample string 5</Description>
      <Id>1</Id>
      <Name>sample string 4</Name>
      <Timer>true</Timer>
      <TimerMinutes>3</TimerMinutes>
    </CommandResult>
    <CommandResult>
      <Assignments>
        <CommandAssignmentResult>
          <CommandId>2</CommandId>
          <Description>sample string 4</Description>
          <ForceRequirements>true</ForceRequirements>
          <MaxTimeInRole>9</MaxTimeInRole>
          <MaxUnitPersonnel>6</MaxUnitPersonnel>
          <MaxUnits>7</MaxUnits>
          <MinTimeInRole>8</MinTimeInRole>
          <MinUnitPersonnel>5</MinUnitPersonnel>
          <Name>sample string 3</Name>
          <RequiredCerts>
            <AssignmentCertResult>
              <CertificationTypeId>3</CertificationTypeId>
              <Id>1</Id>
              <RoleId>2</RoleId>
            </AssignmentCertResult>
            <AssignmentCertResult>
              <CertificationTypeId>3</CertificationTypeId>
              <Id>1</Id>
              <RoleId>2</RoleId>
            </AssignmentCertResult>
          </RequiredCerts>
          <RequiredRoles>
            <AssignmentPersonnelResult>
              <Id>1</Id>
              <PersonnelRoleId>3</PersonnelRoleId>
              <RoleId>2</RoleId>
            </AssignmentPersonnelResult>
            <AssignmentPersonnelResult>
              <Id>1</Id>
              <PersonnelRoleId>3</PersonnelRoleId>
              <RoleId>2</RoleId>
            </AssignmentPersonnelResult>
          </RequiredRoles>
          <RequiredUnitTypes>
            <AssignmentUnitTypeResult>
              <Id>1</Id>
              <RoleId>2</RoleId>
              <UnitTypeId>3</UnitTypeId>
            </AssignmentUnitTypeResult>
            <AssignmentUnitTypeResult>
              <Id>1</Id>
              <RoleId>2</RoleId>
              <UnitTypeId>3</UnitTypeId>
            </AssignmentUnitTypeResult>
          </RequiredUnitTypes>
          <RoleId>1</RoleId>
        </CommandAssignmentResult>
        <CommandAssignmentResult>
          <CommandId>2</CommandId>
          <Description>sample string 4</Description>
          <ForceRequirements>true</ForceRequirements>
          <MaxTimeInRole>9</MaxTimeInRole>
          <MaxUnitPersonnel>6</MaxUnitPersonnel>
          <MaxUnits>7</MaxUnits>
          <MinTimeInRole>8</MinTimeInRole>
          <MinUnitPersonnel>5</MinUnitPersonnel>
          <Name>sample string 3</Name>
          <RequiredCerts>
            <AssignmentCertResult>
              <CertificationTypeId>3</CertificationTypeId>
              <Id>1</Id>
              <RoleId>2</RoleId>
            </AssignmentCertResult>
            <AssignmentCertResult>
              <CertificationTypeId>3</CertificationTypeId>
              <Id>1</Id>
              <RoleId>2</RoleId>
            </AssignmentCertResult>
          </RequiredCerts>
          <RequiredRoles>
            <AssignmentPersonnelResult>
              <Id>1</Id>
              <PersonnelRoleId>3</PersonnelRoleId>
              <RoleId>2</RoleId>
            </AssignmentPersonnelResult>
            <AssignmentPersonnelResult>
              <Id>1</Id>
              <PersonnelRoleId>3</PersonnelRoleId>
              <RoleId>2</RoleId>
            </AssignmentPersonnelResult>
          </RequiredRoles>
          <RequiredUnitTypes>
            <AssignmentUnitTypeResult>
              <Id>1</Id>
              <RoleId>2</RoleId>
              <UnitTypeId>3</UnitTypeId>
            </AssignmentUnitTypeResult>
            <AssignmentUnitTypeResult>
              <Id>1</Id>
              <RoleId>2</RoleId>
              <UnitTypeId>3</UnitTypeId>
            </AssignmentUnitTypeResult>
          </RequiredUnitTypes>
          <RoleId>1</RoleId>
        </CommandAssignmentResult>
      </Assignments>
      <CallTypeId>1</CallTypeId>
      <Description>sample string 5</Description>
      <Id>1</Id>
      <Name>sample string 4</Name>
      <Timer>true</Timer>
      <TimerMinutes>3</TimerMinutes>
    </CommandResult>
  </Commmands>
</AllCommandsResult>