XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

This API provides detailed information about integration endpoint.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/management/integration/endpoint

Request Headers

Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.
Authorization
Access or identity token taken from oauth APIs.
Sample: Bearer dc8f1dcdbe454da8a25621839a93569337522968019e4bd7becd6e01285444da
Accept
Includes minor version header.
Sample: application/vnd.xomni.api-v4-1, */*

Response

{
  "ServiceName": "test",
  "ManagementPortalUrl": "http://xomni.com",
  "Status": 1
}

Response Body Description

Parameter Name Description Type
ServiceName Name of the service. String
ManagementPortalUrl Management portal URL of the integration endpoint. String
Status Creation status of integration endpoint. Number

Possible values for status

Value Description
1 Integration endpoint creation operation is in progress. Please call this API later for updated status.
2 Integration endpoint creation operation was succeeded
3 Integration endpoint creation operation was failed. Please create a new integration endpoint.

Response Headers

Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.

Status Codes

A successful operation returns status code 200 (OK) for GET operations. Possible response status codes are as listed below:

Status Code Description
404 (Not Found) Integration endpoint not found.