GET api/v1/providers?name={name}&firstName={firstName}&lastName={lastName}&email={email}&properties={properties}&orderBy={orderBy}&take={take}&skip={skip}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
name

string

None.

firstName

string

None.

lastName

string

None.

email

string

None.

properties

string

None.

orderBy

string

None.

take

integer

Default value is 0

skip

integer

Default value is 0

Body Parameters

None.

Response Information

Resource Description

ResponseWrapperBindingModelOfIEnumerableOfProviderBindingModel
NameDescriptionTypeAdditional information
Results

Collection of ProviderBindingModel

None.

TotalResults

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalResults": 1,
  "Results": [
    {
      "Id": "sample string 1",
      "Href": "sample string 2",
      "Name": "sample string 3",
      "IsContracted": true,
      "ContractFee": 5.0,
      "Currency": "sample string 6",
      "Location": {
        "Address": {
          "AddressLine": [
            "sample string 1",
            "sample string 2"
          ],
          "Locality": "sample string 1",
          "AdminDistrict": "sample string 2",
          "PostalCode": "sample string 3",
          "Country": "sample string 4",
          "FormattedAddress": "sample string 5"
        },
        "Contact": {
          "FirstName": "sample string 1",
          "LastName": "sample string 2",
          "Email": "sample string 3",
          "PhoneNumber": "sample string 4",
          "FaxNumber": "sample string 5"
        }
      }
    },
    {
      "Id": "sample string 1",
      "Href": "sample string 2",
      "Name": "sample string 3",
      "IsContracted": true,
      "ContractFee": 5.0,
      "Currency": "sample string 6",
      "Location": {
        "Address": {
          "AddressLine": [
            "sample string 1",
            "sample string 2"
          ],
          "Locality": "sample string 1",
          "AdminDistrict": "sample string 2",
          "PostalCode": "sample string 3",
          "Country": "sample string 4",
          "FormattedAddress": "sample string 5"
        },
        "Contact": {
          "FirstName": "sample string 1",
          "LastName": "sample string 2",
          "Email": "sample string 3",
          "PhoneNumber": "sample string 4",
          "FaxNumber": "sample string 5"
        }
      }
    }
  ]
}

application/xml, text/xml

Sample:
<ResponseWrapperBindingModelOfArrayOfProviderBindingModelG65svhyd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Prometric.Api.Models">
  <TotalResults>1</TotalResults>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models.Provider">
    <d2p1:ProviderBindingModel>
      <d2p1:ContractFee>5</d2p1:ContractFee>
      <d2p1:Currency>sample string 6</d2p1:Currency>
      <d2p1:Href>sample string 2</d2p1:Href>
      <d2p1:Id>sample string 1</d2p1:Id>
      <d2p1:IsContracted>true</d2p1:IsContracted>
      <d2p1:Location>
        <d2p1:Address xmlns:d5p1="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">
          <d5p1:AddressLine xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </d5p1:AddressLine>
          <d5p1:AdminDistrict>sample string 2</d5p1:AdminDistrict>
          <d5p1:Country>sample string 4</d5p1:Country>
          <d5p1:FormattedAddress>sample string 5</d5p1:FormattedAddress>
          <d5p1:Locality>sample string 1</d5p1:Locality>
          <d5p1:PostalCode>sample string 3</d5p1:PostalCode>
        </d2p1:Address>
        <d2p1:Contact>
          <FaxNumber xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 5</FaxNumber>
          <PhoneNumber xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 4</PhoneNumber>
          <d2p1:Email>sample string 3</d2p1:Email>
          <d2p1:FirstName>sample string 1</d2p1:FirstName>
          <d2p1:LastName>sample string 2</d2p1:LastName>
        </d2p1:Contact>
      </d2p1:Location>
      <d2p1:Name>sample string 3</d2p1:Name>
    </d2p1:ProviderBindingModel>
    <d2p1:ProviderBindingModel>
      <d2p1:ContractFee>5</d2p1:ContractFee>
      <d2p1:Currency>sample string 6</d2p1:Currency>
      <d2p1:Href>sample string 2</d2p1:Href>
      <d2p1:Id>sample string 1</d2p1:Id>
      <d2p1:IsContracted>true</d2p1:IsContracted>
      <d2p1:Location>
        <d2p1:Address xmlns:d5p1="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">
          <d5p1:AddressLine xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </d5p1:AddressLine>
          <d5p1:AdminDistrict>sample string 2</d5p1:AdminDistrict>
          <d5p1:Country>sample string 4</d5p1:Country>
          <d5p1:FormattedAddress>sample string 5</d5p1:FormattedAddress>
          <d5p1:Locality>sample string 1</d5p1:Locality>
          <d5p1:PostalCode>sample string 3</d5p1:PostalCode>
        </d2p1:Address>
        <d2p1:Contact>
          <FaxNumber xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 5</FaxNumber>
          <PhoneNumber xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 4</PhoneNumber>
          <d2p1:Email>sample string 3</d2p1:Email>
          <d2p1:FirstName>sample string 1</d2p1:FirstName>
          <d2p1:LastName>sample string 2</d2p1:LastName>
        </d2p1:Contact>
      </d2p1:Location>
      <d2p1:Name>sample string 3</d2p1:Name>
    </d2p1:ProviderBindingModel>
  </Results>
</ResponseWrapperBindingModelOfArrayOfProviderBindingModelG65svhyd>