Skip to content

DataProviderCollApi.md

Latest commit

 

History

History
165 lines (105 loc) · 4.26 KB

DataProviderCollApi.md

File metadata and controls

165 lines (105 loc) · 4.26 KB
Raw

DataProviderCollApi

All URIs are relative to http://localhost

Method HTTP request Description
fetchDataProviderColl GET /api/v1/data_provider_colls/{id} DataProviderColl@show
fetchDataProviderCollSummary GET /api/v1/data_provider_colls/{id}/summary DataProviderColl@showSummary
fetchDataProviderColls GET /api/v1/data_provider_colls DataProviderColl@index

fetchDataProviderColl

FetchDataProviderColl200Response fetchDataProviderColl()

Return a single DataProviderColl

Example

import {
    DataProviderCollApi,
    Configuration
} from '@hdruk/gateway-api-sdk';

const configuration = new Configuration();
const apiInstance = new DataProviderCollApi(configuration);

let id: number; //DataProviderColl ID (default to undefined)

const { status, data } = await apiInstance.fetchDataProviderColl(
    id
);

Parameters

Name Type Description Notes
id [number] DataProviderColl ID defaults to undefined

Return type

FetchDataProviderColl200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
404 Not found response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fetchDataProviderCollSummary

FetchDataProviderCollSummary200Response fetchDataProviderCollSummary()

Return a single DataProviderColl - summary

Example

import {
    DataProviderCollApi,
    Configuration
} from '@hdruk/gateway-api-sdk';

const configuration = new Configuration();
const apiInstance = new DataProviderCollApi(configuration);

let id: number; //DataProviderColl ID - summary (default to undefined)

const { status, data } = await apiInstance.fetchDataProviderCollSummary(
    id
);

Parameters

Name Type Description Notes
id [number] DataProviderColl ID - summary defaults to undefined

Return type

FetchDataProviderCollSummary200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
404 Not found response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fetchDataProviderColls

FetchDataProviderColls200Response fetchDataProviderColls()

Returns a list of DataProviderColls enabled on the system

Example

import {
    DataProviderCollApi,
    Configuration
} from '@hdruk/gateway-api-sdk';

const configuration = new Configuration();
const apiInstance = new DataProviderCollApi(configuration);

let perPage: number; //per page (optional) (default to undefined)

const { status, data } = await apiInstance.fetchDataProviderColls(
    perPage
);

Parameters

Name Type Description Notes
perPage [number] per page (optional) defaults to undefined

Return type

FetchDataProviderColls200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -

[Back to top] [Back to API list] [Back to Model list] [Back to README]