| Required role: | Admin |
| All Verbs | /students |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BuildingIds | query | ArrayOfInt | No | |
| Status | query | string | No | |
| ReserveTermId | query | int? | No | |
| StudentIds | query | ArrayOfInt | No | |
| SchoolIds | query | ArrayOfString | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Results | form | List<StudentDTO> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StudentId | form | int | No | |
| SchoolId | form | string | No | |
| IdSerial | form | string | No | |
| Username | form | string | No | |
| DisplayName | form | string | No | |
| FirstName | form | string | No | |
| MiddleName | form | string | No | |
| LastName | form | string | No | |
| NickName | form | string | No | |
| Birthday | form | DateTime? | No | |
| Gender | form | string | No | |
| EthnicId | form | string | No | |
| TshirtSize | form | string | No | |
| Religion | form | string | No | |
| Age | form | int | No | |
| Address1 | form | string | No | |
| Address2 | form | string | No | |
| City | form | string | No | |
| State | form | string | No | |
| Postal | form | string | No | |
| Country | form | string | No | |
| PhotoFilename | form | string | No | |
| ImageUrl | form | string | No | |
| form | string | No | ||
| Email2 | form | string | No | |
| Homephone | form | string | No | |
| Summerphone | form | string | No | |
| Cellphone | form | string | No | |
| SmsPermission | form | string | No | |
| Otherphone | form | string | No | |
| Contact1 | form | string | No | |
| Contact2 | form | string | No | |
| Contact1Relation | form | string | No | |
| Contact2Relation | form | string | No | |
| Contactphone1 | form | string | No | |
| Contactphone2 | form | string | No | |
| Contactcomments | form | string | No | |
| Emergency1Contact | form | string | No | |
| Emergency1Relation | form | string | No | |
| Emergency1Address1 | form | string | No | |
| Emergency1Address2 | form | string | No | |
| Emergency1City | form | string | No | |
| Emergency1State | form | string | No | |
| Emergency1Postal | form | string | No | |
| Emergency1HomePhone | form | string | No | |
| Emergency1WorkPhone | form | string | No | |
| Emergency1PagerPhone | form | string | No | |
| Emergency1CellPhone | form | string | No | |
| Emergency1OtherPhone | form | string | No | |
| Emergency2Contact | form | string | No | |
| Emergency2Relation | form | string | No | |
| Emergency2Address1 | form | string | No | |
| Emergency2Address2 | form | string | No | |
| Emergency2City | form | string | No | |
| Emergency2State | form | string | No | |
| Emergency2Postal | form | string | No | |
| Emergency2Country | form | string | No | |
| Emergency2HomePhone | form | string | No | |
| Emergency2WorkPhone | form | string | No | |
| Emergency2CellPhone | form | string | No | |
| Emergency2OtherPhone | form | string | No | |
| Emergency2Email | form | string | No | |
| DepositReceived | form | DateTime? | No | |
| DepositRefunded | form | DateTime? | No | |
| FinClear | form | string | No | |
| EnrollmentFeePaid | form | string | No | |
| ClassId | form | string | No | |
| ClassStanding | form | string | No | |
| Gpa | form | decimal? | No | |
| ArrivingYear | form | string | No | |
| ArrivingTerm | form | string | No | |
| Graduating | form | string | No | |
| GraduatingTermId | form | string | No | |
| CreditLoad | form | int? | No | |
| TermsAttended | form | int? | No | |
| CreditsCompleted | form | int? | No | |
| Major1 | form | string | No | |
| Major2 | form | string | No | |
| Major3 | form | string | No | |
| Minor1 | form | string | No | |
| Minor2 | form | string | No | |
| Minor3 | form | string | No | |
| Highschool | form | string | No | |
| Hsgpa | form | decimal? | No | |
| Assigned | form | int | No | |
| CheckedIn | form | int | No | |
| IntendHousing | form | string | No | |
| BuildingId | form | int? | No | |
| Room | form | string | No | |
| ReserveBuildingId | form | int? | No | |
| ReserveRoom | form | string | No | |
| CurfewId | form | string | No | |
| CurfewDefaultId | form | string | No | |
| Grace | form | string | No | |
| CurfewOverride | form | string | No | |
| CurfewRestricted | form | string | No | |
| WorshipReqId | form | string | No | |
| WorshipDefaultId | form | string | No | |
| WorshipOverride | form | string | No | |
| WorshipRestricted | form | string | No | |
| PreventLeaves | form | string | No | |
| LeavePermissionFrom1 | form | string | No | |
| LeavePermissionFrom2 | form | string | No | |
| LeavePermissionFrom3 | form | string | No | |
| LeavePermissionFrom4 | form | string | No | |
| LeavePermissionFrom5 | form | string | No | |
| LeavePermissionFrom6 | form | string | No | |
| ParentalContact | form | string | No | |
| LeavePermissions | form | string | No | |
| VisitLocal | form | string | No | |
| ParentSigned | form | string | No | |
| ParentSignDate | form | DateTime? | No | |
| StudentSignDate | form | DateTime? | No | |
| MedicalNotes | form | string | No | |
| MedicalArrangements | form | string | No | |
| Physician | form | string | No | |
| PhysicianPhone | form | string | No | |
| InsuranceCompany | form | string | No | |
| InsurancePolicy | form | string | No | |
| MedicalDisease | form | string | No | |
| MedicalAllergies | form | string | No | |
| MedicalMedicationAllergies | form | string | No | |
| MedicalOngoing | form | string | No | |
| MedicalSpecialTreatment | form | string | No | |
| MedicalOnMeds | form | string | No | |
| MedicalCarePermission | form | string | No | |
| MedicalMedications | form | string | No | |
| WingId | form | int | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST //students HTTP/1.1
Host: api.lsu.abodehms.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{Unable to show example output for type 'FindStudents' using the custom 'csv' filter}One or more errors occurred. (Unable to cast object of type 'ServiceStack.Host.BasicResponse' to type 'ServiceStack.Host.NetCore.NetCoreResponse'.)
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{Unable to show example output for type 'StudentsResponse' using the custom 'csv' filter}One or more errors occurred. (Unable to cast object of type 'ServiceStack.Host.BasicResponse' to type 'ServiceStack.Host.NetCore.NetCoreResponse'.)