IPrimeSuiteAPI REST API Documentation


VisitTypeListGet


Method: POST

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

Request Format: Xml or Json

Request XML Example (schema): 

<?xml version="1.0" encoding="utf-16"?>
<VisitTypeListGetRequest>
  <StandardName>String Content</StandardName>
  <PageSize>0</PageSize>
  <PageStart>0</PageStart>
  <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>
</VisitTypeListGetRequest>

Request Json Example (schema): 

{
  "StandardName": "String Content",
  "PageSize": 0,
  "PageStart": 0,
  "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"
    }
  }
}

Response Format: Xml

Response XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<VisitTypeListGetResponse>
  <VisitTypes>
    <VisitTypeID>0</VisitTypeID>
    <LocalName>String Content</LocalName>
    <StandardName>String Content</StandardName>
    <Description>String Content</Description>
    <IsDefaultField>String Content</IsDefaultField>
    <Enabled>0</Enabled>
    <DefaultLocationID>0</DefaultLocationID>
    <Billable>0</Billable>
    <OnSite>0</OnSite>
    <Clinical>0</Clinical>
    <DefaultPracticeLocationID>0</DefaultPracticeLocationID>
    <AutoPrintSuperBill>0</AutoPrintSuperBill>
    <SuperBillID>String Content</SuperBillID>
  </VisitTypes>
  <TotalRows>0</TotalRows>
</VisitTypeListGetResponse>

Response Format: Json

Response Example (schema):

{
  "VisitTypes": [
    {
      "VisitTypeID": 0.0,
      "LocalName": "String Content",
      "StandardName": "String Content",
      "Description": "String Content",
      "IsDefaultField": "String Content",
      "Enabled": 0,
      "DefaultLocationID": 0,
      "Billable": 0,
      "OnSite": 0,
      "Clinical": 0,
      "DefaultPracticeLocationID": 0,
      "AutoPrintSuperBill": 0,
      "SuperBillID": "String Content"
    }
  ],
  "TotalRows": 0
}