GET v1/clients/{id}

Retrieves a client by their id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Unique Identifier of the client requested.

 globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

The Client, if it exists. Otherwise a 404 error.

Client
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.
Name

string

None.
BaseAddress

string

None.
Uri

string

None.

Response Codes

  • 200 OK: Requested client successfully returned.
  • 401 Unauthorized:
  • 404 NotFound: Requested client does not exist.
  • 500 InternalServerError:

Response Formats

application/json, text/json

Sample: 
{
  "Id": "e03581b8-c8f5-4c4b-bcf1-4a9d003ebde6",
  "Name": "sample string 2",
  "BaseAddress": "sample string 3",
  "Uri": "sample string 4"
}

text/html

Sample: 
{"Id":"e03581b8-c8f5-4c4b-bcf1-4a9d003ebde6","Name":"sample string 2","BaseAddress":"sample string 3","Uri":"sample string 4"}

application/xml, text/xml

Sample: 
<Client xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ITAGroup.TaxValidation.Api.Contracts.v1.Models">
  <BaseAddress>sample string 3</BaseAddress>
  <Id>e03581b8-c8f5-4c4b-bcf1-4a9d003ebde6</Id>
  <Name>sample string 2</Name>
  <Uri>sample string 4</Uri>
</Client>