API documentation

/v1/accounts/{id}

GET /v1/accounts/{id}

Returns a given Account

Rel name	description
self	account
http://cloudapi.soaringspot.com/rel/assets/my	GET returns a collection of assets uploaded by user or shared with the user, POST to create a new asset
http://cloudapi.soaringspot.com/rel/assets/public	GET returns a collection of assets marked as public
http://cloudapi.soaringspot.com/rel/labels	GET returns a collection of labels created by user, POST creates new label
http://cloudapi.soaringspot.com/rel/channels	GET returns collection of channels user has access to
http://cloudapi.soaringspot.com/rel/subscribe	templated url, {idLabel} should be replaced with the id of the channel user would like to (un)subscribe, use PUT method to subscribe, DELETE to unsubscribe

Name	Requirement	Type	Description
id		int	id of a Account to return

/v1/accounts/{id}/assets

GET /v1/accounts/{id}/assets

Returns a collection of Asset under given Account

Documentation

Documentation

Returns a collection of Asset under given Account

Requirements

Name	Requirement	Type	Description
id		int	id of a Account to get the Asset collection for

Filters

Name

Information

limit

Requirement	\d+
Description	Results per page.
Default	20

page

Requirement	\d+
Description	Page to show.
Default

s

Requirement	(([a-z_]+-?),?)*
Description	The comma separated list of fields you'd like to order by. Suffix a field with a - for Descending sort order.
Default	id-

q

Requirement	.*
Description	Result filter.
Default

POST /v1/accounts/{id}/assets

Create new Asset under given Account

Documentation

Documentation

Create new Asset under given Account

Requirements

Name	Requirement	Type	Description
id		int	id of a Account to get the new Asset

Parameters

Parameter	Type	Required?	Description
naviter_asset_asset	object (AssetFormType)	true
naviter_asset_asset[name]	string	true	asset name
naviter_asset_asset[type]	string	true	asset type is a main asset mime type. The supported asset mime types are available in a separate document
naviter_asset_asset[tags]	string	false	comma separated list of tags. If you need the comma inside a tag, then wrap such a tag with ""
naviter_asset_asset[description]	string	false	user entered asset description
naviter_asset_asset[hidden]	boolean	false

/v1/accounts/{id}/assets/{idAsset}/labels

GET /v1/accounts/{id}/assets/{idAsset}/labels

Returns a collection of Label under given Asset for a given Account

Name	Requirement	Type	Description
id		int	id of a Account to get the Label collection for
idAsset		int	id of a Asset to get the Label collection for

/v1/accounts/{id}/channels

GET /v1/accounts/{id}/channels

Returns a channel list

Documentation

Documentation

Returns a channel list

The channel list is a collection of Label resources.

Requirements

Name	Requirement	Type	Description
id		int	id of a Account to get the Channel collection for

Filters

Name

Information

type

Requirement	all\|channel\|featured\|subscribed
Description	Channel type filter
Default	featured

/v1/accounts/{id}/labels

GET /v1/accounts/{id}/labels

Returns a collection of Label under given Account

Name	Requirement	Type	Description
id		int	id of a Account to get the Label collection for

POST /v1/accounts/{id}/labels

Create new Label under given Account

Documentation

Documentation

Create new Label under given Account

Requirements

Name	Requirement	Type	Description
id		int	id of a Account to get the new Label

Parameters

Parameter	Type	Required?	Format	Description
naviter_asset_label	object (LabelFormType)	true
naviter_asset_label[label]	string	true		label name, "folders" are separated by /. Please note that parent labels are not created automatically.
naviter_asset_label[color]	integer	true		label color in ARGB fromat
naviter_asset_label[type]	choice	true	{"label":"enum.label.type.label","channel":"enum.label.type.channel","featured":"enum.label.type.featured"}	one of [label, channel, featured]. Please note that you can't have a channel inside a channel and that as 3rd party developer you, can't set the the label to a featured one.

/v1/accounts/{id}/subscriptions/{idLabel}

PUT /v1/accounts/{id}/subscriptions/{idLabel}

Subscribe given Account to a given Label

Name	Requirement	Type	Description
id		int	id of a Account to add the subscription for
idLabel		int	id of a Label to be added

DELETE /v1/accounts/{id}/subscriptions/{idLabel}

Unsubscribe given Account from a given Label

Name	Requirement	Type	Description
id		int	id of a Account to remove the Subscription from
idLabel		int	id of a Label to be removed

/v1/assets

GET /v1/assets

Returns a collection of public Asset

Documentation

Documentation

Returns a collection of public Asset

Filters

Name

Information

limit

Requirement	\d+
Description	Results per page.
Default	20

page

Requirement	\d+
Description	Page to show.
Default

s

Requirement	(([a-z_]+-?),?)*
Description	The comma separated list of fields you'd like to order by. Suffix a field with a - for Descending sort order.
Default	id-

q

Requirement	.*
Description	Result filter.
Default

/v1/assets/{id}

GET /v1/assets/{id}

Returns a given Asset

Name	Requirement	Type	Description
id		int	id of a Asset to return

PUT /v1/assets/{id}

Update an existing Asset

Documentation

Documentation

Update an existing Asset

Requirements

Name	Requirement	Type	Description
id		int	id of a Asset to update

Parameters

