GET api/providers

Gets all the available providers for the current tenant.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Returns the available providers.

Collection of Provider

Name	Description	Type	Additional information
Id	The Provider's ID	integer	None.
Name	The name of the Provider	string	None.
Description	A description of the Provider	string	None.
ActiveDates	The dates when the provider is active	Collection of ProviderDateWindow	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "name": "sample string 2",
    "description": "sample string 3",
    "activeDates": [
      {
        "fromDate": "2024-12-23",
        "toDate": "2024-12-23"
      },
      {
        "fromDate": "2024-12-23",
        "toDate": "2024-12-23"
      }
    ]
  },
  {
    "id": 1,
    "name": "sample string 2",
    "description": "sample string 3",
    "activeDates": [
      {
        "fromDate": "2024-12-23",
        "toDate": "2024-12-23"
      },
      {
        "fromDate": "2024-12-23",
        "toDate": "2024-12-23"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfProvider xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
  <Provider>
    <ActiveDates>
      <ProviderDateWindow>
        <FromDate>2024-12-23T12:18:24.2756261-07:00</FromDate>
        <ToDate>2024-12-23T12:18:24.2756261-07:00</ToDate>
      </ProviderDateWindow>
      <ProviderDateWindow>
        <FromDate>2024-12-23T12:18:24.2756261-07:00</FromDate>
        <ToDate>2024-12-23T12:18:24.2756261-07:00</ToDate>
      </ProviderDateWindow>
    </ActiveDates>
    <Description>sample string 3</Description>
    <Id>1</Id>
    <Name>sample string 2</Name>
  </Provider>
  <Provider>
    <ActiveDates>
      <ProviderDateWindow>
        <FromDate>2024-12-23T12:18:24.2756261-07:00</FromDate>
        <ToDate>2024-12-23T12:18:24.2756261-07:00</ToDate>
      </ProviderDateWindow>
      <ProviderDateWindow>
        <FromDate>2024-12-23T12:18:24.2756261-07:00</FromDate>
        <ToDate>2024-12-23T12:18:24.2756261-07:00</ToDate>
      </ProviderDateWindow>
    </ActiveDates>
    <Description>sample string 3</Description>
    <Id>1</Id>
    <Name>sample string 2</Name>
  </Provider>
</ArrayOfProvider>