POST api/OnTest/ValidateTestCategory

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
SiteNum	integer	None.
TestCategory	string	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",
  "SessionNum": 2,
  "SessionPassword": "QEA=",
  "ApplicationCode": "sample string 3",
  "StagesURL": "sample string 4"
}

application/xml, text/xml

Sample:

<TestCategoryRequest 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>
  <SiteNum>1</SiteNum>
  <TestCategory>sample string 1</TestCategory>
</TestCategoryRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ValidateTestCategoryQueryResult

Name	Type	Additional information
OutputParameter	ValidateTestCategoryOutput	None.
Success	boolean	None.
UserErrorMessage	string	None.
ErrorTypeNum	integer	None.
SqlConnectionLost	boolean	None.
ClientVersion	string	None.

Response Formats

application/json, text/json

Sample:

{
  "OutputParameter": {
    "TestCategoryDescription": "sample string 1",
    "EffectiveDate": "2025-05-03T22:09:28.3949532-07:00",
    "EffectiveTime": "sample string 2",
    "ExpireDate": "2025-05-03T22:09:28.3949532-07:00",
    "ExpireTime": "sample string 3",
    "ExpireDateDefault": "2025-05-03T22:09:28.3949532-07:00",
    "ExpireTimeDefault": "sample string 4",
    "TestDuration": "sample string 5",
    "DefaultMinutes": 1,
    "AutoNotifyOption": "sample string 6",
    "AutoNotifyOptionDescription": "sample string 7",
    "AutoNotifyRecipient": "sample string 8",
    "AutoNotifyResultsFlag": true,
    "DefaultComment": "sample string 9"
  },
  "Success": true,
  "UserErrorMessage": "sample string 2",
  "ErrorTypeNum": 3,
  "SqlConnectionLost": true,
  "ClientVersion": "sample string 5"
}

application/xml, text/xml

Sample:

<ValidateTestCategoryQueryResult 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>
    <AutoNotifyOption>sample string 6</AutoNotifyOption>
    <AutoNotifyOptionDescription>sample string 7</AutoNotifyOptionDescription>
    <AutoNotifyRecipient>sample string 8</AutoNotifyRecipient>
    <AutoNotifyResultsFlag>true</AutoNotifyResultsFlag>
    <DefaultComment>sample string 9</DefaultComment>
    <DefaultMinutes>1</DefaultMinutes>
    <EffectiveDate>2025-05-03T22:09:28.3949532-07:00</EffectiveDate>
    <EffectiveTime>sample string 2</EffectiveTime>
    <ExpireDate>2025-05-03T22:09:28.3949532-07:00</ExpireDate>
    <ExpireDateDefault>2025-05-03T22:09:28.3949532-07:00</ExpireDateDefault>
    <ExpireTime>sample string 3</ExpireTime>
    <ExpireTimeDefault>sample string 4</ExpireTimeDefault>
    <TestCategoryDescription>sample string 1</TestCategoryDescription>
    <TestDuration>sample string 5</TestDuration>
  </OutputParameter>
</ValidateTestCategoryQueryResult>