Experience Version Actions

https://api.losant.com/applications/APPLICATION_ID/experience/versions/EXPERIENCE_VERSION_ID_OR_NAME

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

Delete

Deletes an experience version

Method And Url

DELETE https://api.losant.com/applications/APPLICATION_ID/experience/versions/EXPERIENCE_VERSION_ID_OR_NAME

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.cli, all.Organization, all.User, all.User.cli, experienceVersion.*, or experienceVersion.delete.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
EXPERIENCE_VERSION_ID_OR_NAME	Version ID or version name associated with the experience version	575ed78e7ae143cd83dc4aab

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/versions/EXPERIENCE_VERSION_ID_OR_NAME

Successful Responses

Code	Type	Description
200	Success	If experience version was successfully deleted

Error Responses

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

Get

Retrieves information on an experience version

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/experience/versions/EXPERIENCE_VERSION_ID_OR_NAME

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.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, experienceVersion.*, or experienceVersion.get.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
EXPERIENCE_VERSION_ID_OR_NAME	Version ID or version name associated with the experience version	575ed78e7ae143cd83dc4aab

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/versions/EXPERIENCE_VERSION_ID_OR_NAME

Successful Responses

Code	Type	Description
200	Experience Version	Experience version information

Error Responses

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

Patch

Updates information about an experience version

Method And Url

PATCH https://api.losant.com/applications/APPLICATION_ID/experience/versions/EXPERIENCE_VERSION_ID_OR_NAME

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.cli, all.Organization, all.User, all.User.cli, experienceVersion.*, or experienceVersion.patch.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
EXPERIENCE_VERSION_ID_OR_NAME	Version ID or version name associated with the experience version	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 Version Patch schema. For example, the following would be a valid body for this request:

{
  "endpointDefaultCors": false
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"endpointDefaultCors":false}' \
    https://api.losant.com/applications/APPLICATION_ID/experience/versions/EXPERIENCE_VERSION_ID_OR_NAME

Successful Responses

Code	Type	Description
200	Experience Version	Updated experience version information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if experience version 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 Version

Schema for a single Experience Version

Experience Version Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 18 keys
▶
id:{} 2 keys
▶
experienceVersionId:{} 2 keys
▶
applicationId:{} 2 keys
▶
creationDate:{} 2 keys
▶
createdById:{} 2 keys
▶
createdByType:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
lastUpdatedById:{} 2 keys
▶
lastUpdatedByType:{} 2 keys
▶
endpointDefaultCors:{} 1 key
▶
allowedCorsOrigins:{} 3 keys
▶
version:{} 3 keys
▶
description:{} 2 keys
▶
globals:{} 3 keys
▶
notFoundReply:{} 1 key
▶
unauthorizedReply:{} 1 key
▶
attachedDomains:{} 2 keys
▶
attachedSlugs:{} 2 keys

Experience Version Example

▶
root:{} 9 keys
id:"5b995ec6ea9994b50d745285"
experienceVersionId:"5b995ec6ea9994b50d745285"
applicationId:"575ec8687ae143cd83dc4a97"
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
version:"myVersionName"
endpointDefaultCors:true
▶
attachedDomains:[] 1 item
▶
attachedSlugs:[] 1 item

Experience Version Patch

Schema for the body of an Experience Version modification request

Experience Version Patch Schema

▶
root:{} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 7 keys
▶
endpointDefaultCors:{} 1 key
▶
allowedCorsOrigins:{} 3 keys
▶
globals:{} 3 keys
▶
notFoundReply:{} 1 key
▶
unauthorizedReply:{} 1 key
▶
description:{} 2 keys
▶
sourceVersionIdOrName:{} 3 keys
additionalProperties:false

Experience Version Patch Example

▶
root:{} 1 key
endpointDefaultCors:false

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