Agenda photo/sort

Změní pořadí fotek inzerátu a hlavní fotku jedním požadavkem. Obsah fotek ani jejich ID se nemění.

Funkce agendy

Název	Možnosti
Podporované metody	PUT/POST – jiná metoda vrátí chybu 405
Podpora úrovně detailu	✘
Podpora filtrace	✘
Podpora fulltextu	✘
Podpora stránkování	✘
Podpora řazení	✘
Podpora externích identifikátorů	✔
Podpora schémat	https://api.tipmoto.com/schemas/photo/sort-import.{xsd|rng}
Podpora ?fail-on-warning	✘
Podpora dry-run	✔
Vrací location	✘

Adresa

https://api.tipmoto.com/c/{ID firmy}/{moto|dily|prislusenstvi}/{ID inzerátu}/photo/sort.{xml|json}

Místo ID inzerátu můžete použít externí identifikátor api-{idApi}.

Specifikace XML/JSON

Str. název	Název	Typ	Informace
photos	Seznam fotek		Povinné. Obsahuje jednu nebo více položek photo v požadovaném pořadí.
photo/id	ID fotky	integer	Povinné. ID fotky v rámci daného inzerátu (viz agenda photo). Fotka musí patřit k inzerátu a v seznamu smí být nanejvýš jednou.
photo/main	Hlavní fotka	select	Nepovinné – hlavní fotkou se vždy stane první položka. Možné hodnoty: 1 nebo true Ano – smí být jen u první položky 0 nebo false Ne – nesmí být u první položky Neplatná hodnota se ignoruje a v odpovědi přijde warning.
photo/sortOrder	Pořadí fotky		Neposílá se – pořadí určuje pořadí položek. Uvedení vrátí chybu 406. Pozici jedné fotky změníte přes PUT /photo/{id} se sortOrder.
ostatní	Prvky z výpisu fotek		Prvky a atributy z výpisu photo.xml (url, stamp, width, height, urlApi, stampApi, resize, @forceupdate, @modify, id@ref) se připouštějí, ale ignorují se.

Jak se pořadí určí

• Pořadí určuje pořadí položek photo: první položka je hlavní fotka (pozice 1), další následují v uvedeném pořadí.
• Seznam nemusí být úplný: fotky inzerátu, které v něm nejsou, se zařadí za vyjmenované ve svém dosavadním pořadí.
• Posílejte jen id, main nanejvýš u první položky. Aby šlo poslat zpět přeřazený výpis photo.xml, ostatní prvky z něj se připouštějí a ignorují a main = 0 u ostatních položek projde. Jen sortOrder z výpisu je nutné vynechat a položky photo obalit do <photos> (výpis je vrací přímo pod <tipmoto>).
• Požadavek, který pořadí nezmění, vrátí 200 s informací, že se pořadí nezměnilo; změna se pak nehlásí (neobjeví se v agendě change).
• S parametrem ?dry-run=true se nic neuloží a odpověď ukáže pořadí, které by nastalo.
• Pravidla pořadí a hlavní fotky jsou stejná pro všechny cesty, viz Pořadí a hlavní fotka.

Příklad

XML (PUT na …/photo/sort.xml) – fotka 11 bude hlavní, za ní fotky 2 a 3, ostatní fotky inzerátu za nimi:

<tipmoto>
  <photos>
    <photo><id>11</id><main>1</main></photo>
    <photo><id>2</id></photo>
    <photo><id>3</id></photo>
  </photos>
</tipmoto>

JSON (PUT na …/photo/sort.json):

{"tipmoto": {"photos": {"photo": [{"id": "11", "main": "1"}, {"id": "2"}, {"id": "3"}]}}}

Odpověď obsahuje result/photos s výsledným pořadím všech fotek inzerátu (sortOrder = pozice, 1 = hlavní fotka) a případně result/warnings a result/infos:

<tipmoto>
  <success>true</success>
  <result>
    <photos>
      <photo><id>11</id><sortOrder>1</sortOrder><main>1</main></photo>
      <photo><id>2</id><sortOrder>2</sortOrder><main>0</main></photo>
      <photo><id>3</id><sortOrder>3</sortOrder><main>0</main></photo>
      <photo><id>1</id><sortOrder>4</sortOrder><main>0</main></photo>
    </photos>
  </result>
</tipmoto>

Celý postup od načtení fotek po přeřazení ukazuje příklad.

Chyby

HTTP kód	Kdy
400	neplatná hodnota parametru dry-run
402	login nemá právo zápisu do agend firmy, nebo firma nemá povolené importy
404	jiná agenda než moto, dily, prislusenstvi; inzerát neexistuje nebo nepatří firmě
405	jiná metoda než PUT/POST
406	chybné XML/JSON; chybí photos se seznamem photo; prázdný seznam; chybějící nebo neplatné id; fotka, která k inzerátu nepatří; id v seznamu vícekrát; uvedený sortOrder; main = 1 jinde než u první položky; main = 0 u první položky. Hláška řekne, u které položky a proč. Nic se nezmění.
503	pořadí fotek téhož inzerátu právě mění jiný požadavek (nebo se fotky nepodařilo načíst); nic se nezměnilo, požadavek zopakujte