CardAssignmentInfo

Represents the Current or Historical card assignment for a Person

Credentials (cards) allow for intelligent controllers to match a card value against a person in order to lookup Access Rights at the door.

CardAssignmentInfo Properties

Item -> CardAssignmentInfo

Field Type Inherited from Description
Href String Item Gets or sets the href.
ActiveOn DateTime CardAssignmentInfo Gets or sets the active on.
AntiPassbackExempt Boolean CardAssignmentInfo Gets or sets a value indicating whether [anti passback exempt].Possible Values (true, false)
CurrentUseCount Int32 CardAssignmentInfo Gets or sets the CurrentUseCount value
DisplayCardNumber String CardAssignmentInfo Gets or sets the display card number. Set the same as Encoded Card Number unless custom value required.
EncodedCardNumber Int64 CardAssignmentInfo Gets or sets the encoded card number. This is the actual card data.
ExpiresOn DateTime CardAssignmentInfo Gets or sets the expires on.
ExtendedAccess Boolean CardAssignmentInfo Gets or sets a value indicating whether [extended access].Possible Values (true, false)
HexValue String CardAssignmentInfo Gets or sets the HexValue value
IsDisabled Boolean CardAssignmentInfo Gets or sets a value indicating whether this instance is disabled.Possible Values (true, false)
Key String CardAssignmentInfo Gets or sets the key.
LastUsed LastUsedItem CardAssignmentInfo Gets or sets the LastUsed value
ManagerLevel Int32 CardAssignmentInfo Gets or sets the manager level.
Note String CardAssignmentInfo Gets or sets the Note value
OriginalUseCount Nullable<Int32> CardAssignmentInfo Gets or sets the use count.When set above zero the controller will deactivate the card once the use count has been reached
OrigoCredentialId Int64 CardAssignmentInfo Gets or sets the OrigoCredentialId value
PinCode String CardAssignmentInfo Gets or sets the pin code.
PinExempt Boolean CardAssignmentInfo Gets or sets a value indicating whether [pin exempt].Possible Values (true, false)
RecordId Nullable<Int32> CardAssignmentInfo Gets or sets the RecordId value

JSON Structure of CardAssignmentInfo

{
   "Href"	:	"String",
   "ActiveOn"	:	"DateTime",
   "AntiPassbackExempt"	:	"Boolean",
   "CurrentUseCount"	:	"Int32",
   "DisplayCardNumber"	:	"String",
   "EncodedCardNumber"	:	"Int64",
   "ExpiresOn"	:	"DateTime",
   "ExtendedAccess"	:	"Boolean",
   "HexValue"	:	"String",
   "IsDisabled"	:	"Boolean",
   "Key"	:	"String",
   "LastUsed"	:	"[LastUsedItem](/object-model/lastuseditem)",
   "ManagerLevel"	:	"Int32",
   "Note"	:	"String",
   "OriginalUseCount"	:	"Nullable\<Int32\>",
   "OrigoCredentialId"	:	"Int64",
   "PinCode"	:	"String",
   "PinExempt"	:	"Boolean",
   "RecordId"	:	"Nullable\<Int32\>"
}

Add Card Assignment Async

Example in C#

// Returns: CardAssignmentInfo
var cardAssignmentInfo = await client.AddCardAssignmentAsync(PersonInfo person, CardAssignmentInfo cardAssignment)

Example in CURL



           curl -X POST \
               https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/people/PERSON.KEY/cards \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' \
               -H 'Content-Type: application/json' \
               -d '{
                       "$type":"Feenics.Keep.WebApi.Model.CardAssignmentInfo, Feenics.Keep.WebApi.Model",
                       "Key":null,
                       "EncodedCardNumber":751535,
                       "DisplayCardNumber":"751535",
                       "ActiveOn":"2019-02-22T20:51:31.4443735Z",
                       "ExpiresOn":"2020-02-22T20:51:31.4443735Z",
                       "PinCode":null,
                       "AntiPassbackExempt":false,
                       "ExtendedAccess":false,
                       "PinExempt":false,
                       "IsDisabled":false,
                       "ManagerLevel":0,
                       "OriginalUseCount":null,
                       "CurrentUseCount":0,
                       "Note":null,
                       "HexValue":null,
                       "RecordId":null,
                       "LastUsed":null,
                       "Href":null
                   }'
            

