POST api/Trainees

Request Information

URI Parameters

None.

Body Parameters

DataTableTraineesParameter
NameDescriptionTypeAdditional information
columns

Collection of DataTableColumn

None.

draw

integer

None.

length

integer

None.

order

Collection of DataTableOrderValue

None.

start

integer

None.

filter

FilterType

None.

CoachID

integer

None.

search

DataTableSearchValue

None.

Request Formats

application/json, text/json

Sample:
{
  "filter": 0,
  "CoachID": 1,
  "search": {
    "value": "sample string 1",
    "regex": true
  },
  "columns": [
    {
      "data": "sample string 1",
      "name": "sample string 2",
      "searchable": true,
      "orderable": true,
      "Search": {
        "value": "sample string 1",
        "regex": true
      }
    },
    {
      "data": "sample string 1",
      "name": "sample string 2",
      "searchable": true,
      "orderable": true,
      "Search": {
        "value": "sample string 1",
        "regex": true
      }
    }
  ],
  "draw": 1,
  "length": 2,
  "order": [
    {
      "column": 1,
      "dir": "sample string 2"
    },
    {
      "column": 1,
      "dir": "sample string 2"
    }
  ],
  "start": 3
}

application/xml, text/xml

Sample:
<DataTableTraineesParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/_10RuleAPI.Models.DataTables">
  <columns>
    <DataTableColumn>
      <Search>
        <regex>true</regex>
        <value>sample string 1</value>
      </Search>
      <data>sample string 1</data>
      <name>sample string 2</name>
      <orderable>true</orderable>
      <searchable>true</searchable>
    </DataTableColumn>
    <DataTableColumn>
      <Search>
        <regex>true</regex>
        <value>sample string 1</value>
      </Search>
      <data>sample string 1</data>
      <name>sample string 2</name>
      <orderable>true</orderable>
      <searchable>true</searchable>
    </DataTableColumn>
  </columns>
  <draw>1</draw>
  <length>2</length>
  <order>
    <DataTableOrderValue>
      <column>1</column>
      <dir>sample string 2</dir>
    </DataTableOrderValue>
    <DataTableOrderValue>
      <column>1</column>
      <dir>sample string 2</dir>
    </DataTableOrderValue>
  </order>
  <search>
    <regex>true</regex>
    <value>sample string 1</value>
  </search>
  <start>3</start>
  <CoachID>1</CoachID>
  <filter>ALL</filter>
</DataTableTraineesParameter>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'DataTableTraineesParameter'.

Response Information

Resource Description

DataTableTraineesResponse
NameDescriptionTypeAdditional information
data

Collection of TraineeAllModel

None.

draw

integer

None.

recordsTotal

integer

None.

recordsFiltered

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "data": [
    {
      "PeopleID": 1,
      "PersonName": "sample string 2",
      "strEmail1": "sample string 3",
      "strCompanyName": "sample string 4",
      "prog_id": 5,
      "prog_start_date": "2021-06-18T21:02:05.1044168-07:00",
      "CoachName": "sample string 7",
      "currentsession": 8,
      "currenttrait": "sample string 9",
      "numsessions": 10,
      "active": true,
      "TestKey": 1
    },
    {
      "PeopleID": 1,
      "PersonName": "sample string 2",
      "strEmail1": "sample string 3",
      "strCompanyName": "sample string 4",
      "prog_id": 5,
      "prog_start_date": "2021-06-18T21:02:05.1044168-07:00",
      "CoachName": "sample string 7",
      "currentsession": 8,
      "currenttrait": "sample string 9",
      "numsessions": 10,
      "active": true,
      "TestKey": 1
    }
  ],
  "draw": 1,
  "recordsTotal": 2,
  "recordsFiltered": 3
}

application/xml, text/xml

Sample:
<DataTableTraineesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/_10RuleAPI.Models.DataTables">
  <draw>1</draw>
  <recordsFiltered>3</recordsFiltered>
  <recordsTotal>2</recordsTotal>
  <data xmlns:d2p1="http://schemas.datacontract.org/2004/07/_10RuleAPI.Models.CoachProfile">
    <d2p1:TraineeAllModel>
      <d2p1:CoachName>sample string 7</d2p1:CoachName>
      <d2p1:PeopleID>1</d2p1:PeopleID>
      <d2p1:PersonName>sample string 2</d2p1:PersonName>
      <d2p1:TestKey>1</d2p1:TestKey>
      <d2p1:active>true</d2p1:active>
      <d2p1:currentsession>8</d2p1:currentsession>
      <d2p1:currenttrait>sample string 9</d2p1:currenttrait>
      <d2p1:numsessions>10</d2p1:numsessions>
      <d2p1:prog_id>5</d2p1:prog_id>
      <d2p1:prog_start_date>2021-06-18T21:02:05.1044168-07:00</d2p1:prog_start_date>
      <d2p1:strCompanyName>sample string 4</d2p1:strCompanyName>
      <d2p1:strEmail1>sample string 3</d2p1:strEmail1>
    </d2p1:TraineeAllModel>
    <d2p1:TraineeAllModel>
      <d2p1:CoachName>sample string 7</d2p1:CoachName>
      <d2p1:PeopleID>1</d2p1:PeopleID>
      <d2p1:PersonName>sample string 2</d2p1:PersonName>
      <d2p1:TestKey>1</d2p1:TestKey>
      <d2p1:active>true</d2p1:active>
      <d2p1:currentsession>8</d2p1:currentsession>
      <d2p1:currenttrait>sample string 9</d2p1:currenttrait>
      <d2p1:numsessions>10</d2p1:numsessions>
      <d2p1:prog_id>5</d2p1:prog_id>
      <d2p1:prog_start_date>2021-06-18T21:02:05.1044168-07:00</d2p1:prog_start_date>
      <d2p1:strCompanyName>sample string 4</d2p1:strCompanyName>
      <d2p1:strEmail1>sample string 3</d2p1:strEmail1>
    </d2p1:TraineeAllModel>
  </data>
</DataTableTraineesResponse>