GET api/companies/{managementCompanyId}/wlcorrespondence

Request Information

URI Parameters

Name	Description	Type	Additional information
managementCompanyId		integer	Required

Body Parameters

None.

Response Information

Resource Description

Collection of WLCorrespondenceViewModel

Name	Type	Additional information
CorrespondenceID	integer	Range: inclusive between 1 and 2147483647
IsActive	boolean	None.
ManagementCompanySettings	Collection of LetterManagementCompanySettingViewModel	None.
DownloadFileType	DownloadFileTypeViewModel	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.

Response Formats

application/json, text/json

Sample:

[
  {
    "correspondenceID": 1,
    "isActive": true,
    "managementCompanySettings": [
      {
        "letterManagementCompanyID": 1,
        "correspondenceID": 2,
        "delivery": {
          "deliverySettingID": 1,
          "name": "sample string 2",
          "isUnitBillingAddress": true,
          "isUnitAddress": true
        },
        "audience": {
          "audienceID": 1,
          "name": "sample string 2"
        },
        "residentLedgerHistory": {
          "id": 1,
          "description": "sample string 2"
        },
        "auditTrailUserID": 3,
        "providerId": 4,
        "managementCompanyId": 5,
        "letterAudienceId": 6,
        "letterDeliverySettingId": 7,
        "residentLedgerHistoryId": 8,
        "isActive": true
      },
      {
        "letterManagementCompanyID": 1,
        "correspondenceID": 2,
        "delivery": {
          "deliverySettingID": 1,
          "name": "sample string 2",
          "isUnitBillingAddress": true,
          "isUnitAddress": true
        },
        "audience": {
          "audienceID": 1,
          "name": "sample string 2"
        },
        "residentLedgerHistory": {
          "id": 1,
          "description": "sample string 2"
        },
        "auditTrailUserID": 3,
        "providerId": 4,
        "managementCompanyId": 5,
        "letterAudienceId": 6,
        "letterDeliverySettingId": 7,
        "residentLedgerHistoryId": 8,
        "isActive": true
      }
    ],
    "downloadFileType": {
      "downloadFileTypeId": 1,
      "downloadFileTypeName": "sample string 2",
      "groupId": 1,
      "typePath": "sample string 3",
      "isInternal": true,
      "createdOn": "2024-10-14T08:21:08.2313721-04:00",
      "searchPattern": "sample string 6"
    },
    "displayName": "sample string 3",
    "filePrefix": "sample string 4",
    "isCollections": true,
    "downloadFileTypeID": 6,
    "description": "sample string 7"
  },
  {
    "correspondenceID": 1,
    "isActive": true,
    "managementCompanySettings": [
      {
        "letterManagementCompanyID": 1,
        "correspondenceID": 2,
        "delivery": {
          "deliverySettingID": 1,
          "name": "sample string 2",
          "isUnitBillingAddress": true,
          "isUnitAddress": true
        },
        "audience": {
          "audienceID": 1,
          "name": "sample string 2"
        },
        "residentLedgerHistory": {
          "id": 1,
          "description": "sample string 2"
        },
        "auditTrailUserID": 3,
        "providerId": 4,
        "managementCompanyId": 5,
        "letterAudienceId": 6,
        "letterDeliverySettingId": 7,
        "residentLedgerHistoryId": 8,
        "isActive": true
      },
      {
        "letterManagementCompanyID": 1,
        "correspondenceID": 2,
        "delivery": {
          "deliverySettingID": 1,
          "name": "sample string 2",
          "isUnitBillingAddress": true,
          "isUnitAddress": true
        },
        "audience": {
          "audienceID": 1,
          "name": "sample string 2"
        },
        "residentLedgerHistory": {
          "id": 1,
          "description": "sample string 2"
        },
        "auditTrailUserID": 3,
        "providerId": 4,
        "managementCompanyId": 5,
        "letterAudienceId": 6,
        "letterDeliverySettingId": 7,
        "residentLedgerHistoryId": 8,
        "isActive": true
      }
    ],
    "downloadFileType": {
      "downloadFileTypeId": 1,
      "downloadFileTypeName": "sample string 2",
      "groupId": 1,
      "typePath": "sample string 3",
      "isInternal": true,
      "createdOn": "2024-10-14T08:21:08.2313721-04:00",
      "searchPattern": "sample string 6"
    },
    "displayName": "sample string 3",
    "filePrefix": "sample string 4",
    "isCollections": true,
    "downloadFileTypeID": 6,
    "description": "sample string 7"
  }
]

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Type 'System.Collections.Generic.List`1[[CamAcctApi.ViewModels.CreateLetterManagementCompanySettingViewModel, CamAcctApi, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' with data contract name 'ArrayOfCreateLetterManagementCompanySettingViewModel:http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels' is not expected. Consider using a DataContractResolver if you are using DataContractSerializer or add any types not known statically to the list of known types - for example, by using the KnownTypeAttribute attribute or by adding them to the list of known types passed to the serializer.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Type 'System.Collections.Generic.List`1[[CamAcctApi.ViewModels.CreateLetterManagementCompanySettingViewModel, CamAcctApi, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' with data contract name 'ArrayOfCreateLetterManagementCompanySettingViewModel:http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels' is not expected. Consider using a DataContractResolver if you are using DataContractSerializer or add any types not known statically to the list of known types - for example, by using the KnownTypeAttribute attribute or by adding them to the list of known types passed to the serializer.