IPrimeSuiteAPI REST API Documentation


FaxDocumentGet


Method: POST

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

Request Format: Xml or Json

Request XML Example (schema): 

<?xml version="1.0" encoding="utf-16"?>
<FaxQDocumentGetRequest>
  <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>
  <FaxQItemID>0</FaxQItemID>
  <ExportType>2</ExportType>
</FaxQDocumentGetRequest>

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
  },
  "FaxQItemID": 0,
  "ExportType": 2
}

Response Format: Xml

Response XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<FaxQDocumentGetResponse>
  <FaxJobQID>0</FaxJobQID>
  <FaxDocumentID>0</FaxDocumentID>
  <CreateDateTime>String Content</CreateDateTime>
  <FaxedByName>String Content</FaxedByName>
  <FaxDocumentType>0</FaxDocumentType>
  <FileType>String Content</FileType>
  <Data>String Content</Data>
</FaxQDocumentGetResponse>

Response Format: Json

Response Example (schema):

{
  "FaxJobQID": 0,
  "FaxDocumentID": 0,
  "CreateDateTime": "String Content",
  "FaxedByName": "String Content",
  "FaxDocumentType": 0,
  "FileType": "String Content",
  "Data": "String Content"
}