POST api/Student

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
FirstName		string	None.
LastName		string	None.
Password		string	None.
EmailAddress		string	None.
StudentNumber		string	None.
StudentId	The Student ID of an existing GMetrix student, returned by other endpoints, optional for the Create endpoint	integer	None.
Username		string	None.
AccessCode		string	None.
ReferenceInfo	contains information to pass to the student portal to determine where to send the student after log on.	string	None.
Claims		Collection of Pair of string [key] and string [value]	None.
Key	Key to Access API provided by GMetrix	string	None.

Request Formats

application/json, text/json

Sample:

{
  "FirstName": "sample string 1",
  "LastName": "sample string 2",
  "Password": "sample string 3",
  "EmailAddress": "sample string 4",
  "StudentNumber": "sample string 5",
  "StudentId": 6,
  "Username": "sample string 7",
  "AccessCode": "sample string 8",
  "ReferenceInfo": "sample string 9",
  "Claims": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "Key": "sample string 10"
}

application/xml, text/xml

Sample:

<CreateStudentPost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ManagementServicesApi.Models">
  <Key>sample string 10</Key>
  <AccessCode>sample string 8</AccessCode>
  <Claims xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
    <d2p1:KeyValuePairOfstringstring>
      <d2p1:key>sample string 1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfstringstring>
    <d2p1:KeyValuePairOfstringstring>
      <d2p1:key>sample string 1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfstringstring>
  </Claims>
  <ReferenceInfo>sample string 9</ReferenceInfo>
  <StudentId>6</StudentId>
  <Username>sample string 7</Username>
  <EmailAddress>sample string 4</EmailAddress>
  <FirstName>sample string 1</FirstName>
  <LastName>sample string 2</LastName>
  <Password>sample string 3</Password>
  <StudentNumber>sample string 5</StudentNumber>
</CreateStudentPost>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GMetrixUser

Name	Type	Additional information
Id	string	None.
UserProfileID	integer	None.
StudentProfileID	integer	None.
UserName	string	None.
FirstName	string	None.
LastName	string	None.
Email	string	None.
PasswordHash	string	None.
SecretQuestion	byte	None.
SecretAnswer	string	None.
SecurityStamp	string	None.
PhoneNumber	string	None.
PhoneNumberConfirmed	boolean	None.
TwoFactorEnabled	boolean	None.
LockoutEndDateUtc	date	None.
LockoutEnabled	boolean	None.
AccessFailedCount	integer	None.
CultureID	integer	None.
IsActive	boolean	None.
IsADA	boolean	None.
CountryID	integer	None.
StateID	integer	None.
StudentNumber	string	None.
CanAddUsers	boolean	None.
IsFlaggedForDelete	boolean	None.
Role	EUserRole	None.
UserType	EUserType	None.
PartnerIdEditFor	integer	None.
PermissionsCSV	string	None.
Roles	Collection of GMetrixRole	None.
Claims	Collection of Claim	None.
ExternalLogins	Collection of UserLoginInfo	None.
ExternalLoginsCsv	string	None.
ClaimDataCsv	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": "sample string 1",
  "UserProfileID": 1,
  "StudentProfileID": 1,
  "UserName": "sample string 2",
  "FirstName": "sample string 3",
  "LastName": "sample string 4",
  "Email": "sample string 5",
  "PasswordHash": "sample string 6",
  "SecretQuestion": 64,
  "SecretAnswer": "sample string 7",
  "SecurityStamp": "sample string 8",
  "PhoneNumber": "sample string 9",
  "PhoneNumberConfirmed": true,
  "TwoFactorEnabled": true,
  "LockoutEndDateUtc": "2025-05-06T08:15:08.1537629-07:00",
  "LockoutEnabled": true,
  "AccessFailedCount": 13,
  "CultureID": 14,
  "IsActive": true,
  "IsADA": true,
  "CountryID": 17,
  "StateID": 18,
  "StudentNumber": "sample string 19",
  "CanAddUsers": true,
  "IsFlaggedForDelete": true,
  "Role": 1,
  "UserType": 1,
  "PartnerIdEditFor": 22,
  "PermissionsCSV": "sample string 23",
  "Roles": [
    {
      "Id": null,
      "Name": "sample string 1"
    },
    {
      "Id": null,
      "Name": "sample string 1"
    }
  ],
  "Claims": null,
  "ExternalLogins": null,
  "ExternalLoginsCsv": "",
  "ClaimDataCsv": ""
}

application/xml, text/xml

Sample:

<GMetrixUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GMetrixAuthentication.Models">
  <AccessFailedCount>13</AccessFailedCount>
  <CanAddUsers>true</CanAddUsers>
  <Claims xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Security.Claims" i:nil="true" />
  <CountryID>17</CountryID>
  <CultureID>14</CultureID>
  <Email>sample string 5</Email>
  <ExternalLogins xmlns:d2p1="http://schemas.datacontract.org/2004/07/Microsoft.AspNet.Identity" i:nil="true" />
  <FirstName>sample string 3</FirstName>
  <Id>sample string 1</Id>
  <IsADA>true</IsADA>
  <IsActive>true</IsActive>
  <IsFlaggedForDelete>true</IsFlaggedForDelete>
  <LastName>sample string 4</LastName>
  <LockoutEnabled>true</LockoutEnabled>
  <LockoutEndDateUtc>2025-05-06T08:15:08.1537629-07:00</LockoutEndDateUtc>
  <PartnerIdEditFor>22</PartnerIdEditFor>
  <PasswordHash>sample string 6</PasswordHash>
  <PermissionsCSV>sample string 23</PermissionsCSV>
  <PhoneNumber>sample string 9</PhoneNumber>
  <PhoneNumberConfirmed>true</PhoneNumberConfirmed>
  <Role>SuperAdmin</Role>
  <Roles>
    <GMetrixRole>
      <Name>sample string 1</Name>
    </GMetrixRole>
    <GMetrixRole>
      <Name>sample string 1</Name>
    </GMetrixRole>
  </Roles>
  <SecretAnswer>sample string 7</SecretAnswer>
  <SecretQuestion>64</SecretQuestion>
  <SecurityStamp>sample string 8</SecurityStamp>
  <StateID>18</StateID>
  <StudentNumber>sample string 19</StudentNumber>
  <StudentProfileID>1</StudentProfileID>
  <TwoFactorEnabled>true</TwoFactorEnabled>
  <UserName>sample string 2</UserName>
  <UserProfileID>1</UserProfileID>
  <UserType>Admin</UserType>
</GMetrixUser>