GET api/Phone/Forms/{staffId}/{form}/update/{formType}

Request Information

URI Parameters

Name	Type	Additional information
staffId	string	Required
form	string	Required
formType	string	Required

Body Parameters

None.

Response Information

Resource Description

ProcessAudit

Name	Type	Additional information
SendToTraining	boolean	None.
Id	integer	None.
Name	string	None.
NameUpper	string	None.
Description	string	None.
DeviceIdentifier	string	None.
Status	string	None.
IsActive	boolean	None.
IsVisible	boolean	None.
IconHexColor	string	None.
Icon	string	None.
Indent	integer	None.
LastPerformed	string	None.
LastScore	decimal number	None.
ScheduledLocation	string	None.
ScheduledDate	date	None.
TypeOfWorkType	string	None.
ScheduledTime	time interval	None.
Scheduled	boolean	None.
Forms	Collection of FormLite	None.
Steps	Collection of ProcessAuditStep	None.
Hazards	Collection of ProcessAuditElement	None.
Tasks	Collection of ProcessAuditElement	None.
Ppe	Collection of ProcessAuditPpeGroup	None.
Blurbs	Collection of ProcessAuditElement	None.
Parts	Collection of ProcessAuditElement	None.
Conditions	Collection of ProcessAuditElement	None.
Remedies	Collection of ProcessAuditElement	None.
Locations	Collection of ProcessAuditElement	None.
EquipmentTypes	Collection of ProcessAuditElement	None.
PpeFlat	Collection of PpeElement	None.
Notes	ProcessAuditNote	None.
Score	ProcessAuditScore	None.
LastSaved	date	None.
NoSteps	boolean	None.
IsProcess	boolean	None.
IsTask	boolean	None.
ElevatorLocation	string	None.
PleaseSelect	boolean	None.
Menus	Collection of MenuLite	None.
Questions	Collection of QuestionsLite	None.

Response Formats

application/json, text/json

Sample:

