POST api/OnTest/DeviceOnTest

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
SiteNum	integer	None.
TestCategory	string	None.
TestType	string	None.
EffectiveDate	date	None.
EffectiveTime	string	None.
ExpireDate	date	None.
ExpireTime	string	None.
Points	Collection of TestPointListRow	None.
EventCodes	Collection of EventCodeListRow	None.
Comment	string	None.
SiteTestFlag	boolean	None.
XmitTestType	string	None.
AdvancedDetails	Collection of PlaceOnTestDetails	None.
AutoNotifyOption	string	None.
AutoNotifyRecipient	string	None.
XtUserPassword	string	None.
DevNum	integer	None.
SiteFlag	boolean	None.
SessionNum	integer	None.
SessionPassword	Collection of byte	None.
ApplicationCode	string	None.
StagesURL	string	None.

Request Formats

application/json, text/json

Sample:

{
  "SiteNum": 1,
  "TestCategory": "sample string 1",
  "TestType": "sample string 2",
  "EffectiveDate": "2024-05-01T17:05:57.675499-04:00",
  "EffectiveTime": "sample string 3",
  "ExpireDate": "2024-05-01T17:05:57.675499-04:00",
  "ExpireTime": "sample string 4",
  "Points": [
    {
      "SelectedFlag": true,
      "SignalRuleNum": 1
    },
    {
      "SelectedFlag": true,
      "SignalRuleNum": 1
    }
  ],
  "EventCodes": [
    {
      "EventCode": "sample string 1",
      "SelectedFlag": true
    },
    {
      "EventCode": "sample string 1",
      "SelectedFlag": true
    }
  ],
  "Comment": "sample string 5",
  "SiteTestFlag": true,
  "XmitTestType": "sample string 6",
  "AdvancedDetails": [
    {
      "AreaNum": 1,
      "EventCode": "sample string 1",
      "Point": "sample string 2",
      "SeqNum": 1,
      "ServType": "sample string 3",
      "SignalCode": "sample string 4",
      "NodeNumber": "sample string 5"
    },
    {
      "AreaNum": 1,
      "EventCode": "sample string 1",
      "Point": "sample string 2",
      "SeqNum": 1,
      "ServType": "sample string 3",
      "SignalCode": "sample string 4",
      "NodeNumber": "sample string 5"
    }
  ],
  "AutoNotifyOption": "sample string 7",
  "AutoNotifyRecipient": "sample string 8",
  "XtUserPassword": "sample string 9",
  "DevNum": 1,
  "SiteFlag": true,
  "SessionNum": 10,
  "SessionPassword": "QEA=",
  "ApplicationCode": "sample string 11",
  "StagesURL": "sample string 12"
}

application/xml, text/xml

Sample:

<DeviceOnTestRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models">
  <StagesURL>sample string 12</StagesURL>
  <ApplicationCode>sample string 11</ApplicationCode>
  <SessionNum>10</SessionNum>
  <SessionPassword>QEA=</SessionPassword>
  <DevNum>1</DevNum>
  <SiteFlag>true</SiteFlag>
  <AdvancedDetails>
    <PlaceOnTestDetails>
      <AreaNum>1</AreaNum>
      <EventCode>sample string 1</EventCode>
      <NodeNumber>sample string 5</NodeNumber>
      <Point>sample string 2</Point>
      <SeqNum>1</SeqNum>
      <ServType>sample string 3</ServType>
      <SignalCode>sample string 4</SignalCode>
    </PlaceOnTestDetails>
    <PlaceOnTestDetails>
      <AreaNum>1</AreaNum>
      <EventCode>sample string 1</EventCode>
      <NodeNumber>sample string 5</NodeNumber>
      <Point>sample string 2</Point>
      <SeqNum>1</SeqNum>
      <ServType>sample string 3</ServType>
      <SignalCode>sample string 4</SignalCode>
    </PlaceOnTestDetails>
  </AdvancedDetails>
  <AutoNotifyOption>sample string 7</AutoNotifyOption>
  <AutoNotifyRecipient>sample string 8</AutoNotifyRecipient>
  <Comment>sample string 5</Comment>
  <EffectiveDate>2024-05-01T17:05:57.675499-04:00</EffectiveDate>
  <EffectiveTime>sample string 3</EffectiveTime>
  <EventCodes xmlns:d2p1="http://schemas.datacontract.org/2004/07/Stages">
    <d2p1:EventCodeListRow>
      <d2p1:EventCode>sample string 1</d2p1:EventCode>
      <d2p1:SelectedFlag>true</d2p1:SelectedFlag>
    </d2p1:EventCodeListRow>
    <d2p1:EventCodeListRow>
      <d2p1:EventCode>sample string 1</d2p1:EventCode>
      <d2p1:SelectedFlag>true</d2p1:SelectedFlag>
    </d2p1:EventCodeListRow>
  </EventCodes>
  <ExpireDate>2024-05-01T17:05:57.675499-04:00</ExpireDate>
  <ExpireTime>sample string 4</ExpireTime>
  <Points xmlns:d2p1="http://schemas.datacontract.org/2004/07/Stages">
    <d2p1:TestPointListRow>
      <d2p1:SelectedFlag>true</d2p1:SelectedFlag>
      <d2p1:SignalRuleNum>1</d2p1:SignalRuleNum>
    </d2p1:TestPointListRow>
    <d2p1:TestPointListRow>
      <d2p1:SelectedFlag>true</d2p1:SelectedFlag>
      <d2p1:SignalRuleNum>1</d2p1:SignalRuleNum>
    </d2p1:TestPointListRow>
  </Points>
  <SiteNum>1</SiteNum>
  <SiteTestFlag>true</SiteTestFlag>
  <TestCategory>sample string 1</TestCategory>
  <TestType>sample string 2</TestType>
  <XmitTestType>sample string 6</XmitTestType>
  <XtUserPassword>sample string 9</XtUserPassword>
</DeviceOnTestRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

DeviceOnTestQueryResult

Name	Type	Additional information
ExcludeColumnList	Collection of string	None.
ResultSet	Collection of DeviceOnTestResult	None.
Success	boolean	None.
UserErrorMessage	string	None.
ErrorTypeNum	integer	None.
SqlConnectionLost	boolean	None.
ClientVersion	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ExcludeColumnList": [
    "sample string 1",
    "sample string 2"
  ],
  "ResultSet": [
    {
      "AdditionalPoints": "sample string 1",
      "AdvancedDetailsList": [
        {
          "AreaNum": 1,
          "DevNum": 1,
          "EventCode": "sample string 1",
          "Point": "sample string 2",
          "SeqNum": 1,
          "ServType": "sample string 3",
          "SignalCode": "sample string 4",
          "TestNum": 1
        },
        {
          "AreaNum": 1,
          "DevNum": 1,
          "EventCode": "sample string 1",
          "Point": "sample string 2",
          "SeqNum": 1,
          "ServType": "sample string 3",
          "SignalCode": "sample string 4",
          "TestNum": 1
        }
      ],
      "AdvancedTestFlag": true,
      "AutoNotifyOption": "sample string 2",
      "AutoNotifyRecipient": "sample string 3",
      "CommentBig": "sample string 4",
      "ConfirmationPrompt": "sample string 5",
      "DevNum": 1,
      "EffectiveDate": "2024-05-01T17:05:57.6911409-04:00",
      "EffectiveTime": "sample string 6",
      "EventCodeList": [
        {
          "EventCode": "sample string 1",
          "SelectedFlag": true
        },
        {
          "EventCode": "sample string 1",
          "SelectedFlag": true
        }
      ],
      "ExpireDate": "2024-05-01T17:05:57.6911409-04:00",
      "ExpireTime": "sample string 7",
      "PromptFlag": true,
      "RecurringTestFlag": true,
      "ServiceTypeList": [
        {
          "SelectedFlag": true,
          "ServType": "sample string 1"
        },
        {
          "SelectedFlag": true,
          "ServType": "sample string 1"
        }
      ],
      "SiteNum": 1,
      "SiteTestFlag": true,
      "Status": "sample string 8",
      "TestCategory": "sample string 9",
      "TestNum": 1,
      "TestPointList": [
        {
          "SelectedFlag": true,
          "SignalRuleNum": 1
        },
        {
          "SelectedFlag": true,
          "SignalRuleNum": 1
        }
      ],
      "TestType": "sample string 10",
      "TestTypeDescription": "sample string 11",
      "XmitTestType": "sample string 12",
      "XtUserPassword": "sample string 13"
    },
    {
      "AdditionalPoints": "sample string 1",
      "AdvancedDetailsList": [
        {
          "AreaNum": 1,
          "DevNum": 1,
          "EventCode": "sample string 1",
          "Point": "sample string 2",
          "SeqNum": 1,
          "ServType": "sample string 3",
          "SignalCode": "sample string 4",
          "TestNum": 1
        },
        {
          "AreaNum": 1,
          "DevNum": 1,
          "EventCode": "sample string 1",
          "Point": "sample string 2",
          "SeqNum": 1,
          "ServType": "sample string 3",
          "SignalCode": "sample string 4",
          "TestNum": 1
        }
      ],
      "AdvancedTestFlag": true,
      "AutoNotifyOption": "sample string 2",
      "AutoNotifyRecipient": "sample string 3",
      "CommentBig": "sample string 4",
      "ConfirmationPrompt": "sample string 5",
      "DevNum": 1,
      "EffectiveDate": "2024-05-01T17:05:57.6911409-04:00",
      "EffectiveTime": "sample string 6",
      "EventCodeList": [
        {
          "EventCode": "sample string 1",
          "SelectedFlag": true
        },
        {
          "EventCode": "sample string 1",
          "SelectedFlag": true
        }
      ],
      "ExpireDate": "2024-05-01T17:05:57.6911409-04:00",
      "ExpireTime": "sample string 7",
      "PromptFlag": true,
      "RecurringTestFlag": true,
      "ServiceTypeList": [
        {
          "SelectedFlag": true,
          "ServType": "sample string 1"
        },
        {
          "SelectedFlag": true,
          "ServType": "sample string 1"
        }
      ],
      "SiteNum": 1,
      "SiteTestFlag": true,
      "Status": "sample string 8",
      "TestCategory": "sample string 9",
      "TestNum": 1,
      "TestPointList": [
        {
          "SelectedFlag": true,
          "SignalRuleNum": 1
        },
        {
          "SelectedFlag": true,
          "SignalRuleNum": 1
        }
      ],
      "TestType": "sample string 10",
      "TestTypeDescription": "sample string 11",
      "XmitTestType": "sample string 12",
      "XtUserPassword": "sample string 13"
    }
  ],
  "Success": true,
  "UserErrorMessage": "sample string 2",
  "ErrorTypeNum": 3,
  "SqlConnectionLost": true,
  "ClientVersion": "sample string 5"
}

