Element: tns:createSimpleEntitlementResponse

Description

A createSimpleEntitlementResponse message contains an element of createSimpleEntitlementResponseType.

Each entitlement in the createSimpleEntitlementRequest is added as an atomic unit; adding each either succeeds or fails.

Derived By

Type createSimpleEntitlementResponseType

Content Model

Contains elements as defined in the following table.

Component

Type

Occurs

Description

1..1

statusInfo

StatusInfoType

1..1

Element

Data Type

Description

status

StatusType

Returns one of the following:

SUCCESS—All items in the request were processed.
PARTIAL_FAILURE—Some, but not all items in the request were processed. The getCount and getQuery operations never return PARTIAL_FAILURE.
FAILURE—None of the items in the request were processed.

When the opType is either CREATE_OR_UPDATE or CREATE_OR_IGNORE, the Entitlement response and the Line Item response together result in the final response.

Both the Entitlement response and the Line Item response must be a success for the final result to be a success.
If one is a success and the other is a failure, the final result is a failure.
If one is a partial failure and one is a failure, the final result is a failure.

Note: A line item request cannot succeed in the absence of an entitlement request.

reason

string

Gives reason for partial failure or failure.

failedData

failedSimpleEntitlementDataListType

0..1

Information about the entitlements that were not added is listed in the failedData element. See failedSimpleEntitlementDataListType.

responseData

createdSimpleEntitlementDataListType

0..1

Information about the entitlements that were added is listed in the responseData element. See createdSimpleEntitlementDataListType.

Referenced By

Name	Type
createSimpleEntitlement	Method

XML Example

The following XML fragment illustrates a successful createSimpleEntitlementResponse message:

<createSimpleEntitlementResponse>
   <statusInfo>
      <status>SUCCESS</status>
   </statusInfo>
   <responseData>
      <createdSimpleEntitlement>
         <recordRefNo>1</recordRefNo>
         <uniqueId>HID-100270</uniqueId>
         <entitlementId>Ent_basic</entitlementId>
         <lineItemUniqueIds>HID-100288</lineItemUniqueIds>
      </createdSimpleEntitlement>
   </responseData>
</createSimpleEntitlementResponse>