REST API for Oracle Commerce Cloud 21C

listSiteProperties

get

/ccstore/v1/profiles/current/siteProperties

Gets the list of all the site based properties for the current profile.

Request

Supported Media Types

application/json

Query Parameters

limit(optional): integer

This is the field to specify the number of records to be fetched per REST call.
offset(optional): integer

This field specifies the offset/starting index from which data to be fetched.

Header Parameters

X-CCAsset-Language(optional): string

The asset language of the request.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Root Schema : listSiteProperties_response

Type: object

Show Source

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

{
    "properties":{
        "offset":{
            "description":"The start index of the list of records to be fetched",
            "type":"integer"
        },
        "sort":{
            "description":"Sorting format",
            "type":"string"
        },
        "items":{
            "description":"The list of site related properties for the profile",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "site":{
                        "description":"The site data",
                        "type":"object",
                        "properties":{
                            "id":{
                                "description":"The id of the site",
                                "type":"string"
                            }
                        }
                    },
                    "properties":{
                        "description":"The site related properties for the profile",
                        "type":"object",
                        "properties":{
                            "GDPRProfileP13nConsentDate":{
                                "description":"The date on which GDPR personalization consent was granted by the user.",
                                "type":"string"
                            },
                            "GDPRProfileP13nConsentGranted":{
                                "description":"Indicates whether the user has given GDPR Profile P13n consent on the current site. Can be true or false.",
                                "type":"boolean"
                            },
                            "receiveEmail":{
                                "description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
                                "type":"string"
                            },
                            "receiveEmailDate":{
                                "description":"The date on which email marketing consent was granted by the user.",
                                "type":"string"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

The list of site related properties for the profile

Show Source

Array of: object items

{
    "description":"The list of site related properties for the profile",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "site":{
                "description":"The site data",
                "type":"object",
                "properties":{
                    "id":{
                        "description":"The id of the site",
                        "type":"string"
                    }
                }
            },
            "properties":{
                "description":"The site related properties for the profile",
                "type":"object",
                "properties":{
                    "GDPRProfileP13nConsentDate":{
                        "description":"The date on which GDPR personalization consent was granted by the user.",
                        "type":"string"
                    },
                    "GDPRProfileP13nConsentGranted":{
                        "description":"Indicates whether the user has given GDPR Profile P13n consent on the current site. Can be true or false.",
                        "type":"boolean"
                    },
                    "receiveEmail":{
                        "description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
                        "type":"string"
                    },
                    "receiveEmailDate":{
                        "description":"The date on which email marketing consent was granted by the user.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

properties(optional): object properties

The site related properties for the profile
site(optional): object site

The site data

{
    "type":"object",
    "properties":{
        "site":{
            "description":"The site data",
            "type":"object",
            "properties":{
                "id":{
                    "description":"The id of the site",
                    "type":"string"
                }
            }
        },
        "properties":{
            "description":"The site related properties for the profile",
            "type":"object",
            "properties":{
                "GDPRProfileP13nConsentDate":{
                    "description":"The date on which GDPR personalization consent was granted by the user.",
                    "type":"string"
                },
                "GDPRProfileP13nConsentGranted":{
                    "description":"Indicates whether the user has given GDPR Profile P13n consent on the current site. Can be true or false.",
                    "type":"boolean"
                },
                "receiveEmail":{
                    "description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
                    "type":"string"
                },
                "receiveEmailDate":{
                    "description":"The date on which email marketing consent was granted by the user.",
                    "type":"string"
                }
            }
        }
    }
}

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.

{
    "description":"The site related properties for the profile",
    "type":"object",
    "properties":{
        "GDPRProfileP13nConsentDate":{
            "description":"The date on which GDPR personalization consent was granted by the user.",
            "type":"string"
        },
        "GDPRProfileP13nConsentGranted":{
            "description":"Indicates whether the user has given GDPR Profile P13n consent on the current site. Can be true or false.",
            "type":"boolean"
        },
        "receiveEmail":{
            "description":"Indicates whether the user should receive marketing emails on the current site. Can be yes or no.",
            "type":"string"
        },
        "receiveEmailDate":{
            "description":"The date on which email marketing consent was granted by the user.",
            "type":"string"
        }
    }
}

Nested Schema : site

Type: object

The site data

Show Source

id(optional): string

The id of the site

{
    "description":"The site data",
    "type":"object",
    "properties":{
        "id":{
            "description":"The id of the site",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "totalResults":2,
    "endingIndex":250,
    "offset":0,
    "totalResultsParam":true,
    "count":2,
    "limit":250,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:8080/ccstoreui/v1/profiles/current/siteProperties"
        }
    ],
    "sort":null,
    "items":[
        {
            "site":{
                "repositoryId":"100001",
                "id":"100001"
            },
            "properties":{
                "GDPRProfileP13nConsentDate":"2018-02-26T06:07:49.237Z",
                "GDPRProfileP13nConsentGranted":true,
                "repositoryId":"100002",
                "receiveEmail":"yes",
                "receiveEmailDate":"2018-02-26T06:07:49.237Z"
            }
        },
        {
            "site":{
                "id":"siteUS"
            },
            "properties":{
                "GDPRProfileP13nConsentDate":"2018-02-26T06:07:49.237Z",
                "GDPRProfileP13nConsentGranted":true,
                "receiveEmail":"yes",
                "receiveEmailDate":"2018-02-26T06:07:49.237Z"
            }
        }
    ],
    "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":"siteUS",
        "after":null,
        "calculateTotalAvailable":true
    },
    "startingIndex":0,
    "totalNumberOfItems":2
}

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 properties| |22032|Error occured due to invalid data|

Root Schema : errorModel

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}