GET api/LetterDebtor/GetSummaryByPrincipalID?principalId={principalId}&showInactive={showInactive}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
principalId

integer

Required

showInactive

boolean

Required

Body Parameters

None.

Response Information

Resource Description

LetterSummaryListVM
NameDescriptionTypeAdditional information
LetterSummaryList

Collection of LetterSummaryModel

None.

Response

IResponse

None.

Response Formats

application/json, text/json

Sample:
{
  "LetterSummaryList": [
    {
      "LetterID": 1,
      "Description": "sample string 1",
      "CreateTS": "2025-09-02T23:08:49.8004848+00:00",
      "PrintStatus": "sample string 2"
    },
    {
      "LetterID": 1,
      "Description": "sample string 1",
      "CreateTS": "2025-09-02T23:08:49.8004848+00:00",
      "PrintStatus": "sample string 2"
    }
  ],
  "Response": null
}

application/xml, text/xml

Sample:
<LetterSummaryListVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels.Letter">
  <Response i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels" />
  <LetterSummaryList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Letter">
    <d2p1:LetterSummaryModel>
      <d2p1:CreateTS>2025-09-02T23:08:49.8004848+00:00</d2p1:CreateTS>
      <d2p1:Description>sample string 1</d2p1:Description>
      <d2p1:LetterID>1</d2p1:LetterID>
      <d2p1:PrintStatus>sample string 2</d2p1:PrintStatus>
    </d2p1:LetterSummaryModel>
    <d2p1:LetterSummaryModel>
      <d2p1:CreateTS>2025-09-02T23:08:49.8004848+00:00</d2p1:CreateTS>
      <d2p1:Description>sample string 1</d2p1:Description>
      <d2p1:LetterID>1</d2p1:LetterID>
      <d2p1:PrintStatus>sample string 2</d2p1:PrintStatus>
    </d2p1:LetterSummaryModel>
  </LetterSummaryList>
</LetterSummaryListVM>