updateSiteProperties

put

/ccstore/v1/profiles/current/siteProperties

Updates the site based properties for the current profile. Can be used to update multiple properties of multiple sites at the same time.

Request

Supported Media Types
Query Parameters
Header Parameters
Body ()
Root Schema : updateSiteProperties_request
Type: object
Show Source
Example:
{
    "siteProperties":[
        {
            "site":{
                "id":"100001"
            },
            "properties":{
                "GDPRProfileP13nConsentGranted":false,
                "receiveEmail":"no"
            }
        },
        {
            "site":{
                "id":"siteUS"
            },
            "properties":{
                "GDPRProfileP13nConsentGranted":false,
                "receiveEmail":"yes"
            }
        }
    ]
}
Nested Schema : siteProperties
Type: array
The site related properties
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : properties
Type: object
The site related properties to be updated for the profile
Show Source
Nested Schema : site
Type: object
The site data
Show Source
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : updateSiteProperties_response
Type: object
Show Source
Nested Schema : items
Type: array
The list of site related properties for the profile
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : properties
Type: object
The site related properties for the profile
Show Source
Nested Schema : site
Type: object
The site data
Show Source
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":"no",
                "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| |------------------|------------------| |22031|Internal error during get profile properties.| |22032|Error occured due to invalid data| |22033|User is not logged in.| |22034|No site found| |22035|Error occured when site property not found.| |22036|Internal error during update profile properties.|
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top