GET api/letterprocessing/schedules

Fetch all active letter schedules.

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

LetterScheduleDto
NameDescriptionTypeAdditional information
LetterId

Set or get the letter ID.

 integer
LetterScheduleId

Set or gets the letter schedule ID.

 integer
Name

Set or get the schedule name.

 string
Description

Set or get the schedule description.

 string
Frequency

Set or gets the schedule frequency.

 string
Product

Set or gets the schedule product.

 string
NextValueDate

Set or gets schedule due date.

 date
Active

Set or get schedule active status.

 boolean

Response Formats

application/json, text/json

Sample: 
{
  "letterId": 1,
  "letterScheduleId": 2,
  "name": "sample string 3",
  "description": "sample string 4",
  "frequency": "sample string 5",
  "product": "sample string 6",
  "nextValueDate": "2019-06-04T21:08:15.9901301-04:00",
  "active": true
}

application/xml, text/xml

Sample: 
<LetterScheduleDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto.CRM">
  <Active>true</Active>
  <Description>sample string 4</Description>
  <Frequency>sample string 5</Frequency>
  <LetterId>1</LetterId>
  <LetterScheduleId>2</LetterScheduleId>
  <Name>sample string 3</Name>
  <NextValueDate>2019-06-04T21:08:15.9901301-04:00</NextValueDate>
  <Product>sample string 6</Product>
</LetterScheduleDto>