AbodeONE

<back to all web services

CreateForwardingAddress

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/students/{StudentId}/forwarding_address
POST/forwarding_addresses
CreateForwardingAddress Parameters:
NameParameterData TypeRequiredDescription
StudentIdpathintYes
TypebodystringYes

Allowable Values

  • Summer
  • Home
  • School
AddressbodystringYes
Address2bodystringNo
CitybodystringYes
StatebodystringYes
CountrybodystringYes
PostalbodystringYes
EffectiveDtbodyDateTime?No
CreateForwardingAddressResponse Parameters:
NameParameterData TypeRequiredDescription
resultformForwardingAddressDTONo
ResponseStatusformResponseStatusNo
ForwardingAddressDTO Parameters:
NameParameterData TypeRequiredDescription
ForwardingAddressIdformintYes
StudentIdformintYes
TypeformstringYes

Allowable Values

  • Summer
  • Home
  • School
AddressformstringYes
Address2formstringYes
CityformstringYes
StateformstringYes
CountryformstringYes
PostalformstringYes
EffectiveDtformDateTime?Yes

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

{"studentId":0,"type":"String","address":"String","address2":"String","city":"String","state":"String","country":"String","postal":"String","effectiveDt":"0001-01-01T00:00:00.0000000"}

HTTP/1.1 200 OK
Content-Type: text/csv
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-01T00:00:00.0000000"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}