Oracle Data Governance Manager Web Services

The following table describes the SWIContactServices operations.

Name Description

SWIContactServicesInsertOrUpdate

Calls Insert or Update method used for inserting a new contact along with the child details into the Siebel database. If the contact is already present in the Siebel database, the Contact will be updated with the details from the request message.

SWIContactServicesQueryByExample

Calls the Query by Example method to Query Contact details along with the child details from the Siebel database.

SWIContactServicesSynchronize

Calls the Synchronize method to synchronize the contact in the request message with the contact details in Siebel.

If the child details that are part of the request message are not present in the Siebel database, they will be Inserted and if any additional child are present in the database and not part of request message, those will be deleted from the database.

The following table describes the SWIContactServicesInsertOrUpdate request message.

Node Description Type

Alias

Alias of the contact record.

String

CellularPhone

Mobile phone number of the contact.

String

ContactPersonTitle

Contact’s title.

String

CurrencyCode

Contact’s account currency code.

String

DateofBirth

Contact’s birth date.

String

EmailAddress

Contact’s email address.

String

FaxPhone

Contact’s fax number.

String

FirstName

Contact’s first name.

String

Gender

Contact’s gender.

String

HomePhone

Contact’s home phone number.

String

JobTitle

Contact’s job title.

String

LastName

Contact’s last name.

String

MM

Mr. or Mrs.

String

MaritalStatus

Contact’s marital status.

String

MiddleName

Contact’s middle name.

String

RowId

Row Id of Siebel Contact record

String

SocialSecurityNumber

Contact’s social security number.

String

Status

Contact record’s status.

String

WorkPhone

Contact’s work phone number.

String

AIAIntegrationId

Id value used for mapping the request message and response message contact details.

String

ListofOrganization

Container for Organization

String

PersonalAddress

Contact’s home address.

String

Id

Siebel row Id of the Contact record.

String

AddressName

Contact’s address name.

String

City

Contact’s city of residence.

String

Country

Contact’s country of residence.

String

PostalCode

Contact’s postal code.

String

Province

Contact’s province, if applicable.

String

State

Contact’s state of residence.

String

StreetAddress1

Line 1 details for the contact.

String

StreetAddress2

Line 2 details for the contact.

String

AIAIntegrationId

Id value used for mapping the request and response message.

String

The following table describes the SWIContactServicesInsertOrUpdate response message.

Node Description Type

Alias

Alias of contact record.

String

CellularPhone

Contact’s mobile phone number.

String

ContactPersonTitle

Contact’s title.

String

CurrencyCode

Contact account currency code.

String

DateofBirth

Contact’s birth date.

String

EmailAddress

Contact’s email address.

String

FaxPhone

Contact’s fax number.

String

FirstName

Contact’s first name.

String

Gender

Contact’s gender.

String

HomePhone

Contact’s home phone number.

String

JobTitle

Contact’s job title.

String

LastName

Contact’s last name.

String

MM

Mr. or Mrs.

String

MaritalStatus

Contact’s marital status.

String

MiddleName

Contact’s middle name.

String

RowId

Row Id of Siebel Contact record

String

SocialSecurityNumber

Contact’s social security number.

String

Status

Contact status.

String

WorkPhone

Contact’s work phone number.

String

AIAIntegrationId

Id value used for mapping the request message and response message contact details.

String

ListofOrganization

Container for organization record.

String

PersonalAddress

Contact’s home address.

String

Id

Row Id of the Contact record In Siebel.

String

AddressName

Address name

String

City

Contact’s city.

String

Country

Contact’s country.

String

PostalCode

Contact’s postal code.

String

Province

Contact’s province (if applicable).

String

State

Contact’s state.

String

StreetAddress1

Line 1 details for the contact.

String

StreetAddress2

Line 2 details for the contact.

String

AIAIntegrationId

Id value used for mapping the request and response message.

String

The following table describes the SWIContactServicesQueryByExample request message.

Node Description Type

RowId

Row Id of Siebel Contact record

