API
  • Yumpu documentations
  • JS
    • Introduction
    • Quick setup
    • Magazine example's
    • Bookshelf example's
    • FAQs
  • API
    • Introduction
    • Getting started
      • API token
      • Document API
      • User API
      • Search API
      • Install SDK's
    • Limits
    • Flowchart of basic processes
    • Documents
      • Get
    • Document
      • Get
      • Post file
      • Post url
      • Put
      • Delete
    • Document hotspots
      • Get
    • Document hotspot
      • Get
      • Post
      • Put
      • Delete
    • Document progress
      • Get
    • Document categories
      • Get
    • Document languages
      • Get
    • Countries
      • Get
    • Collections
      • Get
    • Collection
      • Get
      • Post
      • Put
      • Delete
    • Section
      • Get
      • Post
      • Put
      • Delete
    • Section document
      • Post
      • Delete
    • Search
      • Get
    • User
      • Get
      • Post
      • Put
    • Embeds
      • Get
    • Embed
      • Get
      • Post
      • Put
      • Delete
    • Members
      • Get
    • Member
      • Get
      • Post
      • Put
      • Delete
    • Access tags
      • Get
    • Access tag
      • Get
      • Post
      • Put
      • Delete
    • Subscriptions
      • Get
    • Subscription
      • Get
      • Post
      • Put
      • Delete
Powered by GitBook
On this page
  • Retrieve one access tag
  • Parameters:
  • Demo

Was this helpful?

  1. API
  2. Access tag

Get

PreviousAccess tagNextPost

Last updated 3 years ago

Was this helpful?

Retrieve one access tag

Parameters:

Name

Optional / Required

Data type

Description

Default

id

required

String

One of your access tag ids

return_fields

optional

String

Customize the responses by setting the return fields (id, name, description, default, iap, kiosks, create_date, update_date)

id, name, description, default, iap, kiosks, create_date, update_date

Demo

URL Find your token on - Token

id

Optional parameters:

return_fields

Add optional parametersRun request

Example:

curl -X GET -H "X-ACCESS-TOKEN: YOUR_ACCESS_TOKEN" "https://api.yumpu.com/2.0/account/access_tag.json?id=HnD4YrKMeGjxH3xT"

Example:

require_once('../yumpu.php');
$yumpu = new Yumpu();
$data = array(
    'id' => 'HnD4YrKMeGjxH3xT',
    'limit' => '2',
    'offset' => '0'
);
$listAccesstag = $yumpu->getAccessTag($data);
print_r($listAccesstag);

Example:

var yumpu = require('yumpu');
yumpu.setToken('yourToken');
var parameters = {
  id: HnD4YrKMeGjxH3xT,
  limit: 2,
  offset: 0
};
yumpu.getAccessTag(parameters, function(statusCode, document){
   console.log('Status: ' + statusCode);
   console.log(document);
});

Example:

Yumpu y = new Yumpu("your access token");
String[] params = { "id=HnD4YrKMeGjxH3xT", "limit=2", "offset=0" };
System.out.println(y.getAccessTag(params));

Whatever language you are using, the result will be the same.

{
  "access_tag": {
    "id": "HnD4YrKMeGjxH3xT",
    "create_date": "2015-01-27 08:54:41",
    "update_date": "0000-00-00 00:00:00",
    "name": "accesstag1",
    "description": "accesstag1",
    "default": false,
    "iap": true,
    "kiosks": [
      {
        "id": "72",
        "type": "appkiosk"
      }
    ]
  },
  "state": "success",
  "completed_in": "0.0234"
}
yumpu.com