Connect SOAP API Developer’s Guide Exploring Complex Types

AddProcGroupQueueOptions

AddProcGroupQueueOptions is the object used to pass all optional parameters when
adding processing groups to the process queue. Table 7 describes the fields in the
AddProcGroupQueueOptions object.

Table 7: AddProcGroupQueueOptions Fields

AsynchResponse

AsynchResponse is the response object returned by asynchronous operations such as
download, calculateBatch, and validateBatch. Table 8 describes the fields in the
AsynchResponse object.

Table 8: AsynchResponse Fields

AsynchResponseEx

AsynchResponseEx is the response object returned by asynchronous operations such
as downloadEx. Table 9 describes the fields in the AsynchResponseEx object.

Table 9: AsynchResponseEx Fields

CalculationDiagnostics

The CalculationDiagnostics object represents a single calculation diagnostic. CalculationResponse
objects include a CalculationDiagnostics object if errors are detected
during the calculateBatch operation.

Table 10 describes the fields in the CalculationDiagnostics object.

Table 10: CalculationDiagnostics Fields

CalculationResponse is the response object returned by the getCalculationProcess
Diagnostics operation. Table 11 describes the fields in the CalculationResponse
object

Table 11: CalculationResponse Fields

CreditingInitiationResponse

CreditingInitiationResponse is the response object returned by the runCreditAssignment
operation. Table 12 describes the fields in the CreditingInitiationResponse
object

Table 12: CreditingInitiationResponse Fields

CreditingStatusResponse

CreditingStatusResponse is the response object returned by the getCreditAssignmentStatus
operation. Table 13 describes the fields in the CreditingStatusResponse object.

Table 13: CreditingStatusResponse Field

CustomField

The CustomField object is used by the OrderStage and People XObjects. Table 14 describes the fields in the CustomField object.

Table 14: CustomField Fields

Field	Type	Description
name	string	The name of the custom field.
stringValue	string	The string value, if the type is string.
decimalValue	decimal	The decimal value, if the type is decimal.
dateTimeValue	dateTime	The dateTime value, if the type is dateTime.
longValue	long	The long value, if the type is long.
dataType	string	The data type of the custom field.
booleanValue	boolean	The boolean value, if the type is boolean.
dropdownListValue	string	An array of allowed list values, if the type is list.

 

DeleteQueueEventResponse

DeleteQueueEventResponse is the response object returned by the deleteEventsFromQueue
operation. Table 16 describes the fields in the DeleteQueueEventResponse
object.

Table 15: DeleteQueueEventResponse Fields

DeleteResponse

DeleteResponse is the response object returned by the delete operation. Table 16
describes the fields in the DeleteResponse object.

Table 16: DeleteResponse Fields

DocumentOwner

DocumentOwner objects represent how documents are identified and routed in
Xactly eDocs. Table 17 describes the fields in the DocumentOwner object.

Table 17: DocumentOwner Object

DownloadRequestEx

DownloadRequestEx objects represent requests to download a dimension from Xactly
Credit Assignment. Table 18 describes the fields in the DownloadRequestEx object.

Table 18: DownloadRequestEx Object

EnhancedCalculationResponse

EnhancedCalculationResponse is the response object returned by the getEnhancedCalculationDiagnostics
operation. Table 19 describes the fields in the EnhancedCalculationResponse
object.

Table 19: EnhancedCalculationResponse Fields

EnhancedDiagnostics

EnhancedDiagnostics provides information related to credit, commission, and bonus
calculation results. Table 20 describes the fields in the EnhancedDiagnostics object.

Table 20: EnhancedDiagnostics Fields

ErrorCode

The ErrorCode object represents a single error. All response objects include an array of
ErrorCode objects if errors are detected during the service call. Table 21 describes the
fields in the ErrorCode object.

Table 21: ErrorCode Fields

GatewayResolutionResponse

GatewayResolutionResponse is the response object returned by resolveGateway operation. Table 22 describes the fields in the GatewayResolutionResponse object.

Table 22: GatewayResolutionResponse Fields

Field	Type	Description
gatewayUrl	string	The URL of the gateway.
errorCode	ErrorCode	The error code object returned if the operation fails.

JobRunStatusRequest

JobRunStatusRequest is the request object for the isJobRunning operation. Table 23
describes the fields in the JobRunStatusRequest object

Table 23: JobRunStatusResquest Fields

JobRunStatusResponse

JobRunStatusResponse is the response object returned by the isJobRunning operation.
Table 24 describes the fields in the JobRunStatusResponse object.

Table 24: JobRunStatusResponse Fields

Jobs

Jobs is an object returned as part of the JobRunStatusResponse object. The object
contains specific information related to the job. Table 25 describes the fields in the
Jobs object.

Table 25: Jobs Fields

LoginResponse

