Главная > Документация uAPI > Модуль "Фотоальбомы", категории/разделы
 

[GET] Все категории/разделы


Расшифровка переменных

  • access2add – [Массив] – Права на добавление материалов в категорию
  • position – [Число] – Какой по порядку идет категория
  • name – [Строка] – Название категории
  • description – [Строка] – Описание категории
  • access2page – [Массив] – Группы, имеющие возможность скачивать файлы
  • entry_count – [Число] – Количество материалов в категории
  • id – [Число] – ID категории
  • type – [Строка] – Что это именно (category/section)
  • access2category или access2section – [Массив] – Какие группы имеют доступ к просмотру категории/раздела
  • hgu_title – [Строка] – ЧПУ категории

Особенности

1) Если в модуле есть раздел, а в ней категория (категории), то определить принадлежность к разделу можно будет в массиве "section", который будет внутри категории
2) Несмотря на пункт 1, раздел тоже самостоятелен и он будет дополнительно выведен в ответе как самостоятельный массив

<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->get('/stuff/category', array( //без параметров )); print_r($response); //Получаем ответ curl -i -X GET -G --data-urlencode "oauth_consumer_key=ЗНАЧЕНИЕ" --data-urlencode "oauth_nonce=значение" --data-urlencode "oauth_signature_method=HMAC-SHA1" --data-urlencode "oauth_timestamp=значение" --data-urlencode "oauth_version=1.0" --data-urlencode "oauth_token=значение" --data-urlencode "auth_signature=значение" http://yoursite.ucoz.ru/uapi/stuff/category
[ { "access2add":[ "Все группы" ], "position":"1", "name":"Мои статьи", "description":"test", "access2page":[ { "4":"Администраторы" } ], "entry_count":7, "id":1, "type":"category", "access2category":[ "Все группы" ], "hgu_title":null }, { //вывод уже другой категории, например, с ID2 } ] [ { "access2add":[ "Все группы" ], "position":"1", "name":"Мои статьи", "description":"test", "access2page":[ { "4":"Администраторы" } ], "entry_count":7, "id":1, "type":"category", "access2category":[ "Все группы" ], "hgu_title":null }, { //вывод уже другой категории, например, с ID2 } ]
//Для особенности 1 и 2 { "access2section":[ "Все группы" ], "position":"1", "name":"Раздел", "description":"описание раздела", "entry_count":0, "id":2, "type":"section", "hgu_title":"razdel" }, { //тут идет вывод информации о категории "section":{ "access2section":[ "Все группы" ], "name":"Раздел", "id":2, "description":"описание раздела", "hgu_title":"razdel" }, //продолжение информации о категории } //Для особенности 1 и 2 { "access2section":[ "Все группы" ], "position":"1", "name":"Раздел", "description":"описание раздела", "entry_count":0, "id":2, "type":"section", "hgu_title":"razdel" }, { //тут идет вывод информации о категории "section":{ "access2section":[ "Все группы" ], "name":"Раздел", "id":2, "description":"описание раздела", "hgu_title":"razdel" }, //продолжение информации о категории }
 

[GET] Определенную категорию/раздел


Расшифровка переменных

  • access2add – [Массив] – Права на добавление материалов в категорию
  • position – [Число] – Какой по порядку идет категория
  • name – [Строка] – Название категории
  • section – [Массив] – Информации о разделе, которой принадлежит категория
  • description – [Строка] – Описание категории
  • access2page – [Массив] – Группы, имеющие возможность скачивать файлы
  • entry_count – [Число] – Количество материалов в категории
  • access2category или access2section – [Массив] – Какие группы имеют доступ к просмотру категории/раздела
  • id – [Число] – ID категории
  • type – [Строка] – Что это именно (category/section)
  • hgu_title – [Строка] – ЧПУ категории

Особенности

1) Если у категории нет раздела, то массив "section" будет отсутствовать в ответе
2) Если в запросе указать ID раздела, то в ответе мы увидим информацию только о разделе (без категорий)
3) Если нужно получить определенный раздел, то в запросе нужно изменить category на section

<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->get('/stuff/category', array( 'id' => 'АЙДИКАТЕГОРИИ' )); print_r($response); //Получаем ответ curl -i -X GET -G --data-urlencode "oauth_consumer_key=ЗНАЧЕНИЕ" --data-urlencode "oauth_nonce=значение" --data-urlencode "oauth_signature_method=HMAC-SHA1" --data-urlencode "oauth_timestamp=значение" --data-urlencode "oauth_version=1.0" --data-urlencode "oauth_token=значение" --data-urlencode "auth_signature=значение" --data "id=АЙДИКАТЕГОРИИ" http://youresite.ucoz.ru/uapi/stuff/category
[ { "access2add":[ "Все группы" ], "position":"2", "name":"Категория в разделе", "section":{ "access2section":[ "Все группы" ], "name":"Раздел", "id":2, "description":"описание раздела", "hgu_title":"razdel" }, "description":"", "access2page":[ { "4":"Администраторы" } ], "entry_count":0, "access2category":[ "Все группы" ], "id":3, "type":"category", "hgu_title":"kategorija_v_razdele" } ] [ { "access2add":[ "Все группы" ], "position":"2", "name":"Категория в разделе", "section":{ "access2section":[ "Все группы" ], "name":"Раздел", "id":2, "description":"описание раздела", "hgu_title":"razdel" }, "description":"", "access2page":[ { "4":"Администраторы" } ], "entry_count":0, "access2category":[ "Все группы" ], "id":3, "type":"category", "hgu_title":"kategorija_v_razdele" } ]
//для особенности 2 [ { "access2section":[ "Все группы" ], "position":"1", "name":"Раздел", "description":"описание раздела", "entry_count":0, "id":2, "type":"section", "hgu_title":"razdel" } ] //для особенности 2 [ { "access2section":[ "Все группы" ], "position":"1", "name":"Раздел", "description":"описание раздела", "entry_count":0, "id":2, "type":"section", "hgu_title":"razdel" } ]
 

[POST] Добавить категорию/раздел


Расшифровка переменных

  • access2add – [Массив] – Права на добавление материалов в категорию
  • name – [Строка] – Название категории
  • position – [Число] – Какой по порядку идет категория
  • description – [Строка] – Описание категории
  • access2page – [Массив] – Группы, имеющие возможность скачивать файлы
  • entry_count – [Число] – Количество материалов в категории
  • access2category или access2section – [Массив] – Какие группы имеют доступ к просмотру категории/раздела
  • id – [Число] – ID категории
  • type – [Строка] – Что это именно (category/section)
  • hgu_title – [Строка] – ЧПУ категории

Особенности

1) HGU (ЧПУ) нельзя установить при добавлении категории
2) Если требуется добавить раздел, то в запросе достаточно изменить category на section

