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 .xml suffix or ?format=xml

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<CreateHousingPool xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">
  <Description>String</Description>
  <MemberLimit>0</MemberLimit>
  <Name>String</Name>
  <PoolImage>AA==</PoolImage>
  <TermId>0</TermId>
</CreateHousingPool>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateHousingPoolResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Result>
    <CreatedBy>String</CreatedBy>
    <CreatedDt>0001-01-01T00:00:00</CreatedDt>
    <Description>String</Description>
    <Id>0</Id>
    <MemberLimit>0</MemberLimit>
    <ModifiedBy>String</ModifiedBy>
    <ModifiedDt>0001-01-01T00:00:00</ModifiedDt>
    <Name>String</Name>
    <PoolImage>AA==</PoolImage>
    <TermId>0</TermId>
  </Result>
</CreateHousingPoolResponse>