POST api/CourseCompletion

Documentation for 'Post'.

Request Information

Parameters

Name	Description	Additional information
resource	Documentation for 'resource'.	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "course": {
    "id": 1,
    "fullname": "sample string 2",
    "shortname": "sample string 3",
    "categoryid": 1,
    "idnumber": "sample string 4",
    "summary": "sample string 5",
    "summaryformat": 1,
    "format": "sample string 6",
    "showgrades": 1,
    "newsitems": 1,
    "startdate": 1,
    "numsections": 1,
    "maxbytes": 1,
    "showreports": 1,
    "visible": 1,
    "groupmode": 1,
    "groupmodeforce": 1,
    "defaultgroupingid": 1,
    "enablecompletion": 1,
    "completionnotify": 1,
    "lang": "sample string 7",
    "forcetheme": "sample string 8",
    "courseformatoptions": [
      {
        "name": "sample string 1",
        "value": "sample string 2"
      },
      {
        "name": "sample string 1",
        "value": "sample string 2"
      },
      {
        "name": "sample string 1",
        "value": "sample string 2"
      }
    ],
    "image": "sample string 9",
    "knowledgearea": 10,
    "spotlightstart": "2024-09-28T06:24:22.5462241-03:00",
    "spotlightend": "2024-09-28T06:24:22.5462241-03:00"
  },
  "user": {
    "id": "sample string 1",
    "username": "sample string 2",
    "password": "sample string 3",
    "firstName": "sample string 4",
    "lastName": "sample string 5",
    "email": "sample string 6",
    "group": "sample string 7",
    "auth": "sample string 8",
    "idnumber": "sample string 9",
    "lang": "sample string 10",
    "theme": "sample string 11",
    "timezone": "sample string 12",
    "mailformat": 13,
    "description": "sample string 14",
    "city": "sample string 15",
    "country": "sample string 16",
    "firstnamephonetic": "sample string 17",
    "lastnamephonetic": "sample string 18",
    "middlename": "sample string 19",
    "alternatename": "sample string 20",
    "preferences": [
      {
        "type": "sample string 1",
        "value": "sample string 2"
      },
      {
        "type": "sample string 1",
        "value": "sample string 2"
      },
      {
        "type": "sample string 1",
        "value": "sample string 2"
      }
    ],
    "customfields": [
      {
        "type": "sample string 1",
        "value": "sample string 2"
      },
      {
        "type": "sample string 1",
        "value": "sample string 2"
      },
      {
        "type": "sample string 1",
        "value": "sample string 2"
      }
    ],
    "groups": [
      {
        "id": "sample string 1",
        "courseid": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "reference": "sample string 5",
        "enrolmentkey": "sample string 6",
        "ClassroomCourseName": "sample string 7",
        "ClassroomSection": "sample string 8",
        "ClassroomDescription": "sample string 9",
        "ClassroomRoom": "sample string 10"
      },
      {
        "id": "sample string 1",
        "courseid": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "reference": "sample string 5",
        "enrolmentkey": "sample string 6",
        "ClassroomCourseName": "sample string 7",
        "ClassroomSection": "sample string 8",
        "ClassroomDescription": "sample string 9",
        "ClassroomRoom": "sample string 10"
      },
      {
        "id": "sample string 1",
        "courseid": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "reference": "sample string 5",
        "enrolmentkey": "sample string 6",
        "ClassroomCourseName": "sample string 7",
        "ClassroomSection": "sample string 8",
        "ClassroomDescription": "sample string 9",
        "ClassroomRoom": "sample string 10"
      }
    ],
    "enrolledcourses": [
      {
        "id": 1,
        "fullname": "sample string 2",
        "shortname": "sample string 3",
        "categoryid": 1,
        "idnumber": "sample string 4",
        "summary": "sample string 5",
        "summaryformat": 1,
        "format": "sample string 6",
        "showgrades": 1,
        "newsitems": 1,
        "startdate": 1,
        "numsections": 1,
        "maxbytes": 1,
        "showreports": 1,
        "visible": 1,
        "groupmode": 1,
        "groupmodeforce": 1,
        "defaultgroupingid": 1,
        "enablecompletion": 1,
        "completionnotify": 1,
        "lang": "sample string 7",
        "forcetheme": "sample string 8",
        "courseformatoptions": [
          {
            "name": "sample string 1",
            "value": "sample string 2"
          },
          {
            "name": "sample string 1",
            "value": "sample string 2"
          },
          {
            "name": "sample string 1",
            "value": "sample string 2"
          }
        ],
        "image": "sample string 9",
        "knowledgearea": 10,
        "spotlightstart": "2024-09-28T06:24:22.5462241-03:00",
        "spotlightend": "2024-09-28T06:24:22.5462241-03:00"
      },
      {
        "id": 1,
        "fullname": "sample string 2",
        "shortname": "sample string 3",
        "categoryid": 1,
        "idnumber": "sample string 4",
        "summary": "sample string 5",
        "summaryformat": 1,
        "format": "sample string 6",
        "showgrades": 1,
        "newsitems": 1,
        "startdate": 1,
        "numsections": 1,
        "maxbytes": 1,
        "showreports": 1,
        "visible": 1,
        "groupmode": 1,
        "groupmodeforce": 1,
        "defaultgroupingid": 1,
        "enablecompletion": 1,
        "completionnotify": 1,
        "lang": "sample string 7",
        "forcetheme": "sample string 8",
        "courseformatoptions": [
          {
            "name": "sample string 1",
            "value": "sample string 2"
          },
          {
            "name": "sample string 1",
            "value": "sample string 2"
          },
          {
            "name": "sample string 1",
            "value": "sample string 2"
          }
        ],
        "image": "sample string 9",
        "knowledgearea": 10,
        "spotlightstart": "2024-09-28T06:24:22.5462241-03:00",
        "spotlightend": "2024-09-28T06:24:22.5462241-03:00"
      },
      {
        "id": 1,
        "fullname": "sample string 2",
        "shortname": "sample string 3",
        "categoryid": 1,
        "idnumber": "sample string 4",
        "summary": "sample string 5",
        "summaryformat": 1,
        "format": "sample string 6",
        "showgrades": 1,
        "newsitems": 1,
        "startdate": 1,
        "numsections": 1,
        "maxbytes": 1,
        "showreports": 1,
        "visible": 1,
        "groupmode": 1,
        "groupmodeforce": 1,
        "defaultgroupingid": 1,
        "enablecompletion": 1,
        "completionnotify": 1,
        "lang": "sample string 7",
        "forcetheme": "sample string 8",
        "courseformatoptions": [
          {
            "name": "sample string 1",
            "value": "sample string 2"
          },
          {
            "name": "sample string 1",
            "value": "sample string 2"
          },
          {
            "name": "sample string 1",
            "value": "sample string 2"
          }
        ],
        "image": "sample string 9",
        "knowledgearea": 10,
        "spotlightstart": "2024-09-28T06:24:22.5462241-03:00",
        "spotlightend": "2024-09-28T06:24:22.5462241-03:00"
      }
    ],
    "roles": [
      {
        "roleid": "sample string 1",
        "name": "sample string 2",
        "shortname": "sample string 3",
        "sortorder": 4
      },
      {
        "roleid": "sample string 1",
        "name": "sample string 2",
        "shortname": "sample string 3",
        "sortorder": 4
      },
      {
        "roleid": "sample string 1",
        "name": "sample string 2",
        "shortname": "sample string 3",
        "sortorder": 4
      }
    ]
  },
  "timeenrolled": "sample string 1",
  "timestarted": "sample string 2",
  "timecompleted": "sample string 3"
}

