IPrimeSuiteAPI REST API Documentation


FaxQSearch


Method: POST

URI Template: https://api-test.greenwaymedical.com/Integration/RESTv1.0/PrimeSuiteAPIService/Fax/FaxQSearch

Request Format: Xml or Json

Request XML Example (schema): 

<?xml version="1.0" encoding="utf-16"?>
<FaxQSearchRequest>
  <Credentials>
    <PrimeSuiteCredential>
      <PrimeSuiteSiteId>String Content</PrimeSuiteSiteId>
      <PrimeSuiteUserName>String Content</PrimeSuiteUserName>
      <PrimeSuiteUserPassword>String Content</PrimeSuiteUserPassword>
      <PrimeSuiteUserAlias>String Content</PrimeSuiteUserAlias>
    </PrimeSuiteCredential>
    <VendorCredential>
      <VendorLogin>String Content</VendorLogin>
      <VendorPassword>String Content</VendorPassword>
    </VendorCredential>
  </Credentials>
  <Header>
    <SourceSiteID>String Content</SourceSiteID>
    <DestinationSiteID>String Content</DestinationSiteID>
    <PrimeSuiteUserID>0</PrimeSuiteUserID>
  </Header>
  <FaxDocumentType>0</FaxDocumentType>
  <AutoFaxType>2</AutoFaxType>
  <UserID>0</UserID>
  <FaxJobQID>0</FaxJobQID>
  <AllUsersFlag>false</AllUsersFlag>
</FaxQSearchRequest>

Request Json Example (schema): 

{
  "Credentials": {
    "PrimeSuiteCredential": {
      "PrimeSuiteSiteId": "String Content",
      "PrimeSuiteUserName": "String Content",
      "PrimeSuiteUserPassword": "String Content",
      "PrimeSuiteUserAlias": "String Content"
    },
    "VendorCredential": {
      "VendorLogin": "String Content",
      "VendorPassword": "String Content"
    }
  },
  "Header": {
    "SourceSiteID": "String Content",
    "DestinationSiteID": "String Content",
    "PrimeSuiteUserID": 0
  },
  "FaxDocumentType": 0,
  "AutoFaxType": 2,
  "UserID": 0,
  "FaxJobQID": 0,
  "AllUsersFlag": false
}

Response Format: Xml

Response XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<FaxQSearchResponse>
  <FaxQItems>
    <JobQID>0</JobQID>
    <FaxType>0</FaxType>
    <DocumentId>0</DocumentId>
    <SequenceNumber>0</SequenceNumber>
    <Recipient>String Content</Recipient>
    <Subject>String Content</Subject>
    <Description>String Content</Description>
    <FaxNumber>String Content</FaxNumber>
    <IsAutoFax>0</IsAutoFax>
    <CreateDateTime>0001-01-01T00:00:00</CreateDateTime>
    <UserID>0</UserID>
  </FaxQItems>
</FaxQSearchResponse>

Response Format: Json

Response Example (schema):

{
  "FaxQItems": [
    {
      "JobQID": 0,
      "FaxType": 0,
      "DocumentId": 0,
      "SequenceNumber": 0,
      "Recipient": "String Content",
      "Subject": "String Content",
      "Description": "String Content",
      "FaxNumber": "String Content",
      "IsAutoFax": 0,
      "CreateDateTime": "0001-01-01T00:00:00",
      "UserID": 0
    }
  ]
}