AbodeONE

<back to all web services

CreateHousingPool

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/housing_pools
CreateHousingPool Parameters:
NameParameterData TypeRequiredDescription
NamebodystringNo
DescriptionbodystringNo
TermIdbodyint?No
MemberLimitbodyintNo
PoolImagebodybyte[]No
CreateHousingPoolResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformHousingPoolDTONo
ResponseStatusformResponseStatusNo
HousingPoolDTO Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
DescriptionformstringNo
TermIdformintNo
MemberLimitformintNo
PoolImageformbyte[]No
CreatedDtformDateTimeNo
CreatedByformstringNo
ModifiedDtformDateTime?No
ModifiedByformstringNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST //housing_pools HTTP/1.1 
Host: api.lsu-staging.abodehms.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"name":"String","description":"String","termId":0,"memberLimit":0,"poolImage":"AA=="}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"result":{"id":0,"name":"String","description":"String","termId":0,"memberLimit":0,"poolImage":"AA==","createdDt":"0001-01-01T00:00:00.0000000","createdBy":"String","modifiedDt":"0001-01-01T00:00:00.0000000","modifiedBy":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}