ExtendCardExpiryRequest

Represents a request to extend card expiry dates in bulk

This is how to request a card expiry extension.

ExtendCardExpiryRequest Properties

ExtendCardExpiryRequest

Field Type Inherited from Description
Disable Boolean ExtendCardExpiryRequest Gets or sets whether to disable the cards
ExpiredAfter DateTime ExtendCardExpiryRequest Gets or sets the filter for cards with expiry after this date
ExpiredEndDate DateTime ExtendCardExpiryRequest Gets or sets the end of the date range for expired cards
ExpiredFromDate DateTime ExtendCardExpiryRequest Gets or sets the start of the date range for expired cards
ExpiresBefore DateTime ExtendCardExpiryRequest Gets or sets the filter for cards with expiry before this date
NewExpiryDate DateTime ExtendCardExpiryRequest Gets or sets the new expiry date to assign to matching cards
Note String ExtendCardExpiryRequest Gets or sets an optional note about the expiry extension
PersonSearchQuery String ExtendCardExpiryRequest Gets or sets the search query to filter people
Reactivate Nullable<Boolean> ExtendCardExpiryRequest Gets or sets whether to reactivate the cards
TrialRun Boolean ExtendCardExpiryRequest Gets or sets whether this is a trial run (preview changes without applying)

JSON Structure of ExtendCardExpiryRequest

{
   "Disable"	:	"Boolean",
   "ExpiredAfter"	:	"DateTime",
   "ExpiredEndDate"	:	"DateTime",
   "ExpiredFromDate"	:	"DateTime",
   "ExpiresBefore"	:	"DateTime",
   "NewExpiryDate"	:	"DateTime",
   "Note"	:	"String",
   "PersonSearchQuery"	:	"String",
   "Reactivate"	:	"Nullable\<Boolean\>",
   "TrialRun"	:	"Boolean"
}

Extend Card Expiry

Example in C#

// Returns: ExtendCardExpiryResponse
var extendCardExpiryResponse = await client.ExtendCardExpiry(FolderInfo folder, DateTime expiresBefore, DateTime expiresAfter, DateTime newExpiresOn, Boolean trialRun, String query);

Example in CURL



            curl -X POST \
               https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/extendcards \
               -H 'Authorization: Bearer  TOKEN_GOES_HERE'\
               -H 'Content-Type: application/json' \
               -d '{
                   "$type":"Feenics.Keep.WebApi.Model.ExtendCardExpiryRequest, Feenics.Keep.WebApi.Model",
                   "NewExpiryDate":"2022-01-30T15:47:54.5915518Z",
                   "ExpiresBefore":"2019-01-30T15:47:54.5915518Z",
                   "ExpiredAfter":"2019-01-30T15:47:54.5915518Z",
                   "TrialRun":false,
                   "PersonSearchQuery":"{'_t':'Person','Tags':{'$ne':'management'}}"
               }'