Colecciones
Crear o actualizar una colección
Sección titulada «Crear o actualizar una colección»Endpoint de la API:
Sección titulada «Endpoint de la API:»POST http://localhost:7292/dstapi/DSTV1/SaveCollectionParámetros:
{ "Id": 0, "Name": "My Collection", "Description": "My description goes here...", "CollectionLive": true, "IsDefault": false}Usa el ID
0si es una colección nueva. Para actualizarla, usa el ID existente de esa colección.
Las colecciones viven en la base de datos local de la tienda del nodo; no se envía ninguna transacción. Name tiene un límite de 64 caracteres y Description de 200 palabras y 1,200 caracteres.
Respuesta:
Sección titulada «Respuesta:»{ "Success": true, "Message": "Collection saved."}Una actualización responde "Collection updated.".
Ejemplo de código
Sección titulada «Ejemplo de código»const saveCollection = async (id = 0) => { const payload = { Id: id, Name: "My Collection", Description: "My description goes here...", CollectionLive: true, IsDefault: false, };
const url = `${CLI_BASE_URL}/dstapi/DSTV1/SaveCollection`; const request = await fetch(url, { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify(payload), });
const data = await request.json();
return data["Success"];};def save_collection(id=0): payload = { "Id": id, "Name": "My Collection", "Description": "My description goes here...", "CollectionLive": True, "IsDefault": False }
url = f"{CLI_BASE_URL}/dstapi/DSTV1/SaveCollection" headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers) data = response.json()
return data["Success"]Listar colecciones
Sección titulada «Listar colecciones»Endpoint de la API:
Sección titulada «Endpoint de la API:»GET http://localhost:7292/dstapi/DSTV1/GetAllCollectionsRespuesta:
Sección titulada «Respuesta:»{ "Success": true, "Message": "Collections Found", "Collections": [ { "Id": 1, "Name": "My Collection", "Description": "My description goes here...", "CollectionLive": true, "IsDefault": false }, ... ]}Ejemplo de código
Sección titulada «Ejemplo de código»const listCollections = async () => { const url = `${CLI_BASE_URL}/dstapi/DSTV1/GetAllCollections`; const request = await fetch(url);
const data = await request.json();
if (!data) { return null; }
if (data["Success"] == true) { return data["Collections"]; }
return null;};def list_collections(): url = f"{CLI_BASE_URL}/dstapi/DSTV1/GetAllCollections" response = requests.get(url) data = response.json()
if not data: return None
if data["Success"] == True: return data["Collections"]
return NoneConsultar una colección
Sección titulada «Consultar una colección»Endpoint de la API:
Sección titulada «Endpoint de la API:»GET http://localhost:7292/dstapi/DSTV1/GetCollection/{id}Parámetros de la URL:
Sección titulada «Parámetros de la URL:»id: el ID de la colección
Respuesta:
Sección titulada «Respuesta:»{ "Success": true, "Message": "Collection Found", "Collection": { "Id": 1, "Name": "My Collection", "Description": "My description goes here...", "CollectionLive": true, "IsDefault": false }}Ejemplo de código
Sección titulada «Ejemplo de código»const retrieveCollection = async (collectionId) => { const url = `${CLI_BASE_URL}/dstapi/DSTV1/GetCollection/${collectionId}`; const request = await fetch(url);
const data = await request.json();
if (!data) { return null; }
if (data["Success"] == true) { return data["Collection"]; }
return null;};def retrieve_collection(collection_id): url = f"{CLI_BASE_URL}/dstapi/DSTV1/GetCollection/{collection_id}" response = requests.get(url) data = response.json()
if not data: return None
if data["Success"] == True: return data["Collection"]
return NoneEliminar una colección
Sección titulada «Eliminar una colección»Endpoint de la API:
Sección titulada «Endpoint de la API:»GET http://localhost:7292/dstapi/DSTV1/DeleteCollection/{id}Parámetros de la URL:
Sección titulada «Parámetros de la URL:»id: el ID de la colección
Eliminar una colección también elimina sus publicaciones, subastas y ofertas en este nodo. La colección predeterminada no se puede eliminar; primero cambia la predeterminada con GET /dstapi/DSTV1/GetDefaultCollectionChange/{id}.
Respuesta:
Sección titulada «Respuesta:»{ "Success": true, "Message": "Collection deleted."}Ejemplo de código
Sección titulada «Ejemplo de código»const deleteCollection = async (collectionId) => { const url = `${CLI_BASE_URL}/dstapi/DSTV1/DeleteCollection/${collectionId}`; const request = await fetch(url);
const data = await request.json();
return data["Success"] == true;};def delete_collection(collection_id): url = f"{CLI_BASE_URL}/dstapi/DSTV1/DeleteCollection/{collection_id}" response = requests.get(url) data = response.json()
return data["Success"] == True