Parameter	Type	Required?	Description
naviter_asset_asset	object (AssetFormType)	true
naviter_asset_asset[name]	string	true	asset name
naviter_asset_asset[type]	string	true	asset type is a main asset mime type. The supported asset mime types are available in a separate document
naviter_asset_asset[tags]	string	false	comma separated list of tags. If you need the comma inside a tag, then wrap such a tag with ""
naviter_asset_asset[description]	string	false	user entered asset description
naviter_asset_asset[hidden]	boolean	false

DELETE /v1/assets/{id}

Delete a given Asset

Name	Requirement	Type	Description
id		int	id of a Asset to delete

/v1/assets/{id}/files

GET /v1/assets/{id}/files

Returns a collection of File under given Asset

Name	Requirement	Type	Description
id		int	id of a Asset to get the File collection for

POST /v1/assets/{id}/files

Create new File under given Asset

Documentation

Documentation

Create new File under given Asset

Requirements

Name	Requirement	Type	Description
id		int	id of a Asset to get the new File

Parameters

Parameter	Type	Required?	Format	Description
naviter_asset_file_details	object (FileDetailsFormType)	true
naviter_asset_file_details[uri]	string	true		relative path to a file inside an asset.
naviter_asset_file_details[time]	datetime	true	yyyy-MM-dd'THH:mm:ss	date and time of when the file was last modified.

/v1/assets/{id}/labels/{idLabel}

PUT /v1/assets/{id}/labels/{idLabel}

Link a given Label to a given Asset

Name	Requirement	Type	Description
id		int	id of an Asset the Label should be linked with
idLabel		int	id of a Label to be linked

DELETE /v1/assets/{id}/labels/{idLabel}

Unlink given Label from a given Asset

Name	Requirement	Type	Description
id		int	id of a Asset to unlink the Label from
idLabel		int	id of a Label to be unlinked

/v1/assets/{id}/metadata/extended

GET /v1/assets/{id}/metadata/extended

Returns only extended part of metadata for a given Asset

Name	Requirement	Type	Description
id		int	id of a Asset to return extended metadata for

/v1/channels/{id}/labels

GET /v1/channels/{id}/labels

Returns a given collection of Label under a given channel

Name	Requirement	Type	Description
id		int	id of a Label to return

/v1/files/{id}

GET /v1/files/{id}

Returns a given File meta data

Rel name	description
self	file metadata
http://cloudapi.soaringspot.com/rel/upload	file upload
http://cloudapi.soaringspot.com/rel/download	file download

Name	Requirement	Type	Description
id		int	id of a File to return

PUT /v1/files/{id}

Update an existing File meta data

Documentation

Documentation

Update an existing File meta data

Requirements

Name	Requirement	Type	Description
id		int	id of a File to update

Parameters

Parameter	Type	Required?	Format	Description
naviter_asset_file_details	object (FileDetailsFormType)	true
naviter_asset_file_details[uri]	string	true		relative path to a file inside an asset.
naviter_asset_file_details[time]	datetime	true	yyyy-MM-dd'THH:mm:ss	date and time of when the file was last modified.

DELETE /v1/files/{id}

Delete a given File meta data

Name	Requirement	Type	Description
id		int	id of a File to delete

/v1/files/{id}/data

GET /v1/files/{id}/data

Returns a given File stream

Name	Requirement	Type	Description
id		int	id of a File to get the data for

/v1/files/{id}/upload

PUT /v1/files/{id}/upload

Update or Create a given File stream

Documentation

Documentation

Update or Create a given File stream

WATCH OUT!! File uploading is different from other api calls.

the files are uploaded using the same way as if it were done on a website. This means, that the multipart/form-data format is used and not json+hal as elsewhere.
the form is submitted with the POST method and then an X-HTTP-Method-Override header MUST be added with it's value set to PUT e.g. X-HTTP-Method-Override: PUT
you get back the link to the queue where you can check the status of your upload, the links are valid for a couple of days
correct Content-Type header MUST be set for upload to be successful, the list is available in a separate document
file extension does matter and it must match the Content-Type header

Requirements

Name	Requirement	Type	Description
id		int	id of a File to update or create data for

Parameters

Parameter	Type	Required?	Format	Description
naviter_asset_file_upload	object (FileUploadFormType)	true
naviter_asset_file_upload[file]	file	true		file you are uploading

/v1/labels/{id}

GET /v1/labels/{id}

Returns a given Label

Rel name	description
self	label
http://cloudapi.soaringspot.com/rel/labels	GET returns a collection of labels, present only when label is returned as a part of channels collection

Name	Requirement	Type	Description
id		int	id of a Label to return

PUT /v1/labels/{id}

Update an existing Label

Documentation

Documentation

Update an existing Label

Requirements

Name	Requirement	Type	Description
id		int	id of a Label to update

Parameters

Parameter	Type	Required?	Format	Description
naviter_asset_label	object (LabelFormType)	true
naviter_asset_label[label]	string	true		label name, "folders" are separated by /. Please note that parent labels are not created automatically.
naviter_asset_label[color]	integer	true		label color in ARGB fromat
naviter_asset_label[type]	choice	true	{"label":"enum.label.type.label","channel":"enum.label.type.channel","featured":"enum.label.type.featured"}	one of [label, channel, featured]. Please note that you can't have a channel inside a channel and that as 3rd party developer you, can't set the the label to a featured one.

Parameter	Type	Versions	Description
created_at	DateTime	*
updated_at	DateTime	*