AbodeONE

<back to all web services

FindTerms

Requires Authentication
Required role:Admin
The following routes are available for this service:
All Verbs/terms
TermsResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformList<TermDTO>No
ResponseStatusformResponseStatusNo
TermDTO Parameters:
NameParameterData TypeRequiredDescription
TermIdformintNo
NameformstringNo
StartDtformDateTimeNo
EndDtformDateTimeNo
IsSummerformboolNo
DftResrveStartDtformDateTimeNo
DftReserveEndDtformDateTimeNo
BillingStartDtformDateTimeNo
BillingEndDtformDateTimeNo
BillingApplyDtformDateTimeNo
TermCodeformstringNo
CreatedDtformDateTimeNo
CreatedByformstringNo
ModifiedDtformDateTimeNo
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 //terms HTTP/1.1 
Host: api.lsu-staging.abodehms.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FindTerms 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

<TermsResponse 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>
    <TermDTO>
      <BillingApplyDt>0001-01-01T00:00:00</BillingApplyDt>
      <BillingEndDt>0001-01-01T00:00:00</BillingEndDt>
      <BillingStartDt>0001-01-01T00:00:00</BillingStartDt>
      <CreatedBy>String</CreatedBy>
      <CreatedDt>0001-01-01T00:00:00</CreatedDt>
      <DftReserveEndDt>0001-01-01T00:00:00</DftReserveEndDt>
      <DftResrveStartDt>0001-01-01T00:00:00</DftResrveStartDt>
      <EndDt>0001-01-01T00:00:00</EndDt>
      <IsSummer>false</IsSummer>
      <ModifiedBy>String</ModifiedBy>
      <ModifiedDt>0001-01-01T00:00:00</ModifiedDt>
      <Name>String</Name>
      <StartDt>0001-01-01T00:00:00</StartDt>
      <TermCode>String</TermCode>
      <TermId>0</TermId>
    </TermDTO>
  </Result>
</TermsResponse>