IPrimeSuiteAPI REST API Documentation

PatientFlagsGet

Method: POST

URI Template: https://api-test.greenwaymedical.com/Integration/RESTv1.0/PrimeSuiteAPIService/Patient/PatientFlagsGet

Request Format: Xml or Json

Request XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<FlagsGetRequest>
  <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>
  <PatientId>0</PatientId>
</FlagsGetRequest>

Request Json Example (schema):

{
  "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"
    }
  },
  "PatientId": 0
}

Response Format: Xml

Response XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<FlagsGetResponse>
  <Flag>
    <RegFlagId>0</RegFlagId>
    <FlagLabel>String Content</FlagLabel>
    <AltFlagLabel>String Content</AltFlagLabel>
    <AltFlagValue>0</AltFlagValue>
    <CategoryName>String Content</CategoryName>
    <Url>String Content</Url>
    <Icon>String Content</Icon>
    <IconPath>String Content</IconPath>
  </Flag>
</FlagsGetResponse>

Response Format: Json

Response Example (schema):

{
  "Flag": [
    {
      "RegFlagId": 0,
      "FlagLabel": "String Content",
      "AltFlagLabel": "String Content",
      "AltFlagValue": 0.0,
      "CategoryName": "String Content",
      "Url": "String Content",
      "Icon": "String Content",
      "IconPath": "String Content"
    }
  ]
}