BCSWeb MessageRouting Service API

POST - CarrierLookup

POST /MessagingService/CarrierLookup

POST - SendMessage

POST /MessagingService/SendMessage

POST - GetMessageCount

POST /MessagingService/GetMessageCount

POST - GetShortenURL

POST /MessagingService/GetShortenURL

POST /MessagingService/CarrierLookup

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

application/x-www-form-urlencoded

BCSWeb.Model.CarrierLookupRequest

Example:

{
    "PharmacyNumber": "",
    "PhoneNumber": ""
}

Responses

200 200

OK

Body

application/json

text/json

application/xml

text/xml

BCSWeb.Model.ResponseGenericInfo[BCSWeb.Model.CarrierLookupResponse]

Examples:

{
    "Data": {
        "PhoneNumber": "",
        "IsMobile": "",
        "Carrier": ""
    },
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Unknown"
        }
    ]
}

Example with response data

{
    "Data": {
        "PhoneNumber": "7777777777",
        "IsMobile": "true",
        "Carrier": "",
        "IsValid": true
    },
    "IsValid": true,
    "Messages": []
}

POST /MessagingService/SendMessage

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

application/x-www-form-urlencoded

BCSWeb.Model.BE_MESSAGE_REQUEST

Example:

{
    "PharmacyNumber": "",
    "PhoneEmail": "",
    "PhoneEmailVerified": "",
    "MessageMethod": "",
    "MessageSubject": "",
    "MessageBody": "",
    "EntityType": 1,
    "EntityRecNo": 1,
    "EntityName": ""
}

Responses

200 200

OK

Body

application/json

text/json

application/xml

text/xml

BCSWeb.Model.ResponseGenericInfo[System.String]

Examples:

{
    "Data": "",
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Success"
        }
    ]
}

Example with response data

{
    "Data": "",
    "IsValid": true,
    "Messages": []
}

POST /MessagingService/GetMessageCount

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

application/x-www-form-urlencoded

BCSWeb.Model.MessageUsageRequest

Example:

{
    "ClientRecno": 1,
    "StartDate": "",
    "EndDate": ""
}

Responses

200 200

OK

Body

application/json

text/json

application/xml

text/xml

BCSWeb.Model.ResponseGenericInfo[BCSWeb.Model.MessageUsageResponse]

Examples:

{
    "Data": {
        "ClientRecno": 1,
        "SMSUsage": {
            "IncomingUsageUnit": 1,
            "IncomingPrice": 1,
            "OutgoingUsageUnit": 1,
            "OutgoingPrice": 1
        }
    },
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Error"
        }
    ]
}

Example with response data

{
    "Data": {
        "ClientRecno": 1,
        "SMSUsage": {
            "IncomingUsageUnit": 1,
            "IncomingPrice": 1,
            "OutgoingUsageUnit": 1,
            "OutgoingPrice": 1
        }
    },
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Error"
        }
    ]
}

POST /MessagingService/GetShortenURL

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

application/x-www-form-urlencoded

BCSWeb.Model.ShortenURLRequest

Example:

{
    "URL": "",
    "PharmacyNumber": ""
}

Responses

200 200

OK

Body

application/json

text/json

application/xml

text/xml

BCSWeb.Model.ResponseGenericInfo[System.String]

Examples:

{
    "Data": "",
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Error"
        }
    ]
}

Example with response data

{
    "Data": "",
    "IsValid": true,
    "Messages": []
}

Object

PharmacyNumber

string

PhoneNumber

string

Object

Data

BCSWeb.Model.CarrierLookupResponse

IsValid

boolean

Messages

Array of BCSWeb.Model.MessageInfo

Object

PhoneNumber

string

IsMobile

string

Carrier

string

Object

MessageCode

string

Message

string

MessageType

string

Enumeration:

Information

Warning

Error

Success

Unknown

Object

PharmacyNumber

string

PhoneEmail

string

PhoneEmailVerified

string

MessageMethod

string

MessageSubject

string

MessageBody

string

EntityType

integer int32

EntityRecNo

integer int32

EntityName

string

Object

Data

string

IsValid

boolean

Messages

Array of BCSWeb.Model.MessageInfo

Object

ClientRecno

integer int32

StartDate

string date-time

EndDate

string date-time

Object

Data

BCSWeb.Model.MessageUsageResponse

IsValid

boolean

Messages

Array of BCSWeb.Model.MessageInfo

Object

ClientRecno

integer int32

SMSUsage

BCSWeb.Model.SMSUsageInfo

Object

IncomingUsageUnit

integer int32

IncomingPrice

number double

OutgoingUsageUnit

integer int32

OutgoingPrice

number double

Object

URL

string

PharmacyNumber

string