BCSWeb Logging Service API

Operations
CommunicationLogging
POST /CommunicationLogging/Inititalized
POST /CommunicationLogging/SendToPharmacy
POST /CommunicationLogging/ReceivedByPharmacy
POST /CommunicationLogging/ProcessByPharmacy
POST /CommunicationLogging/ResponseFromPharmacy
POST /CommunicationLogging/ResponseToRequester
POST /CommunicationLogging/RemoveOldLogTable
GET /CommunicationLogging/GetRequestInformation
POST /CommunicationLogging/GetPharmacyRequestList
POST - Inititalized
POST /CommunicationLogging/Inititalized

Request headers

Authorization
string optional

Basic Auth

x-access-token
string optional

Access Token

x-device-serial-no
string optional

Device Serial Number

Request body

application/json
text/json
application/xml
text/xml
Example:
{
    "IsResponseRequired": true,
    "ServiceProvider": "AzureQueue",
    "Environment": 1,
    "RequestId": "",
    "PharmacyNumber": "",
    "NotificationType": ""
}

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Examples:
{
    "Data": true,
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Error"
        }
    ]
}
Example with response data

{
    "Data": "",
    "IsValid": true,
    "Messages": []
}
POST - SendToPharmacy
POST /CommunicationLogging/SendToPharmacy

Request headers

Authorization
string optional

Basic Auth

x-access-token
string optional

Access Token

x-device-serial-no
string optional

Device Serial Number

Request body

application/json
text/json
application/xml
text/xml
Example:
{
    "IsPharmacyConnected": true,
    "PharmacyQueueName": "",
    "PharmacyConnectionId": "",
    "SendToPharmacyMessage": "",
    "RequestId": "",
    "PharmacyNumber": "",
    "NotificationType": ""
}

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Examples:
{
    "Data": true,
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Success"
        }
    ]
}
Example with response data

{
    "Data": "",
    "IsValid": true,
    "Messages": []
}
POST - ReceivedByPharmacy
POST /CommunicationLogging/ReceivedByPharmacy

Request headers

Authorization
string optional

Basic Auth

x-access-token
string optional

Access Token

x-device-serial-no
string optional

Device Serial Number

Request body

application/json
text/json
application/xml
text/xml
Example:
{
    "ReceivedByPharmacy": true,
    "ReceivedByPharmacyMessage": "",
    "ReceivedByPharmacyRoutingName": "",
    "RequestId": "",
    "PharmacyNumber": "",
    "NotificationType": ""
}

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Examples:
{
    "Data": true,
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Information"
        }
    ]
}
Example with response data

{
    "Data": "",
    "IsValid": true,
    "Messages": []
}
POST - ProcessByPharmacy
POST /CommunicationLogging/ProcessByPharmacy

Request headers

Authorization
string optional

Basic Auth

x-access-token
string optional

Access Token

x-device-serial-no
string optional

Device Serial Number

Request body

application/json
text/json
application/xml
text/xml
Example:
{
    "ProcessByPharmacy": true,
    "ProcessByPharmacyMessage": "",
    "RequestId": "",
    "PharmacyNumber": "",
    "NotificationType": ""
}

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Examples:
{
    "Data": true,
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Error"
        }
    ]
}
Example with response data

{
    "Data": "",
    "IsValid": true,
    "Messages": []
}
POST - ResponseFromPharmacy
POST /CommunicationLogging/ResponseFromPharmacy

Request headers

Authorization
string optional

Basic Auth

x-access-token
string optional

Access Token

x-device-serial-no
string optional

Device Serial Number

Request body

application/json
text/json
application/xml
text/xml
Example:
{
    "ResponseFromPharmacy": true,
    "ResponseFromChannel": "None",
    "ResponseFromPharmacyMessage": "",
    "RequestId": "",
    "PharmacyNumber": "",
    "NotificationType": ""
}

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Examples:
{
    "Data": true,
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Warning"
        }
    ]
}
Example with response data

{
    "Data": "",
    "IsValid": true,
    "Messages": []
}
POST - ResponseToRequester
POST /CommunicationLogging/ResponseToRequester

Request headers

Authorization
string optional

Basic Auth

x-access-token
string optional

Access Token

x-device-serial-no
string optional

Device Serial Number

Request body

application/json
text/json
application/xml
text/xml
Example:
{
    "ResponseToRequester": true,
    "ResponseToRequesterMessage": "",
    "RequestId": "",
    "PharmacyNumber": "",
    "NotificationType": ""
}

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Examples:
{
    "Data": true,
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Success"
        }
    ]
}
Example with response data

