LIfeline

LifelineProofTypes_Query

Used to search for one or more Lifeline Proof Types (e.g. Award Letter, Program ID Card, Paystub, etc).

Required Input

None

Optional/Conditional Input

• LifelineProofTypeIDAs Integer – when specified, will only return an item matching this
• NameAs String – when specified, will only return an item matching this

Output

• A list of matching:
• IDAs Integer – Lifeline_Proof_Type_ID field from Rev.io's Lifeline Proof Type.
• NameAs String – Description of the Lifeline Proof Type (e.g. Award Letter)
• NotesAs String – Notes explaining the Lifeline Proof Type that should be displayed to the end-user.

LifelineStatus_Update

Change a Customer's Lifeline Status (e.g. from NEEDS_REVIEW to REJECTED or APPROVED), update other important Lifeline parameters (such as Tribal), and/or attach a Self-Certification form.

Required Input

• CustomerIDAs Integer

Optional Input

• StatusAs Enum_LIfeline_Status – Optional – possible values include:
  • NEEDS_REVIEW
  • APPROVED
  • REJECTED
  • NEEDS_FORM
• TribalAs Boolean – Optional – indicates the customer qualifies for Tribal Lifeline. If not specified, the Customer's Tribal property will not be changed by this request.
• MultipleHouseholdsAs Boolean – Optional – indicates the customer is a resides in a unit made up of multiple households at the same location address.
• EconomicUnitAs Boolean – Optional – indicates the customer is a "Separate Economic Unit" as described by the FCC's Lifeline NPRM effective 4/1/2012. If not specified, the Customer's EconomicUnit property will not be changed by this request.
• TemporaryAddressAs Boolean – Optional – indicates the customer's address is considered Temporary as described by the FCC's Lifeline NPRM effective 4/1/2012. If not specified, the Customer's TemporaryAddress property will not be changed by this request.
• CertificationDateAs Date – Optional – indicates the customer's lifeline certification date or recertification date. If not specified, the Customer's CertificationDate property will not be changed by this request.
• OriginalCertificationDateAs Date – Optional – indicates the customer's original lifeline certification date. If not specified, the Customer's OriginalCertificationDate property will not be changed by this request.
• ProofTypeIDAs Integer – Optional – ID that relates to a type of Proof as configured in Rev.io (e.g. ID 1 could represent Program Award Letter, etc.)
• ProofIdentifyingInformationAs String – Optional – identifying information (such as a program ID card #) from a form of proof to be retained.
• ProofNotesAs Boolean – Optional – notes from the representative describing the proof that was reviewed.
• SelfCertificationPDFAs Byte() – Optional – upload a new Self-certification PDF for this customer.
• ProofDocumentationPDFAs Byte() – Optional – upload a new Proof Documentation PDF for this customer.
• HouseholdCountAs Integer – Optional – for Poverty-based-qualification, the number of qualified members of the household.
• AnnualIncomeAs Decimal – Optional – for Poverty-based-qualification, the annual qualified income of the household.
• LifelineTypeIDAs Integer – Optional – set the Lifeline Type ID (aka Subsidy Program) for this customer. (e.g. ID 1 could be Medicaid, etc.)
• StatusNoteAs String – Optional – Customers can now track any time a lifeline status changes and log a record to the Customer's History pane under the Lifeline_ tab on the Customer's profile when updated the V20 API.
• TPIVStatusAs Enum_TPIV_Status – Optional – Third Party Identity Verification (TPIV) Status, will be one of the values from Standard Values: Enum_TPIV_Status.
• ProgramAs Enum_Lifeline_Program – Current regulatory designation of the account.
  • NON_LIFELINE – Indicates account is not Lifeline configured.
  • ETC_LIFELINE – Indicates account is Lifeline and you are acting as the Eligible Telecommunications Carrier recognized by the State in which service is provided.
  • NON_ETC_LIFELINE – Indicates account is Lifeline and the LEC will act as the Eligible Telecommunications Carrier.

Output

• LifelineStatusIDAs Integer – Conditional – Rev.io's ID of the record created in tblLifelineStatus representing this update if applicable.
• FileIDAs Integer – Conditional – Rev.io's ID of the record created in tblFileStore representing this PDF attachment if applicable.

LifelineTypes_Query

Used to search for one or more Lifeline Types (e.g. Food Stamps, SSI, etc). Typically this is used with the State input parameter to list the Lifeline Types for a given state.

Required Input

None

Optional/Conditional Input

• LifelineProofTypeIDAs Integer – when specified, will only return an item matching this
• StateAs String – when specified, will only return items valid in this state
• NameAs String – when specified, will only return an item matching this

Output

• A list of matching:
• IDAs Integer – Lifeline_Type_ID field from Rev.io's Lifeline Type.
• NameAs String – Description of the Lifeline Type.

Examples

<LifelineTypes_Query xmlns="http://api.myh2o.com/">
    <Request>
        <Session>
            <SessionKey>xyzabc123</SessionKey>
        </Session>
        <State>FL</State>
    </Request>
</LifelineTypes_Query>

<LifelineTypes_QueryResponse xmlns="http://api.myh2o.com/">
    <LifelineTypes_QueryResult>
        <Header>
            <Success>true</Success>
            <SessionKey>xyzabc123</SessionKey>
        </Header>
        <LifelineTypes>
            <LifelineType>
                <ID>1</ID>
                <Name>Food Stamps</Name>
                <RequiresTribal>false</RequiresTribal>
            </LifelineType>
            <LifelineType>
                <ID>2</ID>
                <Name>SSI</Name>
            </LifelineType>
        </LifelineTypes>
    </LifelineTypes_QueryResult>
</LifelineTypes_QueryResponse>