GET api/v3/Protocols/GetAllProtocols

Get's all the protocols for a department

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

List of ProtocolResult objects.

Collection of ProtocolResult
NameDescriptionTypeAdditional information
Id

integer

None.

DepartmentId

integer

None.

Name

string

None.

Code

string

None.

IsDisabled

boolean

None.

Description

string

None.

ProtocolText

string

None.

CreatedOn

date

None.

CreatedByUserId

string

None.

UpdatedOn

date

None.

MinimumWeight

integer

None.

UpdatedByUserId

string

None.

Triggers

Collection of ProtocolTriggerResult

None.

Attachments

Collection of ProtocolTriggerAttachmentResult

None.

Questions

Collection of ProtocolTriggerQuestionResult

None.

State

integer

None.

Response Formats

application/json

Sample:
[
  {
    "Id": 1,
    "DepartmentId": 2,
    "Name": "sample string 3",
    "Code": "sample string 4",
    "IsDisabled": true,
    "Description": "sample string 6",
    "ProtocolText": "sample string 7",
    "CreatedOn": "2020-08-14T11:15:15.5551378+00:00",
    "CreatedByUserId": "sample string 9",
    "UpdatedOn": "2020-08-14T11:15:15.5551378+00:00",
    "MinimumWeight": 10,
    "UpdatedByUserId": "sample string 11",
    "Triggers": [
      {
        "Id": 1,
        "Type": 2,
        "StartsOn": "2020-08-14T11:15:15.5707656+00:00",
        "EndsOn": "2020-08-14T11:15:15.5707656+00:00",
        "Priority": 1,
        "CallType": "sample string 3",
        "Geofence": "sample string 4"
      },
      {
        "Id": 1,
        "Type": 2,
        "StartsOn": "2020-08-14T11:15:15.5707656+00:00",
        "EndsOn": "2020-08-14T11:15:15.5707656+00:00",
        "Priority": 1,
        "CallType": "sample string 3",
        "Geofence": "sample string 4"
      }
    ],
    "Attachments": [
      {
        "Id": 1,
        "FileName": "sample string 2",
        "FileType": "sample string 3"
      },
      {
        "Id": 1,
        "FileName": "sample string 2",
        "FileType": "sample string 3"
      }
    ],
    "Questions": [
      {
        "Id": 1,
        "Question": "sample string 2",
        "Answers": [
          {
            "Id": 1,
            "Answer": "sample string 2",
            "Weight": 3
          },
          {
            "Id": 1,
            "Answer": "sample string 2",
            "Weight": 3
          }
        ]
      },
      {
        "Id": 1,
        "Question": "sample string 2",
        "Answers": [
          {
            "Id": 1,
            "Answer": "sample string 2",
            "Weight": 3
          },
          {
            "Id": 1,
            "Answer": "sample string 2",
            "Weight": 3
          }
        ]
      }
    ],
    "State": 12
  },
  {
    "Id": 1,
    "DepartmentId": 2,
    "Name": "sample string 3",
    "Code": "sample string 4",
    "IsDisabled": true,
    "Description": "sample string 6",
    "ProtocolText": "sample string 7",
    "CreatedOn": "2020-08-14T11:15:15.5551378+00:00",
    "CreatedByUserId": "sample string 9",
    "UpdatedOn": "2020-08-14T11:15:15.5551378+00:00",
    "MinimumWeight": 10,
    "UpdatedByUserId": "sample string 11",
    "Triggers": [
      {
        "Id": 1,
        "Type": 2,
        "StartsOn": "2020-08-14T11:15:15.5707656+00:00",
        "EndsOn": "2020-08-14T11:15:15.5707656+00:00",
        "Priority": 1,
        "CallType": "sample string 3",
        "Geofence": "sample string 4"
      },
      {
        "Id": 1,
        "Type": 2,
        "StartsOn": "2020-08-14T11:15:15.5707656+00:00",
        "EndsOn": "2020-08-14T11:15:15.5707656+00:00",
        "Priority": 1,
        "CallType": "sample string 3",
        "Geofence": "sample string 4"
      }
    ],
    "Attachments": [
      {
        "Id": 1,
        "FileName": "sample string 2",
        "FileType": "sample string 3"
      },
      {
        "Id": 1,
        "FileName": "sample string 2",
        "FileType": "sample string 3"
      }
    ],
    "Questions": [
      {
        "Id": 1,
        "Question": "sample string 2",
        "Answers": [
          {
            "Id": 1,
            "Answer": "sample string 2",
            "Weight": 3
          },
          {
            "Id": 1,
            "Answer": "sample string 2",
            "Weight": 3
          }
        ]
      },
      {
        "Id": 1,
        "Question": "sample string 2",
        "Answers": [
          {
            "Id": 1,
            "Answer": "sample string 2",
            "Weight": 3
          },
          {
            "Id": 1,
            "Answer": "sample string 2",
            "Weight": 3
          }
        ]
      }
    ],
    "State": 12
  }
]

