Skip to content
English
  • There are no suggestions because the search field is empty.

Current Active Requests: General

Welcome to the General section of Current Active Requests. Below are options for general sections including descriptors of both, as well as sample requests/parameters for each.

Keep Alive

Basic request that allows for a heartbeat style ping to the Client APIs to keep dns and handshake information cached for another request. A valid API key is still required for this request. 

Sample Request / Parameters

/KeepAlive

curl --location --request GET 'https://rxltestclientapi.rxlogic.com/KeepAlive' \

--header 'apiKey: 00000000-0000-0000-0000-000000000000'

NILRx (Portal Settings)

Endpoint that can be used to retrieve settings set up within the Portal Manager in the RxLogic UI, supplemented with Group related information.

Sample Request / Parameters

/NILRX

curl -X GET --header 'Accept: application/json' --header 'apiKey: 00000000-0000-0000-0000-000000000000' 'https://clientapi.dev.rxlogic.com/NILRX?route=TEST'

{
  "NILRxFAQs": [
    {
      "Id": 1,
      "NILRxConfigId": 2,
      "Priority": 5,
      "Question": "TEST",
      "Answer": "TESTANSWER"
    },
    {
      "Id": 2,
      "NILRxConfigId": 2,
      "Priority": 1,
      "Question": "What are the FAQs for?",
      "Answer": "FAQs are to answer frequently asked questions."
    }
  ],
  "NILRxPharmacyCardInfos": [
    {
      "Group": {
        "BenefitCapSatisfaction": null,
        "BenefitCapSatisfactionCopayRule": null,
        "CarrierGroups": [],
        "DeductibleNotSatisfiedCopayRule": null,
        "DeductibleSatisfaction": null,
        "DeductibleSatisfactionCopayRule": null,
        "Group_Members": [],
        "Group_Plans": [],
        "GroupAddresses": [],
        "GroupBenefitType": null,
        "GroupContacts": [],
        "GroupLocations": [],
        "MOOPSatisfaction": null,
        "MOOPSatisfactionCopayRule": null,
        "PhysicianList": null,
        "Subgroups": [],
        "Id": 251,
        "Name": "A Stable Group That Can Process Claims",
        "Number": "STABLEGROUP",
        "MemberSetupType": null,
        "AutoTerm": null,
        "AutoTermDays": null,
        "EnrollmentSource": "Adjudication",
        "PersonCodeMatching": "SubmittedPC",
        "DobMatching": "DayCount",
        "DobMatchDays": 10,
        "UseDefaultMemberPrefix": false,
        "MemberPrefix": null,
        "LogoImageId": null,
        "UseCarrierLogo": null,
        "BypassMemberEnrollment": false,
        "MemberLimitsEnabled": null,
        "GeneralLimitsEnabled": null,
        "IndividualRxLimitsEnabled": true,
        "ReferenceNumber": null,
        "AllowAutoEnroll": true,
        "AutoEnrollDependents": null,
        "AutoEnrollmentRequireFirstName": false,
        "AutoEnrollmentRequireDemographics": null,
        "AutoEnrollmentRequireLastName": false,
        "AutoEnrollmentRequireDOB": false,
        "AutoEnrollmentRequireSSN": false,
        "AutoEnrollmentRequirePersonCode": false,
        "AutoEnrollmentRequireGender": false,
        "AutoEnrollmentRequireCardholderId": false,
        "AutoEnrollmentRequireAddress": false,
        "AutoEnrollmentRequireCity": false,
        "AutoEnrollmentRequireState": false,
        "AutoEnrollmentRequireZip": false,
        "AutoEnrollmentRequirePhone": false,
        "AutoEnrollmentRequireEmail": false,
        "AutoEnrollmentRestrictDaysSupply": false,
        "AutoEnrollmentRestrictDaysSupplyDays": null,
        "AutoEnrollmentCoverageType": "Family",
        "AutoEnrollmentRequireEmployerInfo": false,
        "AutoEnrollmentRequireEmployerName": false,
        "AutoEnrollmentRequireEmployerAddress": false,
        "AutoEnrollmentRequireEmployerCity": false,
        "AutoEnrollmentRequireEmployerState": false,
        "AutoEnrollmentRequireEmployerZip": false,
        "AutoEnrollmentRequireEmployerPhone": false,
        "AutoEnrollmentRequireEmployerClaimId": false,
        "CardName": null,
        "CardTypeId": 0,
        "PrintCards": false,
        "DoNotListDependantsOnCards": null,
        "RxMaximum": 0,
        "RxMaximumDateSpanOptionType": null,
        "NumberOfDaysSpanValue": null,
        "InactiveDaysTermCount": null,
        "RebateGroupNumber": null,
        "ChildCutoff": null,
        "StudentCutoff": null,
        "PhysicianLimitsEnabled": null,
        "PhysicianValidationType": "NoCheckOnPhysician",
        "PhysicianListId": null,
        "SkipPhysicianCheckForOTC": null,
        "RestrictDaysSupply": null,
        "DaysSupplyRestrictionDays": null,
        "MaxRxDaysOld": null,
        "MaxReversalDaysOld": null,
        "MinDollarPerScript": null,
        "MinDollarPerScriptAmtType": "Sell",
        "MaxDollarPerScript": 99999,
        "SecondaryMaxDollarLimit": 2500,
        "MaxDollarPerScriptAmtType": "Sell",
        "MaxDollarPerScriptIncludeCopay": null,
        "MaxDollarLimitRejectMessage": null,
        "SalesTaxConfigTypeId": null,
        "SecondaryOnly": null,
        "PreventOnlineAdjudication": null,
        "RejectDaysFromRxWrittenDate": null,
        "BenefitYearStartDay": 1,
        "BenefitYearStartMonth": 1,
        "DeductibleSatisfactionId": 2,
        "DeductibleSatisfactionCopayRuleId": 43,
        "BenefitCapSatisfactionId": 16,
        "BenefitCapSatisfactionCopayRuleId": null,
        "MOOPSatisfactionId": 23,
        "MOOPSatisfactionCopayRuleId": null,
        "BenefitCapRejectWhenMet": null,
        "BenefitCapAddOverflowToBenefitPlanPay": null,
        "NoSpecialDeductibleCapLogic": null,
        "GenericsDoNotApplyToDeductible": null,
        "GenericsDoNotApplyToBenefitCap": null,
        "GenericsDoNotApplyToMOOP": null,
        "FormularyBrandDoNotApplyToDeductible": null,
        "FormularyBrandDoNotApplyToBenefitCap": null,
        "FormularyBrandDoNotApplyToMOOP": null,
        "OTabCopayUsedDoNotApplyToDeductible": null,
        "OTabCopayUsedDoNotApplyToBenefitCap": null,
        "OTabCopayUsedDoNotApplyToMOOP": null,
        "YTabCopayUsedDoNotApplyToDeductible": null,
        "YTabCopayUsedDoNotApplyToBenefitCap": null,
        "YTabCopayUsedDoNotApplyToMOOP": null,
        "DeductibleDoNotApplyToBenefitCap": null,
        "DeductibleDoNotApplyToMOOP": null,
        "YTabHalfCopayUsedApplyToDeductible": null,
        "YTabHalfCopayUsedApplyToBenefitCap": null,
        "YTabHalfCopayUsedApplyToMOOP": null,
        "RxDollarsApplyToDeductible": null,
        "RxDollarsApplyToBenefitCap": null,
        "RxDollarsApplyToMOOP": null,
        "DAW2DoNotApplyToDeductible": null,
        "DAW2DoNotApplyToBenefitCap": null,
        "DAW2DoNotApplyToMOOP": null,
        "IngredientCostApplyToDeductible": null,
        "IngredientCostApplyToBenefitCap": null,
        "IngredientCostApplyToMOOP": null,
        "ApplyDeductibleAfterMOOP": null,
        "PriorYearQ4CarryOverDeductible": null,
        "PriorYearQ4CarryOverMOOP": null,
        "IsSecondaryPayer": null,
        "AllowPrimaryToPayZero": null,
        "TriggerSpreadType": null,
        "TriggerSpreadValue": null,
        "MaxSpreadPercent": null,
        "InflateCopayAmount": null,
        "BillUAndCMarkupPercent": null,
        "BillSubmittedMarkupPercent": null,
        "MaxMarginValue": null,
        "MaxMarginType": null,
        "PushToCopayPercent": null,
        "RejectOnExceedMaxSpread": null,
        "SetBillTaxToPayTax": null,
        "IgnoreImportedHistoricalRecords": null,
        "IgnoreHistory": null,
        "IgnoreMemberPriorAuths": null,
        "InactiveForBilling": null,
        "RejectInactiveDrugs": null,
        "RejectRepackagedNDC": null,
        "ExcludeFromPortal": null,
        "TermCardholderSeparately": null,
        "ForceSSNCheckOnMember": null,
        "ForcePreviousCardId": null,
        "AllowOnlyPersonCode01": null,
        "DoNotRequireDateOfBirth": null,
        "RequireAddressForMembers": null,
        "RequirePreferredLanguageForMembers": null,
        "RequireGenderForMembers": null,
        "RequirePhoneForMembers": null,
        "RequirePCPInfoForMembers": null,
        "RequirePrimaryPharmacyInfoForMembers": null,
        "RequireSubgroup": null,
        "BypassAccums": false,
        "AutoEnrollFromDateOfInjury": null,
        "AutoEnrollFromDateOfInjuryDays": null,
        "RebateGroupType": "Open",
        "Broker1": null,
        "Broker2": null,
        "ReportingGroup": null,
        "CheckForstNameForTwins": false,
        "GroupCardType": null,
        "IsInvoiced": null,
        "LimitScriptsCount": null,
        "LimitScriptsDollars": null,
        "GroupBenefitTypeId": null,
        "EnableCustomCHID": null,
        "CustomCHIDFirstLength": null,
        "CustomCHIDLastLength": null,
        "CustomCHIDCarrierCodeLength": null,
        "CustomCHIDDOBFormat": null,
        "CustomCHIDIncludeGender": null,
        "RequireLocationCode": null,
        "StartDateTime": "2019-08-30T00:00:00+00:00",
        "EndDateTime": "2222-09-22T23:59:59.999+00:00",
        "Created": "2021-10-19T09:16:44.7731586-04:00",
        "CreatedBy": "jhill@rxlogic.com",
        "Changed": "2023-03-06T15:59:27.6136263-05:00",
        "ChangedBy": "jhill@rxlogic.com",
        "PersonCodeMatchType": "Dob",
        "SalesTaxConfigType": 1,
        "DeductibleNotSatisfiedCopayRuleId": 2,
        "CopayIncludes100PercentTax": true,
        "PlanPays100PercentTax": null,
        "CarrierSubmittedInGroup": false,
        "BusinessLine": null
      },
      "Id": 3,
      "NILRxConfigId": 2,
      "Bin": "001234",
      "Pcn": "TestPCN",
      "GroupId": 251,
      "HelpDeskPhone": "18009989991"
    }
  ],
  "Id": 2,
  "URL": "TEST",
  "ClientLogoPath": "string",
  "ClientLogoText": "string",
  "HeaderBackgroundColor": "string",
  "HeaderTextColor": "string",
  "FooterBackgroundColor": "string",
  "FooterTextColor": "string",
  "NavbarBackgroundColor": "string",
  "NavbarTextColor": "string"
}
/* Enter your code */

Blob

Allows retrieval of an Blob from Azure storage. The response will be the raw file details to be written into a file. 

Sample Request / Parameters

/Blob

curl --location 'https://clientapi.dev.rxlogic.com/api/Blob?blobPath=RxLogic%2FDocuments%2FUpload%2FPortal%2Frxnewlogo.png' \

--header 'Accept: application/octet-stream' \

--header 'apiKey: 00000000-0000-0000-0000-000000000000'