A Codyt or Standard project
| Child pages (Children Display) |
|---|
FORMAT
| Code Block | ||
|---|---|---|
| ||
<ApiProject> <ClientName>Lux Translations</ClientName> <Comments>Le document n'est pas termine et plusieurs mises a jour sont prevues dans les deux mois a venir</Comments> <CreationDate>2008-12-10T17:26:06.95</CreationDate> <Deadline>2009-02-13T16:00:00</Deadline> <DefaultRefMaterialAccess>1</DefaultRefMaterialAccess> <Domains> <ApiDomain> <DomainId>2147483647</DomainId> <Name>String content</Name> </ApiDomain> </Domains> <Instructions>Traduire manuel de Wordbee en utilisant les documents de reference n° 1 et 2. Traduire en anglais US</Instructions> <ManagerPersonId i:nil="true"/> <OnlineUrl> http:// www.wordbee-translator.com /Project/ProjectView.aspx?x=nTcuiWN5S%2f8T2HQQ4vTFYXHz4jv2sEj4PF0BJ2m%2fj34%3d </OnlineUrl> <PriceListId>1</PriceListId> <ProjectId>3</ProjectId> <ProjectType>Standard</ProjectType> <ReceivedDate>2008-12-10T01:30:00</ReceivedDate> <Reference>Project for teqsting bw Bastien 18923791827</Reference> <SourceLocale>fr</SourceLocale> <Status_>255</Status_> <TargetLocales xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <a:string>en-US</a:string> <a:string>fi</a:string> </TargetLocales> <Tasks> <ApiProjectsTasks> <Code>String content</Code> <Title>String content</Title> </ApiProjectsTasks> </Tasks> </ApiProject> |
...
ApiProject | Represents one project in the results list |
ClientName | The project client name |
Comments | Internal comments |
CreationDate | Date when the project was created |
Deadline | Project deadline |
DefaultRefMaterialAccess | Used for Codyt projects only: Indicates whether the reference material folder of the project is visible in all jobs (of this project). The possible values are: 0 - No access: Reference material is not visible in jobs and cannot be downloaded by suppliers 1 - Read-only: Reference material is accessible in all jobs. Suppliers can download files. 2 - Read/Write: Currently this option is not available. Do not use. |
Domains | Information included when requesting details for a specific project only Lists all the domains of the project. DomainId is the unique domain id Name is the domain's name. Example: "Technical" or "Legal" |
Instructions | Project instructions |
ManagerPersonId | The ID of the manager. See API on companies and persons for more information. |
ParserProfileId | The id of the document format profile associated to the project. Null if not set. |
PriceListId | The prices to use for the project's client. Points to a price list. |
ProjectId | The unique project id |
ProjectType | Can be either Standard = 0 or Codyt = 1) |
ReceivedDate | The date when this project was received |
Reference | The project's reference |
SourceLocale | Source language |
Status_ | The project status. Any of these values:
|
TargetLocales | One or more languages into which to translate the project documents |
Tasks | Information included when requesting details for a specific project only Lists all the tasks of the project. Code Can be TR (Translation), RV (Revision) or APP (Approval/Proofreading) Title is the title name of the task. Example: "Translation" or "Revision" |
OnlineUrl | Url to access the project details page from a web browser. |
ApiProjectJob | Represents standard project's job. Whereas Codyt uses "tasks" to organize work, standard projects uses "jobs". A job has a source and target language, contains one or more documents and is allocated to one specific worker. Format <ApiProjectJob> <ProjectJobId>2147483647</ProjectJobId> <ProjectId>2147483647</ProjectId> <Reference>String content</Reference> <ReferenceMaterialAccess>1</ReferenceMaterialAccess> <TaskCode>String content</TaskCode> <LocaleSource>String content</LocaleSource> <LocaleTarget>String content</LocaleTarget> <WorkerCompanyId>2147483647</WorkerCompanyId> <WorkerPersonId>2147483647</WorkerPersonId> <StartDate>1999-05-31T11:20:00</StartDate> <EndDate>1999-05-31T11:20:00</EndDate> <Deadline>1999-05-31T11:20:00</Deadline> <Status_>255</Status_> <Instructions>String content</Instructions> <Comments>String content</Comments> <CostInformation>String content</CostInformation> <PriceListId>2147483647</PriceListId> <JobTraces> <ProjectJobTrace> <JobId>2147483647</JobId> <TraceDate>1999-05-31T11:20:00</TraceDate> <Status_>255</Status_> <PersonId>2147483647</PersonId> <Message>String content</Message> </ProjectJobTrace> </JobTraces> </ApiProjectJob> Properties ProjectJobId |
The unique job id | ProjectId |
The project to which this job belongs. | Reference |
Job reference | ReferenceMaterialAccess |
Used for Standard projects only: Indicates whether the reference material folder of the project is visible in the job. The possible values are: | 0 - No access: Reference material is not visible in jobs and cannot be downloaded by suppliers 1 - Read-only: Reference material is accessible in the job. Suppliers can download files. 2 - Read/Write: Currently this option is not available. Do not use. |
TaskCode | Can be TR (Translation), RV (Revision) or APP (Approval/Proofreading) |
LocaleSource | LocaleTarget |
The languages of the job. | WorkerCompanyId |
If not empty then the job is allocated to this supplier company (can be the master company). | WorkerPersonId |
The person inside the WorkerCompanyId to which the job is allocated. This field is optional and is exclusively used when ditributing work to inhouse staff. | StartDate |
Date when the job was moved into the InProgress status. | EndDate |
Date when the job was moved into the Completed status. | Deadline |
Optional deadline | Status_ |
Job status: | /// <summary> /// Job visible internally only and not to supplier /// </summary> Draft = 0, /// <summary> /// Job now proposed to supplier and waiting to be accepted by supplier (or rejected) /// </summary> Proposal = 1, /// <summary> /// Can be freely set by supplier to indicate that the job is well accepted but work has not started /// </summary> NotStarted = 2, /// <summary> /// Job accepted and in progress. /// </summary> InProgress = 3, /// <summary> /// Job completed /// </summary> Completed = 4, /// <summary> /// Job results approved. /// </summary> Delivered = 5, /// <summary> /// Job results are archived. This normally means that the job is completed/delivered and /// does not need to show up in lists. "Move it off the workspace!" /// </summary> Archived = 6, /// <summary> /// Supplier rejected a job proposal /// </summary> Rejected = 10, /// <summary> /// Job cancelled by ordering party or inhouse manager /// Job cannot be seen by worker. /// </summary> Cancelled = 11, |
Instructions | Instructions sent to the supplier |
Comments | Optional internal comments |
CostInformation | NOT USED |
PriceListId | Optional supplier price list selected to calculate cost. Points to a price liust of the supplier (WorkerCompanyId) |
JobTraces | Information included when requesting details for a specific document of a job only List of job traces for the job. When the status of the job is changed a trace is saved. JobId is the identifier of the job TraceDate is the date when the status of the job has been changed Status_ is the status of the job. Message is the message left by the user when he changed the status |