POST api/User

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:

{
  "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-27T20:49:11.5890931-03:00",
      "spotlightend": "2024-09-27T20:49:11.5890931-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-27T20:49:11.5890931-03:00",
      "spotlightend": "2024-09-27T20:49:11.5890931-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-27T20:49:11.5890931-03:00",
      "spotlightend": "2024-09-27T20:49:11.5890931-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
    }
  ]
}

application/xml, text/xml

Sample:

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

application/x-www-form-urlencoded

Sample:

Sample not available.