GET api/letterprocessing/history

Returns a list of letter batches.

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”.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Response Codes

Success Status:

OK (200), please see resource description below.

Failed Status(es):

Resource Description

Collection of LetterHistoryDto

Name	Description	Type
LetterBatchId	Returns the batch primary key.	integer
LetterId	Returns the id of the Letter the history is attached to.	integer
DateRun	Batch Date Run.	date
Description	Batch Description.	string
IsFeeCharged	Returns true if fee has been charged.	boolean
IsDocumentCreated	Returns true if document was created.	boolean
NoPosted	Returns the number of posted items.	integer
TotalFees	Returns the batch total fees.	decimal number
User	Returns the name of the user that executed the batch process.	string
Terminal	Returns the name of the user terminal used when batch was processed.	string

Response Formats

application/json, text/json

Sample:

[
  {
    "letterBatchId": 1,
    "letterId": 2,
    "dateRun": "2019-06-04T21:08:15.870129-04:00",
    "description": "sample string 4",
    "isFeeCharged": true,
    "isDocumentCreated": true,
    "noPosted": 7,
    "totalFees": 8.0,
    "user": "sample string 9",
    "terminal": "sample string 10"
  },
  {
    "letterBatchId": 1,
    "letterId": 2,
    "dateRun": "2019-06-04T21:08:15.870129-04:00",
    "description": "sample string 4",
    "isFeeCharged": true,
    "isDocumentCreated": true,
    "noPosted": 7,
    "totalFees": 8.0,
    "user": "sample string 9",
    "terminal": "sample string 10"
  }
]

application/xml, text/xml

Sample:

<ArrayOfLetterHistoryDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto.CRM">
  <LetterHistoryDto>
    <DateRun>2019-06-04T21:08:15.870129-04:00</DateRun>
    <Description>sample string 4</Description>
    <IsDocumentCreated>true</IsDocumentCreated>
    <IsFeeCharged>true</IsFeeCharged>
    <LetterBatchId>1</LetterBatchId>
    <LetterId>2</LetterId>
    <NoPosted>7</NoPosted>
    <Terminal>sample string 10</Terminal>
    <TotalFees>8</TotalFees>
    <User>sample string 9</User>
  </LetterHistoryDto>
  <LetterHistoryDto>
    <DateRun>2019-06-04T21:08:15.870129-04:00</DateRun>
    <Description>sample string 4</Description>
    <IsDocumentCreated>true</IsDocumentCreated>
    <IsFeeCharged>true</IsFeeCharged>
    <LetterBatchId>1</LetterBatchId>
    <LetterId>2</LetterId>
    <NoPosted>7</NoPosted>
    <Terminal>sample string 10</Terminal>
    <TotalFees>8</TotalFees>
    <User>sample string 9</User>
  </LetterHistoryDto>
</ArrayOfLetterHistoryDto>