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
SchoolIdbodystringNo
StudentIdpathint?No
TypebodystringYes

Allowable Values

  • Summer
  • Home
  • School
AddressbodystringYes
Address2bodystringNo
CitybodystringYes
StatebodystringYes
CountrybodystringYes
PostalbodystringYes
PhonebodystringNo
CellPhonebodystringNo
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
PhoneformstringNo
CellPhoneformstringNo
ForwardingAddressType Enum:
Summer
Home
School

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.lsu.abodehms.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{Unable to show example output for type 'CreateForwardingAddress' 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 'CreateForwardingAddressResponse' 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'.)