IPrimeSuiteAPI REST API Documentation


ClinicalTemplateListGet


Method: POST

URI Template: https://api-test.greenwaymedical.com/Integration/RESTv1.0/PrimeSuiteAPIService/ClinicalTemplate/ClinicalTemplateListGet

Request Format: Xml or Json

Request XML Example (schema): 

<?xml version="1.0" encoding="utf-16"?>
<ClinicalTemplateListGetRequest>
  <TemplateUserID>0</TemplateUserID>
  <DocType>0</DocType>
  <Header>
    <SourceSiteID>String Content</SourceSiteID>
    <DestinationSiteID>String Content</DestinationSiteID>
    <PrimeSuiteUserID>0</PrimeSuiteUserID>
  </Header>
  <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>
</ClinicalTemplateListGetRequest>

Request Json Example (schema): 

{
  "TemplateUserID": 0,
  "DocType": 0,
  "Header": {
    "SourceSiteID": "String Content",
    "DestinationSiteID": "String Content",
    "PrimeSuiteUserID": 0
  },
  "Credentials": {
    "PrimeSuiteCredential": {
      "PrimeSuiteSiteId": "String Content",
      "PrimeSuiteUserName": "String Content",
      "PrimeSuiteUserPassword": "String Content",
      "PrimeSuiteUserAlias": "String Content"
    },
    "VendorCredential": {
      "VendorLogin": "String Content",
      "VendorPassword": "String Content"
    }
  }
}

Response Format: Xml

Response XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<ClinicalTemplateListGetResponse>
  <ClinicalTemplates>
    <FolderID>0</FolderID>
    <ParentFolderID>0</ParentFolderID>
    <FolderName>String Content</FolderName>
    <FolderDescription>String Content</FolderDescription>
    <Templates>
      <TemplateID>0</TemplateID>
      <TemplateName>String Content</TemplateName>
      <TemplateDescription>String Content</TemplateDescription>
      <TemplateType>String Content</TemplateType>
    </Templates>
  </ClinicalTemplates>
</ClinicalTemplateListGetResponse>

Response Format: Json

Response Example (schema):

{
  "ClinicalTemplates": [
    {
      "FolderID": 0,
      "ParentFolderID": 0,
      "FolderName": "String Content",
      "FolderDescription": "String Content",
      "Templates": [
        {
          "TemplateID": 0,
          "TemplateName": "String Content",
          "TemplateDescription": "String Content",
          "TemplateType": "String Content"
        }
      ]
    }
  ]
}