POST api/letters/run

Runs the Letters process

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Callback		HttpCallbackViewModel	None.
Items		Collection of ResidentLetterActionItemPayloadIViewModel	None.
ExecutionMode		MicroServiceModeEnum	None.
ExecutionBatchId		integer	None.
RunFor		date	None.
ResidentIds	Gets or sets resident ids to be processed. If this property is null then all eligible residents are processed. Optional property - USE ONLY FOR DEV TROUBLESHOOTING !!!	Collection of integer	None.
BuildingStageIds	Gets or sets BuildingStage ids to be processed. If this property is null then all eligible stages are processed.	Collection of integer	None.
EmailReportRecepient	Gets or sets a single email address to be used for engine overall report. Optional property - USE ONLY FOR DEV TROUBLESHOOTING !!!	string	None.

Request Formats

application/json, text/json

Sample:

{
  "callback": {
    "apiBaseUrl": "sample string 1",
    "headers": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "callback": "sample string 2",
    "callbackType": 1,
    "params": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    }
  },
  "items": [
    {
      "letter": 1,
      "deliveryMethod": 2,
      "minBalance": 3.0,
      "totalBalance": 1.0,
      "chargeBalance": 1.0,
      "asOfDate": "2024-10-14T08:21:37.5671192-04:00",
      "isChargePostingOnRunDate": true,
      "calendarDay": 6,
      "graceDays": 7,
      "residentId": 8,
      "subAccountChargeCodeIds": [
        1,
        2
      ],
      "stageDay": 9,
      "referenceId": "sample string 10"
    },
    {
      "letter": 1,
      "deliveryMethod": 2,
      "minBalance": 3.0,
      "totalBalance": 1.0,
      "chargeBalance": 1.0,
      "asOfDate": "2024-10-14T08:21:37.5671192-04:00",
      "isChargePostingOnRunDate": true,
      "calendarDay": 6,
      "graceDays": 7,
      "residentId": 8,
      "subAccountChargeCodeIds": [
        1,
        2
      ],
      "stageDay": 9,
      "referenceId": "sample string 10"
    }
  ],
  "executionMode": 1,
  "executionBatchId": 1,
  "runFor": "2024-10-14T08:21:37.5671192-04:00",
  "residentIds": [
    1,
    2
  ],
  "buildingStageIds": [
    1,
    2
  ],
  "emailReportRecepient": "sample string 3"
}

application/xml, text/xml

Sample:

<ResidentLetterPayloadViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Collections.Microservice">
  <BuildingStageIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.Host.Shared.ViewModels.Collections.Execution">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </BuildingStageIds>
  <EmailReportRecepient xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.Host.Shared.ViewModels.Collections.Execution">sample string 3</EmailReportRecepient>
  <ExecutionBatchId xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.Host.Shared.ViewModels.Collections.Execution">1</ExecutionBatchId>
  <ExecutionMode xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.Host.Shared.ViewModels.Collections.Execution">PushAndCallback</ExecutionMode>
  <ResidentIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.Host.Shared.ViewModels.Collections.Execution">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ResidentIds>
  <RunFor xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.Host.Shared.ViewModels.Collections.Execution">2024-10-14T08:21:37.5671192-04:00</RunFor>
  <Callback xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.Host.Shared.ViewModels.Collections.Execution">
    <Callback>sample string 2</Callback>
    <CallbackType>API</CallbackType>
    <Params xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Params>
    <ApiBaseUrl>sample string 1</ApiBaseUrl>
    <Headers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Headers>
  </Callback>
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Collections.Execution" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.Host.Shared.ViewModels.Collections.Execution">
    <d2p1:ResidentLetterActionItemPayloadIViewModel>
      <ReferenceId>sample string 10</ReferenceId>
      <ResidentId>8</ResidentId>
      <StageDay>9</StageDay>
      <SubAccountChargeCodeIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </SubAccountChargeCodeIds>
      <AsOfDate>2024-10-14T08:21:37.5671192-04:00</AsOfDate>
      <CalendarDay>6</CalendarDay>
      <ChargeBalance>1</ChargeBalance>
      <GraceDays>7</GraceDays>
      <IsChargePostingOnRunDate>true</IsChargePostingOnRunDate>
      <TotalBalance>1</TotalBalance>
      <d2p1:DeliveryMethod>2</d2p1:DeliveryMethod>
      <d2p1:Letter>1</d2p1:Letter>
      <d2p1:MinBalance>3</d2p1:MinBalance>
    </d2p1:ResidentLetterActionItemPayloadIViewModel>
    <d2p1:ResidentLetterActionItemPayloadIViewModel>
      <ReferenceId>sample string 10</ReferenceId>
      <ResidentId>8</ResidentId>
      <StageDay>9</StageDay>
      <SubAccountChargeCodeIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </SubAccountChargeCodeIds>
      <AsOfDate>2024-10-14T08:21:37.5671192-04:00</AsOfDate>
      <CalendarDay>6</CalendarDay>
      <ChargeBalance>1</ChargeBalance>
      <GraceDays>7</GraceDays>
      <IsChargePostingOnRunDate>true</IsChargePostingOnRunDate>
      <TotalBalance>1</TotalBalance>
      <d2p1:DeliveryMethod>2</d2p1:DeliveryMethod>
      <d2p1:Letter>1</d2p1:Letter>
      <d2p1:MinBalance>3</d2p1:MinBalance>
    </d2p1:ResidentLetterActionItemPayloadIViewModel>
  </Items>
</ResidentLetterPayloadViewModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ResidentLetterPayloadViewModel'.

Response Information

Resource Description

Collection of ActionResponseViewModel

Name	Type	Additional information
ReferenceId	string	None.
ProcessStatusId	ProcessStatusEnum	None.
Messages	Collection of string	None.
HttpCode	HttpStatusCode	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "referenceId": "sample string 1",
    "processStatusId": 2,
    "messages": [
      "sample string 1",
      "sample string 2"
    ],
    "httpCode": 100
  },
  {
    "referenceId": "sample string 1",
    "processStatusId": 2,
    "messages": [
      "sample string 1",
      "sample string 2"
    ],
    "httpCode": 100
  }
]

application/xml, text/xml

Sample:

<ArrayOfActionResponseViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.Host.Shared.ViewModels.Collections.Execution">
  <ActionResponseViewModel>
    <HttpCode>Continue</HttpCode>
    <Messages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Messages>
    <ProcessStatusId>Queued</ProcessStatusId>
    <ReferenceId>sample string 1</ReferenceId>
  </ActionResponseViewModel>
  <ActionResponseViewModel>
    <HttpCode>Continue</HttpCode>
    <Messages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Messages>
    <ProcessStatusId>Queued</ProcessStatusId>
    <ReferenceId>sample string 1</ReferenceId>
  </ActionResponseViewModel>
</ArrayOfActionResponseViewModel>