XOMNI: Experience Omni-Channel

Last Updated: March 24, 2016

The API provides to fetch a full list of apps from the backend.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/management/oauth/apps?skip={skip}&take={take}

URI Parameters

Parameter Name Description Type Conditions
skip The number of items in the collection to skip before executing a select. Integer
Required.
take The number of items that should be fetched from the collection. Integer
Required.

Request Headers

Header Field Name Description
Authorization
Access or identity token taken from oauth APIs.
Sample: Bearer dc8f1dcdbe454da8a25621839a93569337522968019e4bd7becd6e01285444da

Response

{  
   "Results":[  
      {  
         "ApplicationId":"05cdd8b9-06f3-4ff8-8a20-2f6ca3442c7a",
         "ApplicationSecret":"05cdd8b9-06f3-4ff8-8a20-2f6ca3442c7a05cdd8b9-06f3-4ff8-8a20-2f6ca3442c7a",
         "Name":"Sample OAuth App",
         "Description":"Sample OAuth App Description",
         "IsPredefined":false,
         "ApplicationTypeId":1,
         "ApplicationTypeDescription":"Consumer"
      }
   ],
   "TotalCount":6
}

Response Body Description

Parameter Name Description Type
TotalCount Number
Results[0..N].ApplicationId The unique application identity of the oauth app. String
Results[0..N].ApplicationSecret The unique application secret key of the oauth app. String
Results[0..N].Name The name of the oauth app. String
Results[0..N].Description The description of the oauth app. String
Results[0..N].IsPredefined Boolean field indicating if oauth app is predefined or not. Unknown
Results[0..N].ApplicationTypeId The application type id enumeration of the oauth app. Number
Results[0..N].ApplicationTypeDescription The application type description of the oauth app. String

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) No oauth apps found.