Page tree
Skip to end of metadata
Go to start of metadata

 

POST /content_folders

Creates a new content_folder 

Creates a new content_folder and Returns the resulting element 

Request URL

https://{client_id}.salesseek.net/api/content_folders

Request Body
{
	description: "Includes all newsletters",
	name: "Newsletters",
	parent_id: "bda93bb7-da2e-4216-8c2e-3632e0b70c8b",
	type: "folder"
}

 

Response Type

Response content type: JSON content_folder

ModelExample of Response

Folder(JSON): {

description(string): Description of the current directory,

id(sting): unique id of this directory,

last_modified_by_name(string): Name of the SalesSeek user who latest modified the directory,

modified(timestamp): latest modified date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

name(string): Directory name which may be used as an alias,

owner(User): Reference to the user who owns this directory,

short_id(string): short identifier which can be alternatively use as an id for this directory

}

{
	description: "Includes all newsletters"
	id: "bda970c8b"
	last_modified_by_name: null
	modified: "2014-01-15T22:28:14.097105"
	name: "Newsletters"
	owner: {
		id: "87378489"
		name: "Jessica Clayton"
	}
	short_id: "5465"
}

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
responseOut-The content_folder created after the successful requestJSON

 


 

 

Get /content_folders/{content_folder_id} 

Provides the content_folder matching content_folder_id

Returns the unique content_folder matching the content_folder_Id

Request URL

https://{client_id}.salesseek.net/api/content_folders/69d1fbe62

Response Type

Response content type: JSON content_folder

ModelExample of Response

Content_folder (JSON)

{

child_files (Array[Content_file]): List of files (not folders) within this folder,

chilf_folders (Arrray[Folder]): List of directories (not files) within this folder,

description(string): Description of the current directory,

id(sting): unique id of this directory,

last_modified_by_name(string): Name of the SalesSeek user who latest modified the directory,

modified(timestamp): latest modified date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

name(string): Directory name which may be used as an alias,

owner(User): Reference to the user who owns this directory,

short_id(string): short identifier which can be alternatively use as an id for this directory

}

Content_file(JSON): {

content(string): Entire file content, should be an HTML but may be plain text or any other file available from the Content > Library,

description(string): From the Content > Library, a brief description of this file,

ext(string): file extension (eg: .html),

has_thumb(string): complete URL path to the thumbnail file,

id (string): unique identifier for this file,

last_modified_by_name(string): name of the last SalesSeek User who modified it,

modified(timestamp): latest modified date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

name(string): Alias which can be used as a unique identifier for the file,

owner(User): Reference to the user who owns this directory,

parent(Directory): Directory holding the current file,

parent_id(string): id of the parent directory for this file,

short_id(string): short identifier which can be alternatively use as an id for this file

}

Folder(JSON): {

description(string): Description of the current directory,

id(sting): unique id of this directory,

last_modified_by_name(string): Name of the SalesSeek user who latest modified the directory,

modified(timestamp): latest modified date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

name(string): Directory name which may be used as an alias,

owner(User): Reference to the user who owns this directory,

short_id(string): short identifier which can be alternatively use as an id for this directory

}

User {

id (string): unique identifier for the User,

name (string): name to be shown,

type (string): "user"

email_address (string): unique email address identifying this user,

}

{
	child_files: [
		0: {…},
		1: {
			content: "<!DOCTYPE html><body...</html>",
			description: "First Newsletter",
			ext: ".html",
			has_thumb: null,
			id: "537557f",
			last_modified_by_name: "Marina Johnson",
			modified: "2014-01-20T20:50:51.900042",
			name: "newsletter_1.html",
			owner: {
				id: "2cbcf25",
				name: "Marina Johnson"
			}
			parent_id: "b70c8b",
			permissions: [
				0: "salesseek.core.edit",
				1: "salesseek.core.all_permissions",
				2: "salesseek.core.view"
			]
			short_id: "fe57f"
		}
	]
	child_folders: [
		0: {
			description: "This folder includes all email templates"
			id: "5c3c0101e2"
			last_modified_by_name: "Charles Davis"
			modified: "2014-01-25T20:41:12.605085"
			name: "Mail_Templates"
			owner: {
				id: "2901cf25"
				name: "Charles Davis"
			}
			short_id: "5c3432"
		},
		1: {...}
	]
	description: "Root folder"
	id: "bda93bb998b"
	last_modified_by_name: null
	modified: "2014-01-15T22:28:14.097105"
	name: "Library"
	owner: {id:null, name:null}
		id: null
		name: null
	}
	parent_folders: []
	short_id: "root"
}

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 content_folder_idInYThe id of content_folder to be requestedstring
responseOut-The content_folder requestedJSON

 


 

 

PATCH /content_folders/{content_folder_id}

