provisioningUpdate()

ProvisioningResponse provisioningUpdate(int provisionRequestId, ProvisionRequestStatus status, string logMessage)

This method updates the provision status of a given provision request with a log message.

Parameters

provisionRequestId: Format: integer; Purpose: Specifies the provision request ID.
status: Format: ProvisionRequestStatus XML; Purpose: (Optional) Defines a ProvisionRequestStatus XML document that specifies the new status for the provision request.
logMessage: Format: string; Purpose: (Optional) Specifies a message that will be logged for the provision request.; Note: If both optional parameters are not specified, the method will return the details of the provision request.

Example: A ProvisionRequestStatus XML document

This example shows a ProvisionRequestStatus XML document with a status of TempFail.

The <ProvisionRequestStatus> element has one of the following values:

TempFail: Indicates that a failure has occurred, but might be successful if retried.
PermFail: Indicates that a failure has occurred, but will be removed if retried.
Delayed: Indicates that the provision is still in progress.
Provisioned: Indicates that the provision is complete.

<ProvisionRequestStatus xmlns="http://xml.inomial.com/smile/2.xsd">TempFail</ProvisionRequestStatus>

Results

This method returns a ProvisioningResponse XML document that contains details of the provision request after update.

There are no messages defined by this method.

Example: A returned ProvisioningResponse XML document

This example shows a ProvisioningResponse XML document for provision request ID 1018.

<ProvisioningResponse xmlns="http://xml.inomial.com/smile/2.xsd" xmlns="http://ws.inomial.com/smile.2">
  <provisionRequestId>1018</provisionRequestId>
  <company>1</company>
  <USN>2142425467</USN>
  <requestType>RequestProvision</requestType>
  <status>Complete</status>
  <created>2015-01-20T11:23:59.950+11:00</created>
  <actionTime>2015-01-20T11:24:00.106+11:00</actionTime>
  <attemptLimit>1</attemptLimit>
  <result>PermFail</result>
</ProvisioningResponse>

Faults

InvalidRequestException

This fault is returned when no provision request ID is given as a parameter or the status is unknown.

ProvisioningException

This fault is returned when Smile is unable to log a provision request with logMessage or update the provision request.

NoSuchItemException

This fault is returned when Smile is unable to find the provision request with the given provision request ID.

Java client syntax

java -cp build/smilewsv2-client.jar [options] com.inomial.smile.client.v2.examples.ProvisioningUpdate
 provisionRequestId [filename] [logMessage]

provisionRequestId: Purpose: Specifies the provision request ID.
filename: Purpose: (Optional) Defines the filename of the ProvisionRequestStatus XML document.
logMessage: Purpose: (Optional) Specifies a message that will be logged for the provision request.

Note: For more information about the Java client and the options it accepts, see Java client syntax.