1. REST API for Oracle Commerce Cloud
  2. Tasks
  3. Store
  4. Organizations

listLegalApprovers

get

/ccstore/v1/organizations/{id}/legalApprovers

List Legal Approvers. This operation is used to get the collection of contacts having the legal approver role for the given organizationId. Optionally takes X-CCOrganization to specify current Organization of logged in user. It can also be used to return the list on a searched string and in a sorted order against various properties of profile.

Request

Supported Media Types
Path Parameters
Query Parameters
  • This is the field to determine number of records to be fetched per REST call.
  • This field determines the offset/starting index from which data to be fetched.
  • Query string built as per the SCIM standards that helps to search entered string across contact properties, 'firstName', 'lastName', 'email'
  • This field determines the sort order of the list to be fetched.
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : listLegalApprovers_response
Type: object
Show Source
Nested Schema : items
Type: array
list of shopper profiles
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : roles
Type: array
List of user roles
Show Source
Nested Schema : secondaryOrganizations
Type: array
Secondary organizations for the profile
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : associations
Type: array
Associations of the role with the organization member
Show Source
Nested Schema : relativeTo
Type: object
Organization in which the role applies. Present only if type is organizationalRole
Show Source
Nested Schema : items
Type: object
Show Source
  • Organization id to which the role is associated.If the type is global, relatedItemId is null
  • Type of the association.Possible values are - organization,global.
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "total":1,
    "totalResults":1,
    "offset":0,
    "limit":1,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:8080/ccstore/v1/organizations/or-100001/legalApprovers"
        }
    ],
    "sort":[
        {
            "property":"firstName",
            "order":"asc"
        }
    ],
    "items":[
        {
            "lastName":"Dilliard",
            "firstName":"Leota",
            "roles":[
                {
                    "associations":[
                        {
                            "relatedItemId":"or-100001",
                            "type":"organization"
                        }
                    ],
                    "function":"buyer",
                    "relativeTo":{
                        "id":"or-100001"
                    },
                    "repositoryId":"100002",
                    "name":"Buyer",
                    "id":"100002",
                    "type":"organizationalRole"
                },
                {
                    "associations":[
                        {
                            "relatedItemId":"or-100001",
                            "type":"organization"
                        }
                    ],
                    "repositoryId":"ora.legalApprover",
                    "name":"Legal Approver",
                    "id":"ora.legalApprover",
                    "type":"role"
                }
            ],
            "repositoryId":"bb-110006",
            "id":"bb-110006",
            "email":"leota@example.com",
            "secondaryOrganizations":[
            ]
        }
    ]
}

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| |------------------|------------------| |100070|Invalid Query Expression.| |23039|If there was any internal error while getting the profile| |10002|The value x for parameter 'y' is invalid. 'y' can be 'limit', 'offset' or 'sort'.
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