GET api/NE/MailRequestNewMails

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of MailRequestNewMail
NameDescriptionTypeAdditional information
MailRequestNewMailId

integer

None.

EntityId

integer

None.

EntityNameId

integer

None.

MailTypeId

byte

None.

MailTrackingId

integer

None.

Name

string

None.

AddressLine1

string

None.

AddressLine2

string

None.

City

string

None.

StateId

integer

None.

Zip

string

None.

Zip4

string

None.

CreatedDate

date

None.

CreatedBy

integer

None.

IsCancelled

boolean

None.

ModifiedBy

integer

None.

ModifiedDate

date

None.

EntityName

EntityName

None.

MailTracking

MailTracking

None.

MailType

MailType

None.

CreatedByUser

User

None.

ModifiedByUser

User

None.

State

State

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "$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-13T21:31:08.515+00:00",
    "CreatedBy": 13,
    "IsCancelled": true,
    "ModifiedBy": 1,
    "ModifiedDate": "2022-08-13T21:31:08.515+00:00",
    "EntityName": {
      "$id": "2",
      "$type": "AHS.Server.Entities.EntityName, AHS.Server",
      "EntityNameId": 1,
      "Description": "sample string 2",
      "CodeName": "sample string 3"
    },
    "MailTracking": {
      "$id": "3",
      "$type": "NE.Entities.Server.MAIL.MailTracking, NE.Entities.Server",
      "MailTrackingId": 1,
      "MailStatusId": 64,
      "MailTypeCategoryId": 64,
      "MailTypeId": 64,
      "EntityNameId": 4,
      "EntityId": 5,
      "HoldUntilDate": "2022-08-13T21:31:08.515+00:00",
      "CreatedBy": 6,
      "CreatedDate": "2022-08-13T21:31:08.515+00:00",
      "MailHistoryId": 1,
      "SentDate": "2022-08-13T21:31:08.515+00:00",
      "IsReturned": true,
      "MailCancelledReasonId": 64,
      "MailCancelledBy": 1,
      "MailCancelledDate": "2022-08-13T21:31:08.515+00:00",
      "IsCancelled": true,
      "ComplianceDate": "2022-08-13T21:31:08.515+00:00",
      "MailRequestNewMails": [
        {
          "$ref": "1"
        },
        {
          "$ref": "1"
        }
      ],
      "EntityName": {
        "$ref": "2"
      },
      "MailCancelledReason": {
        "$id": "4",
        "$type": "NE.Entities.Server.MAIL.MailCancelledReason, NE.Entities.Server",
        "MailCancelledReasonId": 64,
        "Description": "sample string 2",
        "IsComplianceSatisfactory": true,
        "CodeName": "sample string 4",
        "MailTrackings": [
          {
            "$ref": "3"
          },
          {
            "$ref": "3"
          }
        ]
      },
      "MailHistory": {
        "$id": "5",
        "$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-13T21:31:08.515+00:00",
        "CreatedBy": 14,
        "StartPage": 1,
        "EndPage": 1,
        "CreatedDay": "2022-08-13T21:31:08.515+00:00",
        "StoragePath": "sample string 15",
        "MailHistoryEntities": [
          {
            "$id": "6",
            "$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": {
              "$ref": "2"
            },
            "MailHistory": {
              "$ref": "5"
            },
            "MailTracking": {
              "$ref": "3"
            }
          },
          {
            "$ref": "6"
          }
        ],
        "MailTrackings": [
          {
            "$ref": "3"
          },
          {
            "$ref": "3"
          }
        ],
        "MailBatchItem": {
          "$id": "7",
          "$type": "NE.Entities.Server.MAIL.MailBatchItem, NE.Entities.Server",
          "ApprovedBy": 1,
          "ApprovedDate": "2022-08-13T21:31:08.515+00:00",
          "BulkMailedBy": 1,
          "BulkMailedDate": "2022-08-13T21:31:08.515+00:00",
          "EnquedDate": "2022-08-13T21:31:08.515+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-13T21:31:08.515+00:00",
          "RecordCount": 9,
          "SentBy": 1,
          "SentDate": "2022-08-13T21:31:08.515+00:00",
          "SplitNumber": 64,
          "WasBMBypassed": true,
          "MinComplianceDate": "2022-08-13T21:31:08.515+00:00",
          "MaxComplianceDate": "2022-08-13T21:31:08.515+00:00",
          "MailBatch": {
            "$id": "8",
            "$type": "NE.Entities.Server.MAIL.MailBatch, NE.Entities.Server",
            "MailBatchId": 1,
            "CreatedBy": 2,
            "CreatedDate": "2022-08-13T21:31:08.515+00:00",
            "MailBatchItems": [
              {
                "$ref": "7"
              },
              {
                "$ref": "7"
              }
            ],
            "MailFiles": [
              {
                "$id": "9",
                "$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-13T21:31:08.515+00:00",
                "PrintedBy": 1,
                "PrintedDate": "2022-08-13T21:31:08.515+00:00",
                "PdfPageCount": 1,
                "RenderJobID": 1,
                "RenderedDate": "2022-08-13T21:31:08.515+00:00",
                "IsJobFailed": true,
                "IsRendered": true,
                "IsPending": true,
                "MailBatchItems": [
                  {
                    "$ref": "7"
                  },
                  {
                    "$ref": "7"
                  }
                ],
                "MailBatch": {
                  "$ref": "8"
                },
                "MailInsertGroup": {
                  "$id": "10",
                  "$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": "11",
                    "$type": "NE.Entities.Server.MAIL.MailInsertGroupCategory, NE.Entities.Server",
                    "MailInsertGroupCategoryId": 64,
                    "CodeName": "sample string 2",
                    "Description": "sample string 3",
                    "MailInsertGroups": [
                      {
                        "$ref": "10"
                      },
                      {
                        "$ref": "10"
                      }
                    ]
                  },
                  "MailLanguage": {
                    "$id": "12",
                    "$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": "10"
                      },
                      {
                        "$ref": "10"
                      }
                    ]
                  }
                },
                "MailLanguage": {
                  "$ref": "12"
                },
                "MailType": {
                  "$id": "13",
                  "$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": "2"
                  },
                  "MailTypeCategory": {
                    "$id": "14",
                    "$type": "NE.Entities.Server.MAIL.MailTypeCategory, NE.Entities.Server",
                    "MailTypeCategoryId": 64,
                    "Description": "sample string 2",
                    "CodeName": "sample string 3",
                    "MailTrackings": [
                      {
                        "$ref": "3"
                      },
                      {
                        "$ref": "3"
                      }
                    ],
                    "MailTypes": [
                      {
                        "$ref": "13"
                      },
                      {
                        "$ref": "13"
                      }
                    ]
                  }
                },
                "CreatedByUser": {
                  "$id": "15",
                  "$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": "16",
                    "$type": "AHS.Server.Entities.BusinessUnit, AHS.Server",
                    "BusinessUnitId": 1,
                    "Description": "sample string 2",
                    "IsAHS": true
                  }
                },
                "PrintedByUser": {
                  "$ref": "15"
                }
              },
              {
                "$ref": "9"
              }
            ],
            "CreatedByUser": {
              "$ref": "15"
            }
          },
          "MailFile": {
            "$ref": "9"
          },
          "MailInsertGroup": {
            "$ref": "10"
          },
          "MailLanguage": {
            "$ref": "12"
          },
          "MailType": {
            "$ref": "13"
          },
          "BulkMailedByUser": {
            "$ref": "15"
          },
          "PrintedByUser": {
            "$ref": "15"
          },
          "SentByUser": {
            "$ref": "15"
          },
          "ApprovedByUser": {
            "$ref": "15"
          }
        },
        "CreatedByUser": {
          "$ref": "15"
        },
        "TempFilePath": "sample string 16"
      },
      "MailHistoryEntity": {
        "$ref": "6"
      },
      "MailType": {
        "$ref": "13"
      },
      "MailTypeCategory": {
        "$ref": "14"
      },
      "MailStatus": {
        "$id": "17",
        "$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": "15"
      },
      "MailCancelledByUser": {
        "$ref": "15"
      }
    },
    "MailType": {
      "$ref": "13"
    },
    "CreatedByUser": {
      "$ref": "15"
    },
    "ModifiedByUser": {
      "$ref": "15"
    },
    "State": {
      "$id": "18",
      "$type": "AHS.Server.Entities.State, AHS.Server",
      "StateId": 1,
      "Name": "sample string 2",
      "Abbreviation": "sample string 3"
    }
  },
  {
    "$ref": "1"
  }
]