application/xml, text/xml

Sample:
<ArrayOfProtocolResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Resgrid.Web.Services.Controllers.Version3.Models.Protocols">
  <ProtocolResult>
    <Attachments>
      <ProtocolTriggerAttachmentResult>
        <FileName>sample string 2</FileName>
        <FileType>sample string 3</FileType>
        <Id>1</Id>
      </ProtocolTriggerAttachmentResult>
      <ProtocolTriggerAttachmentResult>
        <FileName>sample string 2</FileName>
        <FileType>sample string 3</FileType>
        <Id>1</Id>
      </ProtocolTriggerAttachmentResult>
    </Attachments>
    <Code>sample string 4</Code>
    <CreatedByUserId>sample string 9</CreatedByUserId>
    <CreatedOn>2020-08-14T11:15:15.5551378+00:00</CreatedOn>
    <DepartmentId>2</DepartmentId>
    <Description>sample string 6</Description>
    <Id>1</Id>
    <IsDisabled>true</IsDisabled>
    <MinimumWeight>10</MinimumWeight>
    <Name>sample string 3</Name>
    <ProtocolText>sample string 7</ProtocolText>
    <Questions>
      <ProtocolTriggerQuestionResult>
        <Answers>
          <ProtocolQuestionAnswerResult>
            <Answer>sample string 2</Answer>
            <Id>1</Id>
            <Weight>3</Weight>
          </ProtocolQuestionAnswerResult>
          <ProtocolQuestionAnswerResult>
            <Answer>sample string 2</Answer>
            <Id>1</Id>
            <Weight>3</Weight>
          </ProtocolQuestionAnswerResult>
        </Answers>
        <Id>1</Id>
        <Question>sample string 2</Question>
      </ProtocolTriggerQuestionResult>
      <ProtocolTriggerQuestionResult>
        <Answers>
          <ProtocolQuestionAnswerResult>
            <Answer>sample string 2</Answer>
            <Id>1</Id>
            <Weight>3</Weight>
          </ProtocolQuestionAnswerResult>
          <ProtocolQuestionAnswerResult>
            <Answer>sample string 2</Answer>
            <Id>1</Id>
            <Weight>3</Weight>
          </ProtocolQuestionAnswerResult>
        </Answers>
        <Id>1</Id>
        <Question>sample string 2</Question>
      </ProtocolTriggerQuestionResult>
    </Questions>
    <State>12</State>
    <Triggers>
      <ProtocolTriggerResult>
        <CallType>sample string 3</CallType>
        <EndsOn>2020-08-14T11:15:15.5707656+00:00</EndsOn>
        <Geofence>sample string 4</Geofence>
        <Id>1</Id>
        <Priority>1</Priority>
        <StartsOn>2020-08-14T11:15:15.5707656+00:00</StartsOn>
        <Type>2</Type>
      </ProtocolTriggerResult>
      <ProtocolTriggerResult>
        <CallType>sample string 3</CallType>
        <EndsOn>2020-08-14T11:15:15.5707656+00:00</EndsOn>
        <Geofence>sample string 4</Geofence>
        <Id>1</Id>
        <Priority>1</Priority>
        <StartsOn>2020-08-14T11:15:15.5707656+00:00</StartsOn>
        <Type>2</Type>
      </ProtocolTriggerResult>
    </Triggers>
    <UpdatedByUserId>sample string 11</UpdatedByUserId>
    <UpdatedOn>2020-08-14T11:15:15.5551378+00:00</UpdatedOn>
  </ProtocolResult>
  <ProtocolResult>
    <Attachments>
      <ProtocolTriggerAttachmentResult>
        <FileName>sample string 2</FileName>
        <FileType>sample string 3</FileType>
        <Id>1</Id>
      </ProtocolTriggerAttachmentResult>
      <ProtocolTriggerAttachmentResult>
        <FileName>sample string 2</FileName>
        <FileType>sample string 3</FileType>
        <Id>1</Id>
      </ProtocolTriggerAttachmentResult>
    </Attachments>
    <Code>sample string 4</Code>
    <CreatedByUserId>sample string 9</CreatedByUserId>
    <CreatedOn>2020-08-14T11:15:15.5551378+00:00</CreatedOn>
    <DepartmentId>2</DepartmentId>
    <Description>sample string 6</Description>
    <Id>1</Id>
    <IsDisabled>true</IsDisabled>
    <MinimumWeight>10</MinimumWeight>
    <Name>sample string 3</Name>
    <ProtocolText>sample string 7</ProtocolText>
    <Questions>
      <ProtocolTriggerQuestionResult>
        <Answers>
          <ProtocolQuestionAnswerResult>
            <Answer>sample string 2</Answer>
            <Id>1</Id>
            <Weight>3</Weight>
          </ProtocolQuestionAnswerResult>
          <ProtocolQuestionAnswerResult>
            <Answer>sample string 2</Answer>
            <Id>1</Id>
            <Weight>3</Weight>
          </ProtocolQuestionAnswerResult>
        </Answers>
        <Id>1</Id>
        <Question>sample string 2</Question>
      </ProtocolTriggerQuestionResult>
      <ProtocolTriggerQuestionResult>
        <Answers>
          <ProtocolQuestionAnswerResult>
            <Answer>sample string 2</Answer>
            <Id>1</Id>
            <Weight>3</Weight>
          </ProtocolQuestionAnswerResult>
          <ProtocolQuestionAnswerResult>
            <Answer>sample string 2</Answer>
            <Id>1</Id>
            <Weight>3</Weight>
          </ProtocolQuestionAnswerResult>
        </Answers>
        <Id>1</Id>
        <Question>sample string 2</Question>
      </ProtocolTriggerQuestionResult>
    </Questions>
    <State>12</State>
    <Triggers>
      <ProtocolTriggerResult>
        <CallType>sample string 3</CallType>
        <EndsOn>2020-08-14T11:15:15.5707656+00:00</EndsOn>
        <Geofence>sample string 4</Geofence>
        <Id>1</Id>
        <Priority>1</Priority>
        <StartsOn>2020-08-14T11:15:15.5707656+00:00</StartsOn>
        <Type>2</Type>
      </ProtocolTriggerResult>
      <ProtocolTriggerResult>
        <CallType>sample string 3</CallType>
        <EndsOn>2020-08-14T11:15:15.5707656+00:00</EndsOn>
        <Geofence>sample string 4</Geofence>
        <Id>1</Id>
        <Priority>1</Priority>
        <StartsOn>2020-08-14T11:15:15.5707656+00:00</StartsOn>
        <Type>2</Type>
      </ProtocolTriggerResult>
    </Triggers>
    <UpdatedByUserId>sample string 11</UpdatedByUserId>
    <UpdatedOn>2020-08-14T11:15:15.5551378+00:00</UpdatedOn>
  </ProtocolResult>
</ArrayOfProtocolResult>