application/xml, text/xml

Sample:

<DeviceOnTestQueryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Stages">
  <ClientVersion>sample string 5</ClientVersion>
  <ErrorTypeNum>3</ErrorTypeNum>
  <SqlConnectionLost>true</SqlConnectionLost>
  <Success>true</Success>
  <UserErrorMessage>sample string 2</UserErrorMessage>
  <ExcludeColumnList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ExcludeColumnList>
  <ResultSet>
    <DeviceOnTestResult>
      <AdditionalPoints>sample string 1</AdditionalPoints>
      <AdvancedDetailsList>
        <AdvancedDetailsListRow>
          <AreaNum>1</AreaNum>
          <DevNum>1</DevNum>
          <EventCode>sample string 1</EventCode>
          <Point>sample string 2</Point>
          <SeqNum>1</SeqNum>
          <ServType>sample string 3</ServType>
          <SignalCode>sample string 4</SignalCode>
          <TestNum>1</TestNum>
        </AdvancedDetailsListRow>
        <AdvancedDetailsListRow>
          <AreaNum>1</AreaNum>
          <DevNum>1</DevNum>
          <EventCode>sample string 1</EventCode>
          <Point>sample string 2</Point>
          <SeqNum>1</SeqNum>
          <ServType>sample string 3</ServType>
          <SignalCode>sample string 4</SignalCode>
          <TestNum>1</TestNum>
        </AdvancedDetailsListRow>
      </AdvancedDetailsList>
      <AdvancedTestFlag>true</AdvancedTestFlag>
      <AutoNotifyOption>sample string 2</AutoNotifyOption>
      <AutoNotifyRecipient>sample string 3</AutoNotifyRecipient>
      <CommentBig>sample string 4</CommentBig>
      <ConfirmationPrompt>sample string 5</ConfirmationPrompt>
      <DevNum>1</DevNum>
      <EffectiveDate>2024-05-01T17:05:57.6911409-04:00</EffectiveDate>
      <EffectiveTime>sample string 6</EffectiveTime>
      <EventCodeList>
        <EventCodeListRow>
          <EventCode>sample string 1</EventCode>
          <SelectedFlag>true</SelectedFlag>
        </EventCodeListRow>
        <EventCodeListRow>
          <EventCode>sample string 1</EventCode>
          <SelectedFlag>true</SelectedFlag>
        </EventCodeListRow>
      </EventCodeList>
      <ExpireDate>2024-05-01T17:05:57.6911409-04:00</ExpireDate>
      <ExpireTime>sample string 7</ExpireTime>
      <PromptFlag>true</PromptFlag>
      <RecurringTestFlag>true</RecurringTestFlag>
      <ServiceTypeList>
        <ServiceTypeListRow>
          <SelectedFlag>true</SelectedFlag>
          <ServType>sample string 1</ServType>
        </ServiceTypeListRow>
        <ServiceTypeListRow>
          <SelectedFlag>true</SelectedFlag>
          <ServType>sample string 1</ServType>
        </ServiceTypeListRow>
      </ServiceTypeList>
      <SiteNum>1</SiteNum>
      <SiteTestFlag>true</SiteTestFlag>
      <Status>sample string 8</Status>
      <TestCategory>sample string 9</TestCategory>
      <TestNum>1</TestNum>
      <TestPointList>
        <TestPointListRow>
          <SelectedFlag>true</SelectedFlag>
          <SignalRuleNum>1</SignalRuleNum>
        </TestPointListRow>
        <TestPointListRow>
          <SelectedFlag>true</SelectedFlag>
          <SignalRuleNum>1</SignalRuleNum>
        </TestPointListRow>
      </TestPointList>
      <TestType>sample string 10</TestType>
      <TestTypeDescription>sample string 11</TestTypeDescription>
      <XmitTestType>sample string 12</XmitTestType>
      <XtUserPassword>sample string 13</XtUserPassword>
    </DeviceOnTestResult>
    <DeviceOnTestResult>
      <AdditionalPoints>sample string 1</AdditionalPoints>
      <AdvancedDetailsList>
        <AdvancedDetailsListRow>
          <AreaNum>1</AreaNum>
          <DevNum>1</DevNum>
          <EventCode>sample string 1</EventCode>
          <Point>sample string 2</Point>
          <SeqNum>1</SeqNum>
          <ServType>sample string 3</ServType>
          <SignalCode>sample string 4</SignalCode>
          <TestNum>1</TestNum>
        </AdvancedDetailsListRow>
        <AdvancedDetailsListRow>
          <AreaNum>1</AreaNum>
          <DevNum>1</DevNum>
          <EventCode>sample string 1</EventCode>
          <Point>sample string 2</Point>
          <SeqNum>1</SeqNum>
          <ServType>sample string 3</ServType>
          <SignalCode>sample string 4</SignalCode>
          <TestNum>1</TestNum>
        </AdvancedDetailsListRow>
      </AdvancedDetailsList>
      <AdvancedTestFlag>true</AdvancedTestFlag>
      <AutoNotifyOption>sample string 2</AutoNotifyOption>
      <AutoNotifyRecipient>sample string 3</AutoNotifyRecipient>
      <CommentBig>sample string 4</CommentBig>
      <ConfirmationPrompt>sample string 5</ConfirmationPrompt>
      <DevNum>1</DevNum>
      <EffectiveDate>2024-05-01T17:05:57.6911409-04:00</EffectiveDate>
      <EffectiveTime>sample string 6</EffectiveTime>
      <EventCodeList>
        <EventCodeListRow>
          <EventCode>sample string 1</EventCode>
          <SelectedFlag>true</SelectedFlag>
        </EventCodeListRow>
        <EventCodeListRow>
          <EventCode>sample string 1</EventCode>
          <SelectedFlag>true</SelectedFlag>
        </EventCodeListRow>
      </EventCodeList>
      <ExpireDate>2024-05-01T17:05:57.6911409-04:00</ExpireDate>
      <ExpireTime>sample string 7</ExpireTime>
      <PromptFlag>true</PromptFlag>
      <RecurringTestFlag>true</RecurringTestFlag>
      <ServiceTypeList>
        <ServiceTypeListRow>
          <SelectedFlag>true</SelectedFlag>
          <ServType>sample string 1</ServType>
        </ServiceTypeListRow>
        <ServiceTypeListRow>
          <SelectedFlag>true</SelectedFlag>
          <ServType>sample string 1</ServType>
        </ServiceTypeListRow>
      </ServiceTypeList>
      <SiteNum>1</SiteNum>
      <SiteTestFlag>true</SiteTestFlag>
      <Status>sample string 8</Status>
      <TestCategory>sample string 9</TestCategory>
      <TestNum>1</TestNum>
      <TestPointList>
        <TestPointListRow>
          <SelectedFlag>true</SelectedFlag>
          <SignalRuleNum>1</SignalRuleNum>
        </TestPointListRow>
        <TestPointListRow>
          <SelectedFlag>true</SelectedFlag>
          <SignalRuleNum>1</SignalRuleNum>
        </TestPointListRow>
      </TestPointList>
      <TestType>sample string 10</TestType>
      <TestTypeDescription>sample string 11</TestTypeDescription>
      <XmitTestType>sample string 12</XmitTestType>
      <XtUserPassword>sample string 13</XtUserPassword>
    </DeviceOnTestResult>
  </ResultSet>
</DeviceOnTestQueryResult>