AbodeONE

CloseHousingTerm

The following routes are available for this service:
All Verbs	/residents/close_housing_term

**CloseHousingTerm** Parameters:
Name	Parameter	Data Type	Required
TermId	query	int	No
StudentId	query	int?	No
BuildingIds	query	ArrayOfInt	No
RoomRatePeriod	query	string	No

**HousingAssignmentsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Result	form	List<HousingAssignmentDTO>	No
ResponseStatus	form	ResponseStatus	No

**HousingAssignmentDTO** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
PersonId	form	string	No
StartDate	form	string	No
EndDate	form	string	No
CurrentStatus	form	string	No
CurrentStatusDate	form	string	No
Room	form	string	No
Building	form	string	No
TermId	form	string	No
RoomRateTable	form	string	No
RoomRatePeriod	form	string	No
OverrideRate	form	string	No
OverrideRateReason	form	string	No
OverrideChargeCode	form	string	No
OverrideReceivableType	form	string	No
OverrideRefundFormula	form	string	No
Contract	form	string	No
Comments	form	string	No
ResidentStaffIndicator	form	string	No
ResidentId	form	int?	No
ReservationId	form	int?	No
StudentId	form	int	No
SchoolId	form	string	No
AbodeTermId	form	int?	No
AbodeUsername	form	string	No

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 //residents/close_housing_term HTTP/1.1 
Host: api.lsu-staging.abodehms.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CloseHousingTerm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">
  <BuildingIds xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:Int>0</d2p1:Int>
  </BuildingIds>
  <RoomRatePeriod>String</RoomRatePeriod>
  <StudentId>0</StudentId>
  <TermId>0</TermId>
</CloseHousingTerm>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<HousingAssignmentsResponse 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>
    <HousingAssignmentDTO>
      <AbodeTermId>0</AbodeTermId>
      <AbodeUsername>String</AbodeUsername>
      <Building>String</Building>
      <Comments>String</Comments>
      <Contract>String</Contract>
      <CurrentStatus>String</CurrentStatus>
      <CurrentStatusDate>String</CurrentStatusDate>
      <EndDate>String</EndDate>
      <Id>String</Id>
      <OverrideChargeCode>String</OverrideChargeCode>
      <OverrideRate>String</OverrideRate>
      <OverrideRateReason>String</OverrideRateReason>
      <OverrideReceivableType>String</OverrideReceivableType>
      <OverrideRefundFormula>String</OverrideRefundFormula>
      <PersonId>String</PersonId>
      <ReservationId>0</ReservationId>
      <ResidentId>0</ResidentId>
      <ResidentStaffIndicator>String</ResidentStaffIndicator>
      <Room>String</Room>
      <RoomRatePeriod>String</RoomRatePeriod>
      <RoomRateTable>String</RoomRateTable>
      <SchoolId>String</SchoolId>
      <StartDate>String</StartDate>
      <StudentId>0</StudentId>
      <TermId>String</TermId>
    </HousingAssignmentDTO>
  </Result>
</HousingAssignmentsResponse>