POST api/Fax/PostMiscellaneousFax
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
AsapResponseOfFaxEncounterDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| isSuccess | boolean |
None. |
|
| message | string |
None. |
|
| jsonObj | FaxEncounterDTO |
None. |
|
| totalCount | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"isSuccess": true,
"message": "sample string 2",
"jsonObj": {
"Id": 1,
"FaxQueueId": 2,
"EncounterId": 1,
"CaseNo": 1,
"DocumentType": "sample string 3",
"Sequence": 4,
"Fax": {
"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": "2025-10-30T07:39:58.6009243-07:00",
"ScheduleTime": "sample string 11",
"ScheduledSendTime": "2025-10-30T07:39:58.6009243-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": "2025-10-30T07:39:58.6009243-07:00",
"DateUpdated": "2025-10-30T07:39:58.6009243-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": "2025-10-30T07:39:58.6009243-07:00",
"DateUpdated": "2025-10-30T07:39:58.6009243-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": "2025-10-30T07:39:58.6009243-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": "2025-10-30T07:39:58.6009243-07:00",
"DateUpdated": "2025-10-30T07:39:58.6009243-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": "2025-10-30T07:39:58.6009243-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": "2025-10-30T07:39:58.6009243-07:00",
"DateUpdated": "2025-10-30T07:39:58.6009243-07:00",
"UserIDCreated": 20,
"UserIDUpdated": 21,
"CompanyCode": "sample string 22",
"IsExcludeDiscount": true
}
],
"ValidRecord": true,
"CompanyName": "sample string 15",
"ScheduledSendTimeCheck": "2025-10-30T07:39:58.6009243-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": "634d2078-571d-4366-996b-7a1be1019f6c",
"EncounterId": 1,
"CaseNo": 1,
"ServiceId": 1,
"EccCaseTypeId": 1,
"DocumentType": "sample string 24",
"ValidFlag": true,
"DateCreated": "2025-10-30T07:39:58.6009243-07:00",
"DateUpdated": "2025-10-30T07:39:58.6009243-07:00",
"UserIDCreated": 28,
"UserIDUpdated": 29,
"CompanyCode": "sample string 30",
"IsExcludeDiscount": true
},
"id": "sample string 5",
"rid": "2406248f-2761-46a4-ba2a-cdc9025bcc8a",
"mid": 1,
"type": 1,
"DispositionId": 1,
"ServiceId": 6,
"EccCaseTypeId": 1,
"FacilityCode": "sample string 7",
"OnsiteLocationId": 1,
"MessageQueueId": 1,
"KeyName": "sample string 8",
"EmployeeId": "sample string 9",
"ScheduleDate": "2025-10-30T07:39:58.6173207-07:00",
"ScheduleTime": "00:00:00.1234567",
"ComponentId": 1,
"faxTypeList": [
{
"Id": 1,
"Name": "sample string 2",
"ServiceId": 3,
"EccCaseTypeId": 1,
"ServiceName": "sample string 4",
"ValidFlag": true,
"DateCreated": "2025-10-30T07:39:58.6173207-07:00",
"DateUpdated": "2025-10-30T07:39:58.6173207-07:00",
"UserIDCreated": 8,
"UserIDUpdated": 9,
"CompanyCode": "sample string 10",
"IsExcludeDiscount": true
},
{
"Id": 1,
"Name": "sample string 2",
"ServiceId": 3,
"EccCaseTypeId": 1,
"ServiceName": "sample string 4",
"ValidFlag": true,
"DateCreated": "2025-10-30T07:39:58.6173207-07:00",
"DateUpdated": "2025-10-30T07:39:58.6173207-07:00",
"UserIDCreated": 8,
"UserIDUpdated": 9,
"CompanyCode": "sample string 10",
"IsExcludeDiscount": true
}
],
"ValidFlag": true,
"DateCreated": "2025-10-30T07:39:58.6173207-07:00",
"DateUpdated": "2025-10-30T07:39:58.6173207-07:00",
"UserIDCreated": 13,
"UserIDUpdated": 14,
"CompanyCode": "sample string 15",
"IsExcludeDiscount": true
},
"totalCount": 3
}
application/xml, text/xml
Sample:
<AsapResponseOfFaxEncounterDTO3NYuOdgi xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ASAP_BL.Common">
<isSuccess>true</isSuccess>
<jsonObj xmlns:d2p1="http://schemas.datacontract.org/2004/07/ASAP_BL.BL">
<d2p1:CompanyCode>sample string 15</d2p1:CompanyCode>
<d2p1:DateCreated>2025-10-30T07:39:58.6173207-07:00</d2p1:DateCreated>
<d2p1:DateUpdated>2025-10-30T07:39:58.6173207-07:00</d2p1:DateUpdated>
<d2p1:IsExcludeDiscount>true</d2p1:IsExcludeDiscount>
<d2p1:UserIDCreated>13</d2p1:UserIDCreated>
<d2p1:UserIDUpdated>14</d2p1:UserIDUpdated>
<d2p1:ValidFlag>true</d2p1:ValidFlag>
<d2p1:CaseNo>1</d2p1:CaseNo>
<d2p1:ComponentId>1</d2p1:ComponentId>
<d2p1:DispositionId>1</d2p1:DispositionId>
<d2p1:DocumentType>sample string 3</d2p1:DocumentType>
<d2p1:EccCaseTypeId>1</d2p1:EccCaseTypeId>
<d2p1:EmployeeId>sample string 9</d2p1:EmployeeId>
<d2p1:EncounterId>1</d2p1:EncounterId>
<d2p1:FacilityCode>sample string 7</d2p1:FacilityCode>
<d2p1:Fax>
<d2p1:CompanyCode>sample string 30</d2p1:CompanyCode>
<d2p1:DateCreated>2025-10-30T07:39:58.6009243-07:00</d2p1:DateCreated>
<d2p1:DateUpdated>2025-10-30T07:39:58.6009243-07:00</d2p1:DateUpdated>
<d2p1:IsExcludeDiscount>true</d2p1:IsExcludeDiscount>
<d2p1:UserIDCreated>28</d2p1:UserIDCreated>
<d2p1:UserIDUpdated>29</d2p1:UserIDUpdated>
<d2p1:ValidFlag>true</d2p1:ValidFlag>
<d2p1:CaseNo>1</d2p1:CaseNo>
<d2p1:CompanyName>sample string 15</d2p1:CompanyName>
<d2p1:CoverPageComments>sample string 9</d2p1:CoverPageComments>
<d2p1:CoverPageSubject>sample string 8</d2p1:CoverPageSubject>
<d2p1:CoverPageTemplateUrl>sample string 7</d2p1:CoverPageTemplateUrl>
<d2p1:DocTypeID>23</d2p1:DocTypeID>
<d2p1:DocumentType>sample string 24</d2p1:DocumentType>
<d2p1:EccCaseTypeId>1</d2p1:EccCaseTypeId>
<d2p1:EncounterId>1</d2p1:EncounterId>
<d2p1:EntityId>22</d2p1:EntityId>
<d2p1:FaxQueueId>1</d2p1:FaxQueueId>
<d2p1:FaxServiceType>sample string 18</d2p1:FaxServiceType>
<d2p1:FaxStatus>21</d2p1:FaxStatus>
<d2p1:HasCoverPage>true</d2p1:HasCoverPage>
<d2p1:IsMatchFaxRecipient>true</d2p1:IsMatchFaxRecipient>
<d2p1:KeyName>sample string 19</d2p1:KeyName>
<d2p1:ListFaxAttachment>
<d2p1:FaxAttachmentsDTO>
<d2p1:CompanyCode>sample string 16</d2p1:CompanyCode>
<d2p1:DateCreated>2025-10-30T07:39:58.6009243-07:00</d2p1:DateCreated>
<d2p1:DateUpdated>2025-10-30T07:39:58.6009243-07:00</d2p1:DateUpdated>
<d2p1:IsExcludeDiscount>true</d2p1:IsExcludeDiscount>
<d2p1:UserIDCreated>14</d2p1:UserIDCreated>
<d2p1:UserIDUpdated>15</d2p1:UserIDUpdated>
<d2p1:ValidFlag>true</d2p1:ValidFlag>
<d2p1:AttachmentType>1</d2p1:AttachmentType>
<d2p1:BucketName>sample string 5</d2p1:BucketName>
<d2p1:ContentByteArray>QEA=</d2p1:ContentByteArray>
<d2p1:EncodedContent>sample string 9</d2p1:EncodedContent>
<d2p1:FaxAttachmentId>1</d2p1:FaxAttachmentId>
<d2p1:FaxQueueId>1</d2p1:FaxQueueId>
<d2p1:FileUrl>sample string 8</d2p1:FileUrl>
<d2p1:FolderPath>sample string 3</d2p1:FolderPath>
<d2p1:IsFaxBucket>true</d2p1:IsFaxBucket>
<d2p1:KeyName>sample string 6</d2p1:KeyName>
<d2p1:Message>sample string 7</d2p1:Message>
<d2p1:ServiceUrl>sample string 4</d2p1:ServiceUrl>
<d2p1:Title>sample string 2</d2p1:Title>
</d2p1:FaxAttachmentsDTO>
<d2p1:FaxAttachmentsDTO>
<d2p1:CompanyCode>sample string 16</d2p1:CompanyCode>
<d2p1:DateCreated>2025-10-30T07:39:58.6009243-07:00</d2p1:DateCreated>
<d2p1:DateUpdated>2025-10-30T07:39:58.6009243-07:00</d2p1:DateUpdated>
<d2p1:IsExcludeDiscount>true</d2p1:IsExcludeDiscount>
<d2p1:UserIDCreated>14</d2p1:UserIDCreated>
<d2p1:UserIDUpdated>15</d2p1:UserIDUpdated>
<d2p1:ValidFlag>true</d2p1:ValidFlag>
<d2p1:AttachmentType>1</d2p1:AttachmentType>
<d2p1:BucketName>sample string 5</d2p1:BucketName>
<d2p1:ContentByteArray>QEA=</d2p1:ContentByteArray>
<d2p1:EncodedContent>sample string 9</d2p1:EncodedContent>
<d2p1:FaxAttachmentId>1</d2p1:FaxAttachmentId>
<d2p1:FaxQueueId>1</d2p1:FaxQueueId>
<d2p1:FileUrl>sample string 8</d2p1:FileUrl>
<d2p1:FolderPath>sample string 3</d2p1:FolderPath>
<d2p1:IsFaxBucket>true</d2p1:IsFaxBucket>
<d2p1:KeyName>sample string 6</d2p1:KeyName>
<d2p1:Message>sample string 7</d2p1:Message>
<d2p1:ServiceUrl>sample string 4</d2p1:ServiceUrl>
<d2p1:Title>sample string 2</d2p1:Title>
</d2p1:FaxAttachmentsDTO>
</d2p1:ListFaxAttachment>
<d2p1:ListFaxRecipient>
<d2p1:FaxRecipientDTO>
<d2p1:CompanyCode>sample string 22</d2p1:CompanyCode>
<d2p1:DateCreated>2025-10-30T07:39:58.6009243-07:00</d2p1:DateCreated>
<d2p1:DateUpdated>2025-10-30T07:39:58.6009243-07:00</d2p1:DateUpdated>
<d2p1:IsExcludeDiscount>true</d2p1:IsExcludeDiscount>
<d2p1:UserIDCreated>20</d2p1:UserIDCreated>
<d2p1:UserIDUpdated>21</d2p1:UserIDUpdated>
<d2p1:ValidFlag>true</d2p1:ValidFlag>
<d2p1:CompanyName>sample string 11</d2p1:CompanyName>
<d2p1:CountryCode>sample string 5</d2p1:CountryCode>
<d2p1:EntityId>sample string 9</d2p1:EntityId>
<d2p1:EntityType>sample string 10</d2p1:EntityType>
<d2p1:FaxNumber>sample string 4</d2p1:FaxNumber>
<d2p1:FaxQueueId>2</d2p1:FaxQueueId>
<d2p1:FaxRecipientId>1</d2p1:FaxRecipientId>
<d2p1:FaxStatus>7</d2p1:FaxStatus>
<d2p1:IsDER>true</d2p1:IsDER>
<d2p1:IsFacility>true</d2p1:IsFacility>
<d2p1:IsRecipientCheck>true</d2p1:IsRecipientCheck>
<d2p1:IsSecureFaxNumber>true</d2p1:IsSecureFaxNumber>
<d2p1:RecipientName>sample string 3</d2p1:RecipientName>
<d2p1:RecipientPhoneNumber>sample string 6</d2p1:RecipientPhoneNumber>
<d2p1:Response>sample string 15</d2p1:Response>
<d2p1:ResponseNoOfAttempt>1</d2p1:ResponseNoOfAttempt>
<d2p1:ResponseUniqId>sample string 16</d2p1:ResponseUniqId>
<d2p1:SentTime>2025-10-30T07:39:58.6009243-07:00</d2p1:SentTime>
</d2p1:FaxRecipientDTO>
<d2p1:FaxRecipientDTO>
<d2p1:CompanyCode>sample string 22</d2p1:CompanyCode>
<d2p1:DateCreated>2025-10-30T07:39:58.6009243-07:00</d2p1:DateCreated>
<d2p1:DateUpdated>2025-10-30T07:39:58.6009243-07:00</d2p1:DateUpdated>
<d2p1:IsExcludeDiscount>true</d2p1:IsExcludeDiscount>
<d2p1:UserIDCreated>20</d2p1:UserIDCreated>
<d2p1:UserIDUpdated>21</d2p1:UserIDUpdated>
<d2p1:ValidFlag>true</d2p1:ValidFlag>
<d2p1:CompanyName>sample string 11</d2p1:CompanyName>
<d2p1:CountryCode>sample string 5</d2p1:CountryCode>
<d2p1:EntityId>sample string 9</d2p1:EntityId>
<d2p1:EntityType>sample string 10</d2p1:EntityType>
<d2p1:FaxNumber>sample string 4</d2p1:FaxNumber>
<d2p1:FaxQueueId>2</d2p1:FaxQueueId>
<d2p1:FaxRecipientId>1</d2p1:FaxRecipientId>
<d2p1:FaxStatus>7</d2p1:FaxStatus>
<d2p1:IsDER>true</d2p1:IsDER>
<d2p1:IsFacility>true</d2p1:IsFacility>
<d2p1:IsRecipientCheck>true</d2p1:IsRecipientCheck>
<d2p1:IsSecureFaxNumber>true</d2p1:IsSecureFaxNumber>
<d2p1:RecipientName>sample string 3</d2p1:RecipientName>
<d2p1:RecipientPhoneNumber>sample string 6</d2p1:RecipientPhoneNumber>
<d2p1:Response>sample string 15</d2p1:Response>
<d2p1:ResponseNoOfAttempt>1</d2p1:ResponseNoOfAttempt>
<d2p1:ResponseUniqId>sample string 16</d2p1:ResponseUniqId>
<d2p1:SentTime>2025-10-30T07:39:58.6009243-07:00</d2p1:SentTime>
</d2p1:FaxRecipientDTO>
</d2p1:ListFaxRecipient>
<d2p1:MaxAttempt>1</d2p1:MaxAttempt>
<d2p1:PBUserId>sample string 17</d2p1:PBUserId>
<d2p1:Priority>1</d2p1:Priority>
<d2p1:Receipt>1</d2p1:Receipt>
<d2p1:ReceiptAttachment>1</d2p1:ReceiptAttachment>
<d2p1:RecordID>634d2078-571d-4366-996b-7a1be1019f6c</d2p1:RecordID>
<d2p1:Response>sample string 12</d2p1:Response>
<d2p1:ResponseUniqId>sample string 13</d2p1:ResponseUniqId>
<d2p1:RetryInterval>1</d2p1:RetryInterval>
<d2p1:ScheduleDate>2025-10-30T07:39:58.6009243-07:00</d2p1:ScheduleDate>
<d2p1:ScheduleTime>sample string 11</d2p1:ScheduleTime>
<d2p1:ScheduledSendTime>2025-10-30T07:39:58.6009243-07:00</d2p1:ScheduledSendTime>
<d2p1:ScheduledSendTimeCheck>2025-10-30T07:39:58.6009243-07:00</d2p1:ScheduledSendTimeCheck>
<d2p1:SenderEmailAddress>sample string 5</d2p1:SenderEmailAddress>
<d2p1:SenderFaxNumber>sample string 4</d2p1:SenderFaxNumber>
<d2p1:SenderName>sample string 2</d2p1:SenderName>
<d2p1:SenderPhoneNumber>sample string 3</d2p1:SenderPhoneNumber>
<d2p1:ServiceId>1</d2p1:ServiceId>
<d2p1:ValidRecord>true</d2p1:ValidRecord>
</d2p1:Fax>
<d2p1:FaxQueueId>2</d2p1:FaxQueueId>
<d2p1:Id>1</d2p1:Id>
<d2p1:KeyName>sample string 8</d2p1:KeyName>
<d2p1:MessageQueueId>1</d2p1:MessageQueueId>
<d2p1:OnsiteLocationId>1</d2p1:OnsiteLocationId>
<d2p1:ScheduleDate>2025-10-30T07:39:58.6173207-07:00</d2p1:ScheduleDate>
<d2p1:ScheduleTime>PT0.1234567S</d2p1:ScheduleTime>
<d2p1:Sequence>4</d2p1:Sequence>
<d2p1:ServiceId>6</d2p1:ServiceId>
<d2p1:faxTypeList>
<d2p1:FaxTypeDTO>
<d2p1:CompanyCode>sample string 10</d2p1:CompanyCode>
<d2p1:DateCreated>2025-10-30T07:39:58.6173207-07:00</d2p1:DateCreated>
<d2p1:DateUpdated>2025-10-30T07:39:58.6173207-07:00</d2p1:DateUpdated>
<d2p1:IsExcludeDiscount>true</d2p1:IsExcludeDiscount>
<d2p1:UserIDCreated>8</d2p1:UserIDCreated>
<d2p1:UserIDUpdated>9</d2p1:UserIDUpdated>
<d2p1:ValidFlag>true</d2p1:ValidFlag>
<d2p1:EccCaseTypeId>1</d2p1:EccCaseTypeId>
<d2p1:Id>1</d2p1:Id>
<d2p1:Name>sample string 2</d2p1:Name>
<d2p1:ServiceId>3</d2p1:ServiceId>
<d2p1:ServiceName>sample string 4</d2p1:ServiceName>
</d2p1:FaxTypeDTO>
<d2p1:FaxTypeDTO>
<d2p1:CompanyCode>sample string 10</d2p1:CompanyCode>
<d2p1:DateCreated>2025-10-30T07:39:58.6173207-07:00</d2p1:DateCreated>
<d2p1:DateUpdated>2025-10-30T07:39:58.6173207-07:00</d2p1:DateUpdated>
<d2p1:IsExcludeDiscount>true</d2p1:IsExcludeDiscount>
<d2p1:UserIDCreated>8</d2p1:UserIDCreated>
<d2p1:UserIDUpdated>9</d2p1:UserIDUpdated>
<d2p1:ValidFlag>true</d2p1:ValidFlag>
<d2p1:EccCaseTypeId>1</d2p1:EccCaseTypeId>
<d2p1:Id>1</d2p1:Id>
<d2p1:Name>sample string 2</d2p1:Name>
<d2p1:ServiceId>3</d2p1:ServiceId>
<d2p1:ServiceName>sample string 4</d2p1:ServiceName>
</d2p1:FaxTypeDTO>
</d2p1:faxTypeList>
<d2p1:id>sample string 5</d2p1:id>
<d2p1:mid>1</d2p1:mid>
<d2p1:rid>2406248f-2761-46a4-ba2a-cdc9025bcc8a</d2p1:rid>
<d2p1:type>1</d2p1:type>
</jsonObj>
<message>sample string 2</message>
<totalCount>3</totalCount>
</AsapResponseOfFaxEncounterDTO3NYuOdgi>