POST Training/getModule

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
page_number	integer	None.
page_size	integer	None.
sort_by	string	None.
sort_order	string	None.
status	string	None.
search	string	None.
admin_id	integer	None.
trainee	integer	None.
module_id	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "page_number": 1,
  "page_size": 1,
  "sort_by": "sample string 1",
  "sort_order": "sample string 2",
  "status": "sample string 3",
  "search": "sample string 4",
  "admin_id": 1,
  "trainee": 1,
  "module_id": 1
}

application/xml, text/xml

Sample:

<moduleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GwreCrmApi.Models">
  <admin_id>1</admin_id>
  <module_id>1</module_id>
  <page_number>1</page_number>
  <page_size>1</page_size>
  <search>sample string 4</search>
  <sort_by>sample string 1</sort_by>
  <sort_order>sample string 2</sort_order>
  <status>sample string 3</status>
  <trainee>1</trainee>
</moduleRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

TrainingModulesResponse

Name	Type	Additional information
status	string	None.
remarks	string	None.
total_modules	integer	None.
files	Collection of TrainingFileData	None.
modules	Collection of ModuleData	None.

Response Formats

application/json, text/json

Sample:

{
  "status": "sample string 1",
  "remarks": "sample string 2",
  "total_modules": 3,
  "files": [
    {
      "file_id": 1,
      "file_path": "sample string 2",
      "file_name": "sample string 3",
      "file_ext": "sample string 4"
    },
    {
      "file_id": 1,
      "file_path": "sample string 2",
      "file_name": "sample string 3",
      "file_ext": "sample string 4"
    }
  ],
  "modules": [
    {
      "module_id": 1,
      "module_name": "sample string 2",
      "module_description": "sample string 3",
      "duration": 4,
      "deadline_date": "sample string 5",
      "module_type": "sample string 6",
      "status": "sample string 7",
      "assigned_trainees": 8,
      "avg_completion": 9,
      "avg_quiz_score": 10,
      "lessons": [
        {
          "sequence": 1,
          "lesson_id": 2,
          "title": "sample string 3",
          "type": "sample string 4",
          "content_type": "sample string 5",
          "total_attempts": 6,
          "status": "sample string 7",
          "url": "sample string 8",
          "duration": 9,
          "is_active": true,
          "show_copyright_info": true,
          "file_id": 12,
          "content": "sample string 13",
          "passing_percent": 14,
          "max_que": 15,
          "total_marks": 16,
          "scored_marks": 17,
          "trainee_response": "sample string 18",
          "questions": [
            {
              "question_id": 1,
              "sequence": 2,
              "marks": 3,
              "question_data": "sample string 4"
            },
            {
              "question_id": 1,
              "sequence": 2,
              "marks": 3,
              "question_data": "sample string 4"
            }
          ]
        },
        {
          "sequence": 1,
          "lesson_id": 2,
          "title": "sample string 3",
          "type": "sample string 4",
          "content_type": "sample string 5",
          "total_attempts": 6,
          "status": "sample string 7",
          "url": "sample string 8",
          "duration": 9,
          "is_active": true,
          "show_copyright_info": true,
          "file_id": 12,
          "content": "sample string 13",
          "passing_percent": 14,
          "max_que": 15,
          "total_marks": 16,
          "scored_marks": 17,
          "trainee_response": "sample string 18",
          "questions": [
            {
              "question_id": 1,
              "sequence": 2,
              "marks": 3,
              "question_data": "sample string 4"
            },
            {
              "question_id": 1,
              "sequence": 2,
              "marks": 3,
              "question_data": "sample string 4"
            }
          ]
        }
      ]
    },
    {
      "module_id": 1,
      "module_name": "sample string 2",
      "module_description": "sample string 3",
      "duration": 4,
      "deadline_date": "sample string 5",
      "module_type": "sample string 6",
      "status": "sample string 7",
      "assigned_trainees": 8,
      "avg_completion": 9,
      "avg_quiz_score": 10,
      "lessons": [
        {
          "sequence": 1,
          "lesson_id": 2,
          "title": "sample string 3",
          "type": "sample string 4",
          "content_type": "sample string 5",
          "total_attempts": 6,
          "status": "sample string 7",
          "url": "sample string 8",
          "duration": 9,
          "is_active": true,
          "show_copyright_info": true,
          "file_id": 12,
          "content": "sample string 13",
          "passing_percent": 14,
          "max_que": 15,
          "total_marks": 16,
          "scored_marks": 17,
          "trainee_response": "sample string 18",
          "questions": [
            {
              "question_id": 1,
              "sequence": 2,
              "marks": 3,
              "question_data": "sample string 4"
            },
            {
              "question_id": 1,
              "sequence": 2,
              "marks": 3,
              "question_data": "sample string 4"
            }
          ]
        },
        {
          "sequence": 1,
          "lesson_id": 2,
          "title": "sample string 3",
          "type": "sample string 4",
          "content_type": "sample string 5",
          "total_attempts": 6,
          "status": "sample string 7",
          "url": "sample string 8",
          "duration": 9,
          "is_active": true,
          "show_copyright_info": true,
          "file_id": 12,
          "content": "sample string 13",
          "passing_percent": 14,
          "max_que": 15,
          "total_marks": 16,
          "scored_marks": 17,
          "trainee_response": "sample string 18",
          "questions": [
            {
              "question_id": 1,
              "sequence": 2,
              "marks": 3,
              "question_data": "sample string 4"
            },
            {
              "question_id": 1,
              "sequence": 2,
              "marks": 3,
              "question_data": "sample string 4"
            }
          ]
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<TrainingModulesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GwreCrmApi.Models">
  <files>
    <TrainingFileData>
      <file_ext>sample string 4</file_ext>
      <file_id>1</file_id>
      <file_name>sample string 3</file_name>
      <file_path>sample string 2</file_path>
    </TrainingFileData>
    <TrainingFileData>
      <file_ext>sample string 4</file_ext>
      <file_id>1</file_id>
      <file_name>sample string 3</file_name>
      <file_path>sample string 2</file_path>
    </TrainingFileData>
  </files>
  <modules>
    <ModuleData>
      <assigned_trainees>8</assigned_trainees>
      <avg_completion>9</avg_completion>
      <avg_quiz_score>10</avg_quiz_score>
      <deadline_date>sample string 5</deadline_date>
      <duration>4</duration>
      <lessons>
        <LessonData>
          <content>sample string 13</content>
          <content_type>sample string 5</content_type>
          <duration>9</duration>
          <file_id>12</file_id>
          <is_active>true</is_active>
          <lesson_id>2</lesson_id>
          <max_que>15</max_que>
          <passing_percent>14</passing_percent>
          <questions>
            <QuestionData>
              <marks>3</marks>
              <question_data>sample string 4</question_data>
              <question_id>1</question_id>
              <sequence>2</sequence>
            </QuestionData>
            <QuestionData>
              <marks>3</marks>
              <question_data>sample string 4</question_data>
              <question_id>1</question_id>
              <sequence>2</sequence>
            </QuestionData>
          </questions>
          <scored_marks>17</scored_marks>
          <sequence>1</sequence>
          <show_copyright_info>true</show_copyright_info>
          <status>sample string 7</status>
          <title>sample string 3</title>
          <total_attempts>6</total_attempts>
          <total_marks>16</total_marks>
          <trainee_response>sample string 18</trainee_response>
          <type>sample string 4</type>
          <url>sample string 8</url>
        </LessonData>
        <LessonData>
          <content>sample string 13</content>
          <content_type>sample string 5</content_type>
          <duration>9</duration>
          <file_id>12</file_id>
          <is_active>true</is_active>
          <lesson_id>2</lesson_id>
          <max_que>15</max_que>
          <passing_percent>14</passing_percent>
          <questions>
            <QuestionData>
              <marks>3</marks>
              <question_data>sample string 4</question_data>
              <question_id>1</question_id>
              <sequence>2</sequence>
            </QuestionData>
            <QuestionData>
              <marks>3</marks>
              <question_data>sample string 4</question_data>
              <question_id>1</question_id>
              <sequence>2</sequence>
            </QuestionData>
          </questions>
          <scored_marks>17</scored_marks>
          <sequence>1</sequence>
          <show_copyright_info>true</show_copyright_info>
          <status>sample string 7</status>
          <title>sample string 3</title>
          <total_attempts>6</total_attempts>
          <total_marks>16</total_marks>
          <trainee_response>sample string 18</trainee_response>
          <type>sample string 4</type>
          <url>sample string 8</url>
        </LessonData>
      </lessons>
      <module_description>sample string 3</module_description>
      <module_id>1</module_id>
      <module_name>sample string 2</module_name>
      <module_type>sample string 6</module_type>
      <status>sample string 7</status>
    </ModuleData>
    <ModuleData>
      <assigned_trainees>8</assigned_trainees>
      <avg_completion>9</avg_completion>
      <avg_quiz_score>10</avg_quiz_score>
      <deadline_date>sample string 5</deadline_date>
      <duration>4</duration>
      <lessons>
        <LessonData>
          <content>sample string 13</content>
          <content_type>sample string 5</content_type>
          <duration>9</duration>
          <file_id>12</file_id>
          <is_active>true</is_active>
          <lesson_id>2</lesson_id>
          <max_que>15</max_que>
          <passing_percent>14</passing_percent>
          <questions>
            <QuestionData>
              <marks>3</marks>
              <question_data>sample string 4</question_data>
              <question_id>1</question_id>
              <sequence>2</sequence>
            </QuestionData>
            <QuestionData>
              <marks>3</marks>
              <question_data>sample string 4</question_data>
              <question_id>1</question_id>
              <sequence>2</sequence>
            </QuestionData>
          </questions>
          <scored_marks>17</scored_marks>
          <sequence>1</sequence>
          <show_copyright_info>true</show_copyright_info>
          <status>sample string 7</status>
          <title>sample string 3</title>
          <total_attempts>6</total_attempts>
          <total_marks>16</total_marks>
          <trainee_response>sample string 18</trainee_response>
          <type>sample string 4</type>
          <url>sample string 8</url>
        </LessonData>
        <LessonData>
          <content>sample string 13</content>
          <content_type>sample string 5</content_type>
          <duration>9</duration>
          <file_id>12</file_id>
          <is_active>true</is_active>
          <lesson_id>2</lesson_id>
          <max_que>15</max_que>
          <passing_percent>14</passing_percent>
          <questions>
            <QuestionData>
              <marks>3</marks>
              <question_data>sample string 4</question_data>
              <question_id>1</question_id>
              <sequence>2</sequence>
            </QuestionData>
            <QuestionData>
              <marks>3</marks>
              <question_data>sample string 4</question_data>
              <question_id>1</question_id>
              <sequence>2</sequence>
            </QuestionData>
          </questions>
          <scored_marks>17</scored_marks>
          <sequence>1</sequence>
          <show_copyright_info>true</show_copyright_info>
          <status>sample string 7</status>
          <title>sample string 3</title>
          <total_attempts>6</total_attempts>
          <total_marks>16</total_marks>
          <trainee_response>sample string 18</trainee_response>
          <type>sample string 4</type>
          <url>sample string 8</url>
        </LessonData>
      </lessons>
      <module_description>sample string 3</module_description>
      <module_id>1</module_id>
      <module_name>sample string 2</module_name>
      <module_type>sample string 6</module_type>
      <status>sample string 7</status>
    </ModuleData>
  </modules>
  <remarks>sample string 2</remarks>
  <status>sample string 1</status>
  <total_modules>3</total_modules>
</TrainingModulesResponse>