1. REST API for Oracle Commerce Cloud 22A
  2. Tasks
  3. Store
  4. Audience Context

saveCurrentSessionContext

put

/ccstore/v1/audienceContext/currentSession

Save the current session context data for the current user.

Request

Supported Media Types
Body ()
Root Schema : saveCurrentSessionContext_request
Type: object
Show Source
Example:
{
    "deviceData":{
        "deviceType":"Mobile",
        "deviceOS":"iOS"
    },
    "entryPage":{
        "Referer":"http://a.com",
        "URL":"http://www.oracle.com?a=b&c=&d=&e="
    },
    "geolocation":{
        "country_code":"US",
        "city":"SANDIEGO",
        "timezone":"(GMT-08:00)",
        "latitude":32.7,
        "region_code":"CA",
        "longitude":117.2
    }
}
Nested Schema : deviceData
Type: object
An object that contains device data properties and values.
Nested Schema : entryPage
Type: object
An object that contains entry page properties and values.
Nested Schema : geolocation
Type: object
An object that contains geolocation properties and values.
Back to Top

Response

Supported Media Types

200 Response

The following model is returned the when operation succeeds and indicates that the session context was updated.
Body ()
Root Schema : saveCurrentSessionContext_response
Type: object
Show Source
Example:
{
    "application/json":{
        "deviceData":{
            "deviceType":"Mobile",
            "deviceOS":"iOS"
        },
        "links":[
            {
                "rel":"self",
                "href":"http://localhost:8080/ccstoreui/v1/audienceContext/currentSession"
            }
        ],
        "entryPage":{
            "Referer":"http://a.com",
            "Params":{
                "a":[
                    "b"
                ],
                "c":[
                ],
                "d":[
                ],
                "e":[
                ]
            },
            "URL":"http://www.oracle.com?a=b&c=&d=&e="
        },
        "geolocation":{
            "country_code":"US",
            "city":"SANDIEGO",
            "timezone":"(GMT-08:00)",
            "latitude":32.7,
            "cityInList":"true",
            "region_code":"CA",
            "longitude":117.2
        }
    }
}
Nested Schema : deviceData
Type: object
The device data that was set for the current session.
Nested Schema : entryPage
Type: object
An object that contains entry page properties and values.
Nested Schema : geolocation
Type: object
The geolocation data that was set for the current session.

201 Response

The following model is returned the when operation succeeds and indicates that the session data was created.
Body ()
Root Schema : saveCurrentSessionContext_response
Type: object
Show Source
Example:
{
    "application/json":{
        "deviceData":{
            "deviceType":"Mobile",
            "deviceOS":"iOS"
        },
        "links":[
            {
                "rel":"self",
                "href":"http://localhost:8080/ccstoreui/v1/audienceContext/currentSession"
            }
        ],
        "entryPage":{
            "Referer":"http://a.com",
            "Params":{
                "a":[
                    "b"
                ],
                "c":[
                ],
                "d":[
                ],
                "e":[
                ]
            },
            "URL":"http://www.oracle.com?a=b&c=&d=&e="
        },
        "geolocation":{
            "country_code":"US",
            "city":"SANDIEGO",
            "timezone":"(GMT-08:00)",
            "latitude":32.7,
            "cityInList":"true",
            "region_code":"CA",
            "longitude":117.2
        }
    }
}
Nested Schema : deviceData
Type: object
The device data that was set for the current session.
Nested Schema : entryPage
Type: object
An object that contains entry page properties and values.
Nested Schema : geolocation
Type: object
The geolocation data that was set for the current session.

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| |------------------|------------------| |54118|The request was missing the required audience context data body.| |54106|Geolocation data contains the following unsupported properties: {0}| |54107|Geolocation data contains an invalid country code: {0}| |54108|Geolocation data must contain a country code if a region code is specified.| |54109|Geolocation data contains an invalid region and/or country code: {0}| |54110|Geolocation data must contain a country code if city is specified.| |54111|Geolocation data contains a city that exceeds the maximum allowable length of {0} characters.| |54112|Geolocation data contains an invalid latitude. The value must be a number between -90 and 90.| |54113|Geolocation data contains an invalid longitude. The value must be a number between -180 and 180.| |54114|Geolocation data contains an unsupported time zone value: {0}| |54115|An error occurred while trying to validate the geolocation time zone.| |54116|An error occurred while trying to cache the geolocation data. The cache was not found.| |54117|An internal error occurred while trying to validate geolocation data.| |54120|Device Data contains the following invalid properties: {0}| |54121|Device Data contains an invalid device type data: {0}| |54122|Device Data contains an invalid device OS data: {0}| |54123|Device Data to be validated or cached is null.| |54144|The required header is missing: X-CCVisitId| |54126|Profile Visit Data to be validated/cached is null.| |54127|Profile visit data contains an invalid first visit date: {0}| |54129|Profile visit data contains invalid dates. The first visit date is after the last visit date.| |54128|Profile visit data contains an invalid last visit date: {0}| |54130|Profile visit data contains invalid dates. The first visit date is after the previous visit date.| |54131|Profile visit data contains invalid dates. The last visit date is before the previous visit date.| |54132|Profile visit data contains an invalid previous visit date: {0}| |54133|Profile visit data contains an invalid number of visits: {0}. It must be a positive integer.|
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