String

ListOfAccount

List of Account records.

String

ListofPersonalAddress

List of personal address records of contact.

String

PersonalAddress

Contact’s personal address.

String

The following table describes the SWIContactServicesQueryByExample response message.

Node Description Type

Id

Row Id.

String

Alias

Alias of contact record.

String

CellularPhone

Contact’s mobile phone number.

String

ContactPersonTitle

Contact’s title.

String

CurrencyCode

Contact account currency code.

String

DateofBirth

Contact’s birth date.

String

EmailAddress

Contact’s email address.

String

FaxPhone

Contact’s fax number.

String

FirstName

Contact’s first name.

String

Gender

Contact’s gender.

String

HomePhone

Contact’s home phone number.

String

JobTitle

Contact’s job title.

String

LastName

Contact’s last name.

String

MM

Mr. or Mrs.

String

MaritalStatus

Contact’s marital status.

String

MiddleName

Contact’s middle name.

String

MotherMaidenName

Contact’s mother’s maiden name.

String

PrimaryOrganizationId

Primary organization for contact.

String

RowId

Row Id in Siebel data table.

String

SocialSecurityNumber

Contact’s social security number.

String

Status

Status of contact record.

String

WorkPhone

Contact’s work telephone number.

String

ListofAccount

Container for Account.

Integration Component

ListofComInvoiceProfile

Container for invoice profile.

Integration Component

ListofOrganization

Container for Organization.

Integration Component

ListofPersonalAddress

Container for personal address records.

Integration Component

PersonalAddress

Contact’s personal address.

String

ListofUCMContactPrivacy

Privacy details for Contact record.

Integration Component

The following table describes the SWIContactServicesSynchronize request message.

Node Description Type

Id

Row Id.

String

Alias

Alias of contact record.

String

CellularPhone

Contact’s mobile phone number.

String

ContactPersonTitle

Contact’s title.

String

CurrencyCode

Contact’s account currency code.

String

DateofBirth

Contact’s birth date.

String

EmailAddress

Contact’s email address.

String

FaxPhone

Contact’s fax number.

String

FirstName

Contact’s first name.

String

Gender

Contact’s gender.

String

HomePhone

Contact’s home phone number.

String

JobTitle

Contact’s job title.

String

LastName

Contact’s last name.

String

MM

Mr. or Mrs.

String

MaritalStatus

Contact’s marital status.

String

MiddleName

Contact’s middle name.

String

MotherMaidenName

Contact’s mother’s maiden name.

String

PrimaryOrganizationId

Primary organization for contact.

String

RowId

Row Id in Siebel data table.

String

SocialSecurityNumber

Contact’s social security number.

String

Status

Status of contact record.

String

WorkPhone

Contact’s work telephone number.

String

AIAIntegrationId

Id value used for mapping the request message and response message contact details.

String

ListofOrganization

Container for Organization.

Integration Component

ListofPersonalAddress

Container for personal address records.

Integration Component

The following table describes the SWIContactServicesSynchronize response message.

Node Description Type

Id

Row Id.

String

Alias

Alias of contact record.

String

CellularPhone

Contact’s mobile phone number.

String

ContactPersonTitle

Contact’s title.

String

CurrencyCode

Contact’s account currency code.

String

DateofBirth

Contact’s birth date.

String

EmailAddress

Contact’s email address.

String

FaxPhone

Contact’s fax number.

String

FirstName

Contact’s first name.

String

Gender

Contact’s gender.

String

HomePhone

Contact’s home phone number.

String

JobTitle

Contact’s job title.

String

LastName

Contact’s last name.

String

MM

Mr. or Mrs.

String

MaritalStatus

Contact’s marital status.

String

MiddleName

Contact’s middle name.

String

MotherMaidenName

Contact’s mother’s maiden name.

String

PrimaryOrganizationId

Primary organization for contact.

String

RowId

Row Id in Siebel data table.

String

SocialSecurityNumber

Contact’s social security number.

String

Status

