AbodeONE

<back to all web services

FindFuturePlanSurveys

Requires Authentication
Required role:Admin
The following routes are available for this service:
All Verbs/future_plan_surveys
FuturePlanSurveysResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformList<FuturePlanSurveyDTO>No
ResponseStatusformResponseStatusNo
FuturePlanSurveyDTO Parameters:
NameParameterData TypeRequiredDescription
FuturePlanSurveyIdformintNo
HolidayLeaveIdformint?No
TermIdformint?No
SurveyTypeformstringNo
NameformstringNo
OpenDtformDateTime?No
CloseDtformDateTime?No
EarliestCheckoutDtformDateTime?No
LatestCheckoutDtformDateTime?No
StatementTextformstringNo
CompletionTextformstringNo
ReservationPeriodIdformint?No
RequireAppNextformboolNo

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

<FindFuturePlanSurveys xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel" />
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FuturePlanSurveysResponse 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>
    <FuturePlanSurveyDTO>
      <CloseDt>0001-01-01T00:00:00</CloseDt>
      <CompletionText>String</CompletionText>
      <EarliestCheckoutDt>0001-01-01T00:00:00</EarliestCheckoutDt>
      <FuturePlanSurveyId>0</FuturePlanSurveyId>
      <HolidayLeaveId>0</HolidayLeaveId>
      <LatestCheckoutDt>0001-01-01T00:00:00</LatestCheckoutDt>
      <Name>String</Name>
      <OpenDt>0001-01-01T00:00:00</OpenDt>
      <RequireAppNext>false</RequireAppNext>
      <ReservationPeriodId>0</ReservationPeriodId>
      <StatementText>String</StatementText>
      <SurveyType>String</SurveyType>
      <TermId>0</TermId>
    </FuturePlanSurveyDTO>
  </Result>
</FuturePlanSurveysResponse>