IPrimeSuiteAPI REST API Documentation

VocabularyUserFavoritesGet

Method: POST

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

Request Format: Xml or Json

Request XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<VocabularyUserFavoritesGetRequest>
  <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>
  <ContextID>0</ContextID>
  <CategoryID>0</CategoryID>
  <PageNumber>0</PageNumber>
  <PageSize>0</PageSize>
</VocabularyUserFavoritesGetRequest>

Request Json Example (schema):

Could not generate example for request. Failed with error: Specified cast is not valid.

Response Format: Xml

Response XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<VocabularyUserFavoritesGetResponse>
  <FavoriteLists>
    <ConceptID>0</ConceptID>
    <ShortName>String Content</ShortName>
    <LongName>String Content</LongName>
    <SynID>0</SynID>
    <CategoryID>0</CategoryID>
    <CPTCodes>String Content</CPTCodes>
  </FavoriteLists>
  <TotalRows>0</TotalRows>
</VocabularyUserFavoritesGetResponse>

Response Format: Json

Response Example (schema):

{
  "FavoriteLists": [
    {
      "ConceptID": 0,
      "ShortName": "String Content",
      "LongName": "String Content",
      "SynID": 0,
      "CategoryID": 0,
      "CPTCodes": "String Content"
    }
  ],
  "TotalRows": 0
}