Status of contact record.

String

WorkPhone

Contact’s work telephone number.

String

AIAIntegrationId

Id value used for mapping the request message and response message contact details.

String

ListofOrganization

Container for Organization.

Integration Component

ListofPersonalAddress

Container for personal address records.

Integration Component

The following table describes the SWIContactService service object.

Siebel Repository Name Boundary Object Type Class

SWI Contact Service

Business Service

CSSEAIDataSyncService

The following table describes the SWIContactService data object.

Siebel Repository Name External Name

SWIContactIO

SWI Contact

The following table describes the SWICustomerPartyService operations.

Name Description

SWICustomerPartyInsertOrUpdate

Calls the Insert or Update method used for inserting a new account along with the child details into the Siebel database. If the account is already present in the Siebel database the account will be updated with any new details contained in the request message.

SWICustomerPartyQueryByExample

Calls the Query by Example method to query the Siebel database for account details along with any child details.

SWICustomerPartySynchronize

Calls Synchronize method to synchronize the account record contained in the request message with the account details in Siebel database.

If the child details that are part of request message are not present in the Siebel database, the details will inserted and if any additional child are present in the Siebel database, are not part of request message those details will be deleted from the database.

The following table describes the SWICustomerPartyInsertOrUpdate request message.

Note: All nodes in the table bar the first node apply to SwicustomerpartyIO.
Node Description Type

ListofSwicustomerpartyIO

An instance of the Integration Object ListofSwicustomerpartyIO.

Integration Object

Account

Account name.

String

AccountStatus

Status of account record.

String

DUNSNumber

Dun and Bradstreet data universal numbering system number.

String

MainFaxNumber

Main fax number of account.

String

MainPhoneNumber

Main phone number of account.

String

Name

Account name.

String

HomePage

Account’s home page address.

String

AIAIntegrationId

Id value used for mapping the request message and response message account details.

String

Location

Account’s location.

String

RowId

Row Id of Siebel Account record.

String

ListofCutAddress

Optional. Business address.

Integration Component

ListofContact

Contact details

Integration Component

ListofInternalDivision

Internal division details.

Integraton Component

City

City where account is located.

String

Country

Country where acccount is located.

String

County

County where acccount is located.

String

PostalCode

Postal code of account.

String

Province

Province (if applicable) where account is located.

String

AIAIntegrationId

Contact’s social security number.

String

Status

Contact status.

String

WorkPhone

Contact’s work phone number.

String

AIAIntegrationId

Id value used for mapping the request message and response message contact details.

String

ListofOrganization

Container for organization record.

String

PersonalAddress

Contact’s home address.

String

Id

Row Id of the Contact record in Siebel data table.

String

AddressName

Address name

String

City

Contact’s city.

String

Country

Contact’s country.

String

PostalCode

Contact’s postal code.

String

Province

Contact’s province (if applicable).

String

State

Contact’s state.

String

StreetAddress1

Line 1 details for the contact.

String

StreetAddress2

Line 2 details for the contact.

String

AIAIntegrationId

Id value used for mapping the request and response message.

String

This table describes the SWICustomerPartyInsertOrUpdate response message.

Note: All nodes in the table bar the first node apply to SwicustomerpartyIO.
Node Description Type

ListofSwicustomerpartyIO

An instance of the Integration Object ListofSwicustomerpartyIO.

Integration Object

Account

Account name.

String

AccountStatus

Status of account record.

String

DUNSNumber

Dun and Bradstreet data universal numbering system number.

String

HomePage

Account’s home page address.

String

Location

Account’s location.

String

MainFaxNumber

Account’s main fax number.

String

MainPhoneNumber

Account’s main phone number.

String

Name

Account name.

String

AIAIntegrationId

Id value used for mapping the request message and response message account details.

String

ListofCutAddress

Optional. Business address.

Integration Component

ListofContact

Contact details

Integration Component

ListOfInternalDivision

Internal division details.

Integration Component

The following table describes the SWICustomerPartyQueryByExample request message.

