Common Behaviors - Revision history

WikiSysop: Reverted edits by Zhyaoxiaiw (Talk) to last revision by WikiSysop

2012-03-01T14:20:36Z

Reverted edits by Zhyaoxiaiw (Talk) to last revision by WikiSysop

Show changes

AngelSlayerL0AZ at 02:24, 22 February 2012

2012-02-22T02:24:06Z

Show changes

WikiSysop: /* Access Permissions */

2010-09-10T15:09:11Z

Access Permissions

← Older revision		Revision as of 15:09, 10 September 2010
Line 1:		Line 1:
	== Access Permissions ==		== Access Permissions ==
-	Accessing the API requires a username and password, provided by Rezora. To obtain a username and password, contact your Rezora Account Manager.	+	Accessing the API requires a username and password, provided by Rezora. Note that this is not the same as your username and password to the Rezora system itself. To obtain a username and password, contact your Rezora Account Manager.

	There are two distinct levels of access to the API, which correspond to user types on the Rezora system in general:		There are two distinct levels of access to the API, which correspond to user types on the Rezora system in general:

WikiSysop: /* Status */

2010-07-23T15:02:37Z

Status

← Older revision		Revision as of 15:02, 23 July 2010
Line 100:		Line 100:

	A list of status codes used by the API and their meanings is provided below.		A list of status codes used by the API and their meanings is provided below.
-	~~<blockquote>~~	+
	==== Status Codes ====		==== Status Codes ====
-	* '''200:~~'''~~ The request was successfully processed.	+	;200
-	* '''204:~~'''~~ The request was formatted correctly, but no data was found for the specified resource.	+	: The request was successfully processed.
-	* '''400:~~'''~~ Your data has failed a validation test.	+	;204
-	* '''401:~~'''~~ Either your username or password are incorrect, or you are attempting to access a resource that is not available for your user type.	+	: The request was formatted correctly, but no data was found for the specified resource.
-	* '''404:~~'''~~ The resource you have requested does not exist.	+	;400
-	* '''405:~~'''~~ The method you are attempting to use (GET, POST, PUT, or DELETE) is not allowed for the resource you have requested.	+	: Your data has failed a validation test.
-	* '''500:~~'''~~ The API experienced an internal error while attempting to process your request.	+	;401
-	* '''501:~~'''~~ The method you are attempting to use (GET, POST, PUT, or DELETE) has not yet been implemented, but may be in a future release.	+	: Either your username or password are incorrect, or you are attempting to access a resource that is not available for your user type.
-	~~</blockquote>~~	+	;404
		+	: The resource you have requested does not exist.
		+	;405
		+	: The method you are attempting to use (GET, POST, PUT, or DELETE) is not allowed for the resource you have requested.
		+	;500
		+	: The API experienced an internal error while attempting to process your request.
		+	;501
		+	: The method you are attempting to use (GET, POST, PUT, or DELETE) has not yet been implemented, but may be in a future release.

	=== Content-type ===		=== Content-type ===

WikiSysop: /* Method (required) */

2010-07-23T15:00:51Z

Method (required)

← Older revision		Revision as of 15:00, 23 July 2010
Line 60:		Line 60:
	=== Method (required) ===		=== Method (required) ===
	The Rezora REST API makes use of the standard HTTP methods (GET, POST, PUT, and DELETE) to determine the action you wish to perform with the resource you have specified in the URI. Note that not all resources will support all four methods. The actions associated with each method are as follows:		The Rezora REST API makes use of the standard HTTP methods (GET, POST, PUT, and DELETE) to determine the action you wish to perform with the resource you have specified in the URI. Note that not all resources will support all four methods. The actions associated with each method are as follows:
-	;~~====~~ GET ~~====~~	+	;GET
	: A request sent using the HTTP GET method is used to retrieve or read the data for the specified resource.		: A request sent using the HTTP GET method is used to retrieve or read the data for the specified resource.
-	;~~====~~ POST ~~====~~	+	;POST
	: A request sent using the HTTP POST method is used to create a new resource of the type specified in the URI.		: A request sent using the HTTP POST method is used to create a new resource of the type specified in the URI.
-	;~~====~~ PUT ~~====~~	+	;PUT
	: A request sent using the HTTP PUT method is used to update an existing resource, as specified in the URI.		: A request sent using the HTTP PUT method is used to update an existing resource, as specified in the URI.
-	;~~====~~ DELETE ~~====~~	+	;DELETE
	: A request sent using the HTTP DELETE method is used to delete the resource indicated in the URI.		: A request sent using the HTTP DELETE method is used to delete the resource indicated in the URI.

WikiSysop: /* Method (required) */

2010-07-23T15:00:21Z

Method (required)

← Older revision		Revision as of 15:00, 23 July 2010
Line 60:		Line 60:
	=== Method (required) ===		=== Method (required) ===
	The Rezora REST API makes use of the standard HTTP methods (GET, POST, PUT, and DELETE) to determine the action you wish to perform with the resource you have specified in the URI. Note that not all resources will support all four methods. The actions associated with each method are as follows:		The Rezora REST API makes use of the standard HTTP methods (GET, POST, PUT, and DELETE) to determine the action you wish to perform with the resource you have specified in the URI. Note that not all resources will support all four methods. The actions associated with each method are as follows:
