78 Retail Location Lookup Services, Version 3.1
This chapter provides the information necessary to send messages contained in Version 3.1 of the Retail Location Lookup API. Information can be obtained using the Web Service Description Language (WSDL) in conjunction with a Simple Object Access Protocol (SOAP), XML Schema, and various methods contained in the classes of the API to provide the web service described above.
The URL for the WSDL is:
https://<servername>:<portNumber>/ws/v3_1/RetailLocLookupServices?wsdl
where <servername> is the name or address of the server. For a cloud installation, the default port number is 443.
The information presented below describes the methods and classes.
The format of the method and any arguments is shown along with an explanation of what the method does and any other information that is necessary to use the method properly. If an argument is shown in dark blue, it is a class and the class name is a link to a description of the class and its attributes.
The class section shows the attributes of the classes along with an explanation of each attribute and when necessary, when they are used.
Note:
Authentication is required. See Introduction for information on creating and implementing an authentication key.
Methods
This section presents the methods used in Version 3.1 of the Retail Location Lookup Services API.
addOrUpdateLocation
string addOrUpdateLocation( RetailLocationRequestType retailLocData, string securityUserId) throws RelateProcessingException
| Variable | Required? | Description |
|---|---|---|
|
|
[optional] |
Location information to be added or updated. |
|
|
[required] |
ID of the Customer Engagement user performing the action. |
The addOrUpdateLocation method inserts a new retail location record into the system, or updates an existing record. If the Retail Location ID in the RetailLocationType exists in the system, the corresponding record is updated with the included information.
This method returns a string containing the Retail Location ID for the location.
Note:
The securityUserId provided within this message must be assigned the proper Security Group permission for this operation to be performed successfully.
getAllRetailLocAttributeTypes
wsAttributeType[] getAllRetailLocAttributeTypes()
No variables are passed to the getAllRetailLocAttributeTypes method.
The getAllRetailLocAttributeTypes method retrieves a list of all retail location attribute types for all retail locations.
This method returns an array of wsAttributeType elements.
ifLocationExists
boolean ifLocationExists( string retailLocationID)
| Variable | Required? | Description |
|---|---|---|
|
|
[optional] |
ID of the location. |
The ifLocationExists method indicates whether there is an existing location with the retailLocationID.
This method returns true if there is a location with the retail location ID and false if there is not.
lookupLocationMaxResults
retailLocsType lookupLocationMaxResults( retailLocLookupKey[] keys, int maxRecords) throws RelateProcessingException
| Variable | Required? | Description |
|---|---|---|
|
|
[optional] |
Location search information. |
|
|
[required] |
Maximum number of locations to return. |
The lookupLocationMaxResults method retrieves a list of retail locations that match the specified lookup keys. The list returned will be, at maximum, maxRecords long.
This method returns a retailLocsType element.
retrieveLocation
RetailLocationType retrieveLocation( string retailLocationID) throws RelateProcessingException
| Variable | Required? | Description |
|---|---|---|
|
retailLocationID |
[optional] |
ID of the location. |
The retrieveLocation method retrieves information about the location corresponding to the retailLocationID.
This method returns a RetailLocationType element.
Classes
This section presents the classes used in Version 3.1 of the Retail Location Lookup Services API.
RetailLocationType
The RetailLocationType class contains the following elements:
| Type | Element | Description |
|---|---|---|
|
string |
RetailLocationID |
Unique identifier for the retail location. |
|
string |
ResponseDescription |
Response description for the location. |
|
string |
FaultDetail |
Fault detail for the location. |
|
string |
ErrorCode |
Error code for the location. |
|
string |
StoreNumber |
Location number for the location. |
|
string |
AddressLine1 |
Address line 1 for the location. |
|
string |
AddressLine2 |
Address line 2 for the location. |
|
string |
AddressLine3 |
Address line 3 for the location. |
|
string |
AddressLine4 |
Address line 4 for the location. |
|
string |
City |
City for the location. |
|
string |
State |
State for the location. |
|
string |
PostalCode |
Postal code for the location. |
|
string |
Country |
Country for the location. |
|
string |
County |
County for the location. |
|
string |
DisplayName |
Display name for the location. |
|
string |
EmailAddress |
Email address for the location. |
|
string |
FranchiseID |
ID of the franchise to which the location is assigned. |
|
string |
FranchiseName |
Name of the franchise. |
|
boolean |
FrachiseLocationFlag |
Flag indicating whether the location is a franchise location. |
|
boolean |
ActiveFlag |
Flag indicating whether the location is currently active. |
|
date |
CreateDate |
Date the location was created in the system. |
|
date |
UpdateDate |
Date the location was last updated in the system. |
|
string |
CreateUser |
User who created the location in the system. |
|
string |
UpdateUser |
User who last updated the location in the system. |
|
StoreAttribute |
List of location attributes for the location. |
RetailLocationRequestType
The RetailLocationRequestType class contains the following elements:
| Type | Element | Description |
|---|---|---|
|
string |
RetailLocationID |
Unique identifier for the retail location. |
|
string |
StoreNumber |
Location number for the location. |
|
string |
AddressLine1 |
Address line 1 for the location. |
|
string |
AddressLine2 |
Address line 2 for the location. |
|
string |
AddressLine3 |
Address line 3 for the location. |
|
string |
AddressLine4 |
Address line 4 for the location. |
|
string |
City |
City for the location. |
|
string |
State |
State for the location. |
|
string |
PostalCode |
Postal code for the location. |
|
string |
Country |
Country for the location. |
|
string |
County |
County for the location. |
|
string |
DisplayName |
Display name for the location. |
|
string |
EmailAddress |
Email address for the location. |
|
string |
FranchiseID |
ID of the franchise to which the location is assigned. |
|
string |
FranchiseName |
Name of the franchise. |
|
boolean |
ActiveFlag |
Flag indicating whether the location is currently active. |
|
date |
CreateDate |
Date the location was created in the system. |
|
date |
UpdateDate |
Date the location was last updated in the system. |
|
string |
CreateUser |
User who created the location in the system. |
|
string |
UpdateUser |
User who last updated the location in the system. |
|
StoreAttribute |
List of location attributes for the location. |
Note:
Oracle recommends that the contact details for a location (for example, email address or phone) identify the physical store rather than an individual.
retailLocLookupKey
The retailLocLookupKey class contains the following elements:
| Type | Element | Description |
|---|---|---|
|
queryField |
field |
Type of key used in the lookup. |
|
string |
fieldValue |
Value of the lookup key |
retailLocsType
The retailLocsType class contains the following elements:
| Type | Element | Description |
|---|---|---|
|
string |
DateTime |
Date and time of the inquiry. |
|
RetailLocation |
A list of retail locations. |
StoreAttributeType
The StoreAttributeType class contains the following element:
| Type | Element | Description |
|---|---|---|
|
string[] |
AttributeValue |
List of values for the attribute. |
The StoreAttributeType class contains the following atrribute:
| Type | Attribute | Description |
|---|---|---|
|
string |
name |
Name of the attribute. |
wsAttributeType
The wsAttributeType class contains the following elements:
| Type | Element | Description |
|---|---|---|
|
string[] |
attributeEnumValues |
If the attribute has an enumerated list of possible values, this list will contain the list of possible values. |
|
string |
dataType |
The data type of the attribute. |
|
string |
defaultValue |
The default value of the attribute. |
|
string |
description |
A description of the attribute. |
|
string |
name |
The name of the attribute. |
|
boolean |
uniqueFlag |
Indicates whether only one of this attribute can be set for each location. |