POST api/Fax/AbortFax
Request Information
URI Parameters
None.
Body Parameters
FaxQueueDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| FaxQueueId | integer |
None. |
|
| SenderName | string |
String length: inclusive between 0 and 200 |
|
| SenderPhoneNumber | string |
String length: inclusive between 0 and 20 |
|
| SenderFaxNumber | string |
String length: inclusive between 0 and 20 |
|
| SenderEmailAddress | string |
String length: inclusive between 0 and 256 |
|
| HasCoverPage | boolean |
None. |
|
| CoverPageTemplateUrl | string |
String length: inclusive between 0 and 500 |
|
| CoverPageSubject | string |
String length: inclusive between 0 and 200 |
|
| CoverPageComments | string |
String length: inclusive between 0 and 1000 |
|
| MaxAttempt | integer |
None. |
|
| Priority | integer |
None. |
|
| RetryInterval | integer |
None. |
|
| Receipt | integer |
None. |
|
| ReceiptAttachment | integer |
None. |
|
| ScheduleDate | date |
None. |
|
| ScheduleTime | string |
String length: inclusive between 0 and 8000 |
|
| ScheduledSendTime | date |
None. |
|
| Response | string |
String length: inclusive between 0 and 8000 |
|
| ResponseUniqId | string |
String length: inclusive between 0 and 50 |
|
| ListFaxAttachment | Collection of FaxAttachmentsDTO |
None. |
|
| ListFaxRecipient | Collection of FaxRecipientDTO |
None. |
|
| ValidRecord | boolean |
None. |
|
| CompanyName | string |
String length: inclusive between 0 and 60 |
|
| ScheduledSendTimeCheck | date |
None. |
|
| IsMatchFaxRecipient | boolean |
None. |
|
| PBUserId | string |
String length: inclusive between 0 and 50 |
|
| FaxServiceType | string |
None. |
|
| KeyName | string |
String length: inclusive between 0 and 50 |
|
| Title | string |
None. |
|
| FaxStatus | integer |
None. |
|
| EntityId | integer |
None. |
|
| DocTypeID | integer |
None. |
|
| RecordID | globally unique identifier |
None. |
|
| EncounterId | integer |
None. |
|
| CaseNo | integer |
None. |
|
| ServiceId | integer |
None. |
|
| EccCaseTypeId | integer |
None. |
|
| DocumentType | string |
String length: inclusive between 0 and 200 |
|
| ValidFlag | boolean |
None. |
|
| DateCreated | date |
None. |
|
| DateUpdated | date |
None. |
|
| UserIDCreated | integer |
None. |
|
| UserIDUpdated | integer |
None. |
|
| CompanyCode | string |
String length: inclusive between 0 and 10 |
|
| IsExcludeDiscount | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"FaxQueueId": 1,
"SenderName": "sample string 2",
"SenderPhoneNumber": "sample string 3",
"SenderFaxNumber": "sample string 4",
"SenderEmailAddress": "sample string 5",
"HasCoverPage": true,
"CoverPageTemplateUrl": "sample string 7",
"CoverPageSubject": "sample string 8",
"CoverPageComments": "sample string 9",
"MaxAttempt": 1,
"Priority": 1,
"RetryInterval": 1,
"Receipt": 1,
"ReceiptAttachment": 1,
"ScheduleDate": "2026-08-04T14:26:40.0234405-07:00",
"ScheduleTime": "sample string 11",
"ScheduledSendTime": "2026-08-04T14:26:40.0234405-07:00",
"Response": "sample string 12",
"ResponseUniqId": "sample string 13",
"ListFaxAttachment": [
{
"FaxAttachmentId": 1,
"FaxQueueId": 1,
"Title": "sample string 2",
"FolderPath": "sample string 3",
"AttachmentType": 1,
"ServiceUrl": "sample string 4",
"BucketName": "sample string 5",
"KeyName": "sample string 6",
"Message": "sample string 7",
"FileUrl": "sample string 8",
"EncodedContent": "sample string 9",
"ContentByteArray": "QEA=",
"IsFaxBucket": true,
"ValidFlag": true,
"DateCreated": "2026-08-04T14:26:40.0234405-07:00",
"DateUpdated": "2026-08-04T14:26:40.0234405-07:00",
"UserIDCreated": 14,
"UserIDUpdated": 15,
"CompanyCode": "sample string 16",
"IsExcludeDiscount": true
},
{
"FaxAttachmentId": 1,
"FaxQueueId": 1,
"Title": "sample string 2",
"FolderPath": "sample string 3",
"AttachmentType": 1,
"ServiceUrl": "sample string 4",
"BucketName": "sample string 5",
"KeyName": "sample string 6",
"Message": "sample string 7",
"FileUrl": "sample string 8",
"EncodedContent": "sample string 9",
"ContentByteArray": "QEA=",
"IsFaxBucket": true,
"ValidFlag": true,
"DateCreated": "2026-08-04T14:26:40.0234405-07:00",
"DateUpdated": "2026-08-04T14:26:40.0234405-07:00",
"UserIDCreated": 14,
"UserIDUpdated": 15,
"CompanyCode": "sample string 16",
"IsExcludeDiscount": true
}
],
"ListFaxRecipient": [
{
"FaxRecipientId": 1,
"FaxQueueId": 2,
"RecipientName": "sample string 3",
"FaxNumber": "sample string 4",
"CountryCode": "sample string 5",
"RecipientPhoneNumber": "sample string 6",
"FaxStatus": 7,
"IsFacility": true,
"SentTime": "2026-08-04T14:26:40.0234405-07:00",
"ResponseNoOfAttempt": 1,
"EntityId": "sample string 9",
"EntityType": "sample string 10",
"CompanyName": "sample string 11",
"IsRecipientCheck": true,
"IsDER": true,
"IsSecureFaxNumber": true,
"Response": "sample string 15",
"ResponseUniqId": "sample string 16",
"ValidFlag": true,
"DateCreated": "2026-08-04T14:26:40.0234405-07:00",
"DateUpdated": "2026-08-04T14:26:40.0234405-07:00",
"UserIDCreated": 20,
"UserIDUpdated": 21,
"CompanyCode": "sample string 22",
"IsExcludeDiscount": true
},
{
"FaxRecipientId": 1,
"FaxQueueId": 2,
"RecipientName": "sample string 3",
"FaxNumber": "sample string 4",
"CountryCode": "sample string 5",
"RecipientPhoneNumber": "sample string 6",
"FaxStatus": 7,
"IsFacility": true,
"SentTime": "2026-08-04T14:26:40.0234405-07:00",
"ResponseNoOfAttempt": 1,
"EntityId": "sample string 9",
"EntityType": "sample string 10",
"CompanyName": "sample string 11",
"IsRecipientCheck": true,
"IsDER": true,
"IsSecureFaxNumber": true,
"Response": "sample string 15",
"ResponseUniqId": "sample string 16",
"ValidFlag": true,
"DateCreated": "2026-08-04T14:26:40.0234405-07:00",
"DateUpdated": "2026-08-04T14:26:40.0234405-07:00",
"UserIDCreated": 20,
"UserIDUpdated": 21,
"CompanyCode": "sample string 22",
"IsExcludeDiscount": true
}
],
"ValidRecord": true,
"CompanyName": "sample string 15",
"ScheduledSendTimeCheck": "2026-08-04T14:26:40.0234405-07:00",
"IsMatchFaxRecipient": true,
"PBUserId": "sample string 17",
"FaxServiceType": "sample string 18",
"KeyName": "sample string 19",
"Title": "sample string 20",
"FaxStatus": 21,
"EntityId": 22,
"DocTypeID": 23,
"RecordID": "890b8320-b6a0-401f-8a71-4c929017473e",
"EncounterId": 1,
"CaseNo": 1,
"ServiceId": 1,
"EccCaseTypeId": 1,
"DocumentType": "sample string 24",
"ValidFlag": true,
"DateCreated": "2026-08-04T14:26:40.0234405-07:00",
"DateUpdated": "2026-08-04T14:26:40.0234405-07:00",
"UserIDCreated": 28,
"UserIDUpdated": 29,
"CompanyCode": "sample string 30",
"IsExcludeDiscount": true
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
AsapResponseOfFaxQueueDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| isSuccess | boolean |
None. |
|
| message | string |
None. |
|
| jsonObj | FaxQueueDTO |
None. |
|
| totalCount | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"isSuccess": true,
"message": "sample string 2",
"jsonObj": {
"FaxQueueId": 1,
"SenderName": "sample string 2",
"SenderPhoneNumber": "sample string 3",
"SenderFaxNumber": "sample string 4",
"SenderEmailAddress": "sample string 5",
"HasCoverPage": true,
"CoverPageTemplateUrl": "sample string 7",
"CoverPageSubject": "sample string 8",
"CoverPageComments": "sample string 9",
"MaxAttempt": 1,
"Priority": 1,
"RetryInterval": 1,
"Receipt": 1,
"ReceiptAttachment": 1,
"ScheduleDate": "2026-08-04T14:26:40.0234405-07:00",
"ScheduleTime": "sample string 11",
"ScheduledSendTime": "2026-08-04T14:26:40.0234405-07:00",
"Response": "sample string 12",
"ResponseUniqId": "sample string 13",
"ListFaxAttachment": [
{
"FaxAttachmentId": 1,
"FaxQueueId": 1,
"Title": "sample string 2",
"FolderPath": "sample string 3",
"AttachmentType": 1,
"ServiceUrl": "sample string 4",
"BucketName": "sample string 5",
"KeyName": "sample string 6",
"Message": "sample string 7",
"FileUrl": "sample string 8",
"EncodedContent": "sample string 9",
"ContentByteArray": "QEA=",
"IsFaxBucket": true,
"ValidFlag": true,
"DateCreated": "2026-08-04T14:26:40.0234405-07:00",
"DateUpdated": "2026-08-04T14:26:40.0234405-07:00",
"UserIDCreated": 14,
"UserIDUpdated": 15,
"CompanyCode": "sample string 16",
"IsExcludeDiscount": true
},
{
"FaxAttachmentId": 1,
"FaxQueueId": 1,
"Title": "sample string 2",
"FolderPath": "sample string 3",
"AttachmentType": 1,
"ServiceUrl": "sample string 4",
"BucketName": "sample string 5",
"KeyName": "sample string 6",
"Message": "sample string 7",
"FileUrl": "sample string 8",
"EncodedContent": "sample string 9",
"ContentByteArray": "QEA=",
"IsFaxBucket": true,
"ValidFlag": true,
"DateCreated": "2026-08-04T14:26:40.0234405-07:00",
"DateUpdated": "2026-08-04T14:26:40.0234405-07:00",
"UserIDCreated": 14,
"UserIDUpdated": 15,
"CompanyCode": "sample string 16",
"IsExcludeDiscount": true
}
],
"ListFaxRecipient": [
{
"FaxRecipientId": 1,
"FaxQueueId": 2,
"RecipientName": "sample string 3",
"FaxNumber": "sample string 4",
"CountryCode": "sample string 5",
"RecipientPhoneNumber": "sample string 6",
"FaxStatus": 7,
"IsFacility": true,
"SentTime": "2026-08-04T14:26:40.0234405-07:00",
"ResponseNoOfAttempt": 1,
"EntityId": "sample string 9",
"EntityType": "sample string 10",
"CompanyName": "sample string 11",
"IsRecipientCheck": true,
"IsDER": true,
"IsSecureFaxNumber": true,
"Response": "sample string 15",
"ResponseUniqId": "sample string 16",
"ValidFlag": true,
"DateCreated": "2026-08-04T14:26:40.0234405-07:00",
"DateUpdated": "2026-08-04T14:26:40.0234405-07:00",
"UserIDCreated": 20,
"UserIDUpdated": 21,
"CompanyCode": "sample string 22",
"IsExcludeDiscount": true
},
{
"FaxRecipientId": 1,
"FaxQueueId": 2,
"RecipientName": "sample string 3",
"FaxNumber": "sample string 4",
"CountryCode": "sample string 5",
"RecipientPhoneNumber": "sample string 6",
"FaxStatus": 7,
"IsFacility": true,
"SentTime": "2026-08-04T14:26:40.0234405-07:00",
"ResponseNoOfAttempt": 1,
"EntityId": "sample string 9",
"EntityType": "sample string 10",
"CompanyName": "sample string 11",
"IsRecipientCheck": true,
"IsDER": true,
"IsSecureFaxNumber": true,
"Response": "sample string 15",
"ResponseUniqId": "sample string 16",
"ValidFlag": true,
"DateCreated": "2026-08-04T14:26:40.0234405-07:00",
"DateUpdated": "2026-08-04T14:26:40.0234405-07:00",
"UserIDCreated": 20,
"UserIDUpdated": 21,
"CompanyCode": "sample string 22",
"IsExcludeDiscount": true
}
],
"ValidRecord": true,
"CompanyName": "sample string 15",
"ScheduledSendTimeCheck": "2026-08-04T14:26:40.0234405-07:00",
"IsMatchFaxRecipient": true,
"PBUserId": "sample string 17",
"FaxServiceType": "sample string 18",
"KeyName": "sample string 19",
"Title": "sample string 20",
"FaxStatus": 21,
"EntityId": 22,
"DocTypeID": 23,
"RecordID": "2dabe07d-7bc7-433f-8d10-ab35de980c59",
"EncounterId": 1,
"CaseNo": 1,
"ServiceId": 1,
"EccCaseTypeId": 1,
"DocumentType": "sample string 24",
"ValidFlag": true,
"DateCreated": "2026-08-04T14:26:40.0234405-07:00",
"DateUpdated": "2026-08-04T14:26:40.0234405-07:00",
"UserIDCreated": 28,
"UserIDUpdated": 29,
"CompanyCode": "sample string 30",
"IsExcludeDiscount": true
},
"totalCount": 3
}