REST
Address locations:
Headers
Header | Type | Example | Description |
|---|---|---|---|
SiteID | integer | Your PharmX SiteID for accessing the network. | |
OutboundSharedAccessKeyName | string | Your PharmX Shared Access Key Name provided by pharmx when joining the network. | |
OutboundSharedAccessKey | string | Your PharmX Shared Access Key provided by pharmx when joining the network. | |
ServiceID (Optional) | integer | An optional number, provided by PharmX that breaks your site into smaller sites (called services.) (e.g. your warehousing management system and your ecommerce website may exist on different services to allow communication between.) | |
SessionID (Optional) | guid | An optional string, used for pairing clients on the network in a bilateral communication flow. |
Methods:
GET
Purpose:
This method allows getting a list of messages off the bus. The response will wait for either the limitCount or limitTime (whichever comes first).
Parameters:
Name | Type | Default | Description |
|---|---|---|---|
limitCount | integer | 1000 | a limit to the maximum numbers you want returned in a single call. (This is not guarenteed.) |
limitTime | integer | 30 | a time in seconds to wait for more records. |
PUT
Purpose:
This method allows sending one message onto the bus. The message will be validated, so you will either recieve 200 (OK) or 400 (Bad Request)
Name | Type | Description |
|---|---|---|
Message | DataSyncMessage | This is the message in json format that you would like to send. |
POST
Purpose:
This method allows sending many message onto the bus. The messages will be validated, so you will either recieve 200 (OK) or 400 (Bad Request). In the event of a validation failure (bad request), no messages will be accepted.
Name | Type | Description |
|---|---|---|
Messages | List<DataSyncMessage> | This is a list of messages in json array format that you would like to send. |