Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

PARAMETERS

Parameters are:

token

The session token obtained when connecting.

ids

Mandatory.

A comma separated list of request IDs to post edit, for example: "1000,2000, 645, 22"

referenceMandatory. A user given free text reference for the post edit request.
deadlineOptional. User given deadline. Please not that deadlines may be mandatory. See the configuration API method for details.
commentsOptional. User given comments to be sent to the translation team. Delimit length of comments to 500 characters.

 

RESULTS

The method returns a JSON object:

trmid

Null if the operation has been completed. In this case the "status" property is either "Finished" or "Failed".

Otherwise an ID that references the operation. With this ID you can poll the API to know when the operation is complete.

int?
status

The status of the operation. Any of:

  • Waiting: The operation is queued for processing
  • Executing: The operation is being processed but not complete
  • Finished: The operation is complete
  • Failed: The operation failed

 

string

 

An HTTP status of 204 200 indicates success. Other HTTP status values indicate an error.The method does not return data.

The post edit status in the individual request records (see API - IT - List Requests) indicates when the request for post editing is acknowledged, in progress and ultimately completed.

 

...