LoginResponse is the response object returned by login operation. Table 26 describes
the fields in the LoginResponse object.

Table 26: LoginResponse Fields

PersonWorkFlowRQ

PersonWorkFlowRQ is the request object related to the saveUserPersonWorkflow operation. Table 27 describes the fields in the PersonWorkFlowRQ object

Table 27: PersonWorkFlowRQ Fields

QueueEventResponse

QueueEventResponse is the response object returned by the getQueueStatusResponse
and getQueueEventErrors operations. Table 28 describes the fields in the
QueueEventResponse object

Table 28: QueueEventResponse Fields

QueuePreferenceResponse

QueuePreferenceResponse is the response object returned by asynchronous get and
update queue process through error flag operations. Table 29 describes the fields in
the QueuePreferenceResponse object.

Table 29: QueuePreferenceResponse Fields

QueueRegionResponse

QueueRegionResponse is the response object returned by asynchronous queue
region operations. Table 30 describes the fields in the QueueRegionResponse object.

Table 30: QueueRegionResponse Fields

QueueResponse

QueueResponse is the response object returned by asynchronous queue operations.
Table 31 describes the fields in the QueueResponse object.

Table 31: QueueResponse Fields

RouteDocumentRQ

RouteDocumentRQ objects represent request objects to route a document, as part of
Xactly eDocs. Table 32 describes the fields in the RouteDocumentRQ object.

Table 32: RouteDocumentRQ Object

RouteDocumentRS

RouteDocumentRS objects represent response objects for routing a document. Table
33 describes the fields in the RouteDocumentRS object.

Table 33: RouteDocumentRS Object

RouteDocumentStatusRQ

RouteDocumentStatusRQ objects represent request objects for querying the status of
documents that have been previously routed. Table 34 describes the fields in the
RouteDocumentStatusRQ object.

Table 34: RouteDocumentStatusRQ Object

RouteDocumentStatusRS

RouteDocumentStatusRS objects represent response objects for querying the document
status. Table 35 describes the fields in the RouteDocumentStatusRS object.

Table 35: RouteDocumentStatusRS Object

SaveResponse

SaveResponse is the response object returned by the save operation. Table 36 describes the fields in the SaveResponse object.

Table 36: SaveResponse Fields

SearchResponse

SearchResponse is the response object returned by the search operation. Table 37 describes the fields in the SearchResponse object.

Table 37: SearchResponse Fields

StepInfo

StepInfo objects represent information about each step in the routing document instance. Table 38 describes the fields in the StepInfo object.

Table 38: StepInfo Object

SubmitPublishRankingInfo

SubmitPublishRankingInfo objects represent requests to submit a job to publish rankings.
Table 39 describes the fields in the StepInfo object.

Table 39: SubmitPublishRankingInfo Object

UploadRequest

UploadRequest objects represent requests for upload operations. Table 40 describes
the fields in the UploadRequest object

Table 40: UploadRequest Object

UploadRequestEx

UploadRequestEx objects represent requests for upload operations in Xactly Credit
Assignment. Table 41 describes the fields in the UploadRequestEx object.

Table 41: UploadRequestEx Object

UploadResponse

UploadResponse is the response object returned by the upload operation. Table 42 describes the fields in the UploadResponse object.

Table 42: UploadResponse Fields

UploadResponseEx

UploadResponseEx is the response object returned by the uploadEx operation. Table 43 describes the fields in the UploadResponseEx object.

Table 43: UploadResponseEx Fields

UploadXObjectResponse

UploadXObjectResponse is the response object returned by the uploadXObject operation.
Table 44 describes the fields in the UploadXObjectResponse object.

Table 44: UploadXObjectResponse Fields

ValidationError

The ValidationError object represents a single validation error. ValidationResponse objects include an array of ValidationError objects if errors are detected during the validateBatch operation. Table 45 describes the fields in the ValidationError object.

Table 45: ValidationError Fields

ValidationResponse

ValidationResponse is the response returned by the getValidationErrorForTransaction
operation. Table 46 describes the fields in the ValidationResponse object.

Table 46: ValidationResponse Fields

XDocument

XDocument contains details about documents defined in Xactly eDocs. Table 47 describes the fields in the XDocument object.

Table 47: XDocument Fields

XField

XField is returned by the describeXObject operation to describe an Xactly Connect XObject. You can use the XField object to determine whether a field is searchable, for example. Table 48 describes the fields in the XField object

Table 48: XField Fields

XObject

XObject is the base class for all the objects in Xactly Connect. Table 49 describes the fields in the XObject object.

Table 49: XObject Fields

XObjectErrorCode

The XObjectErrorCode object represents a single error. The UploadXObjectResponse object includes an array of XObjectErrorCode objects if errors are detected during the service call. Table 50 describes the fields in the XObjectErrorCode object

Table 50: XObjectErrorCode Fields