POST api/Device/ValidateEventCode

Request Information

URI Parameters

None.

Body Parameters

EventCodeRequest
NameDescriptionTypeAdditional information
EventCode

string

None.

SiteNum

integer

None.

DevNum

integer

None.

SessionNum

integer

None.

SessionPassword

Collection of byte

None.

ApplicationCode

string

None.

StagesURL

string

None.

Request Formats

application/json, text/json

Sample:
{
  "EventCode": "sample string 1",
  "SiteNum": 1,
  "DevNum": 1,
  "SessionNum": 2,
  "SessionPassword": "QEA=",
  "ApplicationCode": "sample string 3",
  "StagesURL": "sample string 4"
}

application/xml, text/xml

Sample:
<EventCodeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models">
  <StagesURL>sample string 4</StagesURL>
  <ApplicationCode>sample string 3</ApplicationCode>
  <SessionNum>2</SessionNum>
  <SessionPassword>QEA=</SessionPassword>
  <DevNum>1</DevNum>
  <EventCode>sample string 1</EventCode>
  <SiteNum>1</SiteNum>
</EventCodeRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ValidateEventCodeQueryResult
NameDescriptionTypeAdditional information
OutputParameter

ValidateEventCodeOutput

None.

Success

boolean

None.

UserErrorMessage

string

None.

ErrorTypeNum

integer

None.

SqlConnectionLost

boolean

None.

ClientVersion

string

None.

Response Formats

application/json, text/json

Sample:
{
  "OutputParameter": {
    "EventCodeDescription": "sample string 1",
    "ActionPlanNum": 1,
    "ActPlanDescription": "sample string 2"
  },
  "Success": true,
  "UserErrorMessage": "sample string 2",
  "ErrorTypeNum": 3,
  "SqlConnectionLost": true,
  "ClientVersion": "sample string 5"
}

application/xml, text/xml

Sample:
<ValidateEventCodeQueryResult 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>
  <OutputParameter>
    <ActPlanDescription>sample string 2</ActPlanDescription>
    <ActionPlanNum>1</ActionPlanNum>
    <EventCodeDescription>sample string 1</EventCodeDescription>
  </OutputParameter>
</ValidateEventCodeQueryResult>