Know the current number of days before account-expiration when a notification is sent to users.

Availability

Acrobat Connect Pro Server 7

Description

Returns information about the current settings for account-expiration notifications (the warnings given to users before an account expires). A user is notified x number of days before their account expires. This action simply returns the value of x.

Request URL

 https://example.com/api/xml 
     ?action=expiry-settings-info 
     &account-id=Integer 
     &session=String

Parameters

Name

Type

Required

Description

account-id

BIGINT

N

The ID of the account. If you don’t provide an account ID, the information for the current account is returned.

session

String

N

The value of the BREEZESESSION cookie. Use this parameter if you do not use a client-side cookie management library.

Response structure

 <?xml version="1.0" encoding="utf-8" ?>  
 <results> 
     <status code=allowedValue /> 
     <expiry-num-of-days> 
         <value>30</value> 
        </expiry-num-of-days> 
 </results>

Response values

Element

Attribute

Type

Description

results

Container

All results the action returns.

status

Empty, with attributes

The status of the response.

code

Allowed value

A code indicating the response status (see status).

expiry-num-of-days

Container

Information about the current settings for account-expiration notifications.

value

Integer

The user is notified this many days before their account expires. The default value is 30. For example, if a user’s account expires on December 31, the user is notified on December 1.

Sample request

 https://example.com/api/xml?action=expiry-settings-info&account-id=7

Sample response

 <?xml version="1.0" encoding="utf-8" ?>  
 <results> 
        <status code="ok"/> 
        <expiry-num-of-days> 
            <value>30</value> 
        </expiry-num-of-days> 
 </results>

See also

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy