Current Active Requests: Hierarchy
Welcome to the Hierarchy section of Current Active Requests. Below are options for Hierarchy (Organizations, Carriers, Groups, Plans, etc.). These sections will include descriptors of both, as well as sample requests/parameters for each.
Carrier Get
Carrier Get returns a list of Carrier Codes and Names for the client, regardless of if the Carrier is currently active or not.
Sample Request / Parameters
/Carrier
curl --location --request GET 'https://clientapi.test.ad.rxlogic.com/Carrier'
Carrier Get accepts no parameters. A sample response is seen below.
[
{
"CarrierCode": "SEED",
"CarrierName": "Seeded Carrier"
},
{
"CarrierCode": "TEST2017",
"CarrierName": "Test Carrier 2017"
}
]
/* Enter your code */
Active Carriers by Organization
Returns a list of Carriers for an Organization.
Sample Request / Parameters
/ActiveCarriersByOrg
curl -X GET --header 'Accept: application/json' --header 'apiKey: XXXXXXXX-XXXX-XXXX-XXXX-XXXX' 'https://rxltestclientapi.rxlogic.com/ActiveCarriersByOrg?orgId=1'
Active Carriers By Organization accepts a single orgId parameter, which is the numeric ID related to an organization on the RxLogic system. A sample response is below.
{
"ActiveCarriers": [
{
"CarrierId": 1,
"CarrierCode": "SEED",
"StartDateTime": "2018-08-14T08:18:30.7232829-04:00",
"EndDateTime": "2222-12-31T23:59:59.999-05:00"
},
{
"CarrierId": 30,
"CarrierCode": "TEST2017",
"StartDateTime": "2021-06-01T00:00:00+00:00",
"EndDateTime": null
}
],
"Status": {
"Code": "1",
"Description": "Success"
}
}
/* Enter your code */
Active Groups Endpoints
Returns a list of Carriers for an Organization.
Sample Request / Parameters
/ActiveGroupsByOrg
curl -X GET --header 'Accept: application/json' --header 'apiKey: XXXXXXXX-XXXX-XXXX-XXXX-XXXX' 'https://rxltestclientapi.rxlogic.com/ActiveGroupsByOrg?orgId=2'
Active Groups by Org supports only a single parameter, orgId, which is the numeric ID related to an organization on the RxLogic system.
/ActiveGroupsByCarrier
curl -X GET --header 'Accept: application/json' --header 'apiKey: XXXXXXXX-XXXX-XXXX-XXXX-XXXX' 'https://rxltestclientapi.rxlogic.com/ActiveGroupsByCarrier?carrierCode=8675'
Active Groups By Carrier accepts a single carrierCode parameter, which is the alphanumeric Carrier Code value created in the RxLogic system. A sample response is below.
{
"ActiveGroups": [
{
"GroupId": 47,
"GroupNumber": "889",
"GroupName": "NODEDTEST",
"StartDateTime": "2020-01-01T00:00:00-05:00",
"EndDateTime": "2222-12-31T00:00:00-05:00"
},
{
"GroupId": 164,
"GroupNumber": "A0025",
"GroupName": "A0025",
"StartDateTime": "2020-01-01T00:00:00+00:00",
"EndDateTime": "2029-12-31T23:59:59.999+00:00"
}
],
"Status": {
"Code": "1",
"Description": "Success"
}
}
/* Enter your code */
Group Employer Get
Group Employer Get returns a list of Carrier Code, Employer Name (Group Name), Group Number, and Organization Code for the client. Terminated groups are included in the response.
Sample Request / Parameters
/Group
curl --location --request GET 'https://clientapi.test.ad.rxlogic.com/Group'
Group Employer Get accepts no parameters. A sample response is seen below.
{
"GroupItemList": {
"GroupItems": [
{
"CarrierCode": "8675",
"EmployerName": "Seeded Group",
"GroupNum": "SEED",
"OrgCode": "AT TEST Org"
},
{
"CarrierCode": "MARY",
"EmployerName": "AT_UAT_Group",
"GroupNum": "8675",
"OrgCode": "Marys Test Organization"
},
{
"CarrierCode": "1234",
"EmployerName": "TST-JM Test Group ",
"GroupNum": "TSTJM006",
"OrgCode": "TST- James Test Org"
},
{
"CarrierCode": "12345",
"EmployerName": "Marys Test Group 1",
"GroupNum": "TEST17",
"OrgCode": "Mary Test Organization 2"
}
]
}
}
/* Enter your code */