IPrimeSuiteAPI REST API Documentation


PreferredPharmacyListGet


Method: POST

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

Request Format: Xml or Json

Request XML Example (schema): 

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

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"?>
<PreferredPharmacyListGetResponse>
  <Pharmacy>
    <PharmacyID>0</PharmacyID>
    <ExternalPharmacyID>String Content</ExternalPharmacyID>
    <PharmacyName>String Content</PharmacyName>
    <AddressLine1>String Content</AddressLine1>
    <City>String Content</City>
    <State>String Content</State>
    <ZipCode>String Content</ZipCode>
    <Phone>String Content</Phone>
    <Fax>String Content</Fax>
    <IsAlwaysOpen>String Content</IsAlwaysOpen>
    <CanFaxScheduleIII>String Content</CanFaxScheduleIII>
    <IsActive>String Content</IsActive>
    <InUse>0</InUse>
    <DisplayName>String Content</DisplayName>
    <PatientId>0</PatientId>
    <PatientPharmacyId>0</PatientPharmacyId>
    <IsDefaultPharmacy>0</IsDefaultPharmacy>
    <NCPDPID>String Content</NCPDPID>
    <IsMailOrder>String Content</IsMailOrder>
    <NewRx>String Content</NewRx>
    <RefillRx>String Content</RefillRx>
    <CancelRx>String Content</CancelRx>
    <IsPreferred>0</IsPreferred>
    <Substitution>String Content</Substitution>
    <PharmacyNote>String Content</PharmacyNote>
    <PreferredPharmacyID>0</PreferredPharmacyID>
    <PreferredPharmacy>String Content</PreferredPharmacy>
    <AddressLine2>String Content</AddressLine2>
  </Pharmacy>
</PreferredPharmacyListGetResponse>

Response Format: Json

Response Example (schema):

{
  "Pharmacy": [
    {
      "PharmacyID": 0,
      "ExternalPharmacyID": "String Content",
      "PharmacyName": "String Content",
      "AddressLine1": "String Content",
      "City": "String Content",
      "State": "String Content",
      "ZipCode": "String Content",
      "Phone": "String Content",
      "Fax": "String Content",
      "IsAlwaysOpen": "String Content",
      "CanFaxScheduleIII": "String Content",
      "IsActive": "String Content",
      "InUse": 0,
      "DisplayName": "String Content",
      "PatientId": 0,
      "PatientPharmacyId": 0,
      "IsDefaultPharmacy": 0,
      "NCPDPID": "String Content",
      "IsMailOrder": "String Content",
      "NewRx": "String Content",
      "RefillRx": "String Content",
      "CancelRx": "String Content",
      "IsPreferred": 0,
      "Substitution": "String Content",
      "PharmacyNote": "String Content",
      "PreferredPharmacyID": 0,
      "PreferredPharmacy": "String Content",
      "AddressLine2": "String Content"
    }
  ]
}