GET Project - TextKing/textking-api GitHub Wiki

GET /project/{projectId}

Request: GET /project/{projectId}

Returns a single project with the given ID.

Project states

A project can be in one of the following states.

Header Description
prepared The project has been created but is not yet activated.
running The project has been activated and is currently being translated.
finished The project is completely translated.
canceled The project was canceled.

Request headers

Header Description
Authorization oAuth 2 authentication header
Accept application/json or application/xml

Response status codes

HTTP status Description
200 Ok Successful request.
400 Bad Request The project ID is not a valid UUID.
404 Not Found The project with the given ID does not exist.

Example

Load the project with the ID 9f7f369f-670b-4bc0-8925-0344bfb68b70:

GET /v1/project/9f7f369f-670b-4bc0-8925-0344bfb68b70 HTTP/1.1
Host: api.textking.com
Accept: application/json
Authorization: Bearer youraccesstoken

Response:

HTTP/1.1 200 Ok
Content-Type: application/json; charset=utf-8

{
    "id": "9f7f369f-670b-4bc0-8925-0344bfb68b70",
    "number": "EN1216954",
    "name": "My Translation Project",
    "due_date": "2012-10-22T00:00:00",
    "state": "running",
    "currency": "EUR",
    "net_price": 19.4,
    "vat": 8,
    "coupon_name": null,
    "coupon_value": null,
    "discount_customer": 0,
    "discount_project": 0,
    "affiliate_id": null,
    "billing_address": "9c6f23b6-167d-4b01-977f-4de799e3abf3",
    "links": [
        {
            "rel": "self",
            "href": "https://api.textking.com/v1/project/9f7f369f-670b-4bc0-8925-0344bfb68b70"
        },
        {
            "rel": "urn:textking:jobs",
            "href": "https://api.textking.com/v1/project/9f7f369f-670b-4bc0-8925-0344bfb68b70/jobs"
        },
        {
            "rel": "urn:textking:line_items",
            "href": "https://api.textking.com/v1/project/9f7f369f-670b-4bc0-8925-0344bfb68b70/line-items"
        },
        {
            "rel": "urn:textking:billing_address",
            "href": "https://api.textking.com/v1/account/address/9c6f23b6-167d-4b01-977f-4de799e3abf3"
        }
    ]
}
⚠️ **GitHub.com Fallback** ⚠️