See also
GET
/user/{id}/dataobjectsGET
/user/{id}/dataobject/{key}POST
/user/{id}/dataobject/{key}DELETE
/user/{id}/dataobject/{key}
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/dataobjects
key | optionalThe client-provided data object key. Supports multiple values. |
---|---|
sort | optional |
filters | optional
|
The pagination parameters limit, since, offset, and until are also supported.
Example request
curl
Minimal example
curl https://login.schibsted.com/api/2/dataobjects -G \
-H "Authorization: Bearer [access token]"
With all parameters
curl https://login.schibsted.com/api/2/dataobjects -G \
-H "Authorization: Bearer [access token]" \
-d "key=some-data" \
-d "sort=userId"
Response
This endpoint supports the JSON response format.
Success: 200 OK
Retrieves a single data object.
Returns a collection of Data objects, as an object withdataObjectId
for property names, and Data objects for values.Data object
dataObjectId ✓ | integer (as string)Unique data object ID |
---|---|
clientId ✓ | stringThe ID of the client who created the data object |
merchantId ✓ | integer (as string)The ID of the merchant the client belongs to |
userId ✓ | integer (as string)The user the data is associated with |
key ✓ | stringClient-provided key, e.g. the 'name' of this data. Max length is 255 bytes. |
value ✓ | stringClient-provided value. Max length is 65535 bytes. |
updated ✓ | datetimeWhen this value was last updated |
created ✓ | datetimeWhen this value was originally created |
The check mark ✓ indicates that the field always contains a valid non-empty value.
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.
- 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 Schibsted account 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 data objects found
- 420 Request Ratelimit exceeded
Sample response
JSON
{
"21": {
"dataObjectId": "21",
"clientId": "[Your client ID]",
"merchantId": "[Your merchant ID]",
"userId": "020006",
"key": "mysetting",
"value": "My custom value",
"updated": "2014-08-04 15:10:14",
"created": "2014-08-04 15:10:14"
}
}
Comments/feedback
Do you have questions, or just want to contribute some newly gained insight? Want to share an example? Please leave a comment. Our team reads and responds to every question. Additionally, your experience can help others using Schibsted account, and it can help us continuously improve our documentation.