{
    "Data": "",
    "IsValid": true,
    "Messages": []
}
POST - RemoveOldLogTable
POST /CommunicationLogging/RemoveOldLogTable

Request headers

Authorization
string optional

Basic Auth

x-access-token
string optional

Access Token

x-device-serial-no
string optional

Device Serial Number

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Examples:
{
    "Data": true,
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Unknown"
        }
    ]
}
Example with response data

{
    "Data": "",
    "IsValid": true,
    "Messages": []
}
GET - GetRequestInformation
GET /CommunicationLogging/GetRequestInformation

Request parameters

pharmacyNumber
string required
requestId
string required

Request headers

Authorization
string optional

Basic Auth

x-access-token
string optional

Access Token

x-device-serial-no
string optional

Device Serial Number

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Examples:
{
    "Data": {
        "CreateDate": "",
        "ModifiedDate": "",
        "IsResponseRequired": true,
        "ServiceProvider": "AzureQueue",
        "Environment": 1,
        "RequestDate": "",
        "IsPharmacyConnected": true,
        "PharmacyQueueName": "Test_Queue",
        "PharmacyConnectionId": "",
        "SendToPharmacyMessage": "",
        "SendToPharmacyDate": "",
        "ReceivedByPharmacy": true,
        "ReceivedByPharmacyMessage": "",
        "ReceivedByPharmacyRoutingName": "",
        "ReceivedByPharmacyDate": "",
        "ProcessByPharmacy": true,
        "ProcessByPharmacyMessage": "",
        "ProcessByPharmacyDate": "",
        "ResponseFromPharmacy": true,
        "ResponseFromChannel": "RabbitMQ",
        "ResponseFromPharmacyMessage": "",
        "ResponseFromPharmacyDate": "",
        "ResponseToRequester": true,
        "ResponseToRequesterMessage": "",
        "ResponseToRequesterDate": "",
        "RequestId": "",
        "PharmacyNumber": "",
        "NotificationType": ""
    },
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Error"
        }
    ]
}
2021-07-10Example with response data

{
    "Data": {
        "CreateDate": "2021-07-01",
        "ModifiedDate": "2021-07-08",
        "IsResponseRequired": true,
        "ServiceProvider": "AzureQueue",
        "Environment": 1,
        "RequestDate": "2021-07-10",
        "IsPharmacyConnected": true,
        "PharmacyQueueName": "TEMP012753-abb591ba-383a-4e03-ba32-0335181eca6d-BRXRENDER01-OBD",
        "PharmacyConnectionId": "",
        "SendToPharmacyMessage": "",
        "SendToPharmacyDate": "",
        "ReceivedByPharmacy": true,
        "ReceivedByPharmacyMessage": "testMessage",
        "ReceivedByPharmacyRoutingName": "",
        "ReceivedByPharmacyDate": "",
        "ProcessByPharmacy": true,
        "ProcessByPharmacyMessage": "test",
        "ProcessByPharmacyDate": "",
        "ResponseFromPharmacy": true,
        "ResponseFromChannel": "RabbitMQ",
        "ResponseFromPharmacyMessage": "This is message from BestRx Pharmacy.",
        "ResponseFromPharmacyDate": "",
        "ResponseToRequester": true,
        "ResponseToRequesterMessage": "",
        "ResponseToRequesterDate": "2021-07-10",
        "RequestId": "",
        "PharmacyNumber": "TEMP012753",
        "NotificationType": ""
    },
    "IsValid": true,
    "Messages": []
}
POST - GetPharmacyRequestList
POST /CommunicationLogging/GetPharmacyRequestList

Request headers

Authorization
string optional

Basic Auth

x-access-token
string optional

Access Token

x-device-serial-no
string optional

Device Serial Number

Request body

