An XML string which contains a root element namedStatuswith the following attributes will be returned:
Error(1- error,0– no error)
Code– TheCodeattribute of the XML string will be one of the following values (also includes theDescripand Infoattributes as follows):
CODE DESCRIP INFO
1 "Running" "Proforma Queued"
2 "Running" "Proforma in progress"
3 "Finished" "Proforma complete"
4 "Finished" "Current year locator does not exist"
5 "Finished" "Next year data archived to CD"
6 "Finished" "Next year tax defaults do not exist"
7 "Finished" "Unable to Proforma Return: [descriptive reason for failure]"
Return Value Success Example:
<Status Error="0" Code="3" Descrip="Finished" Info="Proforma complete" />
Return Value Fail Example:
<Status Error="1" Code="7" Descrip="Finished" Info="Unable to Proforma Return: Final return selected"/>
2.1.5.18 GETSAVEASSTATUS
Poll for the status of aSaveAs (page 56)operation. Call as many times as needed until operation is complete.
SeePolling Recommendations (page 3)for more information on polling best practices.
SOAP Body request format:
Parameters
account– The GoSystem account.
locatorId– The GoSystem locator id on which to perform a 'save as'.
taxYear– The tax year of the locator on which to perform a 'save as'.
taxType– The tax type of the locator on which to perform a 'save as'.
password– The locator's password, if any. Blank otherwise.
Returns
An XML string which contains a root element namedStatuswith the following attributes will be returned:
Error(1- error,0– no error)
Code– TheCodeattribute of the XML string will be one of the following values (also includes theDescrip attribute as follows):
CODE DESCRIP
0 “Locator saved”
-1 "<multiple possibilities; most often a bad param indication>"
-2 "Failed to retrieve locator"
-3 "Invalid Password"
-4 "The locator is busy"
Return Value Success:
<Status Error="0" Code="0" Descrip="Locator Saved" />
Return Value Fail:
<Status Error="1" Code="-1" Descrip="<multiple possibilities; most often a bad param indication>" />
<Status Error="1" Code="-2" Descrip="Failed to retrieve locator" />
<Status Error="1" Code="-3" Descrip="Invalid Password" />
<Status Error="1" Code="-4" Descrip="The locator is busy" />
2.1.5.19 GETTRANSFERSTATUS
Poll for the status of aTransferLocator (page 59)operation. Call as many times as needed until operation is complete. SeePolling Recommendations (page 3)for more information on polling best practices.
SOAP Body request format:
Parameters
jobId- The batch job id returned in the Ident attribute of aTransferLocator (page 59)method call.
Return Values
An XML string which contains a root element namedStatuswill be returned. AnyCodewhoseDescripis
“Running” means you must poll again; “Finished” means no more polling is required.Code“3” is the desired completion code for a valid Transfer.
TheStatusXML string will have the following attributes:
Error(1- error,0– no error)
Code– TheCodeattribute of the XML string will be one of the following values (also includes theDescripand Infoattributes):
CODE DESCRIP INFO
1 "Running" "Queued for Transfer"
2 "Running" "Transferring locator"
3 "Finished" "Transfer complete"
4 "Finished" “Unable to transfer locator”
5 "Finished" "Invalid From Account"
6 "Finished" "Invalid To Account"
7 "Finished" “Invalid Year”
8 "Finished" "User does not have sufficient rights"
Ident- This attribute will exist and contain the newly created TEQ locator number only on success as shown in the example below:
(Code=1,Error=0).
Return Value Success Example:
<Status Error="0" Code="3" Descrip="Finished" Info="Transfer complete"
Ident="ABC123"/>
Return Value Fail Example:
<Status Error="1" Code="4" Descrip="Finished" Info="Unable to transfer locator" />
2.1.5.20 GETTRANSFERTOMTISTATUS
Poll for the status of aTransferToMTI (page 60)operation. Call as many times as needed until operation is complete. SeePolling Recommendations (page 3)for more information on polling best practices.
SOAP Body request format:
Parameters
jobId- The batch job id returned in theIdentattribute of anTransferToMTI (page 60)method call.
Returns
An XML string which contains a root element namedStatuswith the following attributes will be returned:
(Code=1,Error=0).
Code– TheCodeattribute of the XML string will be one of the following values (also includes theDescripand Infoattributes as follows):
CODE DESCRIP INFO
1 "Running" "Job Queued"
2 "Finished" "Transfer to MTI complete"
3 "Finished" "Locator In Use"
4 "Running" "Transfer in progress"
5 "Finished" "Unable to Transfer"
6 "Finished" "Transfer Failed"
Return Value Success Example:
<Status Error="0" Code="3" Descrip="Finished" Info="Transfer to MTI complete" />
Return Value Fail Example:
<Status Error="1" Code="5" Descrip="Finished" Info="Unable to Transfer"
/>
2.1.5.21 GETXMLVALIDATORERRORS (MTI ONLY)
This method will download XML validation errors for MTI only. You should call this after receiving an XML validation error on an MTI Import or Export call.
SOAP Body request format:
Parameters
firm– GoSystem RS Firm
account– GoSystem RS Account
locatorId– GoSystem RS Locator Number of Tax Return taxYear– 4-digit tax year of tax return
operationType– Enumerated value indicating retrieval of validation errors for Import or Export operation.
Operation type is defined as “eImport” (value ‘0’) or “eExport” (value ‘1’) or use enumeration values defined in
“RSTaxServicesInterface.RSTaxServices.OpType”
xmlValidationErrors- Upon success, this parameter will contain contents of XML validation error file in XML format.
Returns
An XML string which contains a root element namedStatuswith the following attributes will be returned:
Error(non-zero-error,0–no error, chunk uploaded successfully)
Return Value Success Example:
<Status Error="0" Code="0" Descrip="success"/>
Return Value Fail Example:
<Status Error="1" Code="-1" Descrip="[descriptive reason for failure]" />
2.1.5.22 IMPORTLOCATOR
Import a tax return into GoSystem.
The sequence of web method calls to import tax return data are:
1. CreateLocator (page 11)(returns a new locator id; omit if you do not need to create a new return) 2. AppendChunk (page 10)(call as many times as needed to upload entire data file; if you are using the
RSTAXSERVICES client DLL, then this call is handled within theImportLocator (page 46)method) 3. ImportLocator (page 46)(if you made a call toCreateLocator (page 11), use the returned locator id in
this call)
4. GetImportStatus (page 35)(call until return indicates success or failure)
Note that when importing a CSV-formatted data file, if the locator id is left blank in the header record, then a new locator will be created independently of any previous call toCreateLocator (page 11).