GetScheduleOfBenefits

GetScheduleOfBenefits allows you to make an API request passing in a PayorOrgID and a BenefitPlan and recieve an XML response with a complete list of available benefits.
 
 
 

Parameters

 
  • BenefitCode: A client-defined string used to group different classes of benefits.
  • OrgID
 
 

Return Sample

<ArrayScheduleOfBenefits>
    <ScheduleOfBenefits>
        <BnftPlan>Badger</BnftPlan>
        <Description>Emergency Room Copay - $20</Description>
        <DisplayIndicator>1</DisplayIndicator>
        <DisplayOrder>1</DisplayOrder>
        <ItemId>f6f8d591-9116-4278-b0be-c84ebaba6ef6</ItemId>
        <Label>Emergency Room</Label>
        <PayorOrgId>e180f61a-afaf-43ce-a495-28c942854cd4</PayorOrgId>
        <Value>$20</Value>
        <adddatetime>2009-10-05T16:29:46.663</adddatetime>
        <moddatetime>0001-01-01T00:00:00</moddatetime>
    </ScheduleOfBenefits>
    <ScheduleOfBenefits>
        <BnftPlan>Badger</BnftPlan>
        <Description>Office Visit Copay - $20</Description>
        ...
        <moddatetime>0001-01-01T00:00:00</moddatetime>
    </ScheduleOfBenefits>
</ArrayOfScheduleOfBenefits>
 
Notes:
 
The return values Display Indicator and Display Order are convenience variables submitted by the client. We recommend you use these variables to format your display.
 
 

 
Comments