application/json
text/json
application/xml
text/xml
Example:
{
    "PharmacyNumber": "",
    "FromDate": "",
    "ToDate": "",
    "IsResponseRequired": true,
    "Environment": 1,
    "IsPharmacyConnected": true,
    "ReceivedByPharmacy": true,
    "ProcessByPharmacy": true,
    "ResponseFromPharmacy": true,
    "ResponseToRequester": true
}

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Examples:
{
    "Data": [
        {
            "CreateDate": "",
            "ModifiedDate": "",
            "IsResponseRequired": true,
            "ServiceProvider": "AzureQueue",
            "Environment": 1,
            "RequestDate": "",
            "IsPharmacyConnected": true,
            "PharmacyQueueName": "5n201167--abb591ba-383a-4e03-ba32-0335181eca6d-BRXRENDER01-OBD",
            "PharmacyConnectionId": "",
            "SendToPharmacyMessage": "",
            "SendToPharmacyDate": "",
            "ReceivedByPharmacy": true,
            "ReceivedByPharmacyMessage": "",
            "ReceivedByPharmacyRoutingName": "",
            "ReceivedByPharmacyDate": "",
            "ProcessByPharmacy": true,
            "ProcessByPharmacyMessage": "",
            "ProcessByPharmacyDate": "",
            "ResponseFromPharmacy": true,
            "ResponseFromChannel": "AzureQueue",
            "ResponseFromPharmacyMessage": "",
            "ResponseFromPharmacyDate": "",
            "ResponseToRequester": true,
            "ResponseToRequesterMessage": "",
            "ResponseToRequesterDate": "",
            "RequestId": "",
            "PharmacyNumber": "",
            "NotificationType": ""
        }
    ],
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Success"
        }
    ]
}
Examplw with response data

{
    "Data": {
        "CreateDate": "2021-07-01",
        "ModifiedDate": "2021-07-08",
        "IsResponseRequired": true,
        "ServiceProvider": "AzureQueue",
        "Environment": 1,
        "RequestDate": "2021-07-10",
        "IsPharmacyConnected": true,
        "PharmacyQueueName": "TEMP012753-abb591ba-383a-4e03-ba32-0335181eca6d-BRXRENDER01-OBD",
        "PharmacyConnectionId": "",
        "SendToPharmacyMessage": "",
        "SendToPharmacyDate": "",
        "ReceivedByPharmacy": true,
        "ReceivedByPharmacyMessage": "testMessage",
        "ReceivedByPharmacyRoutingName": "",
        "ReceivedByPharmacyDate": "",
        "ProcessByPharmacy": true,
        "ProcessByPharmacyMessage": "test",
        "ProcessByPharmacyDate": "",
        "ResponseFromPharmacy": true,
        "ResponseFromChannel": "RabbitMQ",
        "ResponseFromPharmacyMessage": "This is message from BestRx Pharmacy.",
        "ResponseFromPharmacyDate": "",
        "ResponseToRequester": true,
        "ResponseToRequesterMessage": "",
        "ResponseToRequesterDate": "2021-07-10",
        "RequestId": "",
        "PharmacyNumber": "TEMP012753",
        "NotificationType": ""
    },
    "IsValid": true,
    "Messages": []
}
PharmacyMessage
POST /PharmacyMessage/Logging
GET /PharmacyMessage/ReadLog
POST /PharmacyMessage/GetNightTechData
POST /PharmacyMessage/GetNightTechDataCount
GET /PharmacyMessage/SendSummaryEmailByType
GET /PharmacyMessage/GetMessage
GET /PharmacyMessage/RemoveOldFiles
POST - Logging
POST /PharmacyMessage/Logging

Request headers

Authorization
string optional

Basic Auth

x-access-token
string optional

Access Token

x-device-serial-no
string optional

Device Serial Number

Request body

application/json
text/json
application/xml
text/xml
Example:
{
    "PharmacyNumber": "",
    "LoggingTypeId": 1,
    "MessageTypeId": 1,
    "ComputerName": "",
    "MacAddress": "",
    "ProgramName": "",
    "Version": "",
    "Message": ""
}

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Examples:
{
    "Data": true,
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Unknown"
        }
    ]
}
Example with response data

{
    "Data": "",
    "IsValid": true,
    "Messages": []
}
GET - ReadLog
GET /PharmacyMessage/ReadLog

Request headers

Authorization
string optional

Basic Auth

x-access-token
string optional

Access Token

x-device-serial-no
string optional

Device Serial Number

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Examples:
{
    "Data": true,
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Unknown"
        }
    ]
}
Example with response data

{
    "Data": "",
    "IsValid": true,
    "Messages": []
}
POST - GetNightTechData
POST /PharmacyMessage/GetNightTechData

Request headers

Authorization
string optional

Basic Auth

x-access-token
string optional

Access Token

x-device-serial-no
string optional

Device Serial Number

Request body

