| Required role: | Admin |
| GET | /students/{Schoolid}/profile |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Schoolid | path | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Result | form | StudentProfileDTO | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FirstName | form | string | No | |
| LastName | form | string | No | |
| Gender | form | string | No | |
| Age | form | int | No | |
| Ethnicity | form | string | No | |
| Birthday | form | string | No | |
| ClassStanding | form | string | No | |
| TshirtSize | form | string | No | |
| form | string | No | ||
| CellPhone | form | string | No | |
| HomePhone | form | string | No | |
| SummerPhone | form | string | No | |
| Residence | form | StudentResidenceDTO | No | |
| Address | form | StudentAddressDTO | No | |
| Curfew | form | StudentCurfewDTO | No | |
| guardian | form | GuardianDTO | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Room | form | string | No | |
| Building | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Address | form | string | No | |
| Address2 | form | string | No | |
| City | form | string | No | |
| State | form | string | No | |
| Postal | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CurfewType | form | string | No | |
| CurfewDays | form | Dictionary<string, DateTime> | No | |
| LateLeaveDays | form | Dictionary<string, DateTime> | No | |
| Grace | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Contact1 | form | string | No | |
| Contact1Phone | form | string | No | |
| Contact1Relation | form | string | No | |
| Contact2 | form | string | No | |
| Contact2Phone | form | string | No | |
| Contact2Relation | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /students/{Schoolid}/profile HTTP/1.1
Host: api.oau.abodehms.com
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}