Note: All nodes in the table bar the first node apply to SwicustomerpartyIO.
Node Description Type

ListofSwicustomerpartyIO

An instance of the Integration Object ListofSwicustomerpartyIO.

Integration Object

RowId

Row Id of account in Siebel data table.

String

ListofCutAddress

Optional. Business address.

Integration Component

The following table describes the SWIContactServicesQueryByExample response message.

Note: All nodes in the table bar the first node apply to SwicustomerpartyIO.
Node Description Type

ListofSwicustomerpartyIO

An instance of the Integration Object ListofSwicustomerpartyIO.

Integration Object

Account

Account name.

String

AccountStatus

Status of account record.

String

AccountTypeCode

Dun and Bradstreet data universal numbering system number.

String

CurrencyCode

Account’s currency code.

String

DUNSNumber

Dun and Bradstreet data universal numbering system number.

String

HomePage

Homepage of account

String

IntegrationId

Integration Id.

String

Location

Account location.

String

MainFaxNumber

Main fax number of account.

String

MainPhoneNumber

Main phone number of account.

String

Name

Account name.

String

ParentAccountId

Account Id of parent account.

String

PrimaryAddressId

Primary address of account.

String

PrimaryBillToAddressId

Primary billing address of account.

String

PrimaryContactId

Primary Contact Id for the account.

String

PrimaryOrganizationId

Primary Organization Id for the account.

String

PrimaryShipToAddress

Primary shipping address for the account.

String

RowId

Row Id in Siebel data table.

String

Type

Account type.

String

ListofCutAddress

Optional. Business address.

Integration Component

ListofContact

Contact details

Integration Component

ListofInternalDivision

Internal division details.

Integraton Component

The following table describes the SWICustomerPartySynchronize request message.

Note: All nodes in the table bar the first node apply to SwicustomerpartyIO.
Node Description Type

ListofSwicustomerpartyIO

An instance of the Integration Object ListofSwicustomerpartyIO.

Integration Object

Account

Account name.

String

AccountStatus

Status of account record.

String

DUNSNumber

Dun and Bradstreet data universal numbering system number.

String

MainFaxNumber

Main fax number of account.

String

MainPhoneNumber

Main phone number of account.

String

Name

Account name.

String

HomePage

Account’s home page address.

String

AIAIntegrationId

Id value used for mapping the request message and response message account details.

String

Location

Account’s location.

String

RowId

Row Id of Siebel Account record.

String

ListofCutAddress

Optional. Business address.

Integration Component

ListofContact

Contact details

Integration Component

ListofInternalDivision

Internal division details.

Integraton Component

City

City where account is located.

String

Country

Country where acccount is located.

String

County

County where acccount is located.

String

PostalCode

Postal code of account.

String

Province

Province (if applicable) where account is located.

String

AIAIntegrationId

Contact’s social security number.

String

Status

Contact status.

String

WorkPhone

Contact’s work phone number.

String

AIAIntegrationId

Id value used for mapping the request message and response message contact details.

String

ListofOrganization

Container for organization record.

String

PersonalAddress

Contact’s home address.

String

Id

Row Id of the Contact record in Siebel data table.

String

AddressName

Address name

String

City

Contact’s city.

String

Country

Contact’s country.

String

PostalCode

Contact’s postal code.

String

Province

Contact’s province (if applicable).

String

State

Contact’s state.

String

StreetAddress1

Line 1 details for the contact.

String

StreetAddress2

Line 2 details for the contact.

String

AIAIntegrationId

Id value used for mapping the request and response message.

String

The following table describes the SWICustomerPartySynchronize response message.

Note: All nodes in the table bar the first node apply to SwicustomerpartyIO.
Node Description Type

ListofSwicustomerpartyIO

An instance of the Integration Object ListofSwicustomerpartyIO.

Integration Object

Account

Account name.

String

AccountStatus

Status of account record.

String

DUNSNumber

Dun and Bradstreet data universal numbering system number.

