Help Page Services API

https://developer.bestrxconnect.com/TestBestRxHelpPagesService

https://developer.bestrxconnect.com/TestBestRxHelpPagesService
Operations
BestRxHelpPages
GET /BestRxHelpPages/getdynamicurl
GET - GetDynamicUrl
GET /BestRxHelpPages/getdynamicurl

This endpoint is used to get dynamic url.

Request parameters

PageName
string optional

Responses

200 200

Success

Body
Examples:
{
    "data": "",
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "3"
        }
    ]
}
Example with response data

{
    "data": "",
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "2"
        }
    ]
}
GenerateURL
POST /GenerateURL/addupdatemapping
POST /GenerateURL/geturllist
POST - AddUpdateMapping
POST /GenerateURL/addupdatemapping

This endpoint is save and update URl.

Request body

application/json
Example:
{
    "offset": 1,
    "pageSize": 1,
    "orderBy": "",
    "orderOn": "",
    "dynamicURL": "",
    "staticURL": "",
    "searchFor": "",
    "program": 1,
    "urlId": 1
}

Responses

200 200

Success

Body
Examples:
{
    "data": "",
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "4"
        }
    ]
}
Example with response data

{
    "data":"test",
    "isValid":true,
    "messages":[]
}
POST - GetUrlList
POST /GenerateURL/geturllist

This endpoint is used to get short url list with pagename and program like BestRx,POS and Esig.

Request body

application/json
Example:
{
    "offset": 1,
    "pageSize": 1,
    "orderBy": "",
    "orderOn": "",
    "dynamicURL": "",
    "staticURL": "",
    "searchFor": "",
    "program": 1,
    "urlId": 1
}

Responses

200 200

Success

Body
Examples:
{
    "data": "",
    "totalcount": 1,
    "listgenerateUrls": [
        {
            "dynamicurl": "",
            "staticurl": "",
            "urlid": 1,
            "program": "1"
        }
    ],
    "isValid": true,
    "messages": {
        "MessageCode": "",
        "Message": "",
        "MessageType": "1"
    }
}
Example with response data

{
  "data": {
    "totalCount": 268,
    "listgenerateUrls": [
      {
        "dynamicURL": "https://www.google.com/search?q=how+to+convert+number+to+words+in+excel&rlz=1C1SQJL_enIN969IN969&oq=How+to+convert&aqs=chrome.5.69i57j0i512l9.4488j0j7&sourceid=chrome&ie=UTF-8",
        "staticURL": "test",
        "urlId": 269,
        "program": 1
      },
      {
        "dynamicURL": "https://bestrxps.atlassian.net/wiki/spaces/BRXHLP/pages/876871722/NPLEX+PSE+Meth+Check",
        "staticURL": "POS_CR_Other",
        "urlId": 268,
        "program": 2
      },
      {
        "dynamicURL": "https://bestrxps.atlassian.net/wiki/spaces/BRXHLP/pages/876871722/NPLEX+PSE+Meth+Check",
        "staticURL": "POS_CR_Payment",
        "urlId": 267,
        "program": 2
      },
      {
        "dynamicURL": "https://bestrxps.atlassian.net/wiki/spaces/BRXHLP/pages/876871722/NPLEX+PSE+Meth+Check",
        "staticURL": "POS_CR_Layaway",
        "urlId": 266,
        "program": 2
      },
      {
        "dynamicURL": "https://bestrxps.atlassian.net/wiki/spaces/BRXHLP/pages/876871722/NPLEX+PSE+Meth+Check",
        "staticURL": "POS_CR_SalesRep",
        "urlId": 265,
        "program": 2
      },
      {
        "dynamicURL": "https://bestrxps.atlassian.net/wiki/spaces/BRXHLP/pages/876871722/NPLEX+PSE+Meth+Check",
        "staticURL": "POS_CR_ItemSelect",
        "urlId": 264,
        "program": 2
      },
      {
        "dynamicURL": "https://bestrxps.atlassian.net/wiki/spaces/BRXHLP/pages/876871722/NPLEX+PSE+Meth+Check",
        "staticURL": "POS_CR_GetRxbyPatient",
        "urlId": 263,
        "program": 2
      },
      {
        "dynamicURL": "https://bestrxps.atlassian.net/wiki/spaces/BRXHLP/pages/876871722/NPLEX+PSE+Meth+Check",
        "staticURL": "POS_CR_CalCulator",
        "urlId": 262,
        "program": 2
      },
      {
        "dynamicURL": "https://bestrxps.atlassian.net/wiki/spaces/BRXHLP/pages/876871722/NPLEX+PSE+Meth+Check",
        "staticURL": "POS_CR_AgeCheck",
        "urlId": 261,
        "program": 2
      },
      {
        "dynamicURL": "https://bestrxps.atlassian.net/wiki/spaces/BRXHLP/pages/876871722/NPLEX+PSE+Meth+Check",
        "staticURL": "POS_CR_Tender",
        "urlId": 260,
        "program": 2
      }
    ]
  },
  "isValid": true,
  "messages": []
}
Type Definitions
UrlRequestModel
Object
offset
integer int32
pageSize
integer int32
orderBy
string
orderOn
string
dynamicURL
string
staticURL
string
searchFor
string
program
integer int32
urlId
integer int32
ResponseGenericInfo
Object
Example:
{
    "data": "",
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "3"
        }
    ]
}
data
string
IsValid
boolean
Messages
Array of MessageInfo
MessageInfo
Object
MessageCode
string
Message
string
MessageType
integer
Enumeration:
0

Information

1

Warning

2

Error

3

Success

4

Unknown

ResponseGenericInfo[UrlResponseModel]
Object
Example:
{
    "data": "",
    "totalcount": 1,
    "listgenerateUrls": [
        {
            "dynamicurl": "",
            "staticurl": "",
            "urlid": 1,
            "program": "1"
        }
    ],
    "isValid": true,
    "messages": {
        "MessageCode": "",
        "Message": "",
        "MessageType": "2"
    }
}
data
string
totalcount
integer
listgenerateUrls
Array of GenerateUrl
isValid
boolean
messages
GenerateUrl
Object
dynamicurl
string
staticurl
string
urlid
integer
program
integer
Enumeration:
1

BestRx

2

POS

3

ESig