IPrimeSuiteAPI REST API Documentation


InsurancePlanSearch


Method: POST

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

Request Format: Xml or Json

Request XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<InsurancePlanSearchRequest>
  <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>
  <PageStart>0</PageStart>
  <PlanName>String Content</PlanName>
  <PlanNumber>String Content</PlanNumber>
  <AddressLine>String Content</AddressLine>
  <City>String Content</City>
  <ZipCode>String Content</ZipCode>
  <State>0</State>
  <CategoryID>String Content</CategoryID>
  <CompanyID>String Content</CompanyID>
  <EmployerID>String Content</EmployerID>
  <ClassID>String Content</ClassID>
</InsurancePlanSearchRequest>

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"
    }
  },
  "PageSize": 0,
  "PageStart": 0,
  "PlanName": "String Content",
  "PlanNumber": "String Content",
  "AddressLine": "String Content",
  "City": "String Content",
  "ZipCode": "String Content",
  "State": 0,
  "CategoryID": "String Content",
  "CompanyID": "String Content",
  "EmployerID": "String Content",
  "ClassID": "String Content"
}

Response Format: Xml

Response XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<InsurancePlanSearchResponse>
  <InsurancePlans>
    <PlanID>String Content</PlanID>
    <InsuranceID>String Content</InsuranceID>
    <InsuranceName>String Content</InsuranceName>
    <PlanName>String Content</PlanName>
    <InsDocVisitCoPay>0</InsDocVisitCoPay>
    <EffectiveFrom>String Content</EffectiveFrom>
    <EffectiveTo>String Content</EffectiveTo>
    <EligibilityStatus>String Content</EligibilityStatus>
    <CompanyName>String Content</CompanyName>
    <PlanNumber>String Content</PlanNumber>
    <Address>
      <AddressID>0</AddressID>
      <Country>0</Country>
      <CountryName></CountryName>
      <AddressLine1>String Content</AddressLine1>
      <AddressLine2>String Content</AddressLine2>
      <City>String Content</City>
      <PostalCode>String Content</PostalCode>
      <State>0</State>
      <StateString></StateString>
      <County>String Content</County>
      <FaxNumber>String Content</FaxNumber>
      <PhoneNumber1>String Content</PhoneNumber1>
      <PhoneNumber2>String Content</PhoneNumber2>
    </Address>
  </InsurancePlans>
  <TotalRows>0</TotalRows>
</InsurancePlanSearchResponse>

Response Format: Json

Response Example (schema):

{
  "InsurancePlans": [
    {
      "PlanID": "String Content",
      "InsuranceID": "String Content",
      "InsuranceName": "String Content",
      "PlanName": "String Content",
      "InsDocVisitCoPay": 0.0,
      "EffectiveFrom": "String Content",
      "EffectiveTo": "String Content",
      "EligibilityStatus": "String Content",
      "CompanyName": "String Content",
      "PlanNumber": "String Content",
      "Address": {
        "AddressID": 0,
        "Country": 0,
        "CountryName": "",
        "AddressLine1": "String Content",
        "AddressLine2": "String Content",
        "City": "String Content",
        "PostalCode": "String Content",
        "State": 0,
        "StateString": "",
        "County": "String Content",
        "FaxNumber": "String Content",
        "PhoneNumber1": "String Content",
        "PhoneNumber2": "String Content"
      }
    }
  ],
  "TotalRows": 0
}