String

HomePage

Account’s home page address.

String

Location

Account’s location.

String

MainFaxNumber

Account’s main fax number.

String

MainPhoneNumber

Account’s main phone number.

String

Name

Account name.

String

AIAIntegrationId

Id value used for mapping the request message and response message account details.

String

ListofCutAddress

Optional. Business address.

Integration Component

ListofContact

Contact details

Integration Component

ListOfInternalDivision

Internal division details.

Integraton Component

The following table describes the Service Object.

Siebel Repository Name Boundary Object Type Class

SWI Customer Party Service

Business Service

CSSEAIDataSyncService

The following table describes the Data Object.

Siebel Repository Name External Name

SWICustomerPartyIO

Account

The following table describes the SWIMergeServiceMerge operation.

Name Description

SWIMergeServicesMerge

Calls Merge method of the Business Service SWI Merge Service which is used for merging one or more accounts to another account record. This Web service merges child records of the losing objects to the wining object and deletes the losing object records.

Takes the Business Object name, Business Component name, one wining record's Id value and one or more losing record's Id values as the arguments in .xml format.

The following table describes the SWIMergeServicesMerge request message.

Note: All nodes in the table bar the first node apply to ListOfSwimergeobjectIO.
Node Description Type

ListOfSwimergeobjectIO

An instance of the Integration Object ListofSwimergeobjectIO.

Integration Object

BusinessComponentName

Name of business component.

String

BusinessObjectName

Name of business object.

String

MergeId

Id number assigned to merged item.

String

ListofSwiLosingObject

Container element for the Losing Object details which is an instance of the VBC SWI Losing Object. Contains the details of the object that is merged to another object.

Integration Component

ListOfSwiWinningObject

Container element for the Winning Object details which is an instance of the VBC SWI Winning Object. Contains the details of the object that is merged to another object.

Integration Component

The following table describes the SWIMergeServicesMerge response message.

Note: All nodes in the table bar the first node apply to ListOfSwimergeobjectIO.
Node Description Type

ListOfSwimergeobjectIO

An instance of the Integration Object ListofSwimergeobjectIO.

Integration Object

BusinessComponentName

Name of business component.

String

BusinessObjectName

Name of business object.

String

MergeId

Id number assigned to merged item.

String

ListofSwiLosingObject

Container element for the Losing Object details which is an instance of the VBC SWI Losing Object. Contains the details of the object that is merged to another object.

Integration Component

ListOfSwiWinningObject

Container element for the Winning Object details which is an instance of the VBC SWI Winning Object. Contains the details of the object that is merged to another object.

Integration Component

The following table describes the SWIMergeService service object.

Siebel Repository Name Boundary Object Type Class

SWIMergeService

Business Service

CSSMergeService

The following table describes the SWIMergeService data object.

Siebel Repository Name External Name

SWIMergeObjectIO

SWI Merge Object

The following table describes the SWIProductImport operations.

Name Description

SWIProductImportUpsert

Calls 'Insert or Update' method of the Business Service 'SWI Product Import' used for inserting a new product details in to Siebel. If the product is already present in Siebel the product will be updated with the details from the request message.

The following table describes the SWIProductImportUpsert request message.

Node Description Type

ActiveFlag

Indicates whether record is active.

String

BillableFlag

Indicates whether record is billable.

String

BusinessUnitId

Id of business unit associated with product record.

String

Description

Description.

String

EffectiveEndDate

Effective end date of record.

String

EffectiveStartDate

Effective start date of record.

String

ExternalInventorySystemRef

Reference number from external inventory system.

String

IntegrationId

Integration Id.

String

InventoryFlag

Flag to indicate if product is tracked in inventory.

String

LeadTime

Lead time for product delivery.

String

ProductCost

Cost of product.

String

ProductName

Name of product.

String

ProductSerializedFlag

Serialized flag. Indicates if instances of this product are tracked as serialized assets or simply as quantities of product. Instances of a serialized product will each carry a unique serial number (or license number, policy number, and so on). Quantities of non-serialized assets are sometimes tracked as lots which may have a unique lot number.

