GET v1/clients

Returns an array of all clients

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Client
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.
Name

string

None.
BaseAddress

string

None.
Uri

string

None.

Response Codes

  • 200 OK: All clients returned successfully
  • 401 Unauthorized:
  • 500 InternalServerError:

Response Formats

application/json, text/json

Sample: 
[
  {
    "Id": "7256fc6f-bbd4-4a9d-9ea1-454431970af7",
    "Name": "sample string 2",
    "BaseAddress": "sample string 3",
    "Uri": "sample string 4"
  },
  {
    "Id": "7256fc6f-bbd4-4a9d-9ea1-454431970af7",
    "Name": "sample string 2",
    "BaseAddress": "sample string 3",
    "Uri": "sample string 4"
  }
]

text/html

Sample: 
[{"Id":"7256fc6f-bbd4-4a9d-9ea1-454431970af7","Name":"sample string 2","BaseAddress":"sample string 3","Uri":"sample string 4"},{"Id":"7256fc6f-bbd4-4a9d-9ea1-454431970af7","Name":"sample string 2","BaseAddress":"sample string 3","Uri":"sample string 4"}]

application/xml, text/xml

Sample: 
<ArrayOfClient xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ITAGroup.TaxValidation.Api.Contracts.v1.Models">
  <Client>
    <BaseAddress>sample string 3</BaseAddress>
    <Id>7256fc6f-bbd4-4a9d-9ea1-454431970af7</Id>
    <Name>sample string 2</Name>
    <Uri>sample string 4</Uri>
  </Client>
  <Client>
    <BaseAddress>sample string 3</BaseAddress>
    <Id>7256fc6f-bbd4-4a9d-9ea1-454431970af7</Id>
    <Name>sample string 2</Name>
    <Uri>sample string 4</Uri>
  </Client>
</ArrayOfClient>