ACE Ims Webservice - Revision history

Toaster at 20:09, 9 September 2008

2008-09-09T20:09:58Z

← Older revision		Revision as of 20:09, 9 September 2008
Line 93:		Line 93:
	\|serverFault\|\|boolean		\|serverFault\|\|boolean
	\|-		\|-
	\|statusCode\|\|int\|\|Status code indicating type of failure - See [[Ace IMS Status Codes][Status Code Documentation]] for details		\|statusCode\|\|int\|\|Status code indicating type of failure - See [[Ace IMS Status Codes\|Status Code Documentation]] for details
	\|}		\|}

Line 144:		Line 144:
	\|name\|\|String\|\|Name supplied by client for this token		\|name\|\|String\|\|Name supplied by client for this token
	\|-		\|-
	\|proofElements\|\|List of [[#ProofElement][ProofElements]]		\|proofElements\|\|List of [[#ProofElement\|ProofElements]]
	\|-		\|-
	\|roundId\|\|long\|\|current round id this token was processed in		\|roundId\|\|long\|\|current round id this token was processed in

Toaster at 20:09, 9 September 2008

2008-09-09T20:09:19Z

← Older revision		Revision as of 20:09, 9 September 2008
Line 83:		Line 83:
	==Data Types==		==Data Types==

	~~#ImsFault~~
	===IMSFault===		===IMSFault===

Line 96:		Line 96:
	\|}		\|}

	~~#LinkResponse~~
	===LinkResponse===		===LinkResponse===

Line 114:		Line 114:


	~~#TokenReceipt~~
	===TokenReceipt===		===TokenReceipt===

Line 121:		Line 121:
	\|}		\|}

	~~#TokenRequest~~
	===TokenRequest===		===TokenRequest===

Line 132:		Line 132:
	\|}		\|}

	~~#TokenResponse~~
	===TokenResponse===		===TokenResponse===

Line 150:		Line 150:
	\|statusCode\|\|int\|\|status code indicating type of response - See [[Ace IMS Status Codes\|Status Code Documentation]] for details		\|statusCode\|\|int\|\|status code indicating type of response - See [[Ace IMS Status Codes\|Status Code Documentation]] for details
	\|-		\|-
	\|timeStamp\|dateTime\|Time the round was processed\|		\|timeStamp\|\|dateTime\|\|Time the round was processed
			\|-
			\|tokenClassName\|\|String\|\|Name of token class on IMS that was used
			\|}

	~~\|tokenClassName\|String\|Name of token class on IMS that was used~~
	\|}


	~~#ProofElement~~
	===TokenResponse===		===TokenResponse===
	{\|		{\|

Toaster at 20:08, 9 September 2008

2008-09-09T20:08:09Z

← Older revision		Revision as of 20:08, 9 September 2008
Line 89:		Line 89:
	\|'''Name'''\|\|'''Type'''\|\|'''Description'''		\|'''Name'''\|\|'''Type'''\|\|'''Description'''
	\|-		\|-
	\|message\|String		\|message\|\|String
	\|serverFault\|boolean\|		\|-
	\|statusCode\|int\|Status code indicating type of failure - See [[~~AceV3StatusCodes~~][Status Code Documentation]] for details \|		\|serverFault\|\|boolean
			\|-
			\|statusCode\|\|int\|\|Status code indicating type of failure - See [[Ace IMS Status Codes][Status Code Documentation]] for details
	\|}		\|}

Line 100:		Line 102:
	\|'''Name'''\|\|'''Type'''\|\|'''Description'''		\|'''Name'''\|\|'''Type'''\|\|'''Description'''
	\|-		\|-
	\|previousHash\|String\|		\|previousHash\|\|String
	\|rootHash\|String\|		\|-
	\|roundId\|long\|		\|rootHash\|\|String
	\|timestamp\|dateTime\|		\|-
	\|tokenClassName\|String\|		\|roundId\|\|long
			\|-
			\|timestamp\|\|dateTime
			\|-
			\|tokenClassName\|\|String
	\|}		\|}

Line 121:		Line 127:
	\|'''Name'''\|\|'''Type'''\|\|'''Description'''		\|'''Name'''\|\|'''Type'''\|\|'''Description'''
	\|-		\|-
	\|hashValue\|String\|		\|hashValue\|\|String
	\|name\|String\|		\|-
			\|name\|\|String
	\|}		\|}

