GET api/letter/search?CustomerId={CustomerId}&CUAccountId={CUAccountId}&CustomerOnly={CustomerOnly}&UserId={UserId}&ResultsLimit={ResultsLimit}

Search letters based on search parameters.

Requires Authorisation

The api request must supply authenticated token in a custom variable in the request header. The custom variable name is configured in web.config. The default name of the custom variable is “X-Fern-Token”.

Requires Api License and User Access

The api requires license and user permission for API ID, GETapi/letter/search. The user permission can be defined on User Settings screen in Abacus. For license, please contact Fern manager.

Request Information

URI Parameters

Name	Description	Type	Additional information
CustomerId		integer
CUAccountId		integer
CustomerOnly		boolean
UserId		integer
ResultsLimit	Limit the number of results found.	integer	If no value is passed then it will return all the results. If 0 is passed, then no results will be returned.

Body Parameters

None.

Response Information

Response Codes

Success Status:

OK (200), please see resource description below.

Failed Status(es):

Resource Description

Returns letters that matches the search paramenters.

Collection of LetterDto

Name	Description	Type
LetterBatchID	Letter Batch Id	integer
LetterID	Letter Id	integer
CUAccountID	Account Id	integer
CustomerID	Customer Id	integer
LetterDescription	Description of Letter	string
ValueDate	Letter Date	string
DocumentID	Document ID after archiving letter	integer
FeeCharged	Fees Charged for letter	string
CUSessionID	Session Id	integer
LettersCount	Number of Letters	integer
TotalFees	Total fees	decimal number
PostedCount	Number of posted letters	integer
TotalPosted	Total posted fee	decimal number
FailedCount	Number of failed letters	integer
TotalFailed	Total failed fee	decimal number
UserName	Name of the user who added the letter.	string
TerminalName	Name of the terminal from which the letter is added.	string
LetterType		integer
FromPortfolioID		integer
ToPortfolioID		integer

Response Formats

application/json, text/json

Sample:

[
  {
    "letterBatchID": 1,
    "letterID": 1,
    "cuAccountID": 1,
    "customerID": 1,
    "letterDescription": "sample string 1",
    "valueDate": "sample string 2",
    "documentID": 1,
    "feeCharged": "sample string 3",
    "cuSessionID": 1,
    "lettersCount": 1,
    "totalFees": 1.0,
    "postedCount": 1,
    "totalPosted": 1.0,
    "failedCount": 1,
    "totalFailed": 1.0,
    "userName": "sample string 4",
    "terminalName": "sample string 5",
    "letterType": 1,
    "fromPortfolioID": 1,
    "toPortfolioID": 1
  },
  {
    "letterBatchID": 1,
    "letterID": 1,
    "cuAccountID": 1,
    "customerID": 1,
    "letterDescription": "sample string 1",
    "valueDate": "sample string 2",
    "documentID": 1,
    "feeCharged": "sample string 3",
    "cuSessionID": 1,
    "lettersCount": 1,
    "totalFees": 1.0,
    "postedCount": 1,
    "totalPosted": 1.0,
    "failedCount": 1,
    "totalFailed": 1.0,
    "userName": "sample string 4",
    "terminalName": "sample string 5",
    "letterType": 1,
    "fromPortfolioID": 1,
    "toPortfolioID": 1
  }
]

application/xml, text/xml

Sample:

<ArrayOfLetterDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto.CU">
  <LetterDto>
    <CUAccountID>1</CUAccountID>
    <CUSessionID>1</CUSessionID>
    <CustomerID>1</CustomerID>
    <DocumentID>1</DocumentID>
    <FailedCount>1</FailedCount>
    <FeeCharged>sample string 3</FeeCharged>
    <FromPortfolioID>1</FromPortfolioID>
    <LetterBatchID>1</LetterBatchID>
    <LetterDescription>sample string 1</LetterDescription>
    <LetterID>1</LetterID>
    <LetterType>1</LetterType>
    <LettersCount>1</LettersCount>
    <PostedCount>1</PostedCount>
    <TerminalName>sample string 5</TerminalName>
    <ToPortfolioID>1</ToPortfolioID>
    <TotalFailed>1</TotalFailed>
    <TotalFees>1</TotalFees>
    <TotalPosted>1</TotalPosted>
    <UserName>sample string 4</UserName>
    <ValueDate>sample string 2</ValueDate>
  </LetterDto>
  <LetterDto>
    <CUAccountID>1</CUAccountID>
    <CUSessionID>1</CUSessionID>
    <CustomerID>1</CustomerID>
    <DocumentID>1</DocumentID>
    <FailedCount>1</FailedCount>
    <FeeCharged>sample string 3</FeeCharged>
    <FromPortfolioID>1</FromPortfolioID>
    <LetterBatchID>1</LetterBatchID>
    <LetterDescription>sample string 1</LetterDescription>
    <LetterID>1</LetterID>
    <LetterType>1</LetterType>
    <LettersCount>1</LettersCount>
    <PostedCount>1</PostedCount>
    <TerminalName>sample string 5</TerminalName>
    <ToPortfolioID>1</ToPortfolioID>
    <TotalFailed>1</TotalFailed>
    <TotalFees>1</TotalFees>
    <TotalPosted>1</TotalPosted>
    <UserName>sample string 4</UserName>
    <ValueDate>sample string 2</ValueDate>
  </LetterDto>
</ArrayOfLetterDto>