PUT api/wlcorrespondence/{wlCorrespondenceId}

Update unit type

Request Information

URI Parameters

Name	Description	Type	Additional information
wlCorrespondenceId		integer	Required

Body Parameters

UpdateWLCorrespondenceViewModel

Name	Type	Additional information
ManagementCompanySettings	Collection of UpdateLetterManagementCompanySettingViewModel	None.
DisplayName	string	Required Max length: 100
FilePrefix	string	Required Max length: 10
IsCollections	boolean	None.
DownloadFileTypeID	integer	Range: inclusive between 1 and 2147483647
Description	string	Max length: 255
ManagementCompanySettings	Collection of CreateLetterManagementCompanySettingViewModel	None.

Request Formats

application/json, text/json

Sample:

{
  "managementCompanySettings": [
    {
      "letterManagementCompanyID": 1,
      "managementCompanyId": 2,
      "letterAudienceId": 3,
      "letterDeliverySettingId": 4,
      "residentLedgerHistoryId": 5,
      "isActive": true,
      "providerId": 7
    },
    {
      "letterManagementCompanyID": 1,
      "managementCompanyId": 2,
      "letterAudienceId": 3,
      "letterDeliverySettingId": 4,
      "residentLedgerHistoryId": 5,
      "isActive": true,
      "providerId": 7
    }
  ],
  "displayName": "sample string 1",
  "filePrefix": "sample string 2",
  "isCollections": true,
  "downloadFileTypeID": 4,
  "description": "sample string 5"
}

application/xml, text/xml

Sample:

<UpdateWLCorrespondenceViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <Description>sample string 5</Description>
  <DisplayName>sample string 1</DisplayName>
  <DownloadFileTypeID>4</DownloadFileTypeID>
  <FilePrefix>sample string 2</FilePrefix>
  <IsCollections>true</IsCollections>
  <ManagementCompanySettings>
    <CreateLetterManagementCompanySettingViewModel>
      <IsActive>true</IsActive>
      <LetterAudienceId>2</LetterAudienceId>
      <LetterDeliverySettingId>3</LetterDeliverySettingId>
      <ManagementCompanyId>1</ManagementCompanyId>
      <ProviderId>6</ProviderId>
      <ResidentLedgerHistoryId>4</ResidentLedgerHistoryId>
    </CreateLetterManagementCompanySettingViewModel>
    <CreateLetterManagementCompanySettingViewModel>
      <IsActive>true</IsActive>
      <LetterAudienceId>2</LetterAudienceId>
      <LetterDeliverySettingId>3</LetterDeliverySettingId>
      <ManagementCompanyId>1</ManagementCompanyId>
      <ProviderId>6</ProviderId>
      <ResidentLedgerHistoryId>4</ResidentLedgerHistoryId>
    </CreateLetterManagementCompanySettingViewModel>
  </ManagementCompanySettings>
  <ManagementCompanySettings>
    <UpdateLetterManagementCompanySettingViewModel>
      <IsActive>true</IsActive>
      <LetterAudienceId>3</LetterAudienceId>
      <LetterDeliverySettingId>4</LetterDeliverySettingId>
      <ManagementCompanyId>2</ManagementCompanyId>
      <ProviderId>7</ProviderId>
      <ResidentLedgerHistoryId>5</ResidentLedgerHistoryId>
      <LetterManagementCompanyID>1</LetterManagementCompanyID>
    </UpdateLetterManagementCompanySettingViewModel>
    <UpdateLetterManagementCompanySettingViewModel>
      <IsActive>true</IsActive>
      <LetterAudienceId>3</LetterAudienceId>
      <LetterDeliverySettingId>4</LetterDeliverySettingId>
      <ManagementCompanyId>2</ManagementCompanyId>
      <ProviderId>7</ProviderId>
      <ResidentLedgerHistoryId>5</ResidentLedgerHistoryId>
      <LetterManagementCompanyID>1</LetterManagementCompanyID>
    </UpdateLetterManagementCompanySettingViewModel>
  </ManagementCompanySettings>
</UpdateWLCorrespondenceViewModel>

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 'UpdateWLCorrespondenceViewModel'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.