externalSubmitOnlineUpdateRequest

Submits a request for an online update of a smart card for a specified user. After the request is submitted, it will be processed in the same way as any other request within the Forefront Identity Manager Certificate Management (FIM CM) and subject to the workflow and policy rules associated with the profile template.


externalSubmitOnlineUpdateRequest( @serial varchar(50), @reason int, @template_oid ntext = NULL, @registration_data ntext = NULL, @comments nvarchar(256), @request_uuid uniqueidentifier OUTPUT, @request_priority tinyint = 0 )

externalSubmitOnlineUpdateRequest(
			@serial varchar(50),
		 @reason int, 
		@template_oid ntext = NULL,
		@registration_data ntext = NULL,
		 @comments nvarchar(256),
		 @request_uuid uniqueidentifier OUTPUT,
		 @request_priority tinyint = 0
)

Parameters

Parameter

Description

@serial

[in] The smart card serial number for the smart card to update, prefixed with the manufacturer identification number.

@reason

[in] The reason for the online update request.

This parameter can contain one of the following values:

value	meaning
0	The content of the certificate has changed.
1	The certificate template list has changed.
2	The certificate has expired.

@template_oid

[in] A value of NULL indicates that all certificates are updated. A non-NULL value is an oid for a certificate template whose certificates will be updated.

@registration_data

[in] An XML document that contains the name/value pairs for any data that is required for the FIM CM profile template online update policy. This parameter can be NULL.

@comments

[in] Comment to store for the request. This parameter can be NULL.

@request_uuid

[out] A UUID that is the unique identifier for the submitted request. This identifier can be used to determine the status of the request using the externalGetStatus stored procedure.

@request_priority

[in] An integer value between 0 and 255 indicating the priority of the request. Zero is the highest priority and 255 is the lowest. This parameter can be NULL.

Return Value

Zero if the procedure succeeds, otherwise one of the following error codes.

Value	Meaning
-1	The cause of the error is unknown.
-2	The attempt to create the request failed.
-3	The data is not valid.
-4	The attempt to submit the request failed.

Example

The following code example shows how to submit an online update for a smart card.

	Copy Code
DECLARE @RC int DECLARE @serial varchar(50) DECLARE @reason int DECLARE @comments nvarchar(256) DECLARE @request_uuid uniqueidentifier DECLARE @request_priority tinyint -- Set parameter values SET @serial = 'A.E.T. Europe B.V.:5144018962907492' SET @comments = N'Online Update Request Submitted by External Api (with comments)' SET @request_priority = 1 SET @reason = 2 --0 ContentChange, 1 ListChange, 2 Expiry EXEC @RC = [clm].[dbo].[externalSubmitOnlineUpdateRequest] @serial, @reason, NULL, NULL, @comments, @request_uuid OUTPUT , @request_priority PRINT @request_uuid PRINT @RC

Copy Code

DECLARE @RC			 int
DECLARE @serial		 varchar(50)
DECLARE @reason		 int
DECLARE @comments		 nvarchar(256)
DECLARE @request_uuid	 uniqueidentifier
DECLARE @request_priority tinyint

-- Set parameter values
SET @serial = 'A.E.T. Europe B.V.:5144018962907492'
SET @comments = N'Online Update Request Submitted by External Api (with comments)'
SET @request_priority = 1
SET @reason = 2 --0 ContentChange, 1 ListChange, 2 Expiry

EXEC @RC = [clm].[dbo].[externalSubmitOnlineUpdateRequest] 
						@serial, 
						@reason, 
						NULL, 
						NULL, 
						@comments, 
						@request_uuid OUTPUT , 
						@request_priority

PRINT @request_uuid
PRINT @RC

Requirements

Microsoft SQL Server® 2005 Service Pack 1 or SQL Server 2000 Service Pack 4

Parameters

Return Value

Example

Requirements

See Also

Concepts