Jelentett problémák

A Szerkesztőben jelentett problémák listájának lekérdezése.

Kérelem

POST https://api.crowdin.com/api/project/{project-identifier}/issues?key={project-key}

Paraméterek

Név Érték Leírás
type opcionális string Meghatározza a probléma típusát.
Elfogadható értékek:
  • "general_question" — általános kérdés
  • "translation_mistake" — jelenlegi fordítás rossz
  • "context_request" — szövegösszefüggési információ hiányzik
  • "source_mistake" — hiba a forrás-karakterláncban
  • "all" — az összes fent felsorolt problématípus (alapértelmezett érték)
status opcionális string Meghatározza a probléma megoldásának állapotát.
Elfogadható értékek:
  • "unresolved" — megoldatlan problémák
  • "resolved" — megoldott problémák
  • "all" — az összes fent felsorolt megoldási állapot (alapértelmezett érték)
file opcionális string A problémákhoz kapcsolódó fájl elérési útvonala.
Ha a fájl elérési útja nincs megadva, akkor a módszer az összes projektfájlhoz kapcsolódó problémát kérdezi le.
date_from opcionális string Adott időpont után hozzáadott problémák. A következő ISO 8601 formátumot használja: YYYY-MM-DD±hh:mm
date_to opcionális string Adott időpontig hozzáadott problémák. A következő ISO 8601 formátumot használja: YYYY-MM-DD±hh:mm
json opcionális string Nem tartalmazhat értéket. Meghatározza, hogy a válasz JSON formátumban kell legyen.
jsonp opcionális string Visszahívási funkció neve. Meghatározza, hogy a válasz JSONP formátumban legyen.
Változók
project-identifier szükséges string A projekt azonosítóját kell tartalmaznia.
project-key szükséges string Projekt API kulcs.

Válasz

Ha a módszer sikeres, akkor XML struktúrával válaszol, ahogy az az alábbiakban látható:
<?xml version="1.0" encoding="ISO-8859-1"?>
<issues>
    <issue>
        <source_string>Project name</source_string>
        <context>Headline 3 XPath: /html/body/div/div/h3</context>
        <comment>Source string mistake</comment>
        <created>2017-12-18T14:19:05+0000</created>
        <type>source_mistake</type>
        <status>unresolved</status>
        <file>/crowdin_sample_webpage.html</file>
        <string_url>https://crowdin.com/translate/project-issues/3624/en-uk#14342648</string_url>
        <user>John Doe</user>
    </issue>
    <issue>
        <source_string>Current Password</source_string>
        <context>current_password</context>
        <comment>wrong translation</comment>
        <created>2017-12-18T14:18:29+0000</created>
        <type>translation_mistake</type>
        <status>unresolved</status>
        <file>/crowdin_sample_android.xml</file>
        <string_url>https://crowdin.com/translate/project-issues/3625/en-uk#14342682</string_url>
        <user>John Doe</user>
    </issue>
    <issue>
        <source_string>Gyors indítás</source_string>
        <context>quick_start</context>
        <comment>Need more context</comment>
        <created>2017-12-18T14:18:01+0000</created>
        <type>context_request</type>
        <status>unresolved</status>
        <file>/crowdin_sample_android.xml</file>
        <string_url>https://crowdin.com/translate/project-issues/3625/en-uk#14342693</string_url>
        <user>John Doe</user>
    </issue>
</issues>
Sikertelen válasz példa:
<?xml version="1.0" encoding="ISO-8859-1"?>
<error>
    <code>1</code>
    <message>The requested project does not exist or the API key is not valid.</message>
</error>

Példák

  curl \
    -F "type=general_question" \
    -F "status=unresolved" \
    -F "date_from=2017-01-01" \
    https://api.crowdin.com/api/project/{project-identifier}/issues?key={project-key}
<?php
$post_params = array();
$request_url = 'https://api.crowdin.com/api/project/{project-identifier}/issues?key={project-key}';
$post_params['type'] = 'general_question';
$post_params['status'] = 'unresolved';
$post_params['date_from'] = '2017-01-01';

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $request_url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post_params);

$result = curl_exec($ch);
curl_close($ch);

echo $result;