application/xml, text/xml

Sample:

<CourseCompletionDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AVA_API.DTO">
  <course>
    <categoryid>1</categoryid>
    <completionnotify>1</completionnotify>
    <courseformatoptions xmlns:d3p1="http://schemas.datacontract.org/2004/07/AVA_API.DTO.Moodle.Course">
      <d3p1:courseformatoptions>
        <d3p1:name>sample string 1</d3p1:name>
        <d3p1:value>sample string 2</d3p1:value>
      </d3p1:courseformatoptions>
      <d3p1:courseformatoptions>
        <d3p1:name>sample string 1</d3p1:name>
        <d3p1:value>sample string 2</d3p1:value>
      </d3p1:courseformatoptions>
      <d3p1:courseformatoptions>
        <d3p1:name>sample string 1</d3p1:name>
        <d3p1:value>sample string 2</d3p1:value>
      </d3p1:courseformatoptions>
    </courseformatoptions>
    <defaultgroupingid>1</defaultgroupingid>
    <enablecompletion>1</enablecompletion>
    <forcetheme>sample string 8</forcetheme>
    <format>sample string 6</format>
    <fullname>sample string 2</fullname>
    <groupmode>1</groupmode>
    <groupmodeforce>1</groupmodeforce>
    <id>1</id>
    <idnumber>sample string 4</idnumber>
    <image>sample string 9</image>
    <knowledgearea>10</knowledgearea>
    <lang>sample string 7</lang>
    <maxbytes>1</maxbytes>
    <newsitems>1</newsitems>
    <numsections>1</numsections>
    <shortname>sample string 3</shortname>
    <showgrades>1</showgrades>
    <showreports>1</showreports>
    <spotlightend>2024-09-28T06:24:22.5462241-03:00</spotlightend>
    <spotlightstart>2024-09-28T06:24:22.5462241-03:00</spotlightstart>
    <startdate>1</startdate>
    <summary>sample string 5</summary>
    <summaryformat>1</summaryformat>
    <visible>1</visible>
  </course>
  <timecompleted>sample string 3</timecompleted>
  <timeenrolled>sample string 1</timeenrolled>
  <timestarted>sample string 2</timestarted>
  <user xmlns:d2p1="http://schemas.datacontract.org/2004/07/AVA_API.Models">
    <d2p1:alternatename>sample string 20</d2p1:alternatename>
    <d2p1:auth>sample string 8</d2p1:auth>
    <d2p1:city>sample string 15</d2p1:city>
    <d2p1:country>sample string 16</d2p1:country>
    <d2p1:customfields xmlns:d3p1="http://schemas.datacontract.org/2004/07/AVA_API.DTO.Moodle.Users">
      <d3p1:CustomFields>
        <d3p1:type>sample string 1</d3p1:type>
        <d3p1:value>sample string 2</d3p1:value>
      </d3p1:CustomFields>
      <d3p1:CustomFields>
        <d3p1:type>sample string 1</d3p1:type>
        <d3p1:value>sample string 2</d3p1:value>
      </d3p1:CustomFields>
      <d3p1:CustomFields>
        <d3p1:type>sample string 1</d3p1:type>
        <d3p1:value>sample string 2</d3p1:value>
      </d3p1:CustomFields>
    </d2p1:customfields>
    <d2p1:description>sample string 14</d2p1:description>
    <d2p1:email>sample string 6</d2p1:email>
    <d2p1:enrolledcourses>
      <CourseDTO>
        <categoryid>1</categoryid>
        <completionnotify>1</completionnotify>
        <courseformatoptions xmlns:d5p1="http://schemas.datacontract.org/2004/07/AVA_API.DTO.Moodle.Course">
          <d5p1:courseformatoptions>
            <d5p1:name>sample string 1</d5p1:name>
            <d5p1:value>sample string 2</d5p1:value>
          </d5p1:courseformatoptions>
          <d5p1:courseformatoptions>
            <d5p1:name>sample string 1</d5p1:name>
            <d5p1:value>sample string 2</d5p1:value>
          </d5p1:courseformatoptions>
          <d5p1:courseformatoptions>
            <d5p1:name>sample string 1</d5p1:name>
            <d5p1:value>sample string 2</d5p1:value>
          </d5p1:courseformatoptions>
        </courseformatoptions>
        <defaultgroupingid>1</defaultgroupingid>
        <enablecompletion>1</enablecompletion>
        <forcetheme>sample string 8</forcetheme>
        <format>sample string 6</format>
        <fullname>sample string 2</fullname>
        <groupmode>1</groupmode>
        <groupmodeforce>1</groupmodeforce>
        <id>1</id>
        <idnumber>sample string 4</idnumber>
        <image>sample string 9</image>
        <knowledgearea>10</knowledgearea>
        <lang>sample string 7</lang>
        <maxbytes>1</maxbytes>
        <newsitems>1</newsitems>
        <numsections>1</numsections>
        <shortname>sample string 3</shortname>
        <showgrades>1</showgrades>
        <showreports>1</showreports>
        <spotlightend>2024-09-28T06:24:22.5462241-03:00</spotlightend>
        <spotlightstart>2024-09-28T06:24:22.5462241-03:00</spotlightstart>
        <startdate>1</startdate>
        <summary>sample string 5</summary>
        <summaryformat>1</summaryformat>
        <visible>1</visible>
      </CourseDTO>
      <CourseDTO>
        <categoryid>1</categoryid>
        <completionnotify>1</completionnotify>
        <courseformatoptions xmlns:d5p1="http://schemas.datacontract.org/2004/07/AVA_API.DTO.Moodle.Course">
          <d5p1:courseformatoptions>
            <d5p1:name>sample string 1</d5p1:name>
            <d5p1:value>sample string 2</d5p1:value>
          </d5p1:courseformatoptions>
          <d5p1:courseformatoptions>
            <d5p1:name>sample string 1</d5p1:name>
            <d5p1:value>sample string 2</d5p1:value>
          </d5p1:courseformatoptions>
          <d5p1:courseformatoptions>
            <d5p1:name>sample string 1</d5p1:name>
            <d5p1:value>sample string 2</d5p1:value>
          </d5p1:courseformatoptions>
        </courseformatoptions>
        <defaultgroupingid>1</defaultgroupingid>
        <enablecompletion>1</enablecompletion>
        <forcetheme>sample string 8</forcetheme>
        <format>sample string 6</format>
        <fullname>sample string 2</fullname>
        <groupmode>1</groupmode>
        <groupmodeforce>1</groupmodeforce>
        <id>1</id>
        <idnumber>sample string 4</idnumber>
        <image>sample string 9</image>
        <knowledgearea>10</knowledgearea>
        <lang>sample string 7</lang>
        <maxbytes>1</maxbytes>
        <newsitems>1</newsitems>
        <numsections>1</numsections>
        <shortname>sample string 3</shortname>
        <showgrades>1</showgrades>
        <showreports>1</showreports>
        <spotlightend>2024-09-28T06:24:22.5462241-03:00</spotlightend>
        <spotlightstart>2024-09-28T06:24:22.5462241-03:00</spotlightstart>
        <startdate>1</startdate>
        <summary>sample string 5</summary>
        <summaryformat>1</summaryformat>
        <visible>1</visible>
      </CourseDTO>
      <CourseDTO>
        <categoryid>1</categoryid>
        <completionnotify>1</completionnotify>
        <courseformatoptions xmlns:d5p1="http://schemas.datacontract.org/2004/07/AVA_API.DTO.Moodle.Course">
          <d5p1:courseformatoptions>
            <d5p1:name>sample string 1</d5p1:name>
            <d5p1:value>sample string 2</d5p1:value>
          </d5p1:courseformatoptions>
          <d5p1:courseformatoptions>
            <d5p1:name>sample string 1</d5p1:name>
            <d5p1:value>sample string 2</d5p1:value>
          </d5p1:courseformatoptions>
          <d5p1:courseformatoptions>
            <d5p1:name>sample string 1</d5p1:name>
            <d5p1:value>sample string 2</d5p1:value>
          </d5p1:courseformatoptions>
        </courseformatoptions>
        <defaultgroupingid>1</defaultgroupingid>
        <enablecompletion>1</enablecompletion>
        <forcetheme>sample string 8</forcetheme>
        <format>sample string 6</format>
        <fullname>sample string 2</fullname>
        <groupmode>1</groupmode>
        <groupmodeforce>1</groupmodeforce>
        <id>1</id>
        <idnumber>sample string 4</idnumber>
        <image>sample string 9</image>
        <knowledgearea>10</knowledgearea>
        <lang>sample string 7</lang>
        <maxbytes>1</maxbytes>
        <newsitems>1</newsitems>
        <numsections>1</numsections>
        <shortname>sample string 3</shortname>
        <showgrades>1</showgrades>
        <showreports>1</showreports>
        <spotlightend>2024-09-28T06:24:22.5462241-03:00</spotlightend>
        <spotlightstart>2024-09-28T06:24:22.5462241-03:00</spotlightstart>
        <startdate>1</startdate>
        <summary>sample string 5</summary>
        <summaryformat>1</summaryformat>
        <visible>1</visible>
      </CourseDTO>
    </d2p1:enrolledcourses>
    <d2p1:firstName>sample string 4</d2p1:firstName>
    <d2p1:firstnamephonetic>sample string 17</d2p1:firstnamephonetic>
    <d2p1:group>sample string 7</d2p1:group>
    <d2p1:groups>
      <d2p1:SectionDTO>
        <d2p1:ClassroomCourseName>sample string 7</d2p1:ClassroomCourseName>
        <d2p1:ClassroomDescription>sample string 9</d2p1:ClassroomDescription>
        <d2p1:ClassroomRoom>sample string 10</d2p1:ClassroomRoom>
        <d2p1:ClassroomSection>sample string 8</d2p1:ClassroomSection>
        <d2p1:courseid>sample string 2</d2p1:courseid>
        <d2p1:description>sample string 4</d2p1:description>
        <d2p1:enrolmentkey>sample string 6</d2p1:enrolmentkey>
        <d2p1:id>sample string 1</d2p1:id>
        <d2p1:name>sample string 3</d2p1:name>
        <d2p1:reference>sample string 5</d2p1:reference>
      </d2p1:SectionDTO>
      <d2p1:SectionDTO>
        <d2p1:ClassroomCourseName>sample string 7</d2p1:ClassroomCourseName>
        <d2p1:ClassroomDescription>sample string 9</d2p1:ClassroomDescription>
        <d2p1:ClassroomRoom>sample string 10</d2p1:ClassroomRoom>
        <d2p1:ClassroomSection>sample string 8</d2p1:ClassroomSection>
        <d2p1:courseid>sample string 2</d2p1:courseid>
        <d2p1:description>sample string 4</d2p1:description>
        <d2p1:enrolmentkey>sample string 6</d2p1:enrolmentkey>
        <d2p1:id>sample string 1</d2p1:id>
        <d2p1:name>sample string 3</d2p1:name>
        <d2p1:reference>sample string 5</d2p1:reference>
      </d2p1:SectionDTO>
      <d2p1:SectionDTO>
        <d2p1:ClassroomCourseName>sample string 7</d2p1:ClassroomCourseName>
        <d2p1:ClassroomDescription>sample string 9</d2p1:ClassroomDescription>
        <d2p1:ClassroomRoom>sample string 10</d2p1:ClassroomRoom>
        <d2p1:ClassroomSection>sample string 8</d2p1:ClassroomSection>
        <d2p1:courseid>sample string 2</d2p1:courseid>
        <d2p1:description>sample string 4</d2p1:description>
        <d2p1:enrolmentkey>sample string 6</d2p1:enrolmentkey>
        <d2p1:id>sample string 1</d2p1:id>
        <d2p1:name>sample string 3</d2p1:name>
        <d2p1:reference>sample string 5</d2p1:reference>
      </d2p1:SectionDTO>
    </d2p1:groups>
    <d2p1:id>sample string 1</d2p1:id>
    <d2p1:idnumber>sample string 9</d2p1:idnumber>
    <d2p1:lang>sample string 10</d2p1:lang>
    <d2p1:lastName>sample string 5</d2p1:lastName>
    <d2p1:lastnamephonetic>sample string 18</d2p1:lastnamephonetic>
    <d2p1:mailformat>13</d2p1:mailformat>
    <d2p1:middlename>sample string 19</d2p1:middlename>
    <d2p1:password>sample string 3</d2p1:password>
    <d2p1:preferences xmlns:d3p1="http://schemas.datacontract.org/2004/07/AVA_API.DTO.Moodle.Users">
      <d3p1:Preferences>
        <d3p1:type>sample string 1</d3p1:type>
        <d3p1:value>sample string 2</d3p1:value>
      </d3p1:Preferences>
      <d3p1:Preferences>
        <d3p1:type>sample string 1</d3p1:type>
        <d3p1:value>sample string 2</d3p1:value>
      </d3p1:Preferences>
      <d3p1:Preferences>
        <d3p1:type>sample string 1</d3p1:type>
        <d3p1:value>sample string 2</d3p1:value>
      </d3p1:Preferences>
    </d2p1:preferences>
    <d2p1:roles xmlns:d3p1="http://schemas.datacontract.org/2004/07/AVA_API.DTO.Moodle">
      <d3p1:RoleDTO>
        <d3p1:name>sample string 2</d3p1:name>
        <d3p1:roleid>sample string 1</d3p1:roleid>
        <d3p1:shortname>sample string 3</d3p1:shortname>
        <d3p1:sortorder>4</d3p1:sortorder>
      </d3p1:RoleDTO>
      <d3p1:RoleDTO>
        <d3p1:name>sample string 2</d3p1:name>
        <d3p1:roleid>sample string 1</d3p1:roleid>
        <d3p1:shortname>sample string 3</d3p1:shortname>
        <d3p1:sortorder>4</d3p1:sortorder>
      </d3p1:RoleDTO>
      <d3p1:RoleDTO>
        <d3p1:name>sample string 2</d3p1:name>
        <d3p1:roleid>sample string 1</d3p1:roleid>
        <d3p1:shortname>sample string 3</d3p1:shortname>
        <d3p1:sortorder>4</d3p1:sortorder>
      </d3p1:RoleDTO>
    </d2p1:roles>
    <d2p1:theme>sample string 11</d2p1:theme>
    <d2p1:timezone>sample string 12</d2p1:timezone>
    <d2p1:username>sample string 2</d2p1:username>
  </user>
</CourseCompletionDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.