Get Project

Resource:
/api/projects/<<project id>>
Method:
GET

Retrieves information about a project.  If the project is complete, the request will return all of the translated products associated with the project.

Arguments

  • Project ID: The onDemand Project ID. You will receive this ID from Generate Quote

Return Codes

Status Code Comments
Success 200 Successful request
Bad Request 400  
Unauthorized 401

The request did not

pass authentication or

the customer is not a

member of an enterprise

site.

Not Found 404

The URL does not relate

to a project that the

account owns.

Response Body

The response body shows information about the project.

Property Type Comments
ProjectID
Integer

onDemand ID of the

project

QuoteID
Integer

onDemand ID of the

quote

Status
String Status of the project
ProjectName
String Name of the project
ServiceID
Integer  
Price
Decimal  
Currency
String

Currency paid for the

project.  See glossary

for list of valid

currencies.

CreationDate
String

String representing

Date/Time (ISO 8601)

 that the Item was

added to onDemand.

DueDate
String

String representing

Date/Time (ISO 8601)

 that the translation

of the project is

scheduled to be

completed.

CompletionDate
String

String representing

Date/Time (ISO 8601)

that the translation of

the item was completed.

SourceLanguage

.LanguageCode
String

See LanguageCode in

glossary

TargetLanguages
Container

Container containing

target languages.

TargetLanguages

.TargetLanguage

.LanguageCode

String

See LanguageCode in

glossary

TargetLanguages

.TargetLanguage

.Units

Integer

The estimated number of

words, minutes, or pages

counted in the source

file. Depending on the

pricing algorithm, this

this unit count could be

used to price the

project. This feature is

only enabled on certain

enterprise sites. Talk

to your account

representatives for

details.

Products
Container

Container of Products.

This element will be

empty if this project

contiains fils instead

of products.

Products

.Product
Container

Container of Item

information

Products

.Product

.SKU

String The SKU of the item

Products

.Product

.AssetID

Integer

The internal Asset ID

of the product.

Products

.Product

.TargetLanguages

Container

Container containing

target languages.

Products

.Product

.TargetLanguages

.TargetLanguage

.LanguageCode

String

See LanguageCode in

glossary

Products

.Product

.TargetLanguages

.TargetLanguage

.URL

String

URL to retrieve this

particular translation.

Products

.Product

.TargetLanguages

.TargetLanguage

.Translation

Container

Container Element for

translated content. The

description will use

the same structure as

the source content.

 Only ItemSpecifics

that are recommended or

required on the target

language will be

returned.  The API will

add an additional node

called “SourceName” on

each ItemSpecific

Files
Container

Contains file elements.

It will be empty on

projects that have

products instead of

files.

Files

.File

.AssetID

Integer Asset ID of the file.

Files

.File

.FileName

String

Original name of the

file.

Files

.File

.Status

String

Status of individual

file. Options include

Analyzing, Analyzed,

Analysis Failed, In

Translation, Translated

Files

.File

.URL

String

URL to download the

source file.

Files

.File

.TargetLanguages

Container

Container containing

target languages.

Files

.File

.TargetLanguages

.TargetLanguage

.AcceptedBy

 

If the file is a target

file and has been

accepted, the user who

accepted it.

Files

.File

.TargetLanguages

.TargetLanguage

.AcceptedDate

 

If the file is a target

file and has been

accepted, the date it

was accepted.

Files

.File

.TargetLanguages

.TargetLanguage

.AcceptedMethod

 

If the file is a target

file and has been

accepted, the method of

acceptance (implicit or

explicit).

Files

.File

.TargetLanguages

.TargetLanguage

.LanguageCode

String

See LanguageCode in

glossary

Files

.File

.TargetLanguages

.TargetLanguage

.Status

String

Status of this target

file.

Files

.File

.TargetLanguages

.TargetLanguage

.URL

String

String representing

the url to download

the translated file.

ReferenceFiles

.ReferenceFile
Container

Container for a

reference file. A

reference file is used

to inform the work that

is being done. There is

no charge for reference

files.

ReferenceFiles

.ReferenceFile

.AssetID

Integer

Asset ID of the

reference file.

ReferenceFiles

.ReferenceFile

.FileName

String

Original name of

the file.

ReferenceFiles

.ReferenceFile

.URL

String

URL where the file can

be downloaded.

ReferenceFiles

.ReferenceFile

.TargetLanguages

Container Empty element.

Response Examples

Example of get project response for product-based projects.

