IPrimeSuiteAPI REST API Documentation

UserSettingsGet

Method: POST

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

Request Format: Xml or Json

Request XML Example (schema):

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

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"
    }
  },
  "Section": [
    0
  ]
}

Response Format: Xml

Response XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<UserSettingsGetResponse>
  <ActivePatients>
    <LastName>String Content</LastName>
    <Firstname>String Content</Firstname>
    <DOB>String Content</DOB>
    <MiddleName>String Content</MiddleName>
    <CurrentDocStatus1>String Content</CurrentDocStatus1>
    <CurrentDocStatus2>String Content</CurrentDocStatus2>
    <CurrentDocStatus3>String Content</CurrentDocStatus3>
    <CurrentDocStatus4>String Content</CurrentDocStatus4>
    <CurrentDocType1>String Content</CurrentDocType1>
    <CurrentDocType2>String Content</CurrentDocType2>
    <CurrentDocType3>String Content</CurrentDocType3>
    <CurrentDocType4>String Content</CurrentDocType4>
    <CurrentDocID1>String Content</CurrentDocID1>
    <CurrentDocID2>String Content</CurrentDocID2>
    <CurrentDocID3>String Content</CurrentDocID3>
    <CurrentDocID4>String Content</CurrentDocID4>
    <VisitID>String Content</VisitID>
    <PatientID>String Content</PatientID>
  </ActivePatients>
</UserSettingsGetResponse>

Response Format: Json

Response Example (schema):

{
  "ActivePatients": [
    {
      "LastName": "String Content",
      "Firstname": "String Content",
      "DOB": "String Content",
      "MiddleName": "String Content",
      "CurrentDocStatus1": "String Content",
      "CurrentDocStatus2": "String Content",
      "CurrentDocStatus3": "String Content",
      "CurrentDocStatus4": "String Content",
      "CurrentDocType1": "String Content",
      "CurrentDocType2": "String Content",
      "CurrentDocType3": "String Content",
      "CurrentDocType4": "String Content",
      "CurrentDocID1": "String Content",
      "CurrentDocID2": "String Content",
      "CurrentDocID3": "String Content",
      "CurrentDocID4": "String Content",
      "VisitID": "String Content",
      "PatientID": "String Content"
    }
  ]
}