<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->post('/stuff/category', array( 'name' => 'Новая категория из АПИ', 'description' => 'Описание категории из АПИ' )); print_r($response); //Получаем ответ curl -i -X POST --data-urlencode "oauth_consumer_key=ЗНАЧЕНИЕ" --data-urlencode "oauth_nonce=значение" --data-urlencode "oauth_signature_method=HMAC-SHA1" --data-urlencode "oauth_timestamp=значение" --data-urlencode "oauth_version=1.0" --data-urlencode "oauth_token=значение" --data-urlencode "auth_signature=значение" --data "name=Новая категория из АПИ" --data-urlencode "description=Описание категории из АПИ" http://yoursite.ucoz.ru/uapi/stuff/category
{ "access2add":[ { "4":"Администраторы" } ], "name":"Новая категория из АПИ", "position":4, "description":null, "access2page":[ { "4":"Администраторы" } ], "entry_count":0, "access2category":[ { "4":"Администраторы" } ], "id":5, "type":"category", "hgu_title":"novaja_kategorija_iz_api" } { "access2add":[ { "4":"Администраторы" } ], "name":"Новая категория из АПИ", "position":4, "description":null, "access2page":[ { "4":"Администраторы" } ], "entry_count":0, "access2category":[ { "4":"Администраторы" } ], "id":5, "type":"category", "hgu_title":"novaja_kategorija_iz_api" }
//для особенности 2 <?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->post('/stuff/section', array( 'name' => 'Новая категория из АПИ', 'description' => 'Описание категории из АПИ' )); print_r($response); //Получаем ответ //для особенности 2 curl -i -X POST --data-urlencode "oauth_consumer_key=ЗНАЧЕНИЕ" --data-urlencode "oauth_nonce=значение" --data-urlencode "oauth_signature_method=HMAC-SHA1" --data-urlencode "oauth_timestamp=значение" --data-urlencode "oauth_version=1.0" --data-urlencode "oauth_token=значение" --data-urlencode "auth_signature=значение" --data "name=Новая категория из АПИ" --data-urlencode "description=Описание категории из АПИ" http://yoursite.ucoz.ru/uapi/stuff/section
 

