REST API OCST - Get Channels

URI

/channels

Http Method

GET

Short Description

Returns the current organization's sales channels to the client

Query Parameters

Example Requests

/channels

Headers:

  • Authorization=... or authentication-token=...
  • UserOrganization =PrimeTech

HTTP Status Codes

200 OK

400 Bad Request
Possible value for header 'error-key':

    • organization.invalid
    • organization.name.missing

401 Authorization Required

Description

Gets the sales channels of the current organization.

The current organization is supplied by the client using the header UserOrganization needed for the authentication.

Cartridge

app_sf_contactcenter_rest

Application

ContactCenter

Product Version

7.5.1

Product To Version

Status

final

JSON

Request Data Format

Request related java object

com.intershop.application.contactcenter.capi.rest.resource.ChannelListResource

Request Example

Response Data Format

application/json

Response related java object

com.intershop.application.contactcenter.capi.rest.resource.ChannelListResource

Response Example

{
    "elements":
    [
        {
            "type": "Link",
            "description": "PrimeTech's channel to sell directly to business customers.",
            "title": "PrimeTech Business",
            "uri": "ContactCenter/-/channels/PrimeTech-PrimeTechBusiness",
            "attributes":
            [
                {
                    "name": "id",
                    "type": "String",
                    "value": "PrimeTech-PrimeTechBusiness"
                }
            ]
        },
        {
            "type": "Link",
            "description": "PrimeTech's channel to sell directly to customers.",
            "title": "PrimeTech Specials",
            "uri": "ContactCenter/-/channels/PrimeTech-PrimeTechSpecials",
            "attributes":
            [
                {
                    "name": "id",
                    "type": "String",
                    "value": "PrimeTech-PrimeTechSpecials"
                }
            ]
        }
    ],
    "type": "ResourceCollection",
    "name": "channels"
}

XML

XML Request Data Format

XML Request Java Objects

com.intershop.application.contactcenter.capi.rest.resource.ChannelListResource

XML Request Example

XML Response Data Format

text/xml

XML Response Java Objects

com.intershop.application.contactcenter.capi.rest.resource.ChannelListResource

XML Response Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ResourceCollection name="channels" type="ResourceCollection">
  <elements>
    <Link type="Link">
      <attributes>
        <ResourceAttribute name="id" type="String">
          <value>PrimeTech-PrimeTechBusiness</value>
        </ResourceAttribute>
      </attributes>
      <description>PrimeTech's channel to sell directly to business customers.</description>
      <title>PrimeTech Business</title>
      <uri>ContactCenter/-/channels/PrimeTech-PrimeTechBusiness</uri>
    </Link>
    <Link type="Link">
      <attributes>
        <ResourceAttribute name="id" type="String">
          <value>PrimeTech-PrimeTechSpecials</value>
        </ResourceAttribute>
      </attributes>
      <description>PrimeTech's channel to sell directly to customers.</description>
      <title>PrimeTech Specials</title>
      <uri>ContactCenter/-/channels/PrimeTech-PrimeTechSpecials</uri>
    </Link>
  </elements>
</ResourceCollection>



    

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.

Customer Support
Knowledge Base
Product Resources
Support Tickets