Search providers

post

https://virtserver.swaggerhub.com/products/v1/provider/search

Search for providers matching given criteria. This search is not paged, as it not expected to have a large number of providers. Case insensitive partial matching is done on criteria. Results matching all criteris are returned.

Response Code	Fault Code	Fault	Suggested User Message
tbc	tbc	New API created for 1.5	tbc

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

activeFilter

string

enum

If not supplied, only active items will be returned. If supplied, specifies whether to return only active, only inactive, or all items.

Allowed:

orderBy

string

Field and direction to order results

searchId

string

Used for matching search requests and responses where clients may be making multiple concurrent requests

Body Params

The details to use to search for providers

Criteria to use to search providers.

providerRef

string

The reference code for the provider.

providerName

string

The name of this provider.

Headers

tenantId

string

The tenant ID for which the operation is being carried out. This will be automatically generated during the authentication process.

userId

string

The ID of a user who is performing the operation. This will be automatically generated during the authentication process.

source

string

enum

The source of whether records are updated by HMAC or a USER. This will be automatically generated during the authentication process. For customers accessing the service the source will be set to CUSTOMER.

Allowed:

Responses

200Search request successful.

400Bad request