application/json
text/json
application/xml
text/xml
Example:
{
    "FromDate": "",
    "ToDate": "",
    "MessageType": "Warning",
    "PharmacyIds": ""
}

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Examples:
{
    "Data": [
        {
            "MessageType": "Exception",
            "PharmacyNumber": "",
            "PharmacyName": "",
            "NightTechLoggingInfo": {
                "StartDate": "",
                "EndDate": "",
                "ExitReason": "",
                "Exception": "",
                "AddedToAPQueue": 1,
                "RefillCreated": 1,
                "CannotAutoFill": 1,
                "CashRx": 1,
                "ClaimApproved": 1,
                "ClaimNotSent": 1,
                "ClaimRejected": 1,
                "LabelNotPrinted": 1,
                "LabelPrinted": 1
            }
        }
    ],
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Error"
        }
    ]
}
Example with response data

{
    "Data": [
        {
            "MessageType": "Exception",
            "PharmacyNumber": "5N201167",
            "PharmacyName": "BestRx Pharmacy",
            "NightTechLoggingInfo": {
                "StartDate": "2018-09-01",
                "EndDate": "2020-09-01",
                "ExitReason": "not provide facility.",
                "Exception": "",
                "AddedToAPQueue": 1,
                "RefillCreated": 1,
                "CannotAutoFill": 1,
                "CashRx": 1,
                "ClaimApproved": 1,
                "ClaimNotSent": 1,
                "ClaimRejected": 1,
                "LabelNotPrinted": 1,
                "LabelPrinted": 1
            }
        }
    ],
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Unknown"
        }
    ]
}
POST - GetNightTechDataCount
POST /PharmacyMessage/GetNightTechDataCount

Request headers

Authorization
string optional

Basic Auth

x-access-token
string optional

Access Token

x-device-serial-no
string optional

Device Serial Number

Request body

application/json
text/json
application/xml
text/xml
Example:
{
    "FromDate": "",
    "ToDate": "",
    "MessageType": "Exception",
    "PharmacyIds": ""
}

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Examples:
{
    "Data": 1,
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Warning"
        }
    ]
}
Example with response data

{
    "Data": "",
    "IsValid": true,
    "Messages": []
}
GET - SendSummaryEmailByType
GET /PharmacyMessage/SendSummaryEmailByType

Request parameters

sendEmailType
string required
Enumeration:
None
Immediately
Daily
Weekly
Monthly

Request headers

Authorization
string optional

Basic Auth

x-access-token
string optional

Access Token

x-device-serial-no
string optional

Device Serial Number

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Examples:
{
    "Data": true,
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Information"
        }
    ]
}
Example with response data

{
    "Data": "",
    "IsValid": true,
    "Messages": []
}
GET - GetMessage
GET /PharmacyMessage/GetMessage

Request parameters

messageId
integer int32 required
isEncrypted
boolean required

Request headers

Authorization
string optional

Basic Auth

x-access-token
string optional

Access Token

x-device-serial-no
string optional

Device Serial Number

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Examples:
{
    "Data": "",
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Warning"
        }
    ]
}
Example with response data

{
    "Data": "",
    "IsValid": true,
    "Messages": []
}
GET - RemoveOldFiles
GET /PharmacyMessage/RemoveOldFiles

Request parameters

directoryName
string required

Request headers

Authorization
string optional

Basic Auth

x-access-token
string optional

Access Token

x-device-serial-no
string optional

Device Serial Number

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Examples:
{
    "Data": 1,
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Error"
        }
    ]
}
Example with response data

