GET api/Fax/GetFaxEncounter?q={q}

Request Information

URI Parameters

Name	Description	Type	Additional information
q		string	Required

Body Parameters

None.

Response Information

Resource Description

AsapResponseOfListOfGetFaxEncounterDetails

Name	Type	Additional information
isSuccess	boolean	None.
message	string	None.
jsonObj	Collection of GetFaxEncounterDetails	None.
totalCount	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "isSuccess": true,
  "message": "sample string 2",
  "jsonObj": [
    {
      "FaxQueueId": 1,
      "FaxEncounterId": 2,
      "EncounterId": 1,
      "CaseNo": 3,
      "DocumentType": "sample string 4",
      "Sequence": 5,
      "SentTime": "2025-04-04T05:19:37.9751946-07:00",
      "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-04-04T05:19:37.9761968-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-04-04T05:19:37.9781962-07:00",
          "DateUpdated": "2025-04-04T05:19:37.9781962-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-04-04T05:19:37.9761968-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-04-04T05:19:37.9781962-07:00",
          "DateUpdated": "2025-04-04T05:19:37.9781962-07:00",
          "UserIDCreated": 20,
          "UserIDUpdated": 21,
          "CompanyCode": "sample string 22",
          "IsExcludeDiscount": true
        }
      ],
      "ResponseUniqId": "sample string 6",
      "ScheduledSendTime": "2025-04-04T05:19:37.9791931-07:00",
      "FaxType": "sample string 7",
      "ServiceId": 8,
      "EccCaseTypeId": 1,
      "ComponentName": "sample string 9"
    },
    {
      "FaxQueueId": 1,
      "FaxEncounterId": 2,
      "EncounterId": 1,
      "CaseNo": 3,
      "DocumentType": "sample string 4",
      "Sequence": 5,
      "SentTime": "2025-04-04T05:19:37.9751946-07:00",
      "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-04-04T05:19:37.9761968-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-04-04T05:19:37.9781962-07:00",
          "DateUpdated": "2025-04-04T05:19:37.9781962-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-04-04T05:19:37.9761968-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-04-04T05:19:37.9781962-07:00",
          "DateUpdated": "2025-04-04T05:19:37.9781962-07:00",
          "UserIDCreated": 20,
          "UserIDUpdated": 21,
          "CompanyCode": "sample string 22",
          "IsExcludeDiscount": true
        }
      ],
      "ResponseUniqId": "sample string 6",
      "ScheduledSendTime": "2025-04-04T05:19:37.9791931-07:00",
      "FaxType": "sample string 7",
      "ServiceId": 8,
      "EccCaseTypeId": 1,
      "ComponentName": "sample string 9"
    }
  ],
  "totalCount": 3
}

application/xml, text/xml

Sample:

<AsapResponseOfArrayOfGetFaxEncounterDetails3NYuOdgi 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:GetFaxEncounterDetails>
      <d2p1:CaseNo>3</d2p1:CaseNo>
      <d2p1:ComponentName>sample string 9</d2p1:ComponentName>
      <d2p1:DocumentType>sample string 4</d2p1:DocumentType>
      <d2p1:EccCaseTypeId>1</d2p1:EccCaseTypeId>
      <d2p1:EncounterId>1</d2p1:EncounterId>
      <d2p1:FaxEncounterId>2</d2p1:FaxEncounterId>
      <d2p1:FaxQueueId>1</d2p1:FaxQueueId>
      <d2p1:FaxType>sample string 7</d2p1:FaxType>
      <d2p1:ListFaxRecipient>
        <d2p1:FaxRecipientDTO>
          <d2p1:CompanyCode>sample string 22</d2p1:CompanyCode>
          <d2p1:DateCreated>2025-04-04T05:19:37.9781962-07:00</d2p1:DateCreated>
          <d2p1:DateUpdated>2025-04-04T05:19:37.9781962-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-04-04T05:19:37.9761968-07:00</d2p1:SentTime>
        </d2p1:FaxRecipientDTO>
        <d2p1:FaxRecipientDTO>
          <d2p1:CompanyCode>sample string 22</d2p1:CompanyCode>
          <d2p1:DateCreated>2025-04-04T05:19:37.9781962-07:00</d2p1:DateCreated>
          <d2p1:DateUpdated>2025-04-04T05:19:37.9781962-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-04-04T05:19:37.9761968-07:00</d2p1:SentTime>
        </d2p1:FaxRecipientDTO>
      </d2p1:ListFaxRecipient>
      <d2p1:ResponseUniqId>sample string 6</d2p1:ResponseUniqId>
      <d2p1:ScheduledSendTime>2025-04-04T05:19:37.9791931-07:00</d2p1:ScheduledSendTime>
      <d2p1:SentTime>2025-04-04T05:19:37.9751946-07:00</d2p1:SentTime>
      <d2p1:Sequence>5</d2p1:Sequence>
      <d2p1:ServiceId>8</d2p1:ServiceId>
    </d2p1:GetFaxEncounterDetails>
    <d2p1:GetFaxEncounterDetails>
      <d2p1:CaseNo>3</d2p1:CaseNo>
      <d2p1:ComponentName>sample string 9</d2p1:ComponentName>
      <d2p1:DocumentType>sample string 4</d2p1:DocumentType>
      <d2p1:EccCaseTypeId>1</d2p1:EccCaseTypeId>
      <d2p1:EncounterId>1</d2p1:EncounterId>
      <d2p1:FaxEncounterId>2</d2p1:FaxEncounterId>
      <d2p1:FaxQueueId>1</d2p1:FaxQueueId>
      <d2p1:FaxType>sample string 7</d2p1:FaxType>
      <d2p1:ListFaxRecipient>
        <d2p1:FaxRecipientDTO>
          <d2p1:CompanyCode>sample string 22</d2p1:CompanyCode>
          <d2p1:DateCreated>2025-04-04T05:19:37.9781962-07:00</d2p1:DateCreated>
          <d2p1:DateUpdated>2025-04-04T05:19:37.9781962-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-04-04T05:19:37.9761968-07:00</d2p1:SentTime>
        </d2p1:FaxRecipientDTO>
        <d2p1:FaxRecipientDTO>
          <d2p1:CompanyCode>sample string 22</d2p1:CompanyCode>
          <d2p1:DateCreated>2025-04-04T05:19:37.9781962-07:00</d2p1:DateCreated>
          <d2p1:DateUpdated>2025-04-04T05:19:37.9781962-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-04-04T05:19:37.9761968-07:00</d2p1:SentTime>
        </d2p1:FaxRecipientDTO>
      </d2p1:ListFaxRecipient>
      <d2p1:ResponseUniqId>sample string 6</d2p1:ResponseUniqId>
      <d2p1:ScheduledSendTime>2025-04-04T05:19:37.9791931-07:00</d2p1:ScheduledSendTime>
      <d2p1:SentTime>2025-04-04T05:19:37.9751946-07:00</d2p1:SentTime>
      <d2p1:Sequence>5</d2p1:Sequence>
      <d2p1:ServiceId>8</d2p1:ServiceId>
    </d2p1:GetFaxEncounterDetails>
  </jsonObj>
  <message>sample string 2</message>
  <totalCount>3</totalCount>
</AsapResponseOfArrayOfGetFaxEncounterDetails3NYuOdgi>