Submitted feedback of the given user

GET/v2/users/self/spotlights/{spotlightId}/

API version

v2

Request method

GET

Operation ID

user-get-spotlight-info

---

Request

• spotlightIdstring

  required

Responses

Format

application/json

Beschreibung

Feedback submitted by the user.

Schema-Dokumentation

• acknowledgedboolean

  required
• decisionstring (one of: keep, kill, ignore)
• spotlightIdstring

  required
• usedboolean

  required

Beispiel

Content-Type: application/json

{
  "acknowledged": true,
  "decision": "keep",
  "spotlightId": "string",
  "used": true
}

JSON Schema

{
  "properties": {
    "acknowledged": {
      "type": "boolean"
    },
    "decision": {
      "enum": [
        "keep",
        "kill",
        "ignore"
      ],
      "type": "string"
    },
    "spotlightId": {
      "type": "string"
    },
    "used": {
      "type": "boolean"
    }
  },
  "required": [
    "spotlightId",
    "used",
    "acknowledged"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/users/self/spotlights/string

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.user.getSpotlightInfo({
  "spotlightId": "string"
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\User\GetSpotlightInfo\GetSpotlightInfoRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new GetSpotlightInfoRequest(
  spotlightId: "string"
));
$response = $client->user()->getSpotlightInfo($request);

var_dump($response->getBody();