Function Return Types

Result

Each function of crossAPI SI returns an object of the type Result.

Result is a container for three variables:

The descriptions under the item return value/success for each of the functions always refer to the data member of the result container if no error has occurred. The values under return value/error always refer to the error code member of the result container in case of an error. In single function descriptions, you will only find a purely numeric value.

Error Codes

Error Code	Description	General error for all functions
1	crossAPI SI is not connected to the Across Server.
2	User does not exist.
3	Unable to create security token.
4	The assigned security token is either invalid or expired.
5	The SQL query is invalid. This can either mean that it is syntactically incorrect or that it is writing.
6	Unable to execute SQL query.
7	The user is not in the crossAPI group.
8	The server has given an incorrect answer.
9	Unable to send message.
10	The security token could not be returned because crossAPI has not been started.
11	Unable to create relation.
12	Unable to create project.
13	Relation does not exist.
14	Subject does not exist.
15	Language does not exist.
16	Document does not exist.
17	Job does not exist.
18	Unable to create job.
19	Project does not exist.
20	One or more invalid parameters have been assigned to the function. An example of this is a NULL pointer in C++ when a string is expected.
21	Job has been canceled.
22	crossSPI has not been initialized. Details available in crossAPI.log. There is most probably an incompatibility in a DSE*.dll file.
23	This document format is not supported. Across checks this according to the document extension and not to the content. When a file is checked in or updated, Across first checks whether the document extension is supported and only then if the file is present at the given location.
24	Workflow does not exist.
25	Failed to assign workflow to document. A possible reason for this is that the workflow has already been assigned to the document.
26	Unable to assign user to document.
27	Task template does not exist.
28	Document template does not exist.
29	Cannot generate report.
30	Unable to delete project. More detailed information can be found in the error description.
31	Unable to delete document. More detailed information can be found in the error description.
32	Unable to move project to archive. More detailed information can be found in the error description.
33	Unable to delete relation. More detailed information can be found in the error description.
34	Unable to create subject. More detailed information can be found in the error description.
35	Unable to update document. More detailed information can be found in the error description.
36	Unable to carry out pre-translation. More detailed information can be found in the error description.
37	Unable to copy project. More detailed information can be found in the error description.
38	Unable to carry out relay assignment. More detailed information can be found in the error description.
39	Unable to rename project. More detailed information can be found in the error description.
40	Unable to rename document. More detailed information can be found in the error description.
41	The paragraph state does not exist.
42	Unable to set paragraph state. More detailed information can be found in the error description.
43	The job has not yet been completed.
44	Unable to assign the subject to the project. More detailed information can be found in the error description.
45	Unable to assign the relation to the project. More detailed information can be found in the error description.
46	Unable to read license key.
47	Unable to find license key.
48	The license key is invalid.
49	The user group does not exist.
50	Unable to create user.
51	Unable to remove user.
52	Unable to generate crossWAN packages.
53	Task does not exist.
54	Unable to export crossWAN packages.
55	Unable to import crossWAN packages.
56	Document type is not supported.
57	Unable to add comment to project.
58	Unable to add comment to relation.
59	Unable to set properties of relation.
60	Unable to add comment to document.
61	Unable to add comment to language.
62	Unable to add comment to user.
63	Unable to create license.
64	Unable to delete license.
65	Unable to assign license to user.
66	Unable to unassign license from user.
67	Unable to set license data.
68	Unable to save softkey.
69	The license already exists.
70	Cannot open file.
71	File not found.
72	Cannot remove file.
73	Cannot add attachment.
74	Cannot set project ID.
75	Cannot import exchange data.
76	Cannot export exchange data.
77	Cannot load comments.
78	The crossGrid Server does not exist.
79	crossGrid package does not exist.
80	Cannot create crossGrid package.
81	Cannot get product version.
82	Cannot export crossGrid classic package.
83	Cannot import crossGrid classic package.
84	Cannot adjust DB.
85	Cannot set project to finished.
86	Exchange database (CWU/CRU) migration is not supported.
87	Job already finished.
88	Canceling is not supported for the job.
89	Task cannot be finished. More detailed information can be found in the error description.
90	Check-in job failed.
91	Check-out job failed.
92	crossTank job failed.
93	Project job failed.
94	crossGrid job failed.
95	Cannot create file.
96	Cannot save document settings.
97	Cannot load document settings.
98	Cannot load XML content.
99	Cannot set user properties.
100	Cannot retrieve CWU tasks.
101	Cannot export project.
102	Cannot import project.
103	The project does not have an external ID.
104	External project ID is not set.
105	Cannot add rating.
106	Rating already exists.
107	Rating does not exist.
108	crossGrid user cannot be edited.
109	Cannot revoke the task.
110	Document cannot be finished.
111	Document cannot be set to unfinished.
112	Is not ready to be finished.
113	Language already exists for this document.
114	Cannot add language.
115	Cannot remove language.
116	The language is involved in crossGrid process and cannot be edited or deleted.
117	Cannot remove rating.
118	Cannot switch license status.
119	The user must be an offline user.
120	Cannot change settings.
130	Assign job failed.
131	Cannot apply profile.
132	Cannot create crossWAN/crossGrid session.
133	Cannot upload server task.
134	Cannot download server task.
135	Cannot remove comment.
136	Comment not found.
137	Cannot set finish date.
138	Cannot set deadline.
139	The attachment does not exist.
140	Cannot load attachment.
141	Cannot remove attachment.
142	Unexpected error.
143	User does not have the permission.
144	Project settings do not exist.
145	crossTank/crossTerm package does not exist.
146	Cannot import crossTank/crossTerm package.
147	Cannot create project settings.
148	Cannot load statistics.
149	Cannot create group.
150	Language already exists in the system.
151	Cannot store finished translation.
152	The Server Context does not exist.
153	Cannot remove crossTank/crossTerm package.
154	The task is not assigned.
155	Cannot load profile.
156	Cannot set project to released state.
157	Wrong task type.
158	Cannot remove subject.
159	Cannot change user password.
160	The reporting template does not exist.
161	Cannot load reporting templates.
162	Cannot compare files.
163	Wrong document version number.
164	Cannot remove document version.
165	Cannot activate document version.
166	Cannot set project description.
167	Invalid username or password.
168	License does not exist or does not match the master license.
169	Plugin does not exist.
170	Attribute does not exist.
171	Attribute value does not exist.
172	Cannot add the attribute.
173	Cannot activate project.
174	Cannot deactivate project.
175	Cannot activate all projects.
176	Cannot deactivate all projects.
177	File is empty.
178	The profile does not exist.
179	License disabled.
180	The document is not ready because it is being checked in.
181	Cannot remove attributes.
182	Requested position is larger than the size of the file.
183	Error during file operations.
184	crossTerm job failed.
185	Cannot add user to group.
186	Cannot remove user from group.
187	The instance does not exist.
188	Cannot get instance.
189	Document manager job failed.
190	Task manager job failed.
191	Project cannot be unfinished.
192	Language cannot be finished.
193	Language cannot be unfinished.
194	Task cannot be unfinished.
195	Cannot save project settings.
196	Cannot load project settings.
197	The crossGrid packaging template does not exist.
198	The crossWAN packaging template does not exist.
199	The template cannot be applied.
200	Cannot remove the crossGrid package.
201	Cannot close or open the crossGrid package for assignments.
202	You do not have a license for XLIFF import/export.
203	Given MT engine is disabled
204	MT engine does not contain any language configurations
205	Language configuration with given language pair does not exist
206	Cannot remove/create document partitions.
207	The QM check could not be applied because the document does not support it.
208	QM check failed.
209	Cannot release bizmodel locks.
210	Cannot confirm task.
211	Cannot unconfirm task.
212	Group cannot be assigned.
213	Language manager job failed.
214	Report does not exist.
215	Cannot get crossGrid packages.
216	The task has never been finished.
217	Partitioning is not allowed for source document editing.
218	Workflow with possibility of source document editing cannot be assigned to partitioned document.
219	Some tasks are not assigned to offline users.
220	Some tasks are assigned to different users.
221	Document was checked-in with a higher version of Across. Check-out and preview are not possible in current version.
222	Cannot set the document description.
223	Cannot set progress for non external editing task.
224	Cannot set progress for task.
225	The language content cannot be changed.
226	Cannot reset paragraph states for the task.
227	Cannot set start date.
228	Partitioning of tasks is not allowed by the Master Server.
229	The package cannot be exported because its build is not up to date. Rebuild the package prior to export.
230	The function is not supported.
231	Could not mark all comments as resolved.
234	The operation is rejected.
235	The login exceeds the maximum number of 100 characters.
236	The password exceeds the maximum number of 100 characters.
237	The specified documents have different workflows. The EDR can only handle documents with the same workflow.
238	You do not have a license for advanced reports.
239	Unable to evaluate source language for relay translation because relay tasks have different source languages.
240	The paragraph state is not involved in the workflow.
241	The paragraph state is not involved in the task.
242	The language cannot be loaded.
243	Document extension is not found.
244	Cannot set project settings.
245	Incorrect workflow for unsupported document.