POST api/StudentServices/CreateStudent

Creates and Edits student accounts. the decision to create or edit is based on UserName being unique.

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

CreateStudentSuccess

Name	Type	Additional information
AccessCodeAdded	boolean	None.
StudentId	integer	None.
StudentPortalSingleSignOnURL	string	None.
CourseName	string	None.
FirstName	string	None.
LastName	string	None.
ASPNetUserID	globally unique identifier	None.
UserName	string	None.
CourseID	integer	None.
CourseVendor	string	None.
CourseType	string	None.
CourseControl	string	None.
CourseTypeID	byte	None.
CourseStudentID	integer	None.
Progress	decimal number	None.
SecondsSpent	integer	None.
HMSTimeSpent	string	None.
EnrollmentDate	date	None.
StartDate	date	None.
DueDate	date	None.
ExpirationDate	date	None.
CompletionDate	date	None.
Successful	boolean	None.
MsgSuccess	string	None.

Response Formats

application/json, text/json

Sample:

{
  "AccessCodeAdded": true,
  "StudentId": 2,
  "StudentPortalSingleSignOnURL": "sample string 3",
  "CourseName": "sample string 4",
  "FirstName": "sample string 5",
  "LastName": "sample string 6",
  "ASPNetUserID": "419c496b-5112-429d-99a1-379ea9513d3e",
  "UserName": "sample string 8",
  "CourseID": 9,
  "CourseVendor": "sample string 10",
  "CourseType": "sample string 11",
  "CourseControl": "sample string 12",
  "CourseTypeID": 64,
  "CourseStudentID": 1,
  "Progress": 1.1,
  "SecondsSpent": 1,
  "HMSTimeSpent": "sample string 14",
  "EnrollmentDate": "2025-05-08T22:42:28.3415609-07:00",
  "StartDate": "2025-05-08T22:42:28.3415609-07:00",
  "DueDate": "2025-05-08T22:42:28.3415609-07:00",
  "ExpirationDate": "2025-05-08T22:42:28.3415609-07:00",
  "CompletionDate": "2025-05-08T22:42:28.3415609-07:00",
  "Successful": true,
  "MsgSuccess": "sample string 18"
}

application/xml, text/xml

Sample:

<CreateStudentSuccess xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ManagementServices.Repositories.Response">
  <MsgSuccess>sample string 18</MsgSuccess>
  <Successful>true</Successful>
  <ASPNetUserID>419c496b-5112-429d-99a1-379ea9513d3e</ASPNetUserID>
  <CompletionDate>2025-05-08T22:42:28.3415609-07:00</CompletionDate>
  <CourseControl>sample string 12</CourseControl>
  <CourseID>9</CourseID>
  <CourseName>sample string 4</CourseName>
  <CourseStudentID>1</CourseStudentID>
  <CourseType>sample string 11</CourseType>
  <CourseTypeID>64</CourseTypeID>
  <CourseVendor>sample string 10</CourseVendor>
  <DueDate>2025-05-08T22:42:28.3415609-07:00</DueDate>
  <EnrollmentDate>2025-05-08T22:42:28.3415609-07:00</EnrollmentDate>
  <ExpirationDate>2025-05-08T22:42:28.3415609-07:00</ExpirationDate>
  <FirstName>sample string 5</FirstName>
  <HMSTimeSpent>sample string 14</HMSTimeSpent>
  <LastName>sample string 6</LastName>
  <Progress>1.1</Progress>
  <SecondsSpent>1</SecondsSpent>
  <StartDate>2025-05-08T22:42:28.3415609-07:00</StartDate>
  <StudentId>2</StudentId>
  <StudentPortalSingleSignOnURL>sample string 3</StudentPortalSingleSignOnURL>
  <UserName>sample string 8</UserName>
  <AccessCodeAdded>true</AccessCodeAdded>
</CreateStudentSuccess>