String

ProductVersion

Version of product.

String

ReleaseFlag

Flag which indicates whether a product will be released at the time of a synchronization.

String

SalesProductFlag

Sales product flag. Sales products appear on the product picklist when a user defines products for an opportunity.

String

ServiceTerms

Service terms associated with product.

String

ShipFlag

Flag to indicate whether a product has to be shipped.

String

Status

Status of product. Active or Inactive.

String

StructureType

Depending on the product type, users may be allowed to create a simple bill of materials without using Siebel Product Configurator.

String

UnitofMeasure

Unit of measure.

String

ListofProductInvloc

Location of product in inventory.

String

The following table describes the SWIProductImportUpsert response message.

Node Description Type

Id

Product Id.

String

ActiveFlag

Indicates whether record is active.

String

AutoExplodeFlag

Indicates whether or not the product should be automatically ungrouped and enforce ungrouped quantity equal to 1.

String

BillableFlag

Indicates whether record is billable.

String

BusinessUnitId

Id of business unit associated with product record.

String

CheckEligibilityFlag

Indicates whether or not to apply eligibility and compatibility rules for this product.

String

Description

Description of product.

String

EffectiveEndTime

Effective end date of record.

String

EffectiveStartTime

Effective start date of record.

String

ExternalInventorySystemRef

Reference number from external inventory system.

String

InclusiveEligibilityFlag

Indicates whether or not to process a particular product for inclusive eligibility rules. Inclusive eligibility rules are defined in the eligibility matrix with matrix rule type code set as Inclusive.

String

IntegrationId

Integration Id.

String

InventoryFlag

Flag which indicates if a product is tracked in inventory.

String

LeadTime

Lead time for product delivery.

String

OrderableFlag

Flag which indicates whether a product is orderable.

String

PriceType

Price type, such as One-time, Recurring, Usage and so on.

String

PrimaryOrganizationId

Id of primary organization associated with product record.

String

ProductCost

Cost of product.

String

ProductId

Id of product.

String

ProductName

Name of product.

String

ProductSerializedFlag

Serialized flag. Indicates if instances of this product are tracked as serialized assets or simply as quantities of product. Instances of a serialized product will each carry a unique serial number (or license number, policy number, and so on). Quantities of non-serialized assets are sometimes tracked as lots which may have a unique lot number.

String

ProductType

Product type.

String

ProductVersion

Product version.

String

ReleaseFlag

Flag which indicates whether a product will be released at the time of a synchronization.

String

SalesProductFlag

Sales product flag. Sales products appear on the product picklist when a user defines products for an opportunity.

String

ServiceInstanceFlag

Flag to indicate whether a product requires a metering point.

String

ServiceProductFlag

Sales and Service flag. Sales service products are services that are priced based on the tangible product for which they are purchased (an extended warranty, for example). These products appear on the picklist that pops up when the user clicks the Service button for a tangible product on a quote. When you choose a sales service product from the list, a new quote item for the product is added to the quote and priced according to the value of the tangible product to which it applies.

String

ShipFlag

Flag to indicate whether a product needs to be shipped.

String

Status

Status of product order.

String

StructureType

Depending on the product type, users may be allowed to create a simple bill of materials without using Siebel Product Configurator.

String

TrackAsAssetFlag

Flag to indicate that a product should be tracked as an asset.

String

Type

Product type.

String

UnitofMeasure

Unit of measure.

String

VendorId

Id of product vendor.

String

ListofProductInvLoc

Location of product in inventory.

String

The following table describes the SWIProductImport service object.

Siebel Repository Name Boundary Object Type Class

SWI Product Import

Business Service

CSSCMUProdWebSvc

The following table describes the SWIProductImport data object.

Siebel Repository Name External Name

SWIProductIntegrationIO

SWI Product Integration

Services

The following Web services are used to perform operations for Oracle Data Governance Manager. These Web services include: