IPrimeSuiteAPI REST API Documentation

VocabularyUserFavoritesCategoriesGet

Method: POST

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

Request Format: Xml or Json

Request XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<VocabularyUserFavoritesCategoriesGetRequest>
  <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>
  <PageSize>0</PageSize>
  <PageNumber>0</PageNumber>
  <ContextId>0</ContextId>
  <IncludeEmpty>true</IncludeEmpty>
</VocabularyUserFavoritesCategoriesGetRequest>

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"?>
<VocabularyUserFavoritesCategoriesGetResponse>
  <FavoritesCategories>
    <CategoryId>0</CategoryId>
    <Description>String Content</Description>
    <ConceptCount>0</ConceptCount>
  </FavoritesCategories>
  <TotalRows>0</TotalRows>
</VocabularyUserFavoritesCategoriesGetResponse>

Response Format: Json

Response Example (schema):

{
  "FavoritesCategories": [
    {
      "CategoryId": 0,
      "Description": "String Content",
      "ConceptCount": 0
    }
  ],
  "TotalRows": 0
}