SubSectionPage Class Reference

WSAPI. More...

Detailed Description

Supported system parameters

Supported System parameters:

Name	Description	Default value
$pagenum	This is a pagination paramter to fetch the required page number	1
$pagesize	This ia a pagination parameter. No. of notes returned per page	25. Maximum Page Size must not exceed 75
$attribute	This is to get additional attributes beyond those always returned.	Not Applicable

Supported 'Accept-Language' header language codes

Language Name	Language Code
English US	en-us
French	fr-fr
Spanish	es-es
Italian	it-it
German	de-de
Dutch	nl-nl
Portugese (Brazil)	pt-br
Portugese	pt-pt
Danish(Denmark)	da-dk
Russian	ru-ru
French(Canadian)	fr-ca
Chinese	zh-cn
Japanese	ja-jp
Korean	ko-kr
Swedish	sv-se

Supported values of '$lang'

Language Name	Language Code	Language ID
English (US)	en-us	1
English (UK)	en-gb	4
French	fr-fr	2
Spanish	es-es	8
Italian	it-it	16
German	de-de	8192
Dutch	nl-nl	32
Portugese (Brazil)	pt-br	16384
Portugese	pt-pt	256
Danish	da-dk	64
Russian	ru-ru	262144
Chinese	zh-cn	32768
Swedish	sv-se	128
Finnish	fi-fi	512
Norwegian Bokmal (Norway)	nb-no	1024
Norwegian nynorsk (Norway)	nn-no	2048
Chinese (Taiwan)	zh-tw	65536
Turkish	tr-tr	1048576
Polish	pl-pl	2097152
Czech	cs-cz	4194304
Hungarian	hu-hu	16777216
Arabic	ar-sa	67108864
Romanian	ro-ro	268435456
Japanese	ja-jp	4096
Korean	ko-kr	131072
Greek	el-gr	524288

Supported System parameters

System parameters that are supported with the request are :

Name	Description	Default value
$lang	This to specify the attachment language.	Default user language
$pagenum	This is the page number requested	1
$pagesize	No. of attachments returned per page	25
$attribute	This is to get additional attributes of attachments beyond those always returned.	Not Applicable

Minimal Attributes In Response Body

Supported System parameters:

Name	Description	Type
id	id of the attachment	long
link (self)	URL (location) of the attachment. For 'Article Suggestions', 'Article Suggestion Awaiting Feedback' and 'Personal Articles', the self-link contains 'article' and '$lang' query parameters (same as the request). For 'Articles' and 'Approved Article Suggestions', the self-link contains 'article' and 'version' query parameters.	Link

Default Attributes

Default Attributes that will always be returned on each get request :

Name	Description	Type
id	Attachment ID of the requested attachment	long
link (self)	URL (location) of the attachment. For 'Article Suggestions', 'Article Suggestion Awaiting Feedback' and 'Personal Articles', the self-link contains 'article' and '$lang' query parameters (same as the request). For 'Articles' and 'Approved Article Suggestions', the self-link contains 'article' and 'version' query parameters.	Link
name	Name of the attachment	String
type	Type of the attachment : external or internal	String
created	Creation details of attachment.	Created
filepath	Path of file of attachment. (Note: Its returned only for external attachments.)	String
contentFetchOption	content fetching option which could be one of the following : always_latest_version : The system gets the latest file from the external location every time the article is used. latest_if_available : The system will try to get the latest version of the file. If it is unable to do so, it will use the local copy of the file. A local copy is made when the a file to an article first time. local_copy : The local copy, which is created when you first attach a file to an article, is always used. The changes made in the original file, after the attachment was created, are not reflected in the attachment. (Note: Its returned only for external attachments.)	String

All Attributes

Name	Description	Type
id	Attachment ID of the requested attachment	long
link (self)	URL (location) of the attachment. For 'Article Suggestions', 'Article Suggestion Awaiting Feedback' and 'Personal Articles', the self-link contains 'article' and '$lang' query parameters (same as the request). For 'Articles' and 'Approved Article Suggestions', the self-link contains 'article' and 'version' query parameters.	Link
name	Name of the attachment	String
type	Type of the attachment : external or internal	String
created	Creation details of attachment.	Created
filepath	Path of file of attachment. (Note: Its returned only for external attachments.)	String
contentFetchOption	content fetching option which could be one of the following : always_latest_version : The system gets the latest file from the external location every time the article is used. latest_if_available : The system will try to get the latest version of the file. If it is unable to do so, it will use the local copy of the file. A local copy is made when the a file to an article first time. local_copy : The local copy, which is created when you first attach a file to an article, is always used. The changes made in the original file, after the attachment was created, are not reflected in the attachment. (Note: Its returned only for external attachments.)	String
contentUrl	A link to web server location where the attachment content can be retrieved from.	String

List of values of $attribute supported for attachment

Name	Description	Type
id	Attachment ID of the requested attachment	long
name	Name of the attachment	String
type	Type of the attachment : external or internal	String
created	Creation details of attachment.	Created
filepath	Path of file of attachment. (Note : Its returned only for external attachments. If present in request URL for internal attachments, its ignored.	String
contentFetchOption	content fetching option which could be one of the following : always_latest_version : The system gets the latest file from the external location every time the article is used. latest_if_available : The system will try to get the latest version of the file. If it is unable to do so, it will use the local copy of the file. A local copy is made when the a file to an article first time. local_copy : The local copy, which is created when you first attach a file to an article, is always used. The changes made in the original file, after the attachment was created, are not reflected in the attachment. (Note: Its returned only for external attachments. If present in request URL for internal attachments, its ignored.)	String
contentUrl	A link to web server location where the attachment content can be retrieved from.	String

Supported system parameters

Supported System parameters:

Name	Description	Default value
$pagenum	This is a pagination paramter to fetch the required page number	1
$pagesize	This ia a pagination parameter. No. of notes returned per page	25. Maximum Page Size must not exceed 75
$attribute	This is to get additional attributes beyond those always returned.	Not Applicable