REST API for Oracle Commerce Cloud December 2017

removeSecondaryOrganizations

post

/ccadmin/v1/profiles/{id}/removeSecondaryOrganizations

Remove Secondary Organizations. This operation is used to remove the secondary organizations from the profile. Optionally takes the x-ccasset-language header to get translated content in another language.

Request

Supported Media Types

application/json

Path Parameters

id: Type: string

Required: true

Header Parameters

X-CCAsset-Language: Type: string

The asset language of the request

Body Parameter

Root Schema : removeSecondaryOrganizations_request

Example


{
    "secondaryOrganizations":[
        {
            "id":"200001"
        }
    ]
}

Properties

secondaryOrganizations: Type: array secondaryOrganizations

Required: true

Additional Properties Allowed:

List of secondary organizations that need to be removed from the profile.

Nested Schema : secondaryOrganizations

Type: array

List of secondary organizations that need to be removed from the profile.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

id: Type: string

Required: true

ID of the organization to be removed.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : removeSecondaryOrganizations_response

Properties

secondaryOrganizations: Type: array secondaryOrganizations

Additional Properties Allowed:

List of secondary organizations removed from the profile.

Nested Schema : secondaryOrganizations

Type: array

List of secondary organizations removed from the profile.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

id: Type: string

ID of the organization removed.

Example application/json


{
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/profiles/120175/removeSecondaryOrganizations"
        }
    ],
    "secondaryOrganizations":[
        {
            "id":"200001"
        }
    ]
}

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| |------------------|------------------| |22014|If some internal error occurs while removing secondary organizations from the profile.| |22018|If the user input is null or empty.|

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 Request:

{"secondaryOrganizations": [{"id": "200001"}]}

Sample Response Payload returned by endpoint:

{
  "links": [{
    "rel": "self",
    "href": "http://localhost:9080/ccadminui/v1/profiles/120175/removeSecondaryOrganizations"
  }],
  "secondaryOrganizations": [{"id": "200001"}]
}