Experience Endpoint Actions

https://api.losant.com/applications/APPLICATION_ID/experience/endpoints/EXPERIENCE_ENDPOINT_ID

Below are the various requests that can be performed against the Experience Endpoint resource, as well as the expected parameters and the potential responses.

Delete

Deletes an experience endpoint

Method And Url

DELETE https://api.losant.com/applications/APPLICATION_ID/experience/endpoints/EXPERIENCE_ENDPOINT_ID

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, experienceEndpoint.*, or experienceEndpoint.delete.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
EXPERIENCE_ENDPOINT_ID	ID associated with the experience endpoint	575ed78e7ae143cd83dc4aab

Request Query Parameters

Name	Required	Description	Default	Example
includeWorkflows	N	If the workflows that utilize this experience endpoint should also be deleted.		includeWorkflows=true

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X DELETE \
    https://api.losant.com/applications/APPLICATION_ID/experience/endpoints/EXPERIENCE_ENDPOINT_ID

Successful Responses

Code	Type	Description
200	Success	If experience endpoint was successfully deleted

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if experience endpoint was not found

Get

Retrieves information on an experience endpoint

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/experience/endpoints/EXPERIENCE_ENDPOINT_ID

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, experienceEndpoint.*, or experienceEndpoint.get.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
EXPERIENCE_ENDPOINT_ID	ID associated with the experience endpoint	575ed78e7ae143cd83dc4aab

Request Query Parameters

Name	Required	Description	Default	Example
version	N	Version of this experience endpoint to return	develop	version=develop

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.losant.com/applications/APPLICATION_ID/experience/endpoints/EXPERIENCE_ENDPOINT_ID

Successful Responses

Code	Type	Description
200	Experience Endpoint	Experience endpoint information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if experience endpoint was not found

Linked Resources

Retrieves information on resources linked to an experience endpoint

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/experience/endpoints/EXPERIENCE_ENDPOINT_ID/linkedResources

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, experienceEndpoint.*, or experienceEndpoint.linkedResources.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
EXPERIENCE_ENDPOINT_ID	ID associated with the experience endpoint	575ed78e7ae143cd83dc4aab

Request Query Parameters

Name	Required	Description	Default	Example
version	N	Version of this experience endpoint to query	develop	version=develop
includeCustomNodes	N	If the result of the request should also include the details of any custom nodes referenced by returned workflows	false	includeCustomNodes=true

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.losant.com/applications/APPLICATION_ID/experience/endpoints/EXPERIENCE_ENDPOINT_ID/linkedResources

Successful Responses

Code	Type	Description
200	Experience Linked Resources	Linked resource information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if experience endpoint was not found

Patch

Updates information about an experience endpoint

Method And Url

PATCH https://api.losant.com/applications/APPLICATION_ID/experience/endpoints/EXPERIENCE_ENDPOINT_ID

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, experienceEndpoint.*, or experienceEndpoint.patch.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
EXPERIENCE_ENDPOINT_ID	ID associated with the experience endpoint	575ed78e7ae143cd83dc4aab

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Request Body

The body of the request should be serialized JSON that validates against the Experience Endpoint Patch schema. For example, the following would be a valid body for this request:

{
  "access": "group",
  "experienceGroupIds": [
    "58c1de6f8f812590d8e82983"
  ]
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"access":"group","experienceGroupIds":["58c1de6f8f812590d8e82983"]}' \
    https://api.losant.com/applications/APPLICATION_ID/experience/endpoints/EXPERIENCE_ENDPOINT_ID

Successful Responses

Code	Type	Description
200	Experience Endpoint	Updated experience endpoint information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if experience endpoint was not found

Schemas

Error

Schema for errors returned by the API

Error Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 2 keys
▶
type:{} 1 key
▶
message:{} 1 key

Error Example

▶
root:{} 2 keys
type:"NotFound"
message:"Application was not found"

Experience Endpoint

Schema for a single Experience Endpoint

Experience Endpoint Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 19 keys
▶
id:{} 2 keys
▶
experienceEndpointId:{} 2 keys
▶
applicationId:{} 2 keys
▶
creationDate:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
createdById:{} 2 keys
▶
createdByType:{} 2 keys
▶
lastUpdatedById:{} 2 keys
▶
lastUpdatedByType:{} 2 keys
▶
description:{} 2 keys
▶
route:{} 3 keys
▶
enabled:{} 1 key
▶
method:{} 2 keys
▶
access:{} 2 keys
▶
deviceIdTemplate:{} 2 keys
▶
endpointTags:{} 3 keys
▶
staticReply:{} 1 key
▶
unauthorizedReply:{} 1 key
▶
experienceGroups:{} 2 keys

Experience Endpoint Example

▶
root:{} 10 keys
id:"58c1de6c8f812590d8e82980"
experienceEndpointId:"58c1de6c8f812590d8e82980"
applicationId:"575ec8687ae143cd83dc4a97"
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
route:"/my/route/{id}"
enabled:true
method:"get"
access:"group"
▶
experienceGroups:[] 1 item

Experience Endpoint Patch

Schema for the body of an Experience Endpoint modification request

Experience Endpoint Patch Schema

▶
root:{} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 10 keys
▶
description:{} 2 keys
▶
route:{} 3 keys
▶
enabled:{} 1 key
▶
method:{} 2 keys
▶
access:{} 2 keys
▶
deviceIdTemplate:{} 2 keys
▶
endpointTags:{} 3 keys
▶
experienceGroupIds:{} 3 keys
▶
staticReply:{} 1 key
▶
unauthorizedReply:{} 1 key
additionalProperties:false

Experience Endpoint Patch Example

▶
root:{} 2 keys
access:"group"
▶
experienceGroupIds:[] 1 item

Experience Linked Resources

The body of an experience linked resources response

Experience Linked Resources Schema

▶
root:{} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 4 keys
▶
experienceViews:{} 4 keys
▶
experienceEndpoints:{} 4 keys
▶
flows:{} 4 keys
▶
flowVersions:{} 4 keys
additionalProperties:false

Experience Linked Resources Example

▶
root:{} 4 keys
▶
experienceViews:{} 8 keys
▶
experienceEndpoints:{} 8 keys
▶
flows:{} 8 keys
▶
flowVersions:{} 9 keys

Success

Schema for reporting a successful operation

Success Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 1 key
▶
success:{} 2 keys

Success Example

▶
root:{} 1 key
success:true