GET api/NE/MarkBatchSent?mailBatchItemId={mailBatchItemId}&sentByUserId={sentByUserId}&logMsg={logMsg}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
mailBatchItemId | integer |
Required |
|
sentByUserId | integer |
Required |
|
logMsg | string |
Required |
Body Parameters
None.
Response Information
Resource Description
MailBatchItemName | Description | Type | Additional information |
---|---|---|---|
ApprovedBy | integer |
None. |
|
ApprovedDate | date |
None. |
|
BulkMailedBy | integer |
None. |
|
BulkMailedDate | date |
None. |
|
EnquedDate | date |
None. |
|
EntityLockId | integer |
None. |
|
ExpectedPageCount | integer |
None. |
|
IsApproved | boolean |
None. |
|
IsPrepareComplete | boolean |
None. |
|
Label | string |
None. |
|
MailBatchId | integer |
None. |
|
MailBatchItemId | integer |
None. |
|
MailFileId | integer |
None. |
|
MailInsertGroupId | integer |
None. |
|
MailLanguageId | byte |
None. |
|
MailTypeId | byte |
None. |
|
PieceCount | integer |
None. |
|
PrintedBy | integer |
None. |
|
PrintedDate | date |
None. |
|
RecordCount | integer |
None. |
|
SentBy | integer |
None. |
|
SentDate | date |
None. |
|
SplitNumber | byte |
None. |
|
WasBMBypassed | boolean |
None. |
|
MinComplianceDate | date |
None. |
|
MaxComplianceDate | date |
None. |
|
MailBatch | MailBatch |
None. |
|
MailFile | MailFile |
None. |
|
MailInsertGroup | MailInsertGroup |
None. |
|
MailLanguage | MailLanguage |
None. |
|
MailType | MailType |
None. |
|
BulkMailedByUser | User |
None. |
|
PrintedByUser | User |
None. |
|
SentByUser | User |
None. |
|
ApprovedByUser | User |
None. |
Response Formats
application/json, text/json
Sample:
{ "ApprovedBy": 1, "ApprovedDate": "2024-11-21T09:30:26.762+00:00", "BulkMailedBy": 1, "BulkMailedDate": "2024-11-21T09:30:26.762+00:00", "EnquedDate": "2024-11-21T09:30:26.762+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": "2024-11-21T09:30:26.762+00:00", "RecordCount": 9, "SentBy": 1, "SentDate": "2024-11-21T09:30:26.762+00:00", "SplitNumber": 64, "WasBMBypassed": true, "MinComplianceDate": "2024-11-21T09:30:26.762+00:00", "MaxComplianceDate": "2024-11-21T09:30:26.762+00:00", "MailBatch": { "$id": "2", "$type": "NE.Entities.Server.MAIL.MailBatch, NE.Entities.Server", "MailBatchId": 1, "CreatedBy": 2, "CreatedDate": "2024-11-21T09:30:26.762+00:00", "MailBatchItems": [ { "$ref": "1" }, { "$ref": "1" } ], "MailFiles": [ { "$id": "3", "$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": "2024-11-21T09:30:26.762+00:00", "PrintedBy": 1, "PrintedDate": "2024-11-21T09:30:26.762+00:00", "PdfPageCount": 1, "RenderJobID": 1, "RenderedDate": "2024-11-21T09:30:26.762+00:00", "IsJobFailed": true, "IsRendered": true, "IsPending": true, "MailBatchItems": [ { "$ref": "1" }, { "$ref": "1" } ], "MailBatch": { "$ref": "2" }, "MailInsertGroup": { "$id": "4", "$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": "5", "$type": "NE.Entities.Server.MAIL.MailInsertGroupCategory, NE.Entities.Server", "MailInsertGroupCategoryId": 64, "CodeName": "sample string 2", "Description": "sample string 3", "MailInsertGroups": [ { "$ref": "4" }, { "$ref": "4" } ] }, "MailLanguage": { "$id": "6", "$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": "4" }, { "$ref": "4" } ] } }, "MailLanguage": { "$ref": "6" }, "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": { "$id": "8", "$type": "AHS.Server.Entities.EntityName, AHS.Server", "EntityNameId": 1, "Description": "sample string 2", "CodeName": "sample string 3" }, "MailTypeCategory": { "$id": "9", "$type": "NE.Entities.Server.MAIL.MailTypeCategory, NE.Entities.Server", "MailTypeCategoryId": 64, "Description": "sample string 2", "CodeName": "sample string 3", "MailTrackings": [ { "$id": "10", "$type": "NE.Entities.Server.MAIL.MailTracking, NE.Entities.Server", "MailTrackingId": 1, "MailStatusId": 64, "MailTypeCategoryId": 64, "MailTypeId": 64, "EntityNameId": 4, "EntityId": 5, "HoldUntilDate": "2024-11-21T09:30:26.778+00:00", "CreatedBy": 6, "CreatedDate": "2024-11-21T09:30:26.778+00:00", "MailHistoryId": 1, "SentDate": "2024-11-21T09:30:26.778+00:00", "IsReturned": true, "MailCancelledReasonId": 64, "MailCancelledBy": 1, "MailCancelledDate": "2024-11-21T09:30:26.778+00:00", "IsCancelled": true, "ComplianceDate": "2024-11-21T09:30:26.778+00:00", "MailRequestNewMails": [ { "$id": "11", "$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": "2024-11-21T09:30:26.778+00:00", "CreatedBy": 13, "IsCancelled": true, "ModifiedBy": 1, "ModifiedDate": "2024-11-21T09:30:26.778+00:00", "EntityName": { "$ref": "8" }, "MailTracking": { "$ref": "10" }, "MailType": { "$ref": "7" }, "CreatedByUser": { "$id": "12", "$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": "13", "$type": "AHS.Server.Entities.BusinessUnit, AHS.Server", "BusinessUnitId": 1, "Description": "sample string 2", "IsAHS": true } }, "ModifiedByUser": { "$ref": "12" }, "State": { "$id": "14", "$type": "AHS.Server.Entities.State, AHS.Server", "StateId": 1, "Name": "sample string 2", "Abbreviation": "sample string 3" } }, { "$ref": "11" } ], "EntityName": { "$ref": "8" }, "MailCancelledReason": { "$id": "15", "$type": "NE.Entities.Server.MAIL.MailCancelledReason, NE.Entities.Server", "MailCancelledReasonId": 64, "Description": "sample string 2", "IsComplianceSatisfactory": true, "CodeName": "sample string 4", "MailTrackings": [ { "$ref": "10" }, { "$ref": "10" } ] }, "MailHistory": { "$id": "16", "$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": "2024-11-21T09:30:26.778+00:00", "CreatedBy": 14, "StartPage": 1, "EndPage": 1, "CreatedDay": "2024-11-21T09:30:26.778+00:00", "StoragePath": "sample string 15", "MailHistoryEntities": [ { "$id": "17", "$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": "8" }, "MailHistory": { "$ref": "16" }, "MailTracking": { "$ref": "10" } }, { "$ref": "17" } ], "MailTrackings": [ { "$ref": "10" }, { "$ref": "10" } ], "MailBatchItem": { "$ref": "1" }, "CreatedByUser": { "$ref": "12" }, "TempFilePath": "sample string 16" }, "MailHistoryEntity": { "$ref": "17" }, "MailType": { "$ref": "7" }, "MailTypeCategory": { "$ref": "9" }, "MailStatus": { "$id": "18", "$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": "12" }, "MailCancelledByUser": { "$ref": "12" } }, { "$ref": "10" } ], "MailTypes": [ { "$ref": "7" }, { "$ref": "7" } ] } }, "CreatedByUser": { "$ref": "12" }, "PrintedByUser": { "$ref": "12" } }, { "$ref": "3" } ], "CreatedByUser": { "$ref": "12" } }, "MailFile": { "$ref": "3" }, "MailInsertGroup": { "$ref": "4" }, "MailLanguage": { "$ref": "6" }, "MailType": { "$ref": "7" }, "BulkMailedByUser": { "$ref": "12" }, "PrintedByUser": { "$ref": "12" }, "SentByUser": { "$ref": "12" }, "ApprovedByUser": { "$ref": "12" } }