Studebaker Submetering API Services

<back to all web services

GetAllDelinquencyLetters

The following routes are available for this service:
All Verbs/getAllDelinquencyLettersGets all the delinquency letters for a specified property
Parameters:
NameParameterData TypeRequiredDescription
PropertyIdpathstringYesProperty id

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/GetAllDelinquencyLetters HTTP/1.1 
Host: gallifrey.studebakersubmetering.com 
Content-Type: application/xml
Content-Length: length

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

<GetAllDelinquencyLettersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSIAccountServices.Api.DelinquencyLetters.Responses">
  <Letters xmlns:d2p1="http://schemas.datacontract.org/2004/07/ABS.Interfaces">
    <d2p1:DelinquencyLetter>
      <d2p1:LetterText>String</d2p1:LetterText>
      <d2p1:RawData>
        <d2p1:Account>0</d2p1:Account>
        <d2p1:AdminFeeAmount>0</d2p1:AdminFeeAmount>
        <d2p1:Balance>0</d2p1:Balance>
        <d2p1:BillingStartDate>String</d2p1:BillingStartDate>
        <d2p1:Billingaddress1>String</d2p1:Billingaddress1>
        <d2p1:Billingaddress2>String</d2p1:Billingaddress2>
        <d2p1:Billingaddress3>String</d2p1:Billingaddress3>
        <d2p1:Billingcity>String</d2p1:Billingcity>
        <d2p1:Billingstate>String</d2p1:Billingstate>
        <d2p1:Billingzip>String</d2p1:Billingzip>
        <d2p1:Email>String</d2p1:Email>
        <d2p1:Fax>String</d2p1:Fax>
        <d2p1:FirstName>String</d2p1:FirstName>
        <d2p1:FullBillingAddress>String</d2p1:FullBillingAddress>
        <d2p1:HeadCount>0</d2p1:HeadCount>
        <d2p1:IsExempt>false</d2p1:IsExempt>
        <d2p1:LastName>String</d2p1:LastName>
        <d2p1:LastPaymentAmount>0</d2p1:LastPaymentAmount>
        <d2p1:LastPaymentDate>String</d2p1:LastPaymentDate>
        <d2p1:MaximumDaysLate>0</d2p1:MaximumDaysLate>
        <d2p1:MinimumDaysLate>0</d2p1:MinimumDaysLate>
        <d2p1:MoveInDate>String</d2p1:MoveInDate>
        <d2p1:MoveOutDate>String</d2p1:MoveOutDate>
        <d2p1:NamePrefix>String</d2p1:NamePrefix>
        <d2p1:NameSuffix>String</d2p1:NameSuffix>
        <d2p1:NoOfOverdueInvoices>0</d2p1:NoOfOverdueInvoices>
        <d2p1:PMSAccount>String</d2p1:PMSAccount>
        <d2p1:Phone1>String</d2p1:Phone1>
        <d2p1:Phone2>String</d2p1:Phone2>
        <d2p1:PrintBill>false</d2p1:PrintBill>
        <d2p1:ServiceAddress1>String</d2p1:ServiceAddress1>
        <d2p1:ServiceAddress2>String</d2p1:ServiceAddress2>
        <d2p1:ServiceAddress3>String</d2p1:ServiceAddress3>
        <d2p1:ServiceCity>String</d2p1:ServiceCity>
        <d2p1:ServiceState>String</d2p1:ServiceState>
        <d2p1:ServiceZip>String</d2p1:ServiceZip>
        <d2p1:TenantId>0</d2p1:TenantId>
        <d2p1:TodaysDate>String</d2p1:TodaysDate>
        <d2p1:TotalAmountOverdue>0</d2p1:TotalAmountOverdue>
      </d2p1:RawData>
      <d2p1:TenantId>0</d2p1:TenantId>
      <d2p1:TenantName>
        <d2p1:FirstName>String</d2p1:FirstName>
        <d2p1:LastName>String</d2p1:LastName>
        <d2p1:Prefix>String</d2p1:Prefix>
        <d2p1:Suffix>String</d2p1:Suffix>
      </d2p1:TenantName>
    </d2p1:DelinquencyLetter>
  </Letters>
</GetAllDelinquencyLettersResponse>