GET breeze/NE/ReturnMails

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of ReturnMail
NameDescriptionTypeAdditional information
AddressLine1

string

None.

AddressLine2

string

None.

City

string

None.

CreatedBy

integer

None.

CreatedDate

date

None.

MailHistoryId

integer

None.

MailRequestId

integer

None.

ModifiedBy

integer

None.

ModifiedDate

date

None.

Name

string

None.

ReceivedDate

date

None.

ReturnMailId

integer

None.

ReturnMailOutcomeId

byte

None.

ReturnMailReasonId

byte

None.

StateId

integer

None.

Zip

string

None.

Zip4

string

None.

MailHistory

MailHistory

None.

MailRequest

MailRequest

None.

ReturnMailOutcome

ReturnMailOutcome

None.

ReturnMailReason

ReturnMailReason

None.

CreatedByUser

User

None.

ModifiedByUser

User

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "$type": "NE.Entities.Server.MAIL.ReturnMail, NE.Entities.Server",
    "AddressLine1": "sample string 1",
    "AddressLine2": "sample string 2",
    "City": "sample string 3",
    "CreatedBy": 4,
    "CreatedDate": "2022-08-18T14:18:28.326+00:00",
    "MailHistoryId": 6,
    "MailRequestId": 1,
    "ModifiedBy": 1,
    "ModifiedDate": "2022-08-18T14:18:28.326+00:00",
    "Name": "sample string 7",
    "ReceivedDate": "2022-08-18T14:18:28.326+00:00",
    "ReturnMailId": 9,
    "ReturnMailOutcomeId": 64,
    "ReturnMailReasonId": 64,
    "StateId": 1,
    "Zip": "sample string 11",
    "Zip4": "sample string 12",
    "MailHistory": {
      "$id": "2",
      "$type": "NE.Entities.Server.MAIL.MailHistory, NE.Entities.Server",
      "MailHistoryId": 1,
      "MailBatchItemId": 2,
      "SequenceNumber": 3,
      "ReturnBarcode": "sample string 4",
      "BMPrintOrder": 1,
      "NCOAMatchFlagId": 64,
      "Name": "sample string 5",
      "AddressLine1": "sample string 6",
      "AddressLine2": "sample string 7",
      "City": "sample string 8",
      "StateName": "sample string 9",
      "StateId": 10,
      "Zip": "sample string 11",
      "Zip4": "sample string 12",
      "CreatedDate": "2022-08-18T14:18:28.326+00:00",
      "CreatedBy": 14,
      "StartPage": 1,
      "EndPage": 1,
      "CreatedDay": "2022-08-18T14:18:28.326+00:00",
      "StoragePath": "sample string 15",
      "MailHistoryEntities": [
        {
          "$id": "3",
          "$type": "NE.Entities.Server.MAIL.MailHistoryEntity, NE.Entities.Server",
          "EntityId": 1,
          "EntityNameId": 2,
          "MailHistoryId": 3,
          "MailTrackingId": 4,
          "MedicaidId": "sample string 5",
          "MemberName": "sample string 6",
          "PersonId": 1,
          "RowID": 7,
          "EntityName": {
            "$id": "4",
            "$type": "AHS.Server.Entities.EntityName, AHS.Server",
            "EntityNameId": 1,
            "Description": "sample string 2",
            "CodeName": "sample string 3"
          },
          "MailHistory": {
            "$ref": "2"
          },
          "MailTracking": {
            "$id": "5",
            "$type": "NE.Entities.Server.MAIL.MailTracking, NE.Entities.Server",
            "MailTrackingId": 1,
            "MailStatusId": 64,
            "MailTypeCategoryId": 64,
            "MailTypeId": 64,
            "EntityNameId": 4,
            "EntityId": 5,
            "HoldUntilDate": "2022-08-18T14:18:28.326+00:00",
            "CreatedBy": 6,
            "CreatedDate": "2022-08-18T14:18:28.326+00:00",
            "MailHistoryId": 1,
            "SentDate": "2022-08-18T14:18:28.326+00:00",
            "IsReturned": true,
            "MailCancelledReasonId": 64,
            "MailCancelledBy": 1,
            "MailCancelledDate": "2022-08-18T14:18:28.326+00:00",
            "IsCancelled": true,
            "ComplianceDate": "2022-08-18T14:18:28.326+00:00",
            "MailRequestNewMails": [
              {
                "$id": "6",
                "$type": "NE.Entities.Server.MAIL.MailRequestNewMail, NE.Entities.Server",
                "MailRequestNewMailId": 1,
                "EntityId": 2,
                "EntityNameId": 3,
                "MailTypeId": 64,
                "MailTrackingId": 1,
                "Name": "sample string 5",
                "AddressLine1": "sample string 6",
                "AddressLine2": "sample string 7",
                "City": "sample string 8",
                "StateId": 9,
                "Zip": "sample string 10",
                "Zip4": "sample string 11",
                "CreatedDate": "2022-08-18T14:18:28.326+00:00",
                "CreatedBy": 13,
                "IsCancelled": true,
                "ModifiedBy": 1,
                "ModifiedDate": "2022-08-18T14:18:28.326+00:00",
                "EntityName": {
                  "$ref": "4"
                },
                "MailTracking": {
                  "$ref": "5"
                },
                "MailType": {
                  "$id": "7",
                  "$type": "NE.Entities.Server.MAIL.MailType, NE.Entities.Server",
                  "Abbreviation": "sample string 1",
                  "CanMailRequest": true,
                  "CodeName": "sample string 3",
                  "DefaultMailLanguageId": 64,
                  "DefaultMailShopId": 64,
                  "Description": "sample string 5",
                  "DisplayText": "sample string 6",
                  "EntityNameId": 7,
                  "IdealBatchSize": 8,
                  "IsActive": true,
                  "IsApprovalRequired": true,
                  "MailTypeCategoryId": 64,
                  "MailTypeId": 64,
                  "RecordsPerLetter": 64,
                  "SetMailTypeIDParameter": true,
                  "UseBulkMailer": true,
                  "EntityName": {
                    "$ref": "4"
                  },
                  "MailTypeCategory": {
                    "$id": "8",
                    "$type": "NE.Entities.Server.MAIL.MailTypeCategory, NE.Entities.Server",
                    "MailTypeCategoryId": 64,
                    "Description": "sample string 2",
                    "CodeName": "sample string 3",
                    "MailTrackings": [
                      {
                        "$ref": "5"
                      },
                      {
                        "$ref": "5"
                      }
                    ],
                    "MailTypes": [
                      {
                        "$ref": "7"
                      },
                      {
                        "$ref": "7"
                      }
                    ]
                  }
                },
                "CreatedByUser": {
                  "$id": "9",
                  "$type": "AHS.Server.Entities.User, AHS.Server",
                  "UserId": 1,
                  "Username": "sample string 2",
                  "FirstName": "sample string 3",
                  "LastName": "sample string 4",
                  "Email": "sample string 5",
                  "IsActive": true,
                  "IsSystem": true,
                  "IsADBased": true,
                  "BusinessUnitId": 9,
                  "PermissionIds": [
                    1,
                    2
                  ],
                  "FullName": "sample string 3 sample string 4",
                  "BusinessUnit": {
                    "$id": "10",
                    "$type": "AHS.Server.Entities.BusinessUnit, AHS.Server",
                    "BusinessUnitId": 1,
                    "Description": "sample string 2",
                    "IsAHS": true
                  }
                },
                "ModifiedByUser": {
                  "$ref": "9"
                },
                "State": {
                  "$id": "11",
                  "$type": "AHS.Server.Entities.State, AHS.Server",
                  "StateId": 1,
                  "Name": "sample string 2",
                  "Abbreviation": "sample string 3"
                }
              },
              {
                "$ref": "6"
              }
            ],
            "EntityName": {
              "$ref": "4"
            },
            "MailCancelledReason": {
              "$id": "12",
              "$type": "NE.Entities.Server.MAIL.MailCancelledReason, NE.Entities.Server",
              "MailCancelledReasonId": 64,
              "Description": "sample string 2",
              "IsComplianceSatisfactory": true,
              "CodeName": "sample string 4",
              "MailTrackings": [
                {
                  "$ref": "5"
                },
                {
                  "$ref": "5"
                }
              ]
            },
            "MailHistory": {
              "$ref": "2"
            },
            "MailHistoryEntity": {
              "$ref": "3"
            },
            "MailType": {
              "$ref": "7"
            },
            "MailTypeCategory": {
              "$ref": "8"
            },
            "MailStatus": {
              "$id": "13",
              "$type": "NE.Entities.Server.MAIL.MailStatus, NE.Entities.Server",
              "MailStatusId": 64,
              "Description": "sample string 2",
              "IsFinal": true,
              "CodeName": "sample string 4",
              "IsInHistory": true
            },
            "CreatedByUser": {
              "$ref": "9"
            },
            "MailCancelledByUser": {
              "$ref": "9"
            }
          }
        },
        {
          "$ref": "3"
        }
      ],
      "MailTrackings": [
        {
          "$ref": "5"
        },
        {
          "$ref": "5"
        }
      ],
      "MailBatchItem": {
        "$id": "14",
        "$type": "NE.Entities.Server.MAIL.MailBatchItem, NE.Entities.Server",
        "ApprovedBy": 1,
        "ApprovedDate": "2022-08-18T14:18:28.326+00:00",
        "BulkMailedBy": 1,
        "BulkMailedDate": "2022-08-18T14:18:28.326+00:00",
        "EnquedDate": "2022-08-18T14:18:28.326+00:00",
        "EntityLockId": 1,
        "ExpectedPageCount": 1,
        "IsApproved": true,
        "IsPrepareComplete": true,
        "Label": "sample string 2",
        "MailBatchId": 3,
        "MailBatchItemId": 4,
        "MailFileId": 1,
        "MailInsertGroupId": 5,
        "MailLanguageId": 64,
        "MailTypeId": 64,
        "PieceCount": 8,
        "PrintedBy": 1,
        "PrintedDate": "2022-08-18T14:18:28.326+00:00",
        "RecordCount": 9,
        "SentBy": 1,
        "SentDate": "2022-08-18T14:18:28.326+00:00",
        "SplitNumber": 64,
        "WasBMBypassed": true,
        "MinComplianceDate": "2022-08-18T14:18:28.326+00:00",
        "MaxComplianceDate": "2022-08-18T14:18:28.326+00:00",
        "MailBatch": {
          "$id": "15",
          "$type": "NE.Entities.Server.MAIL.MailBatch, NE.Entities.Server",
          "MailBatchId": 1,
          "CreatedBy": 2,
          "CreatedDate": "2022-08-18T14:18:28.326+00:00",
          "MailBatchItems": [
            {
              "$ref": "14"
            },
            {
              "$ref": "14"
            }
          ],
          "MailFiles": [
            {
              "$id": "16",
              "$type": "NE.Entities.Server.MAIL.MailFile, NE.Entities.Server",
              "MailFileId": 1,
              "MailBatchId": 2,
              "MailTypeId": 64,
              "MailLanguageId": 64,
              "MailInsertGroupId": 1,
              "Filepath": "sample string 5",
              "LetterCount": 6,
              "RecordCount": 7,
              "CreatedBy": 8,
              "CreatedDate": "2022-08-18T14:18:28.326+00:00",
              "PrintedBy": 1,
              "PrintedDate": "2022-08-18T14:18:28.326+00:00",
              "PdfPageCount": 1,
              "RenderJobID": 1,
              "RenderedDate": "2022-08-18T14:18:28.326+00:00",
              "IsJobFailed": true,
              "IsRendered": true,
              "IsPending": true,
              "MailBatchItems": [
                {
                  "$ref": "14"
                },
                {
                  "$ref": "14"
                }
              ],
              "MailBatch": {
                "$ref": "15"
              },
              "MailInsertGroup": {
                "$id": "17",
                "$type": "NE.Entities.Server.MAIL.MailInsertGroup, NE.Entities.Server",
                "MailInsertGroupId": 1,
                "CodeName": "sample string 2",
                "Description": "sample string 3",
                "Code": "sample string 4",
                "MailLanguageId": 64,
                "MailInsertGroupCategoryId": 64,
                "MailInsertGroupCategory": {
                  "$id": "18",
                  "$type": "NE.Entities.Server.MAIL.MailInsertGroupCategory, NE.Entities.Server",
                  "MailInsertGroupCategoryId": 64,
                  "CodeName": "sample string 2",
                  "Description": "sample string 3",
                  "MailInsertGroups": [
                    {
                      "$ref": "17"
                    },
                    {
                      "$ref": "17"
                    }
                  ]
                },
                "MailLanguage": {
                  "$id": "19",
                  "$type": "NE.Entities.Server.MAIL.MailLanguage, NE.Entities.Server",
                  "MailLanguageId": 64,
                  "Description": "sample string 2",
                  "Code": "sample string 3",
                  "CodeName": "sample string 4",
                  "DisplayInContentEditor": true,
                  "MailInsertGroups": [
                    {
                      "$ref": "17"
                    },
                    {
                      "$ref": "17"
                    }
                  ]
                }
              },
              "MailLanguage": {
                "$ref": "19"
              },
              "MailType": {
                "$ref": "7"
              },
              "CreatedByUser": {
                "$ref": "9"
              },
              "PrintedByUser": {
                "$ref": "9"
              }
            },
            {
              "$ref": "16"
            }
          ],
          "CreatedByUser": {
            "$ref": "9"
          }
        },
        "MailFile": {
          "$ref": "16"
        },
        "MailInsertGroup": {
          "$ref": "17"
        },
        "MailLanguage": {
          "$ref": "19"
        },
        "MailType": {
          "$ref": "7"
        },
        "BulkMailedByUser": {
          "$ref": "9"
        },
        "PrintedByUser": {
          "$ref": "9"
        },
        "SentByUser": {
          "$ref": "9"
        },
        "ApprovedByUser": {
          "$ref": "9"
        }
      },
      "CreatedByUser": {
        "$ref": "9"
      },
      "TempFilePath": "sample string 16"
    },
    "MailRequest": {
      "$id": "20",
      "$type": "NE.Entities.Server.MAIL.MailRequest, NE.Entities.Server",
      "MailRequestId": 1,
      "MailTypeId": 64,
      "MailHistoryId": 3,
      "Name": "sample string 4",
      "AddressLine1": "sample string 5",
      "AddressLine2": "sample string 6",
      "City": "sample string 7",
      "StateId": 8,
      "Zip": "sample string 9",
      "Zip4": "sample string 10",
      "CreatedBy": 11,
      "CreatedDate": "2022-08-18T14:18:28.326+00:00",
      "IsCancelled": true,
      "ModifiedBy": 1,
      "ModifiedDate": "2022-08-18T14:18:28.326+00:00",
      "MailType": {
        "$ref": "7"
      },
      "MailHistory": {
        "$ref": "2"
      },
      "CreatedByUser": {
        "$ref": "9"
      }
    },
    "ReturnMailOutcome": {
      "$id": "21",
      "$type": "NE.Entities.Server.MAIL.ReturnMailOutcome, NE.Entities.Server",
      "CodeName": "sample string 1",
      "Description": "sample string 2",
      "ReturnMailOutcomeId": 64
    },
    "ReturnMailReason": {
      "$id": "22",
      "$type": "NE.Entities.Server.MAIL.ReturnMailReason, NE.Entities.Server",
      "CodeName": "sample string 1",
      "Description": "sample string 2",
      "IsNewAddressAvailable": true,
      "IsResendable": true,
      "IsVisibleInUI": true,
      "ReturnMailReasonId": 64
    },
    "CreatedByUser": {
      "$ref": "9"
    },
    "ModifiedByUser": {
      "$ref": "9"
    }
  },
  {
    "$ref": "1"
  }
]