Studebaker Submetering API Services

<back to all web services

GetOccupiedBuildingsAndUnits

Get the occupied building/units for a property

To override the Content-type in your clients HTTP Accept Header, append the .soap12 suffix or ?format=soap12

HTTP + SOAP12

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /soap12 HTTP/1.1 
Host: gallifrey.studebakersubmetering.com 
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
    <soap12:Body>

<GetOccupiedBuildingsAndUnits xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSIAccountServices.Api.BuildingsAndUnits.Requests">
  <RequestIpAddress xmlns="http://schemas.datacontract.org/2004/07/SSIAccountServices.Api.Common.Requests">String</RequestIpAddress>
  <Token xmlns="http://schemas.datacontract.org/2004/07/SSIAccountServices.Api.Common.Requests">String</Token>
  <IncludePreviousOccupantsWithBalances>false</IncludePreviousOccupantsWithBalances>
  <PropertyId>0</PropertyId>
</GetOccupiedBuildingsAndUnits>

    </soap12:Body>
</soap12:Envelope>

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

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
    <soap12:Body>

<GetOccupiedBuildingsAndUnitsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSIAccountServices.Api.BuildingsAndUnits.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/SSIAccountServices.Api">
    <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:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
  <Buildings xmlns:d2p1="http://schemas.datacontract.org/2004/07/ABS.Interfaces">
    <d2p1:BuildingInfo>
      <d2p1:BuildingCode>String</d2p1:BuildingCode>
      <d2p1:BuildingId>0</d2p1:BuildingId>
      <d2p1:Units>
        <d2p1:UnitInfo>
          <d2p1:Occupant>
            <d2p1:AccountId>0</d2p1:AccountId>
            <d2p1:Balance>0</d2p1:Balance>
            <d2p1:CanPayOnline>false</d2p1:CanPayOnline>
            <d2p1:Email>String</d2p1:Email>
            <d2p1:EmailBeingChecked>String</d2p1:EmailBeingChecked>
            <d2p1:EmailCheckAuth>String</d2p1:EmailCheckAuth>
            <d2p1:FirstName>String</d2p1:FirstName>
            <d2p1:GoPaperlessEmail>String</d2p1:GoPaperlessEmail>
            <d2p1:GoPaperlessVerificationPending>false</d2p1:GoPaperlessVerificationPending>
            <d2p1:IsExempt>false</d2p1:IsExempt>
            <d2p1:IsWebAccessEnabled>false</d2p1:IsWebAccessEnabled>
            <d2p1:LastInvoiceUrl>String</d2p1:LastInvoiceUrl>
            <d2p1:LastName>String</d2p1:LastName>
            <d2p1:MailingAddress>
              <d2p1:City>String</d2p1:City>
              <d2p1:Line1>String</d2p1:Line1>
              <d2p1:Line2>String</d2p1:Line2>
              <d2p1:Line3>String</d2p1:Line3>
              <d2p1:State>String</d2p1:State>
              <d2p1:ZipCode>String</d2p1:ZipCode>
            </d2p1:MailingAddress>
            <d2p1:Mobile>String</d2p1:Mobile>
            <d2p1:MoveInDate>0001-01-01T00:00:00</d2p1:MoveInDate>
            <d2p1:MoveOutDate>0001-01-01T00:00:00</d2p1:MoveOutDate>
            <d2p1:NamePrefix>String</d2p1:NamePrefix>
            <d2p1:NameSuffix>String</d2p1:NameSuffix>
            <d2p1:NumberOfOccupants>0</d2p1:NumberOfOccupants>
            <d2p1:NumberOfOccupantsCanBeSet>false</d2p1:NumberOfOccupantsCanBeSet>
            <d2p1:Password>String</d2p1:Password>
            <d2p1:PasswordHash>String</d2p1:PasswordHash>
            <d2p1:PayNowUrl>String</d2p1:PayNowUrl>
            <d2p1:Phone>String</d2p1:Phone>
            <d2p1:PhoneExt>String</d2p1:PhoneExt>
            <d2p1:PmsAccount>String</d2p1:PmsAccount>
            <d2p1:PropertyId>0</d2p1:PropertyId>
            <d2p1:PropertyIsCollected>false</d2p1:PropertyIsCollected>
            <d2p1:PropertyName>String</d2p1:PropertyName>
            <d2p1:PropertyUsesIntegration>false</d2p1:PropertyUsesIntegration>
            <d2p1:ReceiveServiceAlertEmail>false</d2p1:ReceiveServiceAlertEmail>
            <d2p1:ReceiveServiceAlertSms>false</d2p1:ReceiveServiceAlertSms>
            <d2p1:ReceiveServiceAlertVoice>false</d2p1:ReceiveServiceAlertVoice>
            <d2p1:ResetPasswordAuth>String</d2p1:ResetPasswordAuth>
            <d2p1:ResetPasswordRequested>0001-01-01T00:00:00</d2p1:ResetPasswordRequested>
            <d2p1:ShowGoPaperless>false</d2p1:ShowGoPaperless>
            <d2p1:TenantDetailsReadOnly>false</d2p1:TenantDetailsReadOnly>
            <d2p1:UpdatePassword>false</d2p1:UpdatePassword>
          </d2p1:Occupant>
          <d2p1:PreviousOccupants>
            <d2p1:TenantInfo>
              <d2p1:AccountId>0</d2p1:AccountId>
              <d2p1:Balance>0</d2p1:Balance>
              <d2p1:CanPayOnline>false</d2p1:CanPayOnline>
              <d2p1:Email>String</d2p1:Email>
              <d2p1:EmailBeingChecked>String</d2p1:EmailBeingChecked>
              <d2p1:EmailCheckAuth>String</d2p1:EmailCheckAuth>
              <d2p1:FirstName>String</d2p1:FirstName>
              <d2p1:GoPaperlessEmail>String</d2p1:GoPaperlessEmail>
              <d2p1:GoPaperlessVerificationPending>false</d2p1:GoPaperlessVerificationPending>
              <d2p1:IsExempt>false</d2p1:IsExempt>
              <d2p1:IsWebAccessEnabled>false</d2p1:IsWebAccessEnabled>
              <d2p1:LastInvoiceUrl>String</d2p1:LastInvoiceUrl>
              <d2p1:LastName>String</d2p1:LastName>
              <d2p1:MailingAddress>
                <d2p1:City>String</d2p1:City>
                <d2p1:Line1>String</d2p1:Line1>
                <d2p1:Line2>String</d2p1:Line2>
                <d2p1:Line3>String</d2p1:Line3>
                <d2p1:State>String</d2p1:State>
                <d2p1:ZipCode>String</d2p1:ZipCode>
              </d2p1:MailingAddress>
              <d2p1:Mobile>String</d2p1:Mobile>
              <d2p1:MoveInDate>0001-01-01T00:00:00</d2p1:MoveInDate>
              <d2p1:MoveOutDate>0001-01-01T00:00:00</d2p1:MoveOutDate>
              <d2p1:NamePrefix>String</d2p1:NamePrefix>
              <d2p1:NameSuffix>String</d2p1:NameSuffix>
              <d2p1:NumberOfOccupants>0</d2p1:NumberOfOccupants>
              <d2p1:NumberOfOccupantsCanBeSet>false</d2p1:NumberOfOccupantsCanBeSet>
              <d2p1:Password>String</d2p1:Password>
              <d2p1:PasswordHash>String</d2p1:PasswordHash>
              <d2p1:PayNowUrl>String</d2p1:PayNowUrl>
              <d2p1:Phone>String</d2p1:Phone>
              <d2p1:PhoneExt>String</d2p1:PhoneExt>
              <d2p1:PmsAccount>String</d2p1:PmsAccount>
              <d2p1:PropertyId>0</d2p1:PropertyId>
              <d2p1:PropertyIsCollected>false</d2p1:PropertyIsCollected>
              <d2p1:PropertyName>String</d2p1:PropertyName>
              <d2p1:PropertyUsesIntegration>false</d2p1:PropertyUsesIntegration>
              <d2p1:ReceiveServiceAlertEmail>false</d2p1:ReceiveServiceAlertEmail>
              <d2p1:ReceiveServiceAlertSms>false</d2p1:ReceiveServiceAlertSms>
              <d2p1:ReceiveServiceAlertVoice>false</d2p1:ReceiveServiceAlertVoice>
              <d2p1:ResetPasswordAuth>String</d2p1:ResetPasswordAuth>
              <d2p1:ResetPasswordRequested>0001-01-01T00:00:00</d2p1:ResetPasswordRequested>
              <d2p1:ShowGoPaperless>false</d2p1:ShowGoPaperless>
              <d2p1:TenantDetailsReadOnly>false</d2p1:TenantDetailsReadOnly>
              <d2p1:UpdatePassword>false</d2p1:UpdatePassword>
            </d2p1:TenantInfo>
          </d2p1:PreviousOccupants>
          <d2p1:UnitId>0</d2p1:UnitId>
          <d2p1:UnitNumber>String</d2p1:UnitNumber>
        </d2p1:UnitInfo>
      </d2p1:Units>
    </d2p1:BuildingInfo>
  </Buildings>
</GetOccupiedBuildingsAndUnitsResponse>

    </soap12:Body>
</soap12:Envelope>