Jump to

• Request
• Response

addEntryPageSessionContext

put

/ccstore/v1/audienceContext/currentSession/entryPage/current

Save the current session entry page data for the current user.

Request

Supported Media Types

• application/json

Body ()

Root Schema : addEntryPageSessionContext_request

Type: object

Show Source

• Referer(optional): string
  The referer URL for the current session.
• URL(optional): string
  The entry page URL for the current session.

{
    "properties":{
        "Referer":{
            "description":"The referer URL for the current session.",
            "type":"string"
        },
        "URL":{
            "description":"The entry page URL for the current session.",
            "type":"string"
        }
    },
    "example":{
        "entryPage":{
            "Referer":"http://a.com",
            "URL":"http://www.oracle.com?a=b&c=&d=&e="
        }
    }
}

Example:

{
    "entryPage":{
        "Referer":"http://a.com",
        "URL":"http://www.oracle.com?a=b&c=&d=&e="
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

The following model is returned the when operation succeeds and indicates that the session context was updated.

Body ()

Root Schema : addEntryPageSessionContext_response

Type: object

Show Source

• Referer(optional): string
  The referer URL for the current session.
• URL(optional): string
  The entry page URL for the current session.

{
    "properties":{
        "Referer":{
            "description":"The referer URL for the current session.",
            "type":"string"
        },
        "URL":{
            "description":"The entry page URL for the current session.",
            "type":"string"
        }
    },
    "example":{
        "Referer":"http://a.com",
        "Params":{
            "a":[
                "b"
            ],
            "c":[
            ],
            "d":[
            ],
            "e":[
            ]
        },
        "links":[
            {
                "rel":"self",
                "href":"http://localhost:8080/ccstoreui/v1/audienceContext/currentSession/entryPage/current"
            }
        ],
        "URL":"http://www.oracle.com?a=b&c=&d=&e="
    }
}

Example:

{
    "Referer":"http://a.com",
    "Params":{
        "a":[
            "b"
        ],
        "c":[
        ],
        "d":[
        ],
        "e":[
        ]
    },
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:8080/ccstoreui/v1/audienceContext/currentSession/entryPage/current"
        }
    ],
    "URL":"http://www.oracle.com?a=b&c=&d=&e="
}

201 Response

The following model is returned the when operation succeeds and indicates that the session data was created.

Body ()

Root Schema : addEntryPageSessionContext_response

Type: object

Show Source

• Referer(optional): string
  The referer URL for the current session.
• URL(optional): string
  The entry page URL for the current session.

{
    "properties":{
        "Referer":{
            "description":"The referer URL for the current session.",
            "type":"string"
        },
        "URL":{
            "description":"The entry page URL for the current session.",
            "type":"string"
        }
    },
    "example":{
        "Referer":"http://a.com",
        "Params":{
            "a":[
                "b"
            ],
            "c":[
            ],
            "d":[
            ],
            "e":[
            ]
        },
        "links":[
            {
                "rel":"self",
                "href":"http://localhost:8080/ccstoreui/v1/audienceContext/currentSession/entryPage/current"
            }
        ],
        "URL":"http://www.oracle.com?a=b&c=&d=&e="
    }
}

Example:

{
    "Referer":"http://a.com",
    "Params":{
        "a":[
            "b"
        ],
        "c":[
        ],
        "d":[
        ],
        "e":[
        ]
    },
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:8080/ccstoreui/v1/audienceContext/currentSession/entryPage/current"
        }
    ],
    "URL":"http://www.oracle.com?a=b&c=&d=&e="
}

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| |------------------|------------------| |54142|The entry page property with name {0} has exceeded the maximum allowable length of {1}.| |54143|Unable to store Entry Page data for session because it is null.| |54144|The required header is missing: X-CCVisitId|

Body ()

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"
        }
    }
}

Back to Top