POST /merchant/{merchant_id}/agreements/assign
Requires authentication with server or user access token.
Assign agreement to client.
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
POST /api/2/merchant/{merchant_id}/agreements/assign
merchant_id | required path parameterMerchant ID |
---|---|
term_id | required |
client_id | required |
Example request
cURL
curl https://login.schibsted.com/api/2/merchant/46000/agreements/assign \
-X POST \
-d "oauth_token=[access token]" \
-d "term_id=123123" \
-d "client_id=4321abc00000000000000000"
Java
Map<String, String> params = new HashMap<>() {{
put("term_id", "123123");,
put("client_id", "4321abc00000000000000000");
}};
SpidOAuthToken token = spidClient.getUserToken(code);
String responseJSON = spidClient.
POST(token, "/merchant/46000/agreements/assign", params).
getResponseBody();
This example is an excerpt, see a full example
PHP
<?php
$params = array(
"term_id" => "123123",
"client_id" => "4321abc00000000000000000"
);
$client->auth();
echo var_dump($client->api("/merchant/46000/agreements/assign", "POST", $params));
This example is an excerpt, see a full example
Clojure
(ns example
(:require [spid-client-clojure.core :as spid]))
(let [client (spid/create-client "[client-id]" "[secret]")
token (spid/create-user-token client "[code]")]
(spid/POST client token "/merchant/46000/agreements/assign" {"term_id" "123123"
"client_id" "4321abc00000000000000000"}))
Response
This endpoint supports the JSON response format.
Success: 201 Created
Assignment created successfully
Agreement
Agreement object
merchant_id | stringMerchant ID |
---|---|
type | stringAgreement type: terms |
text | stringAgreement text |
date | stringDate of agreement |
markdown | stringAgreement in Markdown format |
privacy_url | stringURL to privacy policy |
summary | stringSummary text if such exist |
title | stringTitle of agreement |
updated | stringTimestamp of latest changes to agreement |
id | stringID of agreement |
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 parameters or similar error
- 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 Token does not have access to this merchant
- 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 The client or agreement not found
- 420 Request Ratelimit exceeded
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.