-	~~<blockquote>~~	+	;==== GET ====
-	==== GET ====	+	: A request sent using the HTTP GET method is used to retrieve or read the data for the specified resource.
-	A request sent using the HTTP GET method is used to retrieve or read the data for the specified resource.	+	;==== POST ====
-		+	: A request sent using the HTTP POST method is used to create a new resource of the type specified in the URI.
-	==== POST ====	+	;==== PUT ====
-	A request sent using the HTTP POST method is used to create a new resource of the type specified in the URI.	+	: A request sent using the HTTP PUT method is used to update an existing resource, as specified in the URI.
-		+	;==== DELETE ====
-	==== PUT ====	+	: A request sent using the HTTP DELETE method is used to delete the resource indicated in the URI.
-	A request sent using the HTTP PUT method is used to update an existing resource, as specified in the URI.	+
-		+
-	==== DELETE ====	+
-	A request sent using the HTTP DELETE method is used to delete the resource indicated in the URI.	+
-	~~</blockquote>~~	+

	=== Authorization (required) ===		=== Authorization (required) ===

WikiSysop: /* Content-type */

2010-07-22T17:52:09Z

Content-type

← Older revision		Revision as of 17:52, 22 July 2010
Line 118:		Line 118:

	=== Content-type ===		=== Content-type ===
-	The HTTP CONTENT-TYPE header is used to indicate the format of data being sent as part of the response. The format is determined by either the [[Common_Behaviors#Accept_.28required.29\|ACCEPT HTTP request header]] or the [[Common_Behaviors#Response_Format_.28optional.29\|response format indicator (file extension)]] in the request URI. If no ~~HTTP~~ ACCEPT header or ~~URI~~ format indicator are present in the request, the default response format is text/~~plain~~.	+	The HTTP CONTENT-TYPE header is used to indicate the format of data being sent as part of the response. The format is determined by either the [[Common_Behaviors#Accept_.28required.29\|ACCEPT HTTP request header]] or the [[Common_Behaviors#Response_Format_.28optional.29\|response format indicator (file extension)]] in the request URI. If no ACCEPT header or response format indicator are present in the request, the default response format is text/csv.

	'''''Example Header:'''''		'''''Example Header:'''''

WikiSysop: /* Content-type */

2010-07-22T17:50:53Z

Content-type

← Older revision		Revision as of 17:50, 22 July 2010
Line 118:		Line 118:

	=== Content-type ===		=== Content-type ===
-	The HTTP CONTENT-TYPE header is used to indicate the format of data being sent as part of the response. The format is determined by either the ACCEPT HTTP request header or the [[Common_Behaviors#Response_Format_.28optional.29\|response format indicator (file extension)]] in the request URI. If no HTTP ACCEPT header or URI format indicator are present in the request, the default response format is text/plain.	+	The HTTP CONTENT-TYPE header is used to indicate the format of data being sent as part of the response. The format is determined by either the [[Common_Behaviors#Accept_.28required.29\|ACCEPT HTTP request header]] or the [[Common_Behaviors#Response_Format_.28optional.29\|response format indicator (file extension)]] in the request URI. If no HTTP ACCEPT header or URI format indicator are present in the request, the default response format is text/plain.

	'''''Example Header:'''''		'''''Example Header:'''''

WikiSysop: /* Content-type */

2010-07-22T17:49:25Z

Content-type

← Older revision		Revision as of 17:49, 22 July 2010
Line 118:		Line 118:

	=== Content-type ===		=== Content-type ===
-	The HTTP CONTENT-TYPE header is used to indicate the format of data being sent as part of the response. The format is determined by either the ACCEPT HTTP request header or the response format indicator in the request URI. If no HTTP ACCEPT header or URI format indicator are present in the request, the default response format is text/plain.	+	The HTTP CONTENT-TYPE header is used to indicate the format of data being sent as part of the response. The format is determined by either the ACCEPT HTTP request header or the [[Common_Behaviors#Response_Format_.28optional.29\|response format indicator (file extension)]] in the request URI. If no HTTP ACCEPT header or URI format indicator are present in the request, the default response format is text/plain.

	'''''Example Header:'''''		'''''Example Header:'''''

WikiSysop: /* Content-type */

2010-07-22T17:45:09Z

Content-type

← Older revision		Revision as of 17:45, 22 July 2010
Line 119:		Line 119:
	=== Content-type ===		=== Content-type ===
	The HTTP CONTENT-TYPE header is used to indicate the format of data being sent as part of the response. The format is determined by either the ACCEPT HTTP request header or the response format indicator in the request URI. If no HTTP ACCEPT header or URI format indicator are present in the request, the default response format is text/plain.		The HTTP CONTENT-TYPE header is used to indicate the format of data being sent as part of the response. The format is determined by either the ACCEPT HTTP request header or the response format indicator in the request URI. If no HTTP ACCEPT header or URI format indicator are present in the request, the default response format is text/plain.
		+
		+	'''''Example Header:'''''
		+	Content-Type: text/csv; charset=UTF-8

	== About Output Data ==		== About Output Data ==