Update a specific content_folder by its ID

Updates a content_folder by its {content_folder_id}, does not return the changed element

 

Request URL

https://{client_id}.salesseek.net/api/content_folders/69d1fbe62  

 

Request Body
{
  name: "New Name for this Folder",
  description: "New Description for this folder"
}

 

Response Type

Response content type: null

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
content_folder_idInYThe id of the content_folder to be updatedstring
 content_folder InYThe subset of the content_folder fields to be updatedJSON

 

 

 


 

DELETE /content_folders/{content_folder_id}

Deletes a specific content_folder by its ID

Deletes a content_folder by it {content_folder_id}.

 

only allowed if the folder is empty

 


Request URL

https://{client_id}.salesseek.net/api/content_folders/a3451f5  

Response Type

Response content type: null

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 content_folder_idInYThe id of content_folder to be deletedstring

 


 

POST /content_files/{file_id}?download

Downloads the content_file matching the {file_id}

Creates a new content_file and Returns the resulting element 

Request URL

https://{client_id}.salesseek.net/api/content_files/45422?download

Request Body
{
	id:"45422"
}

 

Response Type

Response content type: Downloaded File


Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
content_file_idInYThe id of content_file to be downloadedstring
downloadInYthe download optionstring

 


 

Get /content_files?search={search_name}

Provides the list of content_files matching {search_name}

Returns the list of files matching the name on the search parameter

Request URL

https://{client_id}.salesseek.net/api/content_files?search=name&ext=.html

Response Type

Response content type: JSON content_file

ModelExample of Response

 Array[Content_file]

 

Content_file(JSON): {

content(string): Entire file content, should be an HTML but may be plain text or any other file available from the Content > Library,

description(string): From the Content > Library, a brief description of this file,

ext(string): file extension (eg: .html),

has_thumb(string): complete URL path to the thumbnail file,

id (string): unique identifier for this file,

last_modified_by_name(string): name of the last SalesSeek User who modified it,

modified(timestamp): latest modified date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

name(string): Alias which can be used as a unique identifier for the file,

owner(User): Reference to the user who owns this directory,

parent(Directory): Directory holding the current file,

parent_id(string): id of the parent directory for this file,

short_id(string): short identifier which can be alternatively use as an id for this file

}

Folder(JSON): {

description(string): Description of the current directory,

id(sting): unique id of this directory,

last_modified_by_name(string): Name of the SalesSeek user who latest modified the directory,

modified(timestamp): latest modified date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

name(string): Directory name which may be used as an alias,

owner(User): Reference to the user who owns this directory,

short_id(string): short identifier which can be alternatively use as an id for this directory

}

User {

id (string): unique identifier for the User,

name (string): name to be shown,

type (string): "user"

email_address (string): unique email address identifying this user,

}

[
	0:{
		content: "<!DOCTYPE html><body...</html>",
		description: "First Newsletter",
		ext: ".html",
		has_thumb: null,
		id: "537557f",
		last_modified_by_name: "Marina Johnson",
		modified: "2014-01-20T20:50:51.900042",
		name: "newsletter_1.html",
		owner: {
			id: "2cbcf25",
			name: "Marina Johnson"
		}
		parent_id: "b70c8b",
		path:[
			0: "Library"
			1: "Email Templates"
		]
		permissions: [
			0: "salesseek.core.edit",
			1: "salesseek.core.all_permissions",
			2: "salesseek.core.view"
		]
		short_id: "fe57f"
	},

	1:{...}
]

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
searchInYThe string to be used as the search criteria for file namesstring
extInNThe file extension to refine the searchstring
responseOut-The content_file requestedArray[Content_file]

 


 

 

Get /content_files/{content_file_id} 

Provides the content_file matching content_file_id

Returns the unique content_file matching the content_file_Id

Request URL

https://{client_id}.salesseek.net/api/content_files/69d1fbe62

Response Type

Response content type: JSON content_file

ModelExample of Response

 

Content_file(JSON): {

content(string): Entire file content, should be an HTML but may be plain text or any other file available from the Content > Library,

description(string): From the Content > Library, a brief description of this file,

ext(string): file extension (eg: .html),

has_thumb(string): complete URL path to the thumbnail file,

id (string): unique identifier for this file,

last_modified_by_name(string): name of the last SalesSeek User who modified it,

modified(timestamp): latest modified date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

name(string): Alias which can be used as a unique identifier for the file,

owner(User): Reference to the user who owns this directory,

parent(Directory): Directory holding the current file,

parent_id(string): id of the parent directory for this file,

short_id(string): short identifier which can be alternatively use as an id for this file

}

