AbodeONE

<back to all web services

CreateMoveAppointmentPeriod

Requires Authentication
The following routes are available for this service:
POST/move_appointment_periods
CreateMoveAppointmentPeriod Parameters:
NameParameterData TypeRequiredDescription
HousingPoolIdbodyintNo
TermIdbodyintNo
OpenDtbodyDateTimeNo
CloseDtbodyDateTimeNo
CompletionHtmlbodystringNo
BuildingIdbodyint?No
IntroHtmlbodystringNo
RequireApplicationbodyboolNo
ExcludeNewStudentsbodyboolNo
PreventSameSlotRoommatebodyboolNo
AllowEditbodyboolNo
CreateMoveAppointmentPeriodResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformMoveAppointmentPeriodDTONo
ResponseStatusformResponseStatusNo
MoveAppointmentPeriodDTO Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
HousingPoolIdformintNo
TermIdformintNo
OpenDtformDateTimeNo
CloseDtformDateTimeNo
CompletionHtmlformstringNo
BuildingIdformint?No
IntroHtmlformstringNo
RequireApplicationformboolNo
ExcludeNewStudentsformboolNo
PreventSameSlotRoommateformboolNo
AllowEditformboolNo
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 //move_appointment_periods HTTP/1.1 
Host: api.lsu.abodehms.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateMoveAppointmentPeriod xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">
  <AllowEdit>false</AllowEdit>
  <BuildingId>0</BuildingId>
  <CloseDt>0001-01-01T00:00:00</CloseDt>
  <CompletionHtml>String</CompletionHtml>
  <ExcludeNewStudents>false</ExcludeNewStudents>
  <HousingPoolId>0</HousingPoolId>
  <IntroHtml>String</IntroHtml>
  <OpenDt>0001-01-01T00:00:00</OpenDt>
  <PreventSameSlotRoommate>false</PreventSameSlotRoommate>
  <RequireApplication>false</RequireApplication>
  <TermId>0</TermId>
</CreateMoveAppointmentPeriod>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateMoveAppointmentPeriodResponse 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>
    <AllowEdit>false</AllowEdit>
    <BuildingId>0</BuildingId>
    <CloseDt>0001-01-01T00:00:00</CloseDt>
    <CompletionHtml>String</CompletionHtml>
    <CreatedBy>String</CreatedBy>
    <CreatedDt>0001-01-01T00:00:00</CreatedDt>
    <ExcludeNewStudents>false</ExcludeNewStudents>
    <HousingPoolId>0</HousingPoolId>
    <Id>0</Id>
    <IntroHtml>String</IntroHtml>
    <ModifiedBy>String</ModifiedBy>
    <ModifiedDt>0001-01-01T00:00:00</ModifiedDt>
    <OpenDt>0001-01-01T00:00:00</OpenDt>
    <PreventSameSlotRoommate>false</PreventSameSlotRoommate>
    <RequireApplication>false</RequireApplication>
    <TermId>0</TermId>
  </Result>
</CreateMoveAppointmentPeriodResponse>