Delete Card Assignment Async

Example in C#

// Returns: nothing
await client.DeleteCardAssignmentAsync(CardAssignmentInfo cardAssignment)

Get Card Assignments For Controller Async

Example in C#

// Returns: IEnumerable<CardAccessItem>
var cardAccessItem = await client.GetCardAssignmentsForControllerAsync(ControllerInfo controller)

Example in CURL



           curl -X GET \
               https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/controllers/CONTROLLER.KEY/cards \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' 
            

Get Card Assignments For Controller By Event Batch Async

Example in C#

// Returns: IEnumerable<CardAccessItem>
var cardAccessItem = await client.GetCardAssignmentsForControllerByEventBatchAsync(ControllerInfo controller, String batchId)

Example in CURL



           curl -X GET \
               https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/controllers/CONTROLLER.KEY/batch?batchId=1 \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' 
            

Get Card Assignments For Person Async

Example in C#

// Returns: IEnumerable<CardAssignmentInfo>
var cardAssignmentInfo = await client.GetCardAssignmentsForPersonAsync(PersonInfo person)

Example in CURL



           curl -X GET \
               https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/people/PERSON.KEY/cards \
               -H 'Authorization: Bearer TOKEN_GOES_HERE'
            

Get Random Pin Async

Example in C#

// Returns: Int64
var item = await client.GetRandomPinAsync(FolderInfo folder, Int64 lowValue, Int64 highValue)

Example in CURL



           curl -X GET \
               'https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/randompin?lowValue=1000&highValue=9999' \
               -H 'Authorization: Bearer TOKEN_GOES_HERE'
            

Increment Card Use Count

Example in C#

// Returns: nothing
await client.IncrementCardUseCount(CardAssignmentInfo cardAssignment)

Example in CURL



           curl -X PUT \
               https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/people/PERSON.KEY/cards/CARDASSIGNMENT.KEY/incrementusecount \
               -H 'Authorization: Bearer TOKEN_GOES_HERE'
            

Send Invitation

Example in C#

// Returns: nothing
await client.SendInvitation(PersonInfo personInfo, DateTime activeOn, DateTime expiresOn)

Update Card Assignment Async

Example in C#

// Returns: nothing
await client.UpdateCardAssignmentAsync(CardAssignmentInfo cardAssignment)

Example in CURL



           curl -X PUT \
               https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/people/PERSON.KEY/cards/CARDASSIGNMENT.KEY \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' \
               -H 'Content-Type: application/json' \
               -d '{
                       "$type":"Feenics.Keep.WebApi.Model.CardAssignmentInfo, Feenics.Keep.WebApi.Model",
                       "Key":"CARDASSIGNMENT.KEY",
                       "EncodedCardNumber":751535,
                       "DisplayCardNumber":"751535",
                       "ActiveOn":"2019-02-22T20:51:31.4443735Z",
                       "ExpiresOn":"2020-02-22T20:51:31.4443735Z",
                       "PinCode":null,
                       "AntiPassbackExempt":false,
                       "ExtendedAccess":false,
                       "PinExempt":false,
                       "IsDisabled":false,
                       "ManagerLevel":0,
                       "OriginalUseCount":null,
                       "CurrentUseCount":0,
                       "Note":null,
                       "HexValue":null,
                       "RecordId":null,
                       "LastUsed":null,
                       "Href":"/api/f/INSTANCE.KEY/people/PERSON.KEY/cards/CARDASSIGNMENT.KEY"
                   }'