| Required role: | Admin |
| POST | /students/{StudentId}/forwarding_address | ||
|---|---|---|---|
| POST | /forwarding_addresses |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StudentId | path | int | Yes | |
| Type | body | string | Yes | Allowable Values
|
| Address | body | string | Yes | |
| Address2 | body | string | No | |
| City | body | string | Yes | |
| State | body | string | Yes | |
| Country | body | string | Yes | |
| Postal | body | string | Yes | |
| EffectiveDt | body | DateTime? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| result | form | ForwardingAddressDTO | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ForwardingAddressId | form | int | Yes | |
| StudentId | form | int | Yes | |
| Type | form | string | Yes | Allowable Values
|
| Address | form | string | Yes | |
| Address2 | form | string | Yes | |
| City | form | string | Yes | |
| State | form | string | Yes | |
| Country | form | string | Yes | |
| Postal | form | string | Yes | |
| EffectiveDt | form | DateTime? | Yes |
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.
POST /students/{StudentId}/forwarding_address HTTP/1.1
Host: api.oau.abodehms.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
studentId: 0,
type: String,
address: String,
address2: String,
city: String,
state: String,
country: String,
postal: String,
effectiveDt: 0001-01-01
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
result:
{
forwardingAddressId: 0,
studentId: 0,
type: Summer,
address: String,
address2: String,
city: String,
state: String,
country: String,
postal: String,
effectiveDt: 0001-01-01
},
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}