1. Implementation Guide
  2. SOAP APIs

5 SOAP APIs

The following SOAP APIs are available:

Figure 5-1 Overview of SOAP APIs

This figure shows the SOAP APIs.

Parameters and Filtering

Various parameters can be included in calls to the APIs, generally to define what data is to be returned, but can also control how records are returned. The following table lists some commonly used parameters.

Common Parameters

Parameter Type Description

offset

int

Used with pageSize to control the paging of a returned list of records. Specifies the starting point for the retrieval of records. If not specified, zero is assumed.

For example, to retrieve 150 records:

  1. A call with offset = 0 and pageSize = 50 returns the first 50 records.

  2. Then, a call with offset = 50 and pageSize = 50 returns the next 50.

  3. Then, a call with offset = 100 and pageSize = 50 returns the final 50.

batchSize

int

Used with offset to control the paging of a returned list of records. Specifies the number of entries in each page of returned list of records. If not specified, 30 is assumed. The maximum is 100.

Note:

Date/Time parameters must be provided in the YYYY-MM-DD hh:mm:ss format.

When retrieving records, the returned XML only includes elements that actually contain data; empty elements are omitted.

The following example provides the first 50 Product Specifications that changed status to either Active or Off Range in May 2016. Searching with either fromDate or toDate specified without specStatus, will filter based on the last amended date of the Product Specification.

<soapenv:Envelope xmlns:soapenv="<<hostname>>/soap/envelope/"xmlns:v1="<<servicename>>/">
<soapenv:Header/>
<soapenv:Body>
       <v1:getProductSpecification>
              <request>
                     <batchsize>50</batchsize>
                     <offset>0</offset>
                     <specStatus>ACTIVE</specStatus>
                     <specStatus>OFF_RANGE</specStatus>
                     <fromDate>2016-05-01T00:00:00</fromDate>
                     <toDate>2016-05-31T24:00:00</toDate>
              </request>
       </v1:getProductSpecification>
</soapenv:Body>

Project Activities

This section describes the API for Artwork integration. The following function is available:

Activity Management

Description

Updates the sub status of existing Artwork Project Activities. This function is used for the integration of Supplier Evaluation with an external Artwork Management system, to update the status of an artwork activity from the external system.

Note:

This service has been superseded by the Artwork Restful Service.

Endpoint address: /services/activityManagement HTTP method: updateActivityStatus

Request Details

The body of the request contains an updateActivityStatus/activityUpdateRequest element consisting of the elements shown in the following table.

Request Elements

Element Type Description

activityName

string

Project activity's name

activityRecordId

string

Project activity record's internal ID

projectId

string

ID business key to the Project record

projectRecordId

string

Project record's internal ID

subStatusCode

string

Code business key to the activity's sub status

After the call, the Project Activity record's sub status is updated to match the request.

See the associated WSDL for a full list of the attributes, and the Oracle Retail Supplier Evaluation Cloud Service Data Dictionary, Volume 3 - Process for details of their mapping to the fields within the Supplier Evaluation UI.

Response Details

If successful, an HTTP 200 response is sent with a body containing an updateActivityStatusResponse root element, consisting of a return element populated with SUCCESS.

Error Messages

If an error occurs, the updateActivityStatusResponse root element's return element will contain FAILURE.