POST api/NTMedicalRecodeRequest/SendFax

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	integer	None.
MedicalRecordRequestId	integer	None.
ScheduleTime	date	None.
ScheduledDate	date	None.
CoverPageSubject	string	String length: inclusive between 0 and 8000
CoverPageComments	string	String length: inclusive between 0 and 8000
CoverPageTemplateUrl	string	String length: inclusive between 0 and 300
ListFaxRecipient	Collection of FaxRecipientListDTO	None.
ListFaxAttachment	Collection of DocumentListDTO	None.
SenderEmailAddress	string	String length: inclusive between 0 and 8000
SenderFaxNumber	string	String length: inclusive between 0 and 8000
SenderName	string	String length: inclusive between 0 and 8000
SenderPhoneNumber	string	String length: inclusive between 0 and 8000
HasCoverPage	boolean	None.
IsCurrentScheduleTime	boolean	None.
Response	string	String length: inclusive between 0 and 8000
ResponseUniqId	string	String length: inclusive between 0 and 50
FaxQueueId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "MedicalRecordRequestId": 2,
  "ScheduleTime": "2024-11-21T00:30:13.5723066-08:00",
  "ScheduledDate": "2024-11-21T00:30:13.5723066-08:00",
  "CoverPageSubject": "sample string 3",
  "CoverPageComments": "sample string 4",
  "CoverPageTemplateUrl": "sample string 5",
  "ListFaxRecipient": [
    {
      "FaxRecipientId": 1,
      "FaxNumber": "sample string 2",
      "RecipientName": "sample string 3",
      "RecipientPhoneNumber": "sample string 4",
      "FaxStatus": 5,
      "CountryCode": "sample string 6",
      "FaxQueueId": 1
    },
    {
      "FaxRecipientId": 1,
      "FaxNumber": "sample string 2",
      "RecipientName": "sample string 3",
      "RecipientPhoneNumber": "sample string 4",
      "FaxStatus": 5,
      "CountryCode": "sample string 6",
      "FaxQueueId": 1
    }
  ],
  "ListFaxAttachment": [
    {
      "FaxAttachmentId": 1,
      "Id": 2,
      "DocumentName": "sample string 3",
      "MedicalRecordRequestId": "sample string 4",
      "KeyName": "sample string 5",
      "ServiceUrl": "sample string 6",
      "BucketName": "sample string 7",
      "ContentByteArray": "QEA=",
      "AttachmentType": 1,
      "EncodedContent": "sample string 8",
      "FaxQueueId": 1,
      "RecordId": "sample string 9"
    },
    {
      "FaxAttachmentId": 1,
      "Id": 2,
      "DocumentName": "sample string 3",
      "MedicalRecordRequestId": "sample string 4",
      "KeyName": "sample string 5",
      "ServiceUrl": "sample string 6",
      "BucketName": "sample string 7",
      "ContentByteArray": "QEA=",
      "AttachmentType": 1,
      "EncodedContent": "sample string 8",
      "FaxQueueId": 1,
      "RecordId": "sample string 9"
    }
  ],
  "SenderEmailAddress": "sample string 6",
  "SenderFaxNumber": "sample string 7",
  "SenderName": "sample string 8",
  "SenderPhoneNumber": "sample string 9",
  "HasCoverPage": true,
  "IsCurrentScheduleTime": true,
  "Response": "sample string 12",
  "ResponseUniqId": "sample string 13",
  "FaxQueueId": 14
}

application/xml, text/xml

Sample:

<MRRFaxDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ASAP_BL.BL">
  <CoverPageComments>sample string 4</CoverPageComments>
  <CoverPageSubject>sample string 3</CoverPageSubject>
  <CoverPageTemplateUrl>sample string 5</CoverPageTemplateUrl>
  <FaxQueueId>14</FaxQueueId>
  <HasCoverPage>true</HasCoverPage>
  <Id>1</Id>
  <IsCurrentScheduleTime>true</IsCurrentScheduleTime>
  <ListFaxAttachment>
    <DocumentListDTO>
      <AttachmentType>1</AttachmentType>
      <BucketName>sample string 7</BucketName>
      <ContentByteArray>QEA=</ContentByteArray>
      <DocumentName>sample string 3</DocumentName>
      <EncodedContent>sample string 8</EncodedContent>
      <FaxAttachmentId>1</FaxAttachmentId>
      <FaxQueueId>1</FaxQueueId>
      <Id>2</Id>
      <KeyName>sample string 5</KeyName>
      <MedicalRecordRequestId>sample string 4</MedicalRecordRequestId>
      <RecordId>sample string 9</RecordId>
      <ServiceUrl>sample string 6</ServiceUrl>
    </DocumentListDTO>
    <DocumentListDTO>
      <AttachmentType>1</AttachmentType>
      <BucketName>sample string 7</BucketName>
      <ContentByteArray>QEA=</ContentByteArray>
      <DocumentName>sample string 3</DocumentName>
      <EncodedContent>sample string 8</EncodedContent>
      <FaxAttachmentId>1</FaxAttachmentId>
      <FaxQueueId>1</FaxQueueId>
      <Id>2</Id>
      <KeyName>sample string 5</KeyName>
      <MedicalRecordRequestId>sample string 4</MedicalRecordRequestId>
      <RecordId>sample string 9</RecordId>
      <ServiceUrl>sample string 6</ServiceUrl>
    </DocumentListDTO>
  </ListFaxAttachment>
  <ListFaxRecipient>
    <FaxRecipientListDTO>
      <CountryCode>sample string 6</CountryCode>
      <FaxNumber>sample string 2</FaxNumber>
      <FaxQueueId>1</FaxQueueId>
      <FaxRecipientId>1</FaxRecipientId>
      <FaxStatus>5</FaxStatus>
      <RecipientName>sample string 3</RecipientName>
      <RecipientPhoneNumber>sample string 4</RecipientPhoneNumber>
    </FaxRecipientListDTO>
    <FaxRecipientListDTO>
      <CountryCode>sample string 6</CountryCode>
      <FaxNumber>sample string 2</FaxNumber>
      <FaxQueueId>1</FaxQueueId>
      <FaxRecipientId>1</FaxRecipientId>
      <FaxStatus>5</FaxStatus>
      <RecipientName>sample string 3</RecipientName>
      <RecipientPhoneNumber>sample string 4</RecipientPhoneNumber>
    </FaxRecipientListDTO>
  </ListFaxRecipient>
  <MedicalRecordRequestId>2</MedicalRecordRequestId>
  <Response>sample string 12</Response>
  <ResponseUniqId>sample string 13</ResponseUniqId>
  <ScheduleTime>2024-11-21T00:30:13.5723066-08:00</ScheduleTime>
  <ScheduledDate>2024-11-21T00:30:13.5723066-08:00</ScheduledDate>
  <SenderEmailAddress>sample string 6</SenderEmailAddress>
  <SenderFaxNumber>sample string 7</SenderFaxNumber>
  <SenderName>sample string 8</SenderName>
  <SenderPhoneNumber>sample string 9</SenderPhoneNumber>
</MRRFaxDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AsapResponseOfMRRFaxDTO

Name	Type	Additional information
isSuccess	boolean	None.
message	string	None.
jsonObj	MRRFaxDTO	None.
totalCount	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "isSuccess": true,
  "message": "sample string 2",
  "jsonObj": {
    "Id": 1,
    "MedicalRecordRequestId": 2,
    "ScheduleTime": "2024-11-21T00:30:13.6191986-08:00",
    "ScheduledDate": "2024-11-21T00:30:13.6191986-08:00",
    "CoverPageSubject": "sample string 3",
    "CoverPageComments": "sample string 4",
    "CoverPageTemplateUrl": "sample string 5",
    "ListFaxRecipient": [
      {
        "FaxRecipientId": 1,
        "FaxNumber": "sample string 2",
        "RecipientName": "sample string 3",
        "RecipientPhoneNumber": "sample string 4",
        "FaxStatus": 5,
        "CountryCode": "sample string 6",
        "FaxQueueId": 1
      },
      {
        "FaxRecipientId": 1,
        "FaxNumber": "sample string 2",
        "RecipientName": "sample string 3",
        "RecipientPhoneNumber": "sample string 4",
        "FaxStatus": 5,
        "CountryCode": "sample string 6",
        "FaxQueueId": 1
      }
    ],
    "ListFaxAttachment": [
      {
        "FaxAttachmentId": 1,
        "Id": 2,
        "DocumentName": "sample string 3",
        "MedicalRecordRequestId": "sample string 4",
        "KeyName": "sample string 5",
        "ServiceUrl": "sample string 6",
        "BucketName": "sample string 7",
        "ContentByteArray": "QEA=",
        "AttachmentType": 1,
        "EncodedContent": "sample string 8",
        "FaxQueueId": 1,
        "RecordId": "sample string 9"
      },
      {
        "FaxAttachmentId": 1,
        "Id": 2,
        "DocumentName": "sample string 3",
        "MedicalRecordRequestId": "sample string 4",
        "KeyName": "sample string 5",
        "ServiceUrl": "sample string 6",
        "BucketName": "sample string 7",
        "ContentByteArray": "QEA=",
        "AttachmentType": 1,
        "EncodedContent": "sample string 8",
        "FaxQueueId": 1,
        "RecordId": "sample string 9"
      }
    ],
    "SenderEmailAddress": "sample string 6",
    "SenderFaxNumber": "sample string 7",
    "SenderName": "sample string 8",
    "SenderPhoneNumber": "sample string 9",
    "HasCoverPage": true,
    "IsCurrentScheduleTime": true,
    "Response": "sample string 12",
    "ResponseUniqId": "sample string 13",
    "FaxQueueId": 14
  },
  "totalCount": 3
}

application/xml, text/xml

Sample:

<AsapResponseOfMRRFaxDTO3NYuOdgi 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:CoverPageComments>sample string 4</d2p1:CoverPageComments>
    <d2p1:CoverPageSubject>sample string 3</d2p1:CoverPageSubject>
    <d2p1:CoverPageTemplateUrl>sample string 5</d2p1:CoverPageTemplateUrl>
    <d2p1:FaxQueueId>14</d2p1:FaxQueueId>
    <d2p1:HasCoverPage>true</d2p1:HasCoverPage>
    <d2p1:Id>1</d2p1:Id>
    <d2p1:IsCurrentScheduleTime>true</d2p1:IsCurrentScheduleTime>
    <d2p1:ListFaxAttachment>
      <d2p1:DocumentListDTO>
        <d2p1:AttachmentType>1</d2p1:AttachmentType>
        <d2p1:BucketName>sample string 7</d2p1:BucketName>
        <d2p1:ContentByteArray>QEA=</d2p1:ContentByteArray>
        <d2p1:DocumentName>sample string 3</d2p1:DocumentName>
        <d2p1:EncodedContent>sample string 8</d2p1:EncodedContent>
        <d2p1:FaxAttachmentId>1</d2p1:FaxAttachmentId>
        <d2p1:FaxQueueId>1</d2p1:FaxQueueId>
        <d2p1:Id>2</d2p1:Id>
        <d2p1:KeyName>sample string 5</d2p1:KeyName>
        <d2p1:MedicalRecordRequestId>sample string 4</d2p1:MedicalRecordRequestId>
        <d2p1:RecordId>sample string 9</d2p1:RecordId>
        <d2p1:ServiceUrl>sample string 6</d2p1:ServiceUrl>
      </d2p1:DocumentListDTO>
      <d2p1:DocumentListDTO>
        <d2p1:AttachmentType>1</d2p1:AttachmentType>
        <d2p1:BucketName>sample string 7</d2p1:BucketName>
        <d2p1:ContentByteArray>QEA=</d2p1:ContentByteArray>
        <d2p1:DocumentName>sample string 3</d2p1:DocumentName>
        <d2p1:EncodedContent>sample string 8</d2p1:EncodedContent>
        <d2p1:FaxAttachmentId>1</d2p1:FaxAttachmentId>
        <d2p1:FaxQueueId>1</d2p1:FaxQueueId>
        <d2p1:Id>2</d2p1:Id>
        <d2p1:KeyName>sample string 5</d2p1:KeyName>
        <d2p1:MedicalRecordRequestId>sample string 4</d2p1:MedicalRecordRequestId>
        <d2p1:RecordId>sample string 9</d2p1:RecordId>
        <d2p1:ServiceUrl>sample string 6</d2p1:ServiceUrl>
      </d2p1:DocumentListDTO>
    </d2p1:ListFaxAttachment>
    <d2p1:ListFaxRecipient>
      <d2p1:FaxRecipientListDTO>
        <d2p1:CountryCode>sample string 6</d2p1:CountryCode>
        <d2p1:FaxNumber>sample string 2</d2p1:FaxNumber>
        <d2p1:FaxQueueId>1</d2p1:FaxQueueId>
        <d2p1:FaxRecipientId>1</d2p1:FaxRecipientId>
        <d2p1:FaxStatus>5</d2p1:FaxStatus>
        <d2p1:RecipientName>sample string 3</d2p1:RecipientName>
        <d2p1:RecipientPhoneNumber>sample string 4</d2p1:RecipientPhoneNumber>
      </d2p1:FaxRecipientListDTO>
      <d2p1:FaxRecipientListDTO>
        <d2p1:CountryCode>sample string 6</d2p1:CountryCode>
        <d2p1:FaxNumber>sample string 2</d2p1:FaxNumber>
        <d2p1:FaxQueueId>1</d2p1:FaxQueueId>
        <d2p1:FaxRecipientId>1</d2p1:FaxRecipientId>
        <d2p1:FaxStatus>5</d2p1:FaxStatus>
        <d2p1:RecipientName>sample string 3</d2p1:RecipientName>
        <d2p1:RecipientPhoneNumber>sample string 4</d2p1:RecipientPhoneNumber>
      </d2p1:FaxRecipientListDTO>
    </d2p1:ListFaxRecipient>
    <d2p1:MedicalRecordRequestId>2</d2p1:MedicalRecordRequestId>
    <d2p1:Response>sample string 12</d2p1:Response>
    <d2p1:ResponseUniqId>sample string 13</d2p1:ResponseUniqId>
    <d2p1:ScheduleTime>2024-11-21T00:30:13.6191986-08:00</d2p1:ScheduleTime>
    <d2p1:ScheduledDate>2024-11-21T00:30:13.6191986-08:00</d2p1:ScheduledDate>
    <d2p1:SenderEmailAddress>sample string 6</d2p1:SenderEmailAddress>
    <d2p1:SenderFaxNumber>sample string 7</d2p1:SenderFaxNumber>
    <d2p1:SenderName>sample string 8</d2p1:SenderName>
    <d2p1:SenderPhoneNumber>sample string 9</d2p1:SenderPhoneNumber>
  </jsonObj>
  <message>sample string 2</message>
  <totalCount>3</totalCount>
</AsapResponseOfMRRFaxDTO3NYuOdgi>