listSiteProperties
get
/ccagent/v1/profiles/{id}/siteProperties
Get Site properties related to specific customer.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The customer profile id.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listSiteProperties_response
Type:
Show Source
object
-
items(optional):
array items
The list of site related properties for the profile
-
offset(optional):
integer
The start index of the list of records to be fetched
-
sort(optional):
string
Sorting format
Nested Schema : items
Type:
Show Source
object
-
properties(optional):
object properties
The site related properties for the profile
-
site(optional):
object site
The site data
Nested Schema : properties
Type:
object
The site related properties for the profile
Show Source
-
GDPRProfileP13nConsentDate(optional):
string
The date on which GDPR personalization consent was granted by the user.
-
GDPRProfileP13nConsentGranted(optional):
boolean
Indicates whether the user has given GDPR Profile P13n consent on the current site. Can be true or false.
-
receiveEmail(optional):
string
Indicates whether the user should receive marketing emails on the current site. Can be yes or no.
-
receiveEmailDate(optional):
string
The date on which email marketing consent was granted by the user.
Example Response (application/json)
{
"totalResults":1,
"endingIndex":250,
"offset":0,
"totalResultsParam":true,
"count":1,
"limit":250,
"links":[
{
"rel":"self",
"href":"http://agent.example.com:9080/ccagentui/v1/profiles/se-570031/siteProperties?siteProperties=%5Bobject%20Object%5D"
}
],
"sort":null,
"items":[
{
"site":{
"id":"SiteA"
},
"properties":{
"GDPRProfileP13nConsentDate":"2018-03-21T13:10:08.463Z",
"GDPRProfileP13nConsentGranted":true,
"receiveEmail":"yes",
"receiveEmailDate":"2018-03-21T13:10:08.463Z"
}
}
],
"listingRequest":{
"endingIndex":250,
"correctedView":null,
"queryOptions":{
"precachedPropertyNames":null,
"doNotCacheQuery":false,
"sortDirectives":null,
"endingIndex":250,
"ignoreDuplicates":false,
"nthIndex":1,
"uncachedItems":false,
"uncachedItemsSet":false,
"startingIndex":0
},
"rqlString":null,
"QErrorCodeMap":null,
"QPropertyAliasMap":null,
"sort":null,
"startingIndex":0,
"QIgnoreCase":true,
"QString":null,
"filterProperties":[
"displayName",
"id"
],
"includeRqlInQueryGeneration":true,
"rqlStatement":null,
"expanded":false,
"scimParser":null,
"useSCIMForQ":true,
"limit":250,
"siteId":null,
"after":null,
"calculateTotalAvailable":true
},
"startingIndex":0,
"totalNumberOfItems":1
}
Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|22030|User is not logged in|
|22031|Internal error during get profile|
|22032|Error occurred due to invalid data|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code