Line 128:		Line 135:
	===TokenResponse===		===TokenResponse===

			{\|
	\|'''Name'''\|\|'''Type'''\|\|'''Description'''		\|'''Name'''\|\|'''Type'''\|\|'''Description'''
	\|digestProvider\|String\|Name of the java provider for the digest service\|		\|-
	\|digestService\|String\|Java name for the type of digest (ie, SHA-256)\|		\|digestProvider\|\|String\|Name of the java provider for the digest service
	\|name\|String\|Name supplied by client for this token\|		\|-
	\|proofElements\|List of [[#ProofElement][ProofElements]]\|		\|digestService\|\|String\|\|Java name for the type of digest (ie, SHA-256)
	\|roundId\|long\|current round id this token was processed in\|		\|-
	\|statusCode\|int\|status code indicating type of response - See [[~~AceV3StatusCodes][~~Status Code Documentation]] for details\|		\|name\|\|String\|\|Name supplied by client for this token
			\|-
			\|proofElements\|\|List of [[#ProofElement][ProofElements]]
			\|-
			\|roundId\|\|long\|\|current round id this token was processed in
			\|-
			\|statusCode\|\|int\|\|status code indicating type of response - See [[Ace IMS Status Codes\|Status Code Documentation]] for details
			\|-
	\|timeStamp\|dateTime\|Time the round was processed\|		\|timeStamp\|dateTime\|Time the round was processed\|
	\|tokenClassName\|String\|Name of token class on IMS that was used\|
			\|tokenClassName\|String\|Name of token class on IMS that was used
			\|}


	#ProofElement		#ProofElement
	===TokenResponse===		===TokenResponse===
			{\|
	\|'''Name'''\|\|'''Type'''\|\|'''Description'''		\|'''Name'''\|\|'''Type'''\|\|'''Description'''
	\|hashes\|List of String\|		\|-
	\|index\|int\|		\|hashes\|\|List of String
			\|-
			\|index\|\|int
			\|}

Toaster at 20:00, 9 September 2008

2008-09-09T20:00:38Z

← Older revision		Revision as of 20:00, 9 September 2008
Line 19:		Line 19:
	'''Return Type'''		'''Return Type'''

	[[#LinkResponse][LinkResponse]]		[[#LinkResponse\|LinkResponse]]

	===requestTokensAsync===		===requestTokensAsync===

Toaster at 20:00, 9 September 2008

2008-09-09T20:00:02Z

← Older revision		Revision as of 20:00, 9 September 2008
Line 46:		Line 46:

	{\| width="75%"		{\| width="75%"
	\|'''Name'''\|'''Type'''\|'''Description'''		\|'''Name'''\|\|'''Type'''\|\|'''Description'''
	\|-		\|-
	\|tokenClassString\|\|String		\|tokenClassString\|\|String
Line 65:		Line 65:

	{\| width="75%"		{\| width="75%"
	\|'''Name'''\|'''Type'''\|'''Description'''		\|'''Name'''\|\|'''Type'''\|\|'''Description'''
	\|}		\|}

Line 76:		Line 76:

	{\| width="75%"		{\| width="75%"
	\|'''Name'''\|'''Type'''\|'''Description'''		\|'''Name'''\|\|'''Type'''\|\|'''Description'''
	\|}		\|}

Line 87:		Line 87:

	{\| width="75%"		{\| width="75%"
	\|'''Name'''\|'''Type'''\|'''Description'''		\|'''Name'''\|\|'''Type'''\|\|'''Description'''
	\|-		\|-
	\|message\|String		\|message\|String
Line 98:		Line 98:

	{\| width="75%"		{\| width="75%"
	\|'''Name'''\|'''Type'''\|'''Description'''		\|'''Name'''\|\|'''Type'''\|\|'''Description'''
	\|-		\|-
	\|previousHash\|String\|		\|previousHash\|String\|
Line 112:		Line 112:

	{\| width="75%"		{\| width="75%"
	\|'''Name'''\|'''Type'''\|'''Description'''		\|'''Name'''\|\|'''Type'''\|\|'''Description'''
	\|}		\|}

Line 119:		Line 119:

	{\| width="75%"		{\| width="75%"
	\|'''Name'''\|'''Type'''\|'''Description'''		\|'''Name'''\|\|'''Type'''\|\|'''Description'''
	\|-		\|-
	\|hashValue\|String\|		\|hashValue\|String\|
Line 128:		Line 128:
	===TokenResponse===		===TokenResponse===

	\|Name\|Type\|Description\|		\|'''Name'''\|\|'''Type'''\|\|'''Description'''
	\|digestProvider\|String\|Name of the java provider for the digest service\|		\|digestProvider\|String\|Name of the java provider for the digest service\|
	\|digestService\|String\|Java name for the type of digest (ie, SHA-256)\|		\|digestService\|String\|Java name for the type of digest (ie, SHA-256)\|
Line 141:		Line 141:
	#ProofElement		#ProofElement
	===TokenResponse===		===TokenResponse===
	\|Name\|Type\|Description\|		\|'''Name'''\|\|'''Type'''\|\|'''Description'''
	\|hashes\|List of String\|		\|hashes\|List of String\|
	\|index\|int\|		\|index\|int\|

Toaster at 19:59, 9 September 2008

2008-09-09T19:59:19Z

← Older revision		Revision as of 19:59, 9 September 2008
Line 51:		Line 51:
	\|-		\|-
	\|requests\|\|List of [[#TokenRequest\|TokenRequest]]\|		\|requests\|\|List of [[#TokenRequest\|TokenRequest]]\|
			\|}

	'''Return Type'''		'''Return Type'''

	List[[#TokenResponse\|TokenResponse]]		List of [[#TokenResponse\|TokenResponse]]


Line 63:		Line 64:
	'''Parameters'''		'''Parameters'''

	\|Name\|Type\|Description\|		{\| width="75%"
			\|'''Name'''\|'''Type'''\|'''Description'''
			\|}


	'''Return Type'''		'''Return Type'''
Line 71:		Line 75:
	'''Parameters'''		'''Parameters'''

	\|Name\|Type\|Description\|		{\| width="75%"
			\|'''Name'''\|'''Type'''\|'''Description'''
			\|}

	'''Return Type'''		'''Return Type'''
Line 80:		Line 86:
	===IMSFault===		===IMSFault===

	\|Name\|Type\|Description\|		{\| width="75%"
			\|'''Name'''\|'''Type'''\|'''Description'''
			\|-
	\|message\|String		\|message\|String
	\|serverFault\|boolean\|		\|serverFault\|boolean\|
	\|statusCode\|int\|Status code indicating type of failure - See [[AceV3StatusCodes][Status Code Documentation]] for details \|		\|statusCode\|int\|Status code indicating type of failure - See [[AceV3StatusCodes][Status Code Documentation]] for details \|
			\|}

	#LinkResponse		#LinkResponse
	===LinkResponse===		===LinkResponse===

	\|Name\|Type\|Description\|		{\| width="75%"
			\|'''Name'''\|'''Type'''\|'''Description'''
			\|-
	\|previousHash\|String\|		\|previousHash\|String\|
	\|rootHash\|String\|		\|rootHash\|String\|
Line 94:		Line 105:
	\|timestamp\|dateTime\|		\|timestamp\|dateTime\|
	\|tokenClassName\|String\|		\|tokenClassName\|String\|
			\|}


Line 99:		Line 111:
	===TokenReceipt===		===TokenReceipt===

	\|Name\|Type\|Description\|		{\| width="75%"
			\|'''Name'''\|'''Type'''\|'''Description'''
			\|}

	#TokenRequest		#TokenRequest
	===TokenRequest===		===TokenRequest===

	\|Name\|Type\|Description\|		{\| width="75%"
			\|'''Name'''\|'''Type'''\|'''Description'''
			\|-
	\|hashValue\|String\|		\|hashValue\|String\|
	\|name\|String\|		\|name\|String\|
			\|}

	#TokenResponse		#TokenResponse

Toaster at 19:57, 9 September 2008

2008-09-09T19:57:32Z

← Older revision		Revision as of 19:57, 9 September 2008
Line 28:		Line 28:

	{\| width="75%"		{\| width="75%"
	\|'''Name'''\|'''Type'''\|'''Description'''		\|'''Name'''\|\|'''Type'''\|\|'''Description'''
	\|-		\|-
	\|tokenClassString\|\|String		\|tokenClassString\|\|String

Toaster at 19:57, 9 September 2008

2008-09-09T19:57:12Z

← Older revision		Revision as of 19:57, 9 September 2008
Line 23:		Line 23:
	===requestTokensAsync===		===requestTokensAsync===

	Add tokens to the currently active round. Clients will need to call [[#~~RetrieveTokens][~~retrieveTokens]] to request created tokens after the round has finished. This call is to allow for non-blocking operation.		Add tokens to the currently active round. Clients will need to call [[#retrieveTokens\|retrieveTokens]] to request created tokens after the round has finished. This call is to allow for non-blocking operation.

	'''Parameters'''		'''Parameters'''
Line 32:		Line 32:
	\|tokenClassString\|\|String		\|tokenClassString\|\|String
	\|-		\|-
	\|requests\|\|List[[#TokenRequest\|TokenRequest]]		\|requests\|\|List of [[#TokenRequest\|TokenRequest]]
	\|}		\|}

	'''Return Type'''		'''Return Type'''

	[[#TokenReceipt][TokenReceipt]] receipt to be used to retrieve token responses		[[#TokenReceipt\|TokenReceipt]] receipt to be used to retrieve token responses

	===requestTokensImmediate===		===requestTokensImmediate===
Line 45:		Line 45:
	'''Parameters'''		'''Parameters'''

	\|Name\|Type\|Description\|		{\| width="75%"
	\|tokenClassString\|String\|		\|'''Name'''\|'''Type'''\|'''Description'''
	\|requests\|List[[#TokenRequest][TokenRequest]]\|		\|-
			\|tokenClassString\|\|String
			\|-
			\|requests\|\|List of [[#TokenRequest\|TokenRequest]]\|

	'''Return Type'''		'''Return Type'''

	List[[#TokenResponse][TokenResponse]]		List[[#TokenResponse\|TokenResponse]]

Toaster at 19:55, 9 September 2008

2008-09-09T19:55:34Z

← Older revision		Revision as of 19:55, 9 September 2008
Line 32:		Line 32:
	\|tokenClassString\|\|String		\|tokenClassString\|\|String
	\|-		\|-
	\|requests\|\|List[[#TokenRequest]]		\|requests\|\|List[[#TokenRequest\|TokenRequest]]
	\|}		\|}

Toaster at 19:54, 9 September 2008

2008-09-09T19:54:30Z

← Older revision		Revision as of 19:54, 9 September 2008
Line 27:		Line 27:
	'''Parameters'''		'''Parameters'''

	\|Name\|Type\|Description\|		{\| width="75%"
	\|tokenClassString\|String\|		\|'''Name'''\|'''Type'''\|'''Description'''
	\|requests\|List[[#~~TokenRequest][~~TokenRequest]]\|		\|-
			\|tokenClassString\|\|String
			\|-
			\|requests\|\|List[[#TokenRequest]]
			\|}

	'''Return Type'''		'''Return Type'''

← Older revision		Revision as of 20:08, 9 September 2008
Line 89:		Line 89:
	\|'''Name'''\|\|'''Type'''\|\|'''Description'''		\|'''Name'''\|\|'''Type'''\|\|'''Description'''
	\|-		\|-
	\|message\|String		\|message\|\|String
	\|serverFault\|boolean\|		\|-
	\|statusCode\|int\|Status code indicating type of failure - See [[~~AceV3StatusCodes~~][Status Code Documentation]] for details \|		\|serverFault\|\|boolean
			\|-
			\|statusCode\|\|int\|\|Status code indicating type of failure - See [[Ace IMS Status Codes][Status Code Documentation]] for details
	\|}		\|}

Line 100:		Line 102:
	\|'''Name'''\|\|'''Type'''\|\|'''Description'''		\|'''Name'''\|\|'''Type'''\|\|'''Description'''
	\|-		\|-
	\|previousHash\|String\|		\|previousHash\|\|String
	\|rootHash\|String\|		\|-
	\|roundId\|long\|		\|rootHash\|\|String
	\|timestamp\|dateTime\|		\|-
	\|tokenClassName\|String\|		\|roundId\|\|long
			\|-
			\|timestamp\|\|dateTime
			\|-
			\|tokenClassName\|\|String
	\|}		\|}

Line 121:		Line 127:
	\|'''Name'''\|\|'''Type'''\|\|'''Description'''		\|'''Name'''\|\|'''Type'''\|\|'''Description'''
	\|-		\|-
	\|hashValue\|String\|		\|hashValue\|\|String
	\|name\|String\|		\|-
			\|name\|\|String
	\|}		\|}

Line 128:		Line 135:
	===TokenResponse===		===TokenResponse===

			{\|
	\|'''Name'''\|\|'''Type'''\|\|'''Description'''		\|'''Name'''\|\|'''Type'''\|\|'''Description'''
	\|digestProvider\|String\|Name of the java provider for the digest service\|		\|-
	\|digestService\|String\|Java name for the type of digest (ie, SHA-256)\|		\|digestProvider\|\|String\|Name of the java provider for the digest service
	\|name\|String\|Name supplied by client for this token\|		\|-
	\|proofElements\|List of [[#ProofElement][ProofElements]]\|		\|digestService\|\|String\|\|Java name for the type of digest (ie, SHA-256)
	\|roundId\|long\|current round id this token was processed in\|		\|-
	\|statusCode\|int\|status code indicating type of response - See [[~~AceV3StatusCodes][~~Status Code Documentation]] for details\|		\|name\|\|String\|\|Name supplied by client for this token
			\|-
			\|proofElements\|\|List of [[#ProofElement][ProofElements]]
			\|-
			\|roundId\|\|long\|\|current round id this token was processed in
			\|-
			\|statusCode\|\|int\|\|status code indicating type of response - See [[Ace IMS Status Codes\|Status Code Documentation]] for details
			\|-
	\|timeStamp\|dateTime\|Time the round was processed\|		\|timeStamp\|dateTime\|Time the round was processed\|
	\|tokenClassName\|String\|Name of token class on IMS that was used\|
			\|tokenClassName\|String\|Name of token class on IMS that was used
			\|}


	#ProofElement		#ProofElement
	===TokenResponse===		===TokenResponse===
			{\|
	\|'''Name'''\|\|'''Type'''\|\|'''Description'''		\|'''Name'''\|\|'''Type'''\|\|'''Description'''
	\|hashes\|List of String\|		\|-
	\|index\|int\|		\|hashes\|\|List of String
			\|-
			\|index\|\|int
			\|}

← Older revision		Revision as of 20:00, 9 September 2008
Line 46:		Line 46:

	{\| width="75%"		{\| width="75%"
	\|'''Name'''\|'''Type'''\|'''Description'''		\|'''Name'''\|\|'''Type'''\|\|'''Description'''
	\|-		\|-
	\|tokenClassString\|\|String		\|tokenClassString\|\|String
Line 65:		Line 65:

	{\| width="75%"		{\| width="75%"
	\|'''Name'''\|'''Type'''\|'''Description'''		\|'''Name'''\|\|'''Type'''\|\|'''Description'''
	\|}		\|}

Line 76:		Line 76:

	{\| width="75%"		{\| width="75%"
	\|'''Name'''\|'''Type'''\|'''Description'''		\|'''Name'''\|\|'''Type'''\|\|'''Description'''
	\|}		\|}

Line 87:		Line 87:

	{\| width="75%"		{\| width="75%"
	\|'''Name'''\|'''Type'''\|'''Description'''		\|'''Name'''\|\|'''Type'''\|\|'''Description'''
	\|-		\|-
	\|message\|String		\|message\|String
Line 98:		Line 98:

	{\| width="75%"		{\| width="75%"
	\|'''Name'''\|'''Type'''\|'''Description'''		\|'''Name'''\|\|'''Type'''\|\|'''Description'''
	\|-		\|-
	\|previousHash\|String\|		\|previousHash\|String\|
Line 112:		Line 112:

	{\| width="75%"		{\| width="75%"
	\|'''Name'''\|'''Type'''\|'''Description'''		\|'''Name'''\|\|'''Type'''\|\|'''Description'''
	\|}		\|}

Line 119:		Line 119:

	{\| width="75%"		{\| width="75%"
	\|'''Name'''\|'''Type'''\|'''Description'''		\|'''Name'''\|\|'''Type'''\|\|'''Description'''
	\|-		\|-
	\|hashValue\|String\|		\|hashValue\|String\|
Line 128:		Line 128:
	===TokenResponse===		===TokenResponse===

	\|Name\|Type\|Description\|		\|'''Name'''\|\|'''Type'''\|\|'''Description'''
	\|digestProvider\|String\|Name of the java provider for the digest service\|		\|digestProvider\|String\|Name of the java provider for the digest service\|
	\|digestService\|String\|Java name for the type of digest (ie, SHA-256)\|		\|digestService\|String\|Java name for the type of digest (ie, SHA-256)\|
Line 141:		Line 141:
	#ProofElement		#ProofElement
	===TokenResponse===		===TokenResponse===
	\|Name\|Type\|Description\|		\|'''Name'''\|\|'''Type'''\|\|'''Description'''
	\|hashes\|List of String\|		\|hashes\|List of String\|
	\|index\|int\|		\|index\|int\|