<Project>
    <ProjectID>10001</ProjectID>
    <QuoteID>12345</QuoteID>
    <Status>Complete</ProjectStatus>
    <ServiceID>14</ServiceID>
    <TotalWords>1000</TotalWords>
    <Price>1000.00</Price>
    <Currency>EUR</Currency>
    <CreationDate>2014-01-25T10:32:02Z</CreationDate>
    <DueDate>2014-01-25T10:32:02Z</DueDate>
    <CompletionDate>2014-01-25T10:32:02Z</CompletionDate>
    <SourceLanguage>
        <LanguageCode>en-gb</LanguageCode>
    </SourceLanguage>
    <TargetLanguages>
        <TargetLanguage>
            <LanguageCode>de-de</LanguageCode>
            <Units>21</Units>
        </TargetLanguage>
        <TargetLanguage>
            <LanguageCode>fr-fr</LanguageCode>
            <Units>21</Units>
        </TargetLanguage>
    </TargetLanguages>
    <Products>
        <Product>
            <AssetID>9999</AssetID>
            <SKUs>
                <SKU>
                    <SKUNumber>123</SKUNumber>
                </SKU>
            </SKUs>
            <TargetLanguages>
                <TargetLanguage>
                    <LanguageCode>it-it</LanguageCode>
                    <URL>https://</URL>
                    <Translation>
                        <Title>...</Title>
                        <Description>
                            <!-- Same structure as submitted -->
                        </Description>
                        <PrimaryCategory>123</PrimaryCategory>
                        <SKUs>
                            <SKU>
                                <SKUNumber>123</SKUNumber>
                                <ItemSpecifics>
                                    <ItemSpecific>
                                        <SourceName>Colour</SourceName>
                                        <Name>Culeur</Name>
                                        <Value>Blanc</Value>
                                    </ItemSpecific>
                                    <ItemSpecific>
                                        <SourceName>Size</SourceName>
                                        <Name>Taille</Name>
                                        <Value>Grande</Value>
                                    </ItemSpecific>
                                </ItemSpecifics>
                            </SKU>
                        </SKUs>
                    </Translation>
                </TargetLanguage>
                ...
            </TargetLanguages>
        </Product>
    </Products>

    <ReferenceFiles>
        <ReferenceFile>
            <AssetID>12345</AssetID>
            <FileName>my-file.txt</FileName>
            <URL>https://ondemand.liondemand.com/api/files/12345</URL>
            <TargetLanguages />
        </ReferenceFile>
        <ReferenceFile>
            <AssetID>12346</AssetID>
            <FileName>my-other-file.txt</FileName>
            <URL>https://ondemand.liondemand.com/api/files/<AssetID>12346</AssetID></URL>
            <TargetLanguages />
        </ReferenceFile>
    </ReferenceFiles>
    <SpecialInstructions/>
</Project>

Example of get project response for file-based projects.

<Project>
    <ProjectID>10001</ProjectID>
    <QuoteID>12345</QuoteID>
    <Status>Complete</ProjectStatus>
    <ServiceID>14</ServiceID>
    <TotalWords>1000</TotalWords>
    <Price>1000.00</Price>
    <Currency>EUR</Currency>
    <CreationDate>2014-01-25T10:32:02Z</CreationDate>
    <DueDate>2014-01-25T10:32:02Z</DueDate>
    <CompletionDate>2014-01-25T10:32:02Z</CompletionDate>
    <SourceLanguage>
        <LanguageCode>en-gb</LanguageCode>
    </SourceLanguage>
    <TargetLanguages>
        <TargetLanguage>
            <LanguageCode>de-de</LanguageCode>
            <Units>21</Units>
        </TargetLanguage>
        <TargetLanguage>
            <LanguageCode>fr-fr</LanguageCode>
            <Units>21</Units>
        </TargetLanguage>
    </TargetLanguages>
    <Files>
        <File>
            <AssetID>1111</AssetID>
            <FileName>foo.txt</FileName>
            <URL>https...</URL>
            <Status>Translated</Status>
            <TargetLanguages>
                <TargetLanguage>
                    <LanguageCode>it-it</LanguageCode>
                    <URL>https://</URL>
                    <Status>Accepted</Status>
                    <AcceptedBy> Example &lt;user@example.com&gt; </AcceptedBy>
                    <AcceptedDate>2016-03-15T04:00:00Z</AcceptedDate>
                    <AcceptedMethod>implicit</AcceptedMethod>
                </TargetLanguage>
                ...
            </TargetLanguages>
        </File>
    </Files>
    <ReferenceFiles>
        <ReferenceFile>
            <AssetID>12345</AssetID>
            <FileName>my-file.txt</FileName>
            <URL>https://ondemand.liondemand.com/api/files/12345</URL>
            <TargetLanguages />
        </ReferenceFile>
        <ReferenceFile>
            <AssetID>12346</AssetID>
            <FileName>my-file.txt</FileName>
            <URL>https://ondemand.liondemand.com/api/files/12346</URL>
            <TargetLanguages />
        </ReferenceFile>
    </ReferenceFiles>
    <SpecialInstructions/>
</Project>