REST API for Oracle Commerce Cloud December 2017

listSiteProperties

get

/ccagent/v1/profiles/{id}/siteProperties

Get Site properties related to specific customer.

Request

Supported Media Types

application/json

Path Parameters

id: Type: string

Required: true

The customer profile id.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : listSiteProperties_response

Properties

items: Type: array items

Additional Properties Allowed:

The list of site related properties for the profile
offset: Type: integer

The start index of the list of records to be fetched
sort: Type: string

Sorting format

Nested Schema : items

Type: array

The list of site related properties for the profile

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

properties: Type: object properties

Additional Properties Allowed:

The site related properties for the profile
site: Type: object site

Additional Properties Allowed:

The site data

Nested Schema : properties

Type: object

The site related properties for the profile

Properties

receiveEmail: Type: string

Indicates whether the user should receive marketing emails on the current site. Can be yes or no.

Nested Schema : site

Type: object

The site data

Properties

id: Type: string

The id of the site

Example application/json


{
    "totalResults":1,
    "endingIndex":250,
    "offset":0,
    "totalResultsParam":true,
    "count":1,
    "limit":250,
    "links":[
        {
            "rel":"self",
            "href":"http://blr2213237.idc.oracle.com:9080/ccagentui/v1/profiles/se-570031/siteProperties?siteProperties=%5Bobject%20Object%5D"
        }
    ],
    "sort":null,
    "items":[
        {
            "site":{
                "id":"SiteA"
            },
            "properties":{
                "receiveEmail":"yes"
            }
        }
    ],
    "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 occured due to invalid data|

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

{
  "totalResults": 1,
  "endingIndex": 250,
  "offset": 0,
  "totalResultsParam": true,
  "count": 1,
  "limit": 250,
  "links": [{
    "rel": "self",
    "href": "http://blr2213237.idc.oracle.com:9080/ccagentui/v1/profiles/se-570031/siteProperties?siteProperties=%5Bobject%20Object%5D"
  }],
  "sort": null,
  "items": [{
    "site": {"id": "SiteA"},
    "properties": {"receiveEmail": "yes"}
  }],
  "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
}