[PUT] Отредактировать категорию/раздел


Расшифровка переменных

  • access2add – [Массив] – Права на добавление материалов в категорию
  • name – [Строка] – Название категории
  • position – [Число] – Какой по порядку идет категория
  • description – [Строка] – Описание категории
  • access2page – [Массив] – Группы, имеющие возможность скачивать файлы
  • entry_count – [Число] – Количество материалов в категории
  • access2category или access2section – [Массив] – Какие группы имеют доступ к просмотру категории/раздела
  • id – [Число] – ID категории
  • type – [Строка] – Что это именно (category/section)
  • hgu_title – [Строка] – ЧПУ категории

Особенности

1) Если требуется отредактировать раздел, то в запросе достаточно изменить category на section
2) Невозможно осуществить операцию по превращении раздела в категорию и наоборот
3) Нельзя отредактировать раздел, сделав запрос на category и наоборот

<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->put('/stuff/category', array( 'id' => '2', 'name' => 'Категория с новым именем', 'description' => 'Категория с новым описанием', 'access2category' => '3,4', 'hgu_title' => 'newhgu' )); print_r($response); //Получаем ответ <?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->put('/stuff/category', array( 'id' => '2', 'name' => 'Категория с новым именем', 'description' => 'Категория с новым описанием', 'access2category' => '3,4', 'hgu_title' => 'newhgu' )); print_r($response); //Получаем ответ
{ "access2add":[ "Все группы" ], "name":"Категория с новым именем", "position":1, "description":"Категория с новым описанием", "access2page":[ { "4":"Администраторы" } ], "entry_count":7, "access2category":[ { "3":"Модераторы" }, { "4":"Администраторы" } ], "id":1, "type":"category", "hgu_title":"newhgu" } { "access2add":[ "Все группы" ], "name":"Категория с новым именем", "position":1, "description":"Категория с новым описанием", "access2page":[ { "4":"Администраторы" } ], "entry_count":7, "access2category":[ { "3":"Модераторы" }, { "4":"Администраторы" } ], "id":1, "type":"category", "hgu_title":"newhgu" }
 

[DELETE] Удалить категорию/раздел


Особенности

1) Если требуется удалить раздел, то в запросе достаточно изменить category на section
2) После удаления категории/раздела – обратное действие по восстановлению невозможно

<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->delete('/stuff/category', array( 'id' => '2' )); print_r($response); //Получаем ответ curl -i -X DELETE --data-urlencode "oauth_consumer_key=ЗНАЧЕНИЕ" --data-urlencode "oauth_nonce=значение" --data-urlencode "oauth_signature_method=HMAC-SHA1" --data-urlencode "oauth_timestamp=значение" --data-urlencode "oauth_version=1.0" --data-urlencode "oauth_token=значение" --data-urlencode "auth_signature=значение" --data "id=2" http://yoursite.ucoz.ru/uapi/stuff/category
{ "success":{ "msg":"Выполнено" } } { "success":{ "msg":"Выполнено" } }
Яндекс.Метрика