Skip to content

API Requirements

Tricklebyte edited this page Mar 22, 2020 · 6 revisions

Api GET method

The API must expose at least one GET method that returns Configuration Settings to the client.

Results Filtering

Route parameters and query string parameters are supported to filter results. If no filter parameters are specified in the client configuration, the client will create one route parameter named appId with the default value of the client assembly name.
https://{Host}[:port]/{controller}/{appId}

Api Response

The API Get method must return a type List <ConfigSetting>, filtered for the route and query string parameters supplied by the client as part of the URI.

In the example URI above, the API should return settings for this client only, based on the value of the appId Parameter.

Samples

See the API Samples and Quickstart Solutions for fully configured api samples using multiple authentication types.