List Gateways

Definition

List Gateways is a deprecated approach. https://gateway.pharmx.com.au/ now handles all load balancing.

Service location: https://gateway.pharmx.com.au/Gateway3/GatewayInterfaceManagement.asmx

Provides a list of gateway URLs to fortify API resilience through prioritisation and fallback logic, to be utilised in all subsequent calls to the PharmX web services.

Parameters

userDetail UserDetail
User credentials to authenticate the request.

Returns

ListGatewaysResult ActionResult (with an array of PharmXGateways)

Remarks

The returned list of gateway URLs should be stored for all future requests to PharmX.

Subsequent calls should use the URL with the priority closest to 0 (considered higher priority). Where the PharmX service is not available, the next prioritised URL should be called as a fallback, and this process should be continued throughout the list of gateway URLs.

If the credentials cannot be validated, a single gateway will be returned (the gateway on which the request was placed).