AbodeONE

<back to all web services

UpdateHousingPool

Requires Authentication
Required role:Admin
The following routes are available for this service:
PUT/housing_pools/{Id}
UpdateHousingPool Parameters:
NameParameterData TypeRequiredDescription
IdpathintNo
NamebodystringNo
DescriptionbodystringNo
TermIdbodyintNo
MemberLimitbodyintNo
PoolImagebodybyte[]No
UpdateHousingPoolResponse 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 .jsv suffix or ?format=jsv

HTTP + JSV

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

PUT //housing_pools/{Id} HTTP/1.1 
Host: api.lsu.abodehms.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	name: String,
	description: String,
	termId: 0,
	memberLimit: 0,
	poolImage: AA==
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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