{
    "Data": "",
    "IsValid": true,
    "Messages": []
}
Type Definitions
BestRx.Communication.Model.Logging.RequestInititalizedInfo
Object
IsResponseRequired
boolean
ServiceProvider
string
Enumeration:
None
RabbitMQ
RabbitMQRPC
AzureQueue
SignalR
Environment
integer int32
RequestId
string
PharmacyNumber
string
NotificationType
string
BCSWeb.Model.ResponseGenericInfo[System.Boolean]
Object
Data
boolean
IsValid
boolean
Messages
BCSWeb.Model.MessageInfo
Object
MessageCode
string
Message
string
MessageType
string
Enumeration:
Information
Warning
Error
Success
Unknown
BestRx.Communication.Model.Logging.SendToPharmacyInfo
Object
IsPharmacyConnected
boolean
PharmacyQueueName
string
PharmacyConnectionId
string
SendToPharmacyMessage
string
RequestId
string
PharmacyNumber
string
NotificationType
string
BestRx.Communication.Model.Logging.ReceivedByPharmacyInfo
Object
ReceivedByPharmacy
boolean
ReceivedByPharmacyMessage
string
ReceivedByPharmacyRoutingName
string
RequestId
string
PharmacyNumber
string
NotificationType
string
BestRx.Communication.Model.Logging.ProcessByPharmacyInfo
Object
ProcessByPharmacy
boolean
ProcessByPharmacyMessage
string
RequestId
string
PharmacyNumber
string
NotificationType
string
BestRx.Communication.Model.Logging.ResponseFromPharmacyInfo
Object
ResponseFromPharmacy
boolean
ResponseFromChannel
string
Enumeration:
None
RabbitMQ
RabbitMQRPC
AzureQueue
SignalR
ResponseFromPharmacyMessage
string
RequestId
string
PharmacyNumber
string
NotificationType
string
BestRx.Communication.Model.Logging.ResponseToRequesterInfo
Object
ResponseToRequester
boolean
ResponseToRequesterMessage
string
RequestId
string
PharmacyNumber
string
NotificationType
string
BCSWeb.Model.ResponseGenericInfo[BestRx.Communication.Model.Logging.CommunicationRequestLogInfo]
BestRx.Communication.Model.Logging.CommunicationRequestLogInfo
Object
CreateDate
string date-time
ModifiedDate
string date-time
IsResponseRequired
boolean
ServiceProvider
string
Enumeration:
None
RabbitMQ
RabbitMQRPC
AzureQueue
SignalR
Environment
integer int32
RequestDate
string date-time
IsPharmacyConnected
boolean
PharmacyQueueName
string
PharmacyConnectionId
string
SendToPharmacyMessage
string
SendToPharmacyDate
string date-time
ReceivedByPharmacy
boolean
ReceivedByPharmacyMessage
string
ReceivedByPharmacyRoutingName
string
ReceivedByPharmacyDate
string date-time
ProcessByPharmacy
boolean
ProcessByPharmacyMessage
string
ProcessByPharmacyDate
string date-time
ResponseFromPharmacy
boolean
ResponseFromChannel
string
Enumeration:
None
RabbitMQ
RabbitMQRPC
AzureQueue
SignalR
ResponseFromPharmacyMessage
string
ResponseFromPharmacyDate
string date-time
ResponseToRequester
boolean
ResponseToRequesterMessage
string
ResponseToRequesterDate
string date-time
RequestId
string
PharmacyNumber
string
NotificationType
string
BestRx.Communication.Model.Logging.PharmacyRequestInfo
Object
PharmacyNumber
string
FromDate
string date-time
ToDate
string date-time
IsResponseRequired
boolean
Environment
integer int32
IsPharmacyConnected
boolean
ReceivedByPharmacy
boolean
ProcessByPharmacy
boolean
ResponseFromPharmacy
boolean
ResponseToRequester
boolean
BCSWeb.Model.ResponseGenericInfo[System.Collections.Generic.List[BestRx.Communication.Model.Logging.CommunicationRequestLogInfo]]
Object
BCSWeb.Model.MessageLoggingRequest
Object
PharmacyNumber
string required
LoggingTypeId
integer int32
MessageTypeId
integer int32
ComputerName
string
MacAddress
string
ProgramName
string
Version
string
Message
string
BCSWeb.Model.NightTechReportRequest
Object
FromDate
string date-time
ToDate
string date-time
MessageType
string
Enumeration:
None
Message
Warning
Exception
PharmacyIds
string
BCSWeb.Model.ResponseGenericInfo[System.Collections.Generic.List[BCSWeb.Model.NightTechReportResponse]]
Object
IsValid
boolean
Messages
BCSWeb.Model.NightTechReportResponse
Object
MessageType
string
Enumeration:
None
Message
Warning
Exception
PharmacyNumber
string
PharmacyName
string
NightTechLoggingInfo
BCSWeb.Model.NightTechLoggingInfo
Object
StartDate
string date-time
EndDate
string date-time
ExitReason
string
Exception
string
AddedToAPQueue
integer int32
RefillCreated
integer int32
CannotAutoFill
integer int32
CashRx
integer int32
ClaimApproved
integer int32
ClaimNotSent
integer int32
ClaimRejected
integer int32
LabelNotPrinted
integer int32
LabelPrinted
integer int32
BCSWeb.Model.ResponseGenericInfo[System.Int32]
Object
Data
integer int32
IsValid
boolean
Messages
BCSWeb.Model.ResponseGenericInfo[System.String]
Object
Data
string
IsValid
boolean
Messages