Objets
creerObjet
Créer un objet sur le site CultureWok à partir de données local et de l'insérer dans le wok utilisateur.
Si un objet similaire est détecté à partir de son code EAN, l'objet est inséré en l'état dans le wok utilisateur
Paramètres en entrée.
Nom | obligatoire | Contenu | Commentaire |
---|---|---|---|
userWokId | oui | Identifiant utilisateur | |
fields | oui | Champs de l'objet à créer | voir liste des champs par type de wok |
localUrl | non | Url locale de l'objet | Lien visible sur le détail de l'objet sur le site CultureWok. non obligatoire mais fortement conseillé |
Exemple
données en sortie
Deux tableaux :
publication : voir réponse de la méthode obtenirMonObjetWok
objet : voir réponse de la méthode obtenirObjet
Exemple
obtenirObjet
Obtenir un objet du site CultureWok
Paramètres en entrée.
Un et un seul des 3 paramètres est obligatoire.
Nom | Commentaire |
---|---|
objectId | |
ean | Ean ou ISBN 13. |
ObjetWokID |
données en sortie
champs du modèle de l'objet
Exemple
listerObjets
Cette méthode permet d'obtenir l'intégralité des objets du wok (paramètre type_wok)
Paramètres en entrée.
Nom | Commentaire |
---|---|
offset | position dans la liste du premier objet à retourner |
limit | Nombre d'objets à retourner |
données en sortie
tableau à deux entrées :
count : nombre total d'objets dans le wok
objets : tableau des objets (voir obtenirObjet)
Exemple
obtenirMonObjetWok
Obtenir les instances d'un objet dans un wok personnel
Paramètres en entrée.
objectId : identifiant de l'objet
userWokId : identifiant de l'utilisateur, si le paramètre est absent, on renvoie toutes les instances de l'objet dans les woks personnels.
données en sortie
Champ | Contenu |
---|---|
id | objectWokId |
object_id | objectId |
wok_id | identifiant du wok |
online | objet publié : booléen |
user_id | userWokId |
created_on | Date de création |
Si le paramètre userWokId n'est pas paramétré, on renvoie un tableau avec une entrée par instance d'objet (donc par utilisateur)
Exemple
publierObjet
publier et dépublier un objet pour un wok personnel
Attention
Pour pouvoir être publié, un objet doit :
être sensitivé
comporter obligatoirement une image de couverture, un titre, un auteur et un résumé
Une tentative de publication d'un objet non conforme renverra une erreur
Paramètres en entrée.
Nom | obligatoire | Commentaire |
---|---|---|
objectWokId | oui | |
userWokId | oui | |
etat | oui | booléen true : publier l'objet false : dépublier l'objet |
Données en sortie
Chaîne de caractères précisant l'action effectuée :
"objet publié
" ou "objet dépublié
"
Exemple
supprimerObjet
supprimer un objet dans un wok personnel
Paramètres en entrée.
Nom | obligatoire | Commentaire |
---|---|---|
objectWokId | oui | identifiant de l'objet dans le wok personnel |
userWokId | oui |
Données en sortie
objet supprimé