Create a Staff
- Zach Zhao (Unlicensed)
/staffs
/staffs?timestamp={TimeStamp}&accesskey={AccessKey}&tag={Token}
The following parameters should be included in the request URL of the HTTPS POST call to create a staff.
Parameter | Required? | Data Type | Description |
|---|---|---|---|
| TimeStamp | Yes | DATETIME | the GMT time at which the call is generated. EXAMPLE: 5/1/2013+5:10:5+PM |
| AccessKey | Yes | STRING (128) | a unique key associated with the API user. EXAMPLE: 123456789-987654321 |
| Tag | Yes | STRING (128) | token generated for authorization and authentication. |
The following parameters may be included in the request header of the HTTPS POST call to create a staff.
| Parameter | Required | Data Type | Description |
|---|---|---|---|
| Role | Yes | STRING (100) | the role of the staff, TEACHER, SCHOOL ADMIN or DISTRICT ADMIN. |
| SchoolID | No | INTEGER | the ID of the school associated with the staff. If a school ID is provided when creating a staff, the staff will be associated with that school immediately. Alternatively, you could assign a staff to a school after the staff is created, or even assign multiple schools to a staff. |
| UserName | Yes | STRING (50) | the username used by the staff to log into LinkIt!. EXAMPLES: JSMITH |
| FirstName | No | STRING (50) | the first name of the staff. EXAMPLES: JOHN If a first name is not provided, it will default to blank. |
| LastName | No | STRING (50) | the last name of the staff. EXAMPLES: SMITH If a last name is not provided, it will default to the username. |
| EmailAddress | No | STRING (100) | the email address of the staff. |
| PhoneNumber | No | STRING (50) | the phone number of the staff. |
| LocalCode | Yes | STRING (50) | the local code used by the district or the Student Information System to identify each staff. EXAMPLES: 060, ES001 |
| StateCode | No | STRING (100) | the code used by the state to identify each staff. May or may not be the same as the local code. EXAMPLE: NY123456, 00112233 |
Note about Username and Local Code
Given that LinkIt! requires username and local code to be uniquely paired within each district, you cannot create a staff with an existing username or local code.
The following fields are included in the response following an HTTPS POST call to create a staff.
| Field Name | Data Type | Description | Example |
|---|---|---|---|
| Result | STRING (10) | indicates whether the staff is created successfully. | SUCCESS ERROR |
| Data | JSON/XML | returns properties of the created staff if result is SUCCESS.
Check out the Staff page to learn more about the various properties that define a staff. | 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. |
Create a staff with the following information:
Role: Teacher, UserName: JohnSmith, LocalCode: JS12345
Navigation and Reference