Get specific reindeer details

GET 
http://localhost:8080/reindeers/:reindeerId

Get specific reindeer details

Request

Path Parameters

reindeerId stringrequired

application/json

Bodyrequired

namestringrequired
Name of the reindeer.
Possible values: [Dasher, Dancer, Prancer, Vixen, Comet, Cupid, Donner, Blitzen, Rudolph]
Example: Dasher
ageintegerrequired
Age of the reindeer in years.
Possible values: >= 0 and <= 100
Example: 5
nose_colourstringrequired
Colour of the reindeer's nose.
Possible values: [red, blue, green]
Example: red
notesstring
Additional notes about the reindeer.
Possible values: <= 100 characters
Example: Rudolph has a shiny nose.
idstring
Unique identifier for the reindeer.
Example: reindeer1

Responses

200

Specific reindeer details.

application/json

Schema

Schema

namestringrequired
Name of the reindeer.
Possible values: [Dasher, Dancer, Prancer, Vixen, Comet, Cupid, Donner, Blitzen, Rudolph]
Example: Dasher
ageintegerrequired
Age of the reindeer in years.
Possible values: >= 0 and <= 100
Example: 5
nose_colourstringrequired
Colour of the reindeer's nose.
Possible values: [red, blue, green]
Example: red
notesstring
Additional notes about the reindeer.
Possible values: <= 100 characters
Example: Rudolph has a shiny nose.
idstring
Unique identifier for the reindeer.
Example: reindeer1

Example (auto)

{
  "name": "Dasher",
  "age": 5,
  "nose_colour": "red",
  "notes": "Rudolph has a shiny nose.",
  "id": "reindeer1"
}

Rudolph

Rudolph response

[
  {
    "id": "reindeer1",
    "name": "Rudolph",
    "age": 6,
    "nose_colour": "red",
    "notes": "Rudolph has a shiny nose."
  }
]

Comet

Comet response

[
  {
    "id": "reindeer6",
    "name": "Comet",
    "age": 9,
    "nose_colour": "green"
  }
]

401

Unauthorized - API key is missing or invalid.

application/json

Schema

Schema

errorstring

A message indicating authorization failure.

Example (auto)

{
  "error": "string"
}

missingApiKey

Missing API Key

{
  "error": "Unauthorized - API key is required."
}

404

Not Found - reindeer with the specified ID does not exist.

application/json

Schema

Schema

errorstring

A message indicating that the resource was not found.

Example (auto)

{
  "error": "string"
}

reindeerNotFound

Reindeer not found

{
  "error": "Reindeer with the specified ID was not found."
}

500

Internal Server Error - something went wrong on the server side.

application/json

Schema

Schema

errorstring

General error message indicating a server issue.

messagestring

Additional details about the error, if available.

Example (auto)

{
  "error": "string",
  "message": "string"
}

serverErrorExample

Example response for a server error

{
  "error": "Internal Server Error",
  "message": "An unexpected error occurred. Please try again later."
}

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "http://localhost:8080/reindeers/:reindeerId");
request.Headers.Add("Accept", "application/json");
var content = new StringContent("{\n  \"name\": \"Dasher\",\n  \"age\": 5,\n  \"nose_colour\": \"red\",\n  \"notes\": \"Rudolph has a shiny nose.\",\n  \"id\": \"reindeer1\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

http://localhost:8080

Parameters

reindeerId — pathrequired

Body required

{
  "name": "Dasher",
  "age": 5,
  "nose_colour": "red",
  "notes": "Rudolph has a shiny nose.",
  "id": "reindeer1"
}

ResponseClear

Click the Send API Request button above and see the response here!