IPrimeSuiteAPI REST API Documentation

AuthenticateUser

Method: POST

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

Request Format: Xml or Json

Request XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<UserAuthenticateRequest>
  <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>
  <DomainUser>false</DomainUser>
</UserAuthenticateRequest>

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
  },
  "DomainUser": false
}

Response Format: Xml

Response XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<UserAuthenticateResponse>
  <CareProviderID>0</CareProviderID>
  <CareProviderName>String Content</CareProviderName>
  <LoginStatus>String Content</LoginStatus>
  <FailureReason>String Content</FailureReason>
  <PrimeSuiteUserIdSpecified>false</PrimeSuiteUserIdSpecified>
  <UserFullName>String Content</UserFullName>
  <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>
</UserAuthenticateResponse>

Response Format: Json

Response Example (schema):

{
  "CareProviderID": 0,
  "CareProviderName": "String Content",
  "LoginStatus": "String Content",
  "FailureReason": "String Content",
  "PrimeSuiteUserIdSpecified": false,
  "UserFullName": "String Content",
  "Credentials": {
    "PrimeSuiteCredential": {
      "PrimeSuiteSiteId": "String Content",
      "PrimeSuiteUserName": "String Content",
      "PrimeSuiteUserPassword": "String Content",
      "PrimeSuiteUserAlias": "String Content"
    },
    "VendorCredential": {
      "VendorLogin": "String Content",
      "VendorPassword": "String Content"
    }
  }
}