Folder(JSON): {

description(string): Description of the current directory,

id(sting): unique id of this directory,

last_modified_by_name(string): Name of the SalesSeek user who latest modified the directory,

modified(timestamp): latest modified date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

name(string): Directory name which may be used as an alias,

owner(User): Reference to the user who owns this directory,

short_id(string): short identifier which can be alternatively use as an id for this directory

}

User {

id (string): unique identifier for the User,

name (string): name to be shown,

type (string): "user"

email_address (string): unique email address identifying this user,

}

{
	content: "<!DOCTYPE html><body...</html>",
	description: "First Newsletter",
	ext: ".html",
	has_thumb: null,
	id: "537557f",
	last_modified_by_name: "Marina Johnson",
	modified: "2014-01-20T20:50:51.900042",
	name: "newsletter_1.html",
	owner: {
		id: "2cbcf25",
		name: "Marina Johnson"
	}
	parent_id: "b70c8b",
	permissions: [
		0: "salesseek.core.edit",
		1: "salesseek.core.all_permissions",
		2: "salesseek.core.view"
	]
	short_id: "fe57f"
}

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
content_file_idInYThe id of content_file to be requestedstring
responseOut-The content_file requestedJSON

 


 

 

PATCH /content_files/{content_file_id}

Update a specific content_file by its ID

Updates a content_file by its {content_file_id}, does not return the changed element

 

Request URL

https://{client_id}.salesseek.net/api/content_files/69d1fbe62  

 

Request Body
{
  name: "New File Name",
  description: "New Description for this file"
}

 

Response Type

Response content type: null

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
content_file_idInYThe id of the content_file to be updatedstring
 content_file InYThe subset of the content_file fields to be updatedJSON

 

 

 


 

DELETE /content_files/{content_file_id}

Deletes a specific content_file by its ID

Deletes a content_file by it {content_file_id}.

 

only allowed if the folder is empty

 


Request URL

https://{client_id}.salesseek.net/api/content_files/a3451f5  

Response Type

Response content type: null

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 content_file_idInYThe id of content_file to be deletedstring

 


 

 

Get /content_files/{file_id}/acl

Gets the File permissions list

Returns the allowed permisions for the current user over this file

 

Request URL

https://{client_id}.salesseek.net/api/content_files/69d1fbe62/acl

Response Type

Response content type: Array[Permissions]

 

ModelExample of Response

Array[PermissionRules]

 

PermissionRule (Array[user,permission]) {

0: user(string): string indicating the type and ID of the user to apply the permission rule to. A user can be one of the followings :

- salesseek.core.team

- salesseek.core.owner

- user_id

1: permission_type(Enum): the type of permission assigned to the associated user. A type can be one of the followings :

- salesseek.core.view

- salesseek.core.edit

- salesseek.core.all_permissions

}

[
    0: [
        0: {"salesseek.core.team#0f27c4},
        1: {"salesseek.core.edit"}
	],
    1: [
        0: {"salesseek.core.owner#2901f25"},
        1: {"salesseek.core.all_permissions"}
	],
    2: [
        0: {"46452885245"},
        1: {"salesseek.core.view"}
	]
]

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
File_idInYThe id of the file to get the permission rulesstring
responseOut-The list of permissions configured for this fileArray(PermissionRules)

 


 

POST /content_files/{file_id}/acl

Change permissions to the selected file

Entirely updates the permission rules assigned to this file

Request URL

https://{client_id}.salesseek.net/api/content_files/88773300/acl

Request Body
[
    0: [
        0: {"salesseek.core.team#0f27c4},
        1: {"salesseek.core.edit"}
	],
    1: [
        0: {"salesseek.core.owner#2901f25"},
        1: {"salesseek.core.all_permissions"}
	],
    2: [
        0: {"46452885245"},
        1: {"salesseek.core.view"}
	]
]

Response Type

Response content type: Array[Permissions]

 

ModelExample of Response

 

Array[PermissionRules]

 

PermissionRule (Array[user,permission]) {

0: user(string): string indicating the type and ID of the user to apply the permission rule to. A user can be one of the followings :

- salesseek.core.team

- salesseek.core.owner

- user_id

1: permission_type(Enum): the type of permission assigned to the associated user. A type can be one of the followings :

- salesseek.core.view

- salesseek.core.edit

- salesseek.core.all_permissions

}

[
    0: [
        0: {"salesseek.core.team#0f27c4},
        1: {"salesseek.core.edit"}
	],
    1: [
        0: {"salesseek.core.owner#2901f25"},
        1: {"salesseek.core.all_permissions"}
	],
    2: [
        0: {"46452885245"},
        1: {"salesseek.core.view"}
	]
]

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
File_idInYThe id of the file to get the permission rulesstring
PermissionsInYThe entire list of permission rules to assign to this fileJSON
responseOut-The resulting list of permission rules assigned to this fileJSON
  • No labels