{
  "SendToTraining": true,
  "Id": 2,
  "Name": "sample string 3",
  "NameUpper": "SAMPLE STRING 3",
  "Description": "sample string 4",
  "DeviceIdentifier": "sample string 5",
  "Status": "sample string 6",
  "IsActive": true,
  "IsVisible": true,
  "IconHexColor": "sample string 9",
  "Icon": "sample string 10",
  "Indent": 11,
  "LastPerformed": "sample string 12",
  "LastScore": 13.1,
  "ScheduledLocation": "sample string 14",
  "ScheduledDate": "2025-12-15T08:37:35.926952-05:00",
  "TypeOfWorkType": "sample string 16",
  "ScheduledTime": "00:00:00.1234567",
  "Scheduled": true,
  "Forms": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Type": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Type": "sample string 3"
    }
  ],
  "Steps": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Comment": "sample string 4",
      "Image": "QEA=",
      "Details": "sample string 5",
      "Selected": true,
      "Icon": "󰗡"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Comment": "sample string 4",
      "Image": "QEA=",
      "Details": "sample string 5",
      "Selected": true,
      "Icon": "󰗡"
    }
  ],
  "Hazards": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Selected": true
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Selected": true
    }
  ],
  "Tasks": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Selected": true
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Selected": true
    }
  ],
  "Ppe": [
    {
      "Id": 1,
      "GroupName": "sample string 2",
      "Elements": [
        {
          "GroupName": "sample string 1",
          "Id": 2,
          "Name": "sample string 3",
          "Description": "sample string 4",
          "Selected": true,
          "Icon": "󰗡"
        },
        {
          "GroupName": "sample string 1",
          "Id": 2,
          "Name": "sample string 3",
          "Description": "sample string 4",
          "Selected": true,
          "Icon": "󰗡"
        }
      ]
    },
    {
      "Id": 1,
      "GroupName": "sample string 2",
      "Elements": [
        {
          "GroupName": "sample string 1",
          "Id": 2,
          "Name": "sample string 3",
          "Description": "sample string 4",
          "Selected": true,
          "Icon": "󰗡"
        },
        {
          "GroupName": "sample string 1",
          "Id": 2,
          "Name": "sample string 3",
          "Description": "sample string 4",
          "Selected": true,
          "Icon": "󰗡"
        }
      ]
    }
  ],
  "Blurbs": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Selected": true
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Selected": true
    }
  ],
  "Parts": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Selected": true
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Selected": true
    }
  ],
  "Conditions": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Selected": true
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Selected": true
    }
  ],
  "Remedies": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Selected": true
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Selected": true
    }
  ],
  "Locations": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Selected": true
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Selected": true
    }
  ],
  "EquipmentTypes": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Selected": true
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Selected": true
    }
  ],
  "PpeFlat": [
    {
      "GroupName": "sample string 1",
      "Id": 2,
      "Name": "sample string 3",
      "Description": "sample string 4",
      "Selected": true,
      "Icon": "󰗡"
    },
    {
      "GroupName": "sample string 1",
      "Id": 2,
      "Name": "sample string 3",
      "Description": "sample string 4",
      "Selected": true,
      "Icon": "󰗡"
    }
  ],
  "Notes": {
    "Comment": "sample string 1",
    "Image": "QEA="
  },
  "Score": {
    "Total": 1,
    "Pass": 2,
    "Fails": 3,
    "CompletedOn": "2025-12-15T08:37:35.926952-05:00",
    "Rating": 5,
    "SendToTraining": true
  },
  "LastSaved": "2025-12-15T08:37:35.926952-05:00",
  "NoSteps": true,
  "IsProcess": true,
  "IsTask": true,
  "ElevatorLocation": "sample string 23",
  "PleaseSelect": true,
  "Menus": [
    {
      "Name": "sample string 1",
      "Description": "sample string 2",
      "Id": 3,
      "Type": "sample string 4"
    },
    {
      "Name": "sample string 1",
      "Description": "sample string 2",
      "Id": 3,
      "Type": "sample string 4"
    }
  ],
  "Questions": [
    {
      "Id": 1,
      "Order": 2,
      "Title": "sample string 3",
      "Description": "sample string 4",
      "AnswerType": "sample string 5",
      "CorrectAnswer": 1,
      "Group": "sample string 6",
      "Multis": [
        {
          "Id": 1,
          "Value": "sample string 2"
        },
        {
          "Id": 1,
          "Value": "sample string 2"
        }
      ],
      "Parts": [
        {
          "Id": 1,
          "Code": "sample string 2",
          "Name": "sample string 3",
          "LocationId": 1,
          "SubLocationId": 1,
          "PartType": "sample string 4"
        },
        {
          "Id": 1,
          "Code": "sample string 2",
          "Name": "sample string 3",
          "LocationId": 1,
          "SubLocationId": 1,
          "PartType": "sample string 4"
        }
      ],
      "Conditions": [
        {
          "Id": 1,
          "Code": "sample string 2",
          "Name": "sample string 3",
          "LocationId": 1,
          "SubLocationId": 1,
          "PartType": "sample string 4"
        },
        {
          "Id": 1,
          "Code": "sample string 2",
          "Name": "sample string 3",
          "LocationId": 1,
          "SubLocationId": 1,
          "PartType": "sample string 4"
        }
      ],
      "Remedies": [
        {
          "Id": 1,
          "Code": "sample string 2",
          "Name": "sample string 3",
          "LocationId": 1,
          "SubLocationId": 1,
          "PartType": "sample string 4"
        },
        {
          "Id": 1,
          "Code": "sample string 2",
          "Name": "sample string 3",
          "LocationId": 1,
          "SubLocationId": 1,
          "PartType": "sample string 4"
        }
      ]
    },
    {
      "Id": 1,
      "Order": 2,
      "Title": "sample string 3",
      "Description": "sample string 4",
      "AnswerType": "sample string 5",
      "CorrectAnswer": 1,
      "Group": "sample string 6",
      "Multis": [
        {
          "Id": 1,
          "Value": "sample string 2"
        },
        {
          "Id": 1,
          "Value": "sample string 2"
        }
      ],
      "Parts": [
        {
          "Id": 1,
          "Code": "sample string 2",
          "Name": "sample string 3",
          "LocationId": 1,
          "SubLocationId": 1,
          "PartType": "sample string 4"
        },
        {
          "Id": 1,
          "Code": "sample string 2",
          "Name": "sample string 3",
          "LocationId": 1,
          "SubLocationId": 1,
          "PartType": "sample string 4"
        }
      ],
      "Conditions": [
        {
          "Id": 1,
          "Code": "sample string 2",
          "Name": "sample string 3",
          "LocationId": 1,
          "SubLocationId": 1,
          "PartType": "sample string 4"
        },
        {
          "Id": 1,
          "Code": "sample string 2",
          "Name": "sample string 3",
          "LocationId": 1,
          "SubLocationId": 1,
          "PartType": "sample string 4"
        }
      ],
      "Remedies": [
        {
          "Id": 1,
          "Code": "sample string 2",
          "Name": "sample string 3",
          "LocationId": 1,
          "SubLocationId": 1,
          "PartType": "sample string 4"
        },
        {
          "Id": 1,
          "Code": "sample string 2",
          "Name": "sample string 3",
          "LocationId": 1,
          "SubLocationId": 1,
          "PartType": "sample string 4"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<ProcessAudit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Icculus.Portal.Controllers.Phone">
  <Blurbs>
    <ProcessAuditElement>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Selected>true</Selected>
    </ProcessAuditElement>
    <ProcessAuditElement>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Selected>true</Selected>
    </ProcessAuditElement>
  </Blurbs>
  <Conditions>
    <ProcessAuditElement>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Selected>true</Selected>
    </ProcessAuditElement>
    <ProcessAuditElement>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Selected>true</Selected>
    </ProcessAuditElement>
  </Conditions>
  <Description>sample string 4</Description>
  <DeviceIdentifier>sample string 5</DeviceIdentifier>
  <ElevatorLocation>sample string 23</ElevatorLocation>
  <EquipmentTypes>
    <ProcessAuditElement>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Selected>true</Selected>
    </ProcessAuditElement>
    <ProcessAuditElement>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Selected>true</Selected>
    </ProcessAuditElement>
  </EquipmentTypes>
  <Forms>
    <FormLite>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Type>sample string 3</Type>
    </FormLite>
    <FormLite>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Type>sample string 3</Type>
    </FormLite>
  </Forms>
  <Hazards>
    <ProcessAuditElement>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Selected>true</Selected>
    </ProcessAuditElement>
    <ProcessAuditElement>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Selected>true</Selected>
    </ProcessAuditElement>
  </Hazards>
  <Icon>sample string 10</Icon>
  <IconHexColor>sample string 9</IconHexColor>
  <Id>2</Id>
  <Indent>11</Indent>
  <IsActive>true</IsActive>
  <IsProcess>true</IsProcess>
  <IsTask>true</IsTask>
  <IsVisible>true</IsVisible>
  <LastPerformed>sample string 12</LastPerformed>
  <LastSaved>2025-12-15T08:37:35.926952-05:00</LastSaved>
  <LastScore>13.1</LastScore>
  <Locations>
    <ProcessAuditElement>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Selected>true</Selected>
    </ProcessAuditElement>
    <ProcessAuditElement>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Selected>true</Selected>
    </ProcessAuditElement>
  </Locations>
  <Menus>
    <MenuLite>
      <Description>sample string 2</Description>
      <Id>3</Id>
      <Name>sample string 1</Name>
      <Type>sample string 4</Type>
    </MenuLite>
    <MenuLite>
      <Description>sample string 2</Description>
      <Id>3</Id>
      <Name>sample string 1</Name>
      <Type>sample string 4</Type>
    </MenuLite>
  </Menus>
  <Name>sample string 3</Name>
  <NoSteps>true</NoSteps>
  <Notes>
    <Comment>sample string 1</Comment>
    <Image>QEA=</Image>
  </Notes>
  <Parts>
    <ProcessAuditElement>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Selected>true</Selected>
    </ProcessAuditElement>
    <ProcessAuditElement>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Selected>true</Selected>
    </ProcessAuditElement>
  </Parts>
  <PleaseSelect>true</PleaseSelect>
  <Ppe>
    <ProcessAuditPpeGroup>
      <Elements>
        <PpeElement>
          <Description>sample string 4</Description>
          <GroupName>sample string 1</GroupName>
          <Id>2</Id>
          <Name>sample string 3</Name>
          <Selected>true</Selected>
        </PpeElement>
        <PpeElement>
          <Description>sample string 4</Description>
          <GroupName>sample string 1</GroupName>
          <Id>2</Id>
          <Name>sample string 3</Name>
          <Selected>true</Selected>
        </PpeElement>
      </Elements>
      <GroupName>sample string 2</GroupName>
      <Id>1</Id>
    </ProcessAuditPpeGroup>
    <ProcessAuditPpeGroup>
      <Elements>
        <PpeElement>
          <Description>sample string 4</Description>
          <GroupName>sample string 1</GroupName>
          <Id>2</Id>
          <Name>sample string 3</Name>
          <Selected>true</Selected>
        </PpeElement>
        <PpeElement>
          <Description>sample string 4</Description>
          <GroupName>sample string 1</GroupName>
          <Id>2</Id>
          <Name>sample string 3</Name>
          <Selected>true</Selected>
        </PpeElement>
      </Elements>
      <GroupName>sample string 2</GroupName>
      <Id>1</Id>
    </ProcessAuditPpeGroup>
  </Ppe>
  <PpeFlat>
    <PpeElement>
      <Description>sample string 4</Description>
      <GroupName>sample string 1</GroupName>
      <Id>2</Id>
      <Name>sample string 3</Name>
      <Selected>true</Selected>
    </PpeElement>
    <PpeElement>
      <Description>sample string 4</Description>
      <GroupName>sample string 1</GroupName>
      <Id>2</Id>
      <Name>sample string 3</Name>
      <Selected>true</Selected>
    </PpeElement>
  </PpeFlat>
  <Questions>
    <QuestionsLite>
      <AnswerType>sample string 5</AnswerType>
      <Conditions>
        <PcrLite>
          <Code>sample string 2</Code>
          <Id>1</Id>
          <LocationId>1</LocationId>
          <Name>sample string 3</Name>
          <PartType>sample string 4</PartType>
          <SubLocationId>1</SubLocationId>
        </PcrLite>
        <PcrLite>
          <Code>sample string 2</Code>
          <Id>1</Id>
          <LocationId>1</LocationId>
          <Name>sample string 3</Name>
          <PartType>sample string 4</PartType>
          <SubLocationId>1</SubLocationId>
        </PcrLite>
      </Conditions>
      <CorrectAnswer>1</CorrectAnswer>
      <Description>sample string 4</Description>
      <Group>sample string 6</Group>
      <Id>1</Id>
      <Multis>
        <MultiLite>
          <Id>1</Id>
          <Value>sample string 2</Value>
        </MultiLite>
        <MultiLite>
          <Id>1</Id>
          <Value>sample string 2</Value>
        </MultiLite>
      </Multis>
      <Order>2</Order>
      <Parts>
        <PcrLite>
          <Code>sample string 2</Code>
          <Id>1</Id>
          <LocationId>1</LocationId>
          <Name>sample string 3</Name>
          <PartType>sample string 4</PartType>
          <SubLocationId>1</SubLocationId>
        </PcrLite>
        <PcrLite>
          <Code>sample string 2</Code>
          <Id>1</Id>
          <LocationId>1</LocationId>
          <Name>sample string 3</Name>
          <PartType>sample string 4</PartType>
          <SubLocationId>1</SubLocationId>
        </PcrLite>
      </Parts>
      <Remedies>
        <PcrLite>
          <Code>sample string 2</Code>
          <Id>1</Id>
          <LocationId>1</LocationId>
          <Name>sample string 3</Name>
          <PartType>sample string 4</PartType>
          <SubLocationId>1</SubLocationId>
        </PcrLite>
        <PcrLite>
          <Code>sample string 2</Code>
          <Id>1</Id>
          <LocationId>1</LocationId>
          <Name>sample string 3</Name>
          <PartType>sample string 4</PartType>
          <SubLocationId>1</SubLocationId>
        </PcrLite>
      </Remedies>
      <Title>sample string 3</Title>
    </QuestionsLite>
    <QuestionsLite>
      <AnswerType>sample string 5</AnswerType>
      <Conditions>
        <PcrLite>
          <Code>sample string 2</Code>
          <Id>1</Id>
          <LocationId>1</LocationId>
          <Name>sample string 3</Name>
          <PartType>sample string 4</PartType>
          <SubLocationId>1</SubLocationId>
        </PcrLite>
        <PcrLite>
          <Code>sample string 2</Code>
          <Id>1</Id>
          <LocationId>1</LocationId>
          <Name>sample string 3</Name>
          <PartType>sample string 4</PartType>
          <SubLocationId>1</SubLocationId>
        </PcrLite>
      </Conditions>
      <CorrectAnswer>1</CorrectAnswer>
      <Description>sample string 4</Description>
      <Group>sample string 6</Group>
      <Id>1</Id>
      <Multis>
        <MultiLite>
          <Id>1</Id>
          <Value>sample string 2</Value>
        </MultiLite>
        <MultiLite>
          <Id>1</Id>
          <Value>sample string 2</Value>
        </MultiLite>
      </Multis>
      <Order>2</Order>
      <Parts>
        <PcrLite>
          <Code>sample string 2</Code>
          <Id>1</Id>
          <LocationId>1</LocationId>
          <Name>sample string 3</Name>
          <PartType>sample string 4</PartType>
          <SubLocationId>1</SubLocationId>
        </PcrLite>
        <PcrLite>
          <Code>sample string 2</Code>
          <Id>1</Id>
          <LocationId>1</LocationId>
          <Name>sample string 3</Name>
          <PartType>sample string 4</PartType>
          <SubLocationId>1</SubLocationId>
        </PcrLite>
      </Parts>
      <Remedies>
        <PcrLite>
          <Code>sample string 2</Code>
          <Id>1</Id>
          <LocationId>1</LocationId>
          <Name>sample string 3</Name>
          <PartType>sample string 4</PartType>
          <SubLocationId>1</SubLocationId>
        </PcrLite>
        <PcrLite>
          <Code>sample string 2</Code>
          <Id>1</Id>
          <LocationId>1</LocationId>
          <Name>sample string 3</Name>
          <PartType>sample string 4</PartType>
          <SubLocationId>1</SubLocationId>
        </PcrLite>
      </Remedies>
      <Title>sample string 3</Title>
    </QuestionsLite>
  </Questions>
  <Remedies>
    <ProcessAuditElement>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Selected>true</Selected>
    </ProcessAuditElement>
    <ProcessAuditElement>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Selected>true</Selected>
    </ProcessAuditElement>
  </Remedies>
  <Scheduled>true</Scheduled>
  <ScheduledDate>2025-12-15T08:37:35.926952-05:00</ScheduledDate>
  <ScheduledLocation>sample string 14</ScheduledLocation>
  <ScheduledTime>PT0.1234567S</ScheduledTime>
  <Score>
    <CompletedOn>2025-12-15T08:37:35.926952-05:00</CompletedOn>
    <Fails>3</Fails>
    <Pass>2</Pass>
    <Rating>5</Rating>
    <SendToTraining>true</SendToTraining>
    <Total>1</Total>
  </Score>
  <SendToTraining>true</SendToTraining>
  <Status>sample string 6</Status>
  <Steps>
    <ProcessAuditStep>
      <Comment>sample string 4</Comment>
      <Description>sample string 3</Description>
      <Details>sample string 5</Details>
      <Id>1</Id>
      <Image>QEA=</Image>
      <Name>sample string 2</Name>
      <Selected>true</Selected>
    </ProcessAuditStep>
    <ProcessAuditStep>
      <Comment>sample string 4</Comment>
      <Description>sample string 3</Description>
      <Details>sample string 5</Details>
      <Id>1</Id>
      <Image>QEA=</Image>
      <Name>sample string 2</Name>
      <Selected>true</Selected>
    </ProcessAuditStep>
  </Steps>
  <Tasks>
    <ProcessAuditElement>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Selected>true</Selected>
    </ProcessAuditElement>
    <ProcessAuditElement>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Selected>true</Selected>
    </ProcessAuditElement>
  </Tasks>
  <TypeOfWorkType>sample string 16</TypeOfWorkType>
</ProcessAudit>