Studebaker Submetering API Services

<back to all web services

GetProperty

The following routes are available for this service:
All Verbs/getPropertyGet property information.All available property names will always be provided.
Addresses for all properties will be included if IncludeAddresses=true.
Additional details for a specific property will also be provided if PropertyId is specified.

To override the Content-type in your clients 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 /xml/reply/GetProperty HTTP/1.1 
Host: gallifrey.studebakersubmetering.com 
Content-Type: application/xml
Content-Length: length

<GetProperty xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSIAccountServices.Api.Property.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>
  <IncludeAddresses>false</IncludeAddresses>
  <PropertyId>0</PropertyId>
</GetProperty>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetPropertyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSIAccountServices.Api.Property.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>
  <Properties xmlns:d2p1="http://schemas.datacontract.org/2004/07/ABS.Interfaces">
    <d2p1:PropertyInfo>
      <d2p1:Address1>String</d2p1:Address1>
      <d2p1:Address2>String</d2p1:Address2>
      <d2p1:Address3>String</d2p1:Address3>
      <d2p1:City>String</d2p1:City>
      <d2p1:Contact>
        <d2p1:CompanyName>String</d2p1:CompanyName>
        <d2p1:ContactName>String</d2p1:ContactName>
        <d2p1:Email>String</d2p1:Email>
        <d2p1:Fax>String</d2p1:Fax>
        <d2p1:FaxExtension>String</d2p1:FaxExtension>
        <d2p1:Mobile>String</d2p1:Mobile>
        <d2p1:Phone>String</d2p1:Phone>
        <d2p1:PhoneExtension>String</d2p1:PhoneExtension>
      </d2p1:Contact>
      <d2p1:IntegrationBatches>
        <d2p1:IntegrationBatch>
          <d2p1:BatchReference>String</d2p1:BatchReference>
          <d2p1:DateSent>0001-01-01T00:00:00</d2p1:DateSent>
          <d2p1:TotalCount>0</d2p1:TotalCount>
          <d2p1:TotalDollarAmount>0</d2p1:TotalDollarAmount>
        </d2p1:IntegrationBatch>
      </d2p1:IntegrationBatches>
      <d2p1:IntegrationCode>String</d2p1:IntegrationCode>
      <d2p1:IsCollectable>false</d2p1:IsCollectable>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Password>String</d2p1:Password>
      <d2p1:PropertyId>0</d2p1:PropertyId>
      <d2p1:RubsFilesAreAvailable>false</d2p1:RubsFilesAreAvailable>
      <d2p1:State>String</d2p1:State>
      <d2p1:ZipCode>String</d2p1:ZipCode>
    </d2p1:PropertyInfo>
  </Properties>
</GetPropertyResponse>