Service
The following operations are supported. For a formal definition, please review the Service Description.
-
AbandonProject
This method cancels the specified project as long as the project hasn’t entered the production phase. If the project is already in production but still requires termination – you will need to contact your associated PM through the normal channels. -
About
About the service. -
AcceptOrRejectQuote
This method allows accepting or rejecting a quote. When doing so, the 'PO Reference' value can be updated by passing it in as parameter. If you do not need to update the 'PO Reference' value, simply pass an empty string. A quote, in order to be accepted or rejected, must have a status of 'forecasted'. The status of a quote can be determined by invoking the 'GetProjectInformation' method. Note that the 'Comments' parameter is ignored when accepting a quote. -
AddFileToFeedbackPackage
This method adds files to a feedback package. Source and target languages need to be part of the order -
AddFileToProject
Adds a file to the specified project and language pairing(s). -
AddTaskToProject
This method adds work tasks to the newly created project (or existing projects once production has not begun). If the call has been successful – a boolean of True will be returned. -
AssignAssetToProject
This method assigns an file asset (via the AssetID parameter) to an existing Project. Specify the ProjectID parameter to target an existing project to associate the asset with. You must also specify the source and a list of target languages. If successful a fileInfoList detail is returned. -
CancelFeedbackPackage
This method cancels a feedback package -
CreateFeedbackPackageForProject
This method creates a feedback package for an order -
CreateProject
This method initializes a new project header in Freeway. The parameters specify base settings for the new project such as project description, special instructions etc. Upon a successful call – a string containing a new Project ID is returned. This Project ID is then used in subsequent methods to add lines, files etc to the new project. -
GetComponents
Retrieves a list of the your available Components. -
GetComponentsAsXML
Retrieves an XML list of the your available Components. -
GetCustomerAnalysisCodes
This method allows retrieving the analysis codes for a specific customer. Analysis codes for a specific label can be retrieved by passing the name of the label as the "analysisCodeLabel" parameter (e.g. 'Development', 'Research', etc.). If all analysis codes should be returned, independently of their label, pass an empty string as the "analysisCodeLabel" parameter. -
GetDeliveryList
Get Delivery Listing based on your User details -
GetDeliveryListForProject
Get Delivery List For a Project, also checks your User details -
GetFileStatus
Retrieves a status list in XML of files in the specified project. -
GetFileStatusAsXML
Retrieves a status list in XML of files in the specified project. -
GetProjectInformation
Get full details on the financials of the project. Financials will only be returned if project has a stutus of 'Forecasted', 'In Production', 'Completed', or 'Closed'. -
GetProjectStatus
This method retrieves the overall status of the specified project. -
GetProjectSummariesList
Get project summaries list based on your specified criteria. -
GetProjectSummariesListAsXML
Get project summaries list as XML based on your specified criteria. -
GetSourceLanguages
Retrieves a list of source languages that are available to you. -
GetSourceLanguagesAsXML
Retrieves an XML list of source languages that are available to you. -
GetSubTasks
Retrieves a list of the your available Sub-Tasks for the specified TaskID. -
GetSubTasksAsXML
Retrieves an XML list of the your available Sub-Tasks for the specified TaskID.. -
GetSubjects
Retrieves a list of your available subject matters. -
GetTargetLanguages
Retrieves a list of target languages for the specified source language that are available to you. -
GetTasks
Retrieves a list of the your available Tasks. -
GetTasksAsXML
Retrieves an XML list of the your available Tasks. -
GetUOMs
Retrieves a list of the your available Units of measure. -
GetUOMsAsXML
Retrieves a list of the your available Units of measure. -
RetrieveProjectFileByFilename
Returns the specified file from the project via the Filename, SourceLangaugeID and TargetLanguageID. -
RetrieveProjectFileByID
Returns the specified file from the project via the FileID. -
SetDeliveryAcknowledgement
Set Delivery Acknowledgement based on your Delivery ID -
SetDeliveryAcknowledgementByList
Set Delivery Acknowledgement based on your Delivery IDs List -
SubmitFeedbackPackage
This method submits the feedback package -
SubmitForQuotation
Once all tasks and files have been added to a project – this method is called to submit the project for quotation. -
SubmitProject
Once all tasks and files have been added to a project – this method is called to move the submitted project into production. -
UploadAsset
The UploadAsset method allows you to upload a file by specifying both a byte array and a filename. If the upload was received successfully – a unique asset reference (AssetID) will be returned. Note: Only the user submitting the file will have access to this asset for subsequent operations.
This web service is using http://tempuri.org/ as its default namespace.
Recommendation: Change the default namespace before the XML Web service is made public.
Each XML Web service needs a unique namespace in order for client applications to distinguish it from other services on the Web. http://tempuri.org/ is available for XML Web services that are under development, but published XML Web services should use a more permanent namespace.
Your XML Web service should be identified by a namespace that you control. For example, you can use your company's Internet domain name as part of the namespace. Although many XML Web service namespaces look like URLs, they need not point to actual resources on the Web. (XML Web service namespaces are URIs.)
For XML Web services creating using ASP.NET, the default namespace can be changed using the WebService attribute's Namespace property. The WebService attribute is an attribute applied to the class that contains the XML Web service methods. Below is a code example that sets the namespace to "http://microsoft.com/webservices/":
C#
[WebService(Namespace="http://microsoft.com/webservices/")] public class MyWebService { // implementation }
Visual Basic
<WebService(Namespace:="http://microsoft.com/webservices/")> Public Class MyWebService ' implementation End Class
C++
[WebService(Namespace="http://microsoft.com/webservices/")] public ref class MyWebService { // implementation };
For more details on XML namespaces, see the W3C recommendation on Namespaces in XML.
For more details on WSDL, see the WSDL Specification.
For more details on URIs, see RFC 2396.