Create a Student User Account

Owned by Zach Zhao (Unlicensed)
Last updated: Aug 25, 2017
5 min read

Creates student user account (s) and return user id(s). Student User Id allows students to login into the LinkIt! Student Portal.

Resource URI
/studentaccounts
HTTPS POST
/v1/studentaccounts?timestamp={TimeStamp}&accesskey={AccessKey}&tag={Token}
Parameters for Request Header

The following parameters may be included in the request header of the HTTPS POST call to create student user accounts:

Parameters: The list of students

Parameter
Required?
Data Type
Description
StudentIDYes

STRING (100)

the ID of the student. EXAMPLES: 24324234

CodeYes
STRING (100)

the local code used by the district or the Student Information System to identify each student. EXAMPLES: ST001

UsernameYes

STRING (50)

the user name of the student.  EXAMPLES: JOE.SMITH

EmailNo

STRING (100)

the email of the student. EXAMPLES: MAIL@LINKIT.COM

PasswordNo

STRING (100)

the password of the student. EXAMPLE: NY123456, 00112233 If a password is not provided, default password will be used.

SecurityQuestionNo

STRING (500)

the security question. EXAMPLE: WHRE ARE YOU FROM?

SecurityAnswerNo

STRING (500

the security answer. EXAMPLES: BRIDGEPORT

Response

The following fields are included in the response following an HTTPS POST call to create a school.

Field NameData TypeDescriptionExample
Result
STRING (10)
indicates whether the request is authenticated or authorized.

SUCCESS

ERROR

Data
JSON/XML

returns properties of the list of created student user accounts if result is SUCCESS.


 Returned data includes
  • StudentID: 
  • Code:
  • UserId:
  • FirstName:
  • LastName:
  • Result: indicates whether the student user account is created  SUCCESS   or   ERROR                
  • Errors: provides explanation if result is ERROR."Null" is returned if result is SUCCESS

 Check out the Student page to learn more about the various properties that define a student.

See below for detailed examples.
Error
STRING (100)

provides explanation if result is ERROR."Null" is returned if result is SUCCESS.

Click here for a list of error messages.
Example

 

 JSON
Method

POST

Request URL
/studentaccounts?timestamp=5%2f29%2f2013+6%3a37%3a24+PM&accesskey=123456789-987654321&tag=6ecfe79219d9cd3c6b440b22694f987a29964327
Request Header
[ 
    { 
        "StudentID":"studentid1", 
        "Code":"code1", 
        "Username":"username1", 
        "Email":"", 
        "Password":"", 
        "SecurityQuestion":"", 
        "SecurityAnswer":"", 
    }, 
    { 
        "StudentID":"studentid2", 
        "Code":"Code2", 
        "Username":"", 
        "Email":"", 
        "Password":"", 
        "SecurityQuestion":"", 
        "SecurityAnswer":"", 
    }, 
  { 
        "StudentID":"fakeId", 
        "Code":"fakeCode", 
        "Username":"abc", 
        "Email":"", 
        "Password":"", 
        "SecurityQuestion":"", 
        "SecurityAnswer":"", 
    } 
]
Response Content
{ 
  "Result": "SUCCESS", 
  "Data": { 
        "Students": 
        [ 
          { 
            "Status": "SUCCESS", 
            	"Errors": null, 
            "StudentID":"studentid1", 
            "Code":"code1", 
            "Username":"username1", 
            "UserId":"654564", 
            "FirstName":"Student", 
            "LastName":"1" 
          }, 
          { 
           "Status": "ERROR", 
           "Errors": [ 
                    	{ 
                        	"Code": "3084", 
                    	    "Message": "The Username is required." 
                    	} 
                	],     
            "StudentID":"studentid2", 
            "Code":"code2", 
            "Username":"", 
            "UserId":"", 
            "FirstName":"", 
            "LastName":"" 
          }, 
          { 
            "Status": "ERROR", 
            	"Errors": [ 
    	                    { 
                            	"Code": "1234", 
    	                        "Message": "StudentId and code does not exist in the Student table." 
                        } 
    	                    ], 
            "StudentID":"fakeId", 
            "Code":"fakeCode", 
            "Username":"abc", 
            "UserId":"", 
            "FirstName":"", 
            "LastName":"" 
          } 
        ], 
   "Error": null 
  } 
}

  

Navigation and Reference

Expand all   Collapse all