POST Api/MetricMinder/GetManagementTool

Request Information

URI Parameters

None.

Body Parameters

ManagementToolRequest
NameDescriptionTypeAdditional information
StudentId

decimal number

None.

OutDailyRandMasterID

decimal number

None.

OutProgId

decimal number

None.

ProgProcedureID

decimal number

None.

showProbe

decimal number

None.

hideProbe

decimal number

None.

CboStatus

string

None.

SummaryFilter

string

None.

MasteredProcedure

decimal number

None.

OnHold

decimal number

None.

FromDate

date

None.

ToDate

date

None.

SearchText

string

None.

AscDescOrder

string

None.

FilterPercentNeededToComplete

decimal number

None.

FilterSessionsInARowNeededMastered

integer

None.

FilterSessionsInARowNeededHold

integer

None.

FilterOutOfSessionsMastered

integer

None.

FilterPercentNeededToPutOnHold

decimal number

None.

FilterOutOfSessionsHold

integer

None.

CampusName

string

None.

UserID

string

None.

DeviceID

string

None.

DeviceOS

string

None.

Version

string

None.

accessToken

string

Required

Matching regular expression pattern: ^a4768b1a-b5c1-4561-86e7-324b8a368354$

Request Formats

application/json, text/json

Sample:
{
  "StudentId": 1.0,
  "OutDailyRandMasterID": 2.0,
  "OutProgId": 3.0,
  "ProgProcedureID": 4.0,
  "showProbe": 5.0,
  "hideProbe": 6.0,
  "CboStatus": "sample string 7",
  "SummaryFilter": "sample string 8",
  "MasteredProcedure": 9.0,
  "OnHold": 10.0,
  "FromDate": "2025-12-13T01:17:33.5971156-05:00",
  "ToDate": "2025-12-13T01:17:33.5971156-05:00",
  "SearchText": "sample string 11",
  "AscDescOrder": "sample string 12",
  "FilterPercentNeededToComplete": 13.0,
  "FilterSessionsInARowNeededMastered": 14,
  "FilterSessionsInARowNeededHold": 15,
  "FilterOutOfSessionsMastered": 1,
  "FilterPercentNeededToPutOnHold": 16.0,
  "FilterOutOfSessionsHold": 1,
  "CampusName": "sample string 17",
  "UserID": "sample string 18",
  "DeviceID": "sample string 19",
  "DeviceOS": "sample string 20",
  "Version": "sample string 21",
  "accessToken": "sample string 22"
}

text/html

Sample:
{"StudentId":1.0,"OutDailyRandMasterID":2.0,"OutProgId":3.0,"ProgProcedureID":4.0,"showProbe":5.0,"hideProbe":6.0,"CboStatus":"sample string 7","SummaryFilter":"sample string 8","MasteredProcedure":9.0,"OnHold":10.0,"FromDate":"2025-12-13T01:17:33.5971156-05:00","ToDate":"2025-12-13T01:17:33.5971156-05:00","SearchText":"sample string 11","AscDescOrder":"sample string 12","FilterPercentNeededToComplete":13.0,"FilterSessionsInARowNeededMastered":14,"FilterSessionsInARowNeededHold":15,"FilterOutOfSessionsMastered":1,"FilterPercentNeededToPutOnHold":16.0,"FilterOutOfSessionsHold":1,"CampusName":"sample string 17","UserID":"sample string 18","DeviceID":"sample string 19","DeviceOS":"sample string 20","Version":"sample string 21","accessToken":"sample string 22"}

application/xml, text/xml

Sample:
<ManagementToolRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParadigmPioneer.Core.Model">
  <CampusName>sample string 17</CampusName>
  <DeviceID>sample string 19</DeviceID>
  <DeviceOS>sample string 20</DeviceOS>
  <UserID>sample string 18</UserID>
  <Version>sample string 21</Version>
  <accessToken>sample string 22</accessToken>
  <AscDescOrder>sample string 12</AscDescOrder>
  <CboStatus>sample string 7</CboStatus>
  <FilterOutOfSessionsHold>1</FilterOutOfSessionsHold>
  <FilterOutOfSessionsMastered>1</FilterOutOfSessionsMastered>
  <FilterPercentNeededToComplete>13</FilterPercentNeededToComplete>
  <FilterPercentNeededToPutOnHold>16</FilterPercentNeededToPutOnHold>
  <FilterSessionsInARowNeededHold>15</FilterSessionsInARowNeededHold>
  <FilterSessionsInARowNeededMastered>14</FilterSessionsInARowNeededMastered>
  <FromDate>2025-12-13T01:17:33.5971156-05:00</FromDate>
  <MasteredProcedure>9</MasteredProcedure>
  <OnHold>10</OnHold>
  <OutDailyRandMasterID>2</OutDailyRandMasterID>
  <OutProgId>3</OutProgId>
  <ProgProcedureID>4</ProgProcedureID>
  <SearchText>sample string 11</SearchText>
  <StudentId>1</StudentId>
  <SummaryFilter>sample string 8</SummaryFilter>
  <ToDate>2025-12-13T01:17:33.5971156-05:00</ToDate>
  <hideProbe>6</hideProbe>
  <showProbe>5</showProbe>
</ManagementToolRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Object

None.

Response Formats

application/json, text/json, text/html

Sample:
{}

application/xml, text/xml

Sample:
<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />