Utilities

GET /describe/{object}

Requires authentication with server access token.

Describe an objects's enumerable properties, optionally translated to one of the available locales. This endpoint provides meaningful human-readable explanations of numbers used e.g. for user status and other fields.

See also

Help us improve

Did you spot an error? Or maybe you just have a suggestion for how we can improve? Leave us a comment.

Request

GET /api/2/describe/{object}

object

required path parameter

The object to describe. Possible values:

  • User
  • Address
  • Email
  • Phone
  • Product
  • BundleItem
  • Subscription
  • Content
  • Discount
  • Identifier
  • Campaign
  • Utilities
  • Voucher

property

optional

The property to describe. To get a list of possible values, get the full description of an object.

locale

optional

One of the supported locales

Example request

cURL
Minimal example
curl https://login.schibsted.com/api/2/describe/User -G \
   -d "oauth_token=[access token]"
With all parameters
curl https://login.schibsted.com/api/2/describe/User -G \
   -d "oauth_token=[access token]" \
   -d "property=status" \
   -d "locale=nb_NO"
Java
Minimal example
SpidOAuthToken token = spidClient.getServerToken();
String responseJSON = spidClient.
    GET(token, "/describe/User").
    getResponseBody();
With all parameters
Map<String, String> params = new HashMap<>() {{
    put("property", "status");,
    put("locale", "nb_NO");
}};

SpidOAuthToken token = spidClient.getServerToken();
String responseJSON = spidClient.
    GET(token, "/describe/User", params).
    getResponseBody();

This example is an excerpt, see a full example

PHP
Minimal example
<?php
$client->auth();
echo var_dump($client->api("/describe/User"));
With all parameters
<?php
$params = array(
    "property" => "status",
    "locale" => "nb_NO"
);

$client->auth();
echo var_dump($client->api("/describe/User", $params));

This example is an excerpt, see a full example

Clojure
Minimal example
(ns example
  (:require [spid-client-clojure.core :as spid]))

(let [client (spid/create-client "[client-id]" "[secret]")
      token (spid/create-server-token client)]
  (spid/GET client token "/describe/User"))
With all parameters
(ns example
  (:require [spid-client-clojure.core :as spid]))

(let [client (spid/create-client "[client-id]" "[secret]")
      token (spid/create-server-token client)]
  (spid/GET client token "/describe/User" {"property" "status"
                                           "locale" "nb_NO"}))

Response

This endpoint supports the JSON and JSON-P response formats.

Success: 200 OK

Returns a localized description of and object's enumerable properties. If the property parameter was provided, only this property is described. The returned object has the property name(s) as key(s) and an object of possibles values as keys, and localized descriptions as values.

Failure cases

Some HTTP response codes are used for multiple error situations. There is no consistent way to tell these apart, but the error object will contain a textual explanation of the reason for the error. For explanation on OAuth related failures and errors see OAuth authentication failures.

  • 400 Bad Request Missing required parameter object
  • 401 Unauthorized You don't have administration rights for this client.
  • 401 Unauthorized Your client doesn't have administration rights for this client.
  • 403 Forbidden Client is not authorized to access this API endpoint. Contact SPiD to request access.
  • 403 Forbidden Requesting IP is not whitelisted
  • 403 Forbidden Access token rejected
  • 404 Not Found Unknown client ID
  • 404 Not Found Client ID mismatch. The client making the request is no the owner of this resource, and does not have administrative privileges for it.
  • 404 Not Found No description found for this object
  • 420 Request Ratelimit exceeded

Sample response

JSON
{
  "User.gender": {
    "male": "Male",
    "female": "Female",
    "undisclosed": "Undisclosed"
  },
  "User.status": {
    "-3": "User deleted",
    "-2": "User blocked",
    "-1": "User inactive",
    "0": "User unverified",
    "1": "User verified"
  }
}
JSON-P
callback({
  "User.gender": {
    "male": "Male",
    "female": "Female",
    "undisclosed": "Undisclosed"
  },
  "User.status": {
    "-3": "User deleted",
    "-2": "User blocked",
    "-1": "User inactive",
    "0": "User unverified",
    "1": "User verified"
  }
});

Comments/feedback

Do you have questions, or just want to contribute some newly gained insight? Want to share an example? Please leave a comment. SPiD reads and responds to every question. Additionally, your experience can help others using SPiD, and it can help us continuously improve our documentation.