StreamRenew()

This API is used to extend the ExpirationDateTime of an active Stream lease.

API URL:

[BaseURL]/Account/{AccountID}/Stream/{StreamHandleID}

Request Method:

PUT

Request Parameters:

• AccountID is the unique identifier for an account
• StreamHandleID is the unique identifier for an account

Request Format

XML type:

• dece:Stream

Required information:

• Stream
  • @StreamHandleID
  • RequestingUserID
  • RightsTokenID
  • ExpirationDateTime

Headers:

• Authorization: SAML2 assertion=[Assertion]

Response Format

Status Code:

• HTTP 200

Errors

• StreamNotActive
  • The stream is not active
  • HTTP Status Code: 403
• StreamExpirationDateTimeBelowLowerBoundary
  • The ExpirationDateTime supplied is less than the current existing expiration time
  • HTTP Status Code: 400
• StreamExpirationDateTimeExceedsUpperBoundary
  • The ExpirationDateTime supplied is greater than the stream maximum total hours allowed
  • HTTP Status Code: 400
• StreamExpirationDateTimeExceedsMaximumRenewalTimeAllowed
  • The ExpirationDateTime supplied is greater than the stream renewal max add hours
  • HTTP Status Code: 400
• StreamRenewalMaximumTimeReached
  • Background process did not managed to deactivate expired stream
  • HTTP Status Code: 404
• StreamRenewExceedsMaximumTime
  • The stream-renewal request exceeds the maximum allowable time
  • HTTP Status Code: 409

Example

Extend the lease time of an open Stream

The following example extends the ExpirationDateTime of an open Stream lease.

Sample Request:

PUT /rest/2015/02/Account/urn:dece:accountid:org:dece:16EBFA93BAC64DBD875336ED4B6D3CC9/Stream/urn:dece:streamhandleid:org:dece:22F5178A987D4710AFFB8EA28895A174 HTTP/1.1
Host: api.uvvu.com
Accept: application/xml
Authorization: SAML2 assertion=[Assertion]

<?xml version="1.0" encoding="UTF-8"?>
<Stream StreamHandleID="urn:dece:streamhandleid:org:dece:22F5178A987D4710AFFB8EA28895A174" xmlns="http://www.decellc.org/schema/2015/03/coordinator">
  <RequestingUserID>urn:dece:userid:org:dece:16EBFA93BAC64DBD875336ED4B6D3CC9</RequestingUserID>
  <RightsTokenID>urn:dece:rightstokenid:org:dece:22F5178A987D4710AFFB8EA28895A174</RightsTokenID>
  <ExpirationDateTime>2017-06-22T19:22:12.242Z</ExpirationDateTime>
  <ResourceStatus>
    <Current CreatedBy="urn:dece:org:org:dece:falcon-a1:retailer" CreationDate="2017-06-22T11:22:12.242Z">
      <Value>urn:dece:type:status:active</Value>
    </Current>
  </ResourceStatus>
</Stream>

Sample Response:

HTTP/1.1 200
Date: [Date]
Content-Type: application/xml
X-transaction-info: [TransactionInfo]

<?xml version="1.0" encoding="UTF-8"?>
<Stream StreamHandleID="urn:dece:streamhandleid:org:dece:22F5178A987D4710AFFB8EA28895A174" xmlns="http://www.decellc.org/schema/2015/03/coordinator">
  <RequestingUserID>urn:dece:userid:org:dece:16EBFA93BAC64DBD875336ED4B6D3CC9</RequestingUserID>
  <RightsTokenID>urn:dece:rightstokenid:org:dece:22F5178A987D4710AFFB8EA28895A174</RightsTokenID>
  <ExpirationDateTime>2017-06-22T19:22:12.242Z</ExpirationDateTime>
  <ResourceStatus>
    <Current CreatedBy="urn:dece:org:org:dece:falcon-a1:retailer" CreationDate="2017-06-22T11:22:12.242Z">
      <Value>urn:dece:type:status:active</Value>
    </Current>
  </ResourceStatus>
</Stream>

See Also

• StreamCreate()
• StreamDelete()
• StreamView()
• StreamList()