POST api/Fax/CreateFaxDetails

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	integer	None.
FaxQueueId	integer	None.
EncounterId	integer	None.
CaseNo	integer	None.
DocumentType	string	String length: inclusive between 0 and 200
Sequence	integer	None.
Fax	FaxQueueDTO	None.
id	string	String length: inclusive between 0 and 500
rid	globally unique identifier	None.
mid	integer	None.
type	integer	None.
DispositionId	integer	None.
ServiceId	integer	None.
EccCaseTypeId	integer	None.
FacilityCode	string	String length: inclusive between 0 and 10
OnsiteLocationId	integer	None.
MessageQueueId	integer	None.
KeyName	string	String length: inclusive between 0 and 250
EmployeeId	string	String length: inclusive between 0 and 12
ScheduleDate	date	None.
ScheduleTime	time interval	None.
ComponentId	integer	None.
faxTypeList	Collection of FaxTypeDTO	None.
EncounterStatus	integer	None.
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:

{
  "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": "2026-08-03T21:44:13.6406013-07:00",
    "ScheduleTime": "sample string 11",
    "ScheduledSendTime": "2026-08-03T21:44:13.6406013-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-03T21:44:13.6406013-07:00",
        "DateUpdated": "2026-08-03T21:44:13.6406013-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-03T21:44:13.6406013-07:00",
        "DateUpdated": "2026-08-03T21:44:13.6406013-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-03T21:44:13.6406013-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-03T21:44:13.6406013-07:00",
        "DateUpdated": "2026-08-03T21:44:13.6406013-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-03T21:44:13.6406013-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-03T21:44:13.6406013-07:00",
        "DateUpdated": "2026-08-03T21:44:13.6406013-07:00",
        "UserIDCreated": 20,
        "UserIDUpdated": 21,
        "CompanyCode": "sample string 22",
        "IsExcludeDiscount": true
      }
    ],
    "ValidRecord": true,
    "CompanyName": "sample string 15",
    "ScheduledSendTimeCheck": "2026-08-03T21:44:13.6406013-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": "afbe8838-a36d-4bb8-bbcf-2bab916bb0ad",
    "EncounterId": 1,
    "CaseNo": 1,
    "ServiceId": 1,
    "EccCaseTypeId": 1,
    "DocumentType": "sample string 24",
    "ValidFlag": true,
    "DateCreated": "2026-08-03T21:44:13.6406013-07:00",
    "DateUpdated": "2026-08-03T21:44:13.6406013-07:00",
    "UserIDCreated": 28,
    "UserIDUpdated": 29,
    "CompanyCode": "sample string 30",
    "IsExcludeDiscount": true
  },
  "id": "sample string 5",
  "rid": "8644e0f1-8ee3-4c94-a9ca-97c2adf71cfb",
  "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": "2026-08-03T21:44:13.6406013-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": "2026-08-03T21:44:13.6406013-07:00",
      "DateUpdated": "2026-08-03T21:44:13.6406013-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": "2026-08-03T21:44:13.6406013-07:00",
      "DateUpdated": "2026-08-03T21:44:13.6406013-07:00",
      "UserIDCreated": 8,
      "UserIDUpdated": 9,
      "CompanyCode": "sample string 10",
      "IsExcludeDiscount": true
    }
  ],
  "EncounterStatus": 10,
  "ValidFlag": true,
  "DateCreated": "2026-08-03T21:44:13.6406013-07:00",
  "DateUpdated": "2026-08-03T21:44:13.6406013-07:00",
  "UserIDCreated": 14,
  "UserIDUpdated": 15,
  "CompanyCode": "sample string 16",
  "IsExcludeDiscount": true
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AsapResponseOfFaxEncounterDTO

Name	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": "2026-08-03T21:44:13.7626423-07:00",
      "ScheduleTime": "sample string 11",
      "ScheduledSendTime": "2026-08-03T21:44:13.7626423-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-03T21:44:13.7626423-07:00",
          "DateUpdated": "2026-08-03T21:44:13.7626423-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-03T21:44:13.7626423-07:00",
          "DateUpdated": "2026-08-03T21:44:13.7626423-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-03T21:44:13.7626423-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-03T21:44:13.7626423-07:00",
          "DateUpdated": "2026-08-03T21:44:13.7626423-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-03T21:44:13.7626423-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-03T21:44:13.7626423-07:00",
          "DateUpdated": "2026-08-03T21:44:13.7626423-07:00",
          "UserIDCreated": 20,
          "UserIDUpdated": 21,
          "CompanyCode": "sample string 22",
          "IsExcludeDiscount": true
        }
      ],
      "ValidRecord": true,
      "CompanyName": "sample string 15",
      "ScheduledSendTimeCheck": "2026-08-03T21:44:13.7626423-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": "30cf649f-f0b3-42a5-b853-3d8bc08a27cb",
      "EncounterId": 1,
      "CaseNo": 1,
      "ServiceId": 1,
      "EccCaseTypeId": 1,
      "DocumentType": "sample string 24",
      "ValidFlag": true,
      "DateCreated": "2026-08-03T21:44:13.7626423-07:00",
      "DateUpdated": "2026-08-03T21:44:13.7626423-07:00",
      "UserIDCreated": 28,
      "UserIDUpdated": 29,
      "CompanyCode": "sample string 30",
      "IsExcludeDiscount": true
    },
    "id": "sample string 5",
    "rid": "28acefad-6a37-4325-9e5b-bb920baed212",
    "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": "2026-08-03T21:44:13.7626423-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": "2026-08-03T21:44:13.7626423-07:00",
        "DateUpdated": "2026-08-03T21:44:13.7626423-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": "2026-08-03T21:44:13.7626423-07:00",
        "DateUpdated": "2026-08-03T21:44:13.7626423-07:00",
        "UserIDCreated": 8,
        "UserIDUpdated": 9,
        "CompanyCode": "sample string 10",
        "IsExcludeDiscount": true
      }
    ],
    "EncounterStatus": 10,
    "ValidFlag": true,
    "DateCreated": "2026-08-03T21:44:13.7626423-07:00",
    "DateUpdated": "2026-08-03T21:44:13.7626423-07:00",
    "UserIDCreated": 14,
    "UserIDUpdated": 15,
    "CompanyCode": "sample string 16",
    "IsExcludeDiscount": true
  },
  "totalCount": 3
}