CardFormatInfo

Represents a Card Format

Card Formats are used in a controller to be able to identify allowable cards.Card formats can be added, deleted, and modified in the System by selecting the Card Formats drop down menu in the General Configuration tab. To add a card format, the System Operator shall click the Add New Card Format button in the Card Formats panel. Card formats can be modified by double clicking on the card format description. Once this occurs, a new window shall be opened, and System Operators shall be able to edit the card format, format name, description, card number ranges, etc. The System shall support any industry standard Wiegand format, and magnetic stripe formats. For every card format, the System shall support formats that use card number, facility code, and issue code combinations.

CardFormatInfo Properties

Item -> BaseInfo -> CardFormatInfo

Field Type Inherited from Description
Href String Item Gets or sets the href.
CommonName String BaseInfo Common Name of the resource.The common name of the resource.
InFolderHref String BaseInfo relative path Href value for the containing folderAll objects exist within a folder. Even folders!
InFolderKey String BaseInfo Represents the internal ID of the containing folder
IsGlobal Boolean BaseInfo If set True, the object will be exposed to the entire instance scope in which it resides. Meaning this object will always pass scope wide permissions tests when being queried although other restrictions such as by type will still apply (You need at least Read on the object type to see it regardless where you are in the instance scope). This Attribute is intended for use with AccessLevelInfo objects only. Use with other model objects may cause unexpected behaviors. Particularly this should not be used with ScheduleInfos, HolidayInfos, HolidayDayInfos, or ElevatorAccessLevelInfos. In time more objects will be allowed for use with this attribute but for the time being please only use with AccessLevelInfo Objects.
Key String BaseInfo Represents the internal ID of the object.
Links List<Link> BaseInfo List of related resourcesIt is expected that a resource will have many related resources (i.e. person has many access levels) Consumers of the API are encouraged to iterate through the list of links requesting this additional information as required.
Metadata MetadataItem[] BaseInfo The set of metadata attached to this resourceMetadata is opaque to the server code. Key value pairs are saved as part of a client activity. Users of the Native windows client, are able to design custom forms to display and edit scalar values in the meta data.
Monikers MonikerItem[] BaseInfo the set of Monikers for this object
Notes NoteInfo[] BaseInfo The set of notes attached to this resourceNotes are free form text only that is stored in chronological order. All notes are retrieved as part of an OBJECT get. Notes may be added as one POST but not updated with a PUT of the primary resource. WHen the resource is deleted all the notes are also deleted.
ObjectLinks ObjectLinkItem[] BaseInfo The set of resources that are related to this resourceFrequently resources have a one to one, or one to many relationship with other resources in the system. Use this set of links to discover related resources. 2016/09/29 Href property of the related resource may be null. In which case it’s expected that a set of related objects has already been retrieved by the client and the Key value will be used to index into that set.
Tags String[] BaseInfo the set of tags for this objectTags are used to group objects together for the purposes of selection and assignment of operation rights
CardFieldAsLargeEncodedNumber Boolean CardFormatInfo Gets or sets the CardFieldAsLargeEncodedNumber value
CardNumberLength Int32 CardFormatInfo Gets or sets the length of the card number.
CardNumberStartingAt Int32 CardFormatInfo Gets or sets the card number starting at.
EnableSpecial37BitParityCheck Boolean CardFormatInfo Gets or sets the EnableSpecial37BitParityCheck value
EvenParityBitsLength Int32 CardFormatInfo Gets or sets the length of the even parity bits.
EvenParityBitsStartingAt Int32 CardFormatInfo Gets or sets the even parity bits starting at.
FacilityCode Int32 CardFormatInfo Gets or sets the facility code.
FacilityCodeLength Int32 CardFormatInfo Gets or sets the length of the facility code.
FacilityCodeStartingAt Int32 CardFormatInfo Gets or sets the facility code starting at.
IssueCodeLength Int32 CardFormatInfo Gets or sets the length of the issue code.
IssueCodeStartingAt Int32 CardFormatInfo Gets or sets the issue code starting at.
MagneticFormat Boolean CardFormatInfo Gets or sets a value indicating whether [magnetic format].Possible Values (true, false)
MinCardNumberDigits Int32 CardFormatInfo Gets or sets the minimum card number digits.
NumberOfBits Int32 CardFormatInfo Gets or sets the number of bits.
OddParityBitsLength Int32 CardFormatInfo Gets or sets the length of the odd parity bits.
OddParityBitsStartingAt Int32 CardFormatInfo Gets or sets the odd parity bits starting at.
Offset Int32 CardFormatInfo Gets or sets the offset.
ReverseBitStream Boolean CardFormatInfo Gets or sets the ReverseBitStream value
ReverseBytes Boolean CardFormatInfo Gets or sets the ReverseBytes value

JSON Structure of CardFormatInfo

{
   "Href"	:	"String",
   "CommonName"	:	"String",
   "InFolderHref"	:	"String",
   "InFolderKey"	:	"String",
   "IsGlobal"	:	"Boolean",
   "Key"	:	"String",
   "Links"	:	"List\<[Link](/object-model/link)\>",
   "Metadata"	:	"[MetadataItem](/object-model/metadataitem)[]",
   "Monikers"	:	"[MonikerItem](/object-model/monikeritem)[]",
   "Notes"	:	"[NoteInfo](/object-model/noteinfo)[]",
   "ObjectLinks"	:	"[ObjectLinkItem](/object-model/objectlinkitem)[]",
   "Tags"	:	"String[]",
   "CardFieldAsLargeEncodedNumber"	:	"Boolean",
   "CardNumberLength"	:	"Int32",
   "CardNumberStartingAt"	:	"Int32",
   "EnableSpecial37BitParityCheck"	:	"Boolean",
   "EvenParityBitsLength"	:	"Int32",
   "EvenParityBitsStartingAt"	:	"Int32",
   "FacilityCode"	:	"Int32",
   "FacilityCodeLength"	:	"Int32",
   "FacilityCodeStartingAt"	:	"Int32",
   "IssueCodeLength"	:	"Int32",
   "IssueCodeStartingAt"	:	"Int32",
   "MagneticFormat"	:	"Boolean",
   "MinCardNumberDigits"	:	"Int32",
   "NumberOfBits"	:	"Int32",
   "OddParityBitsLength"	:	"Int32",
   "OddParityBitsStartingAt"	:	"Int32",
   "Offset"	:	"Int32",
   "ReverseBitStream"	:	"Boolean",
   "ReverseBytes"	:	"Boolean"
}

Add Card Format Async

Example in C#

// Returns: CardFormatInfo
var cardFormatInfo = await client.AddCardFormatAsync(FolderInfo folder, CardFormatInfo cardFormat)

Example in CURL



           curl -X POST \
               https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/cardformats \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' \
               -H 'Content-Type: application/json' \
               -d '{
                       "$type":"Feenics.Keep.WebApi.Model.CardFormatInfo, Feenics.Keep.WebApi.Model",
                       "NumberOfBits":26,
                       "FacilityCodeStartingAt":1,
                       "FacilityCodeLength":8,
                       "CardNumberStartingAt":9,
                       "CardNumberLength":16,
                       "IssueCodeStartingAt":0,
                       "IssueCodeLength":0,
                       "EvenParityBitsStartingAt":0,
                       "EvenParityBitsLength":13,
                       "OddParityBitsStartingAt":13,
                       "OddParityBitsLength":13,
                       "Offset":0,
                       "MagneticFormat":false,
                       "FacilityCode":45,
                       "MinCardNumberDigits":0,
                       "ReverseBitStream":false,
                       "CardFieldAsLargeEncodedNumber":false,
                       "ReverseBytes":false,
                       "EnableSpecial37BitParityCheck":false,
                       "Key":null,
                       "CommonName":"cURL_Example_Format",
                       "InFolderHref":null,
                       "InFolderKey":null,
                       "Links":[],
                       "ObjectLinks":null,
                       "Metadata":null,
                       "Notes":null,
                       "Tags":null,
                       "Monikers":null,
                       "Href":null
                   }'
            

Add Card Format To Controller Async

Example in C#

// Returns: nothing
await client.AddCardFormatToControllerAsync(ControllerInfo controller, CardFormatInfo cardFormat)

Example in CURL



           curl -X PUT \
               https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/controllers/CONTROLLER.KEY/cardformats \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' \
               -H 'Content-Type: application/json' \
               -d '"/api/f/INSTANCE.KEY/cardformats/CARDFORMAT.KEY"'
            

Delete Card Format Async

Example in C#

// Returns: nothing
await client.DeleteCardFormatAsync(CardFormatInfo cardFormat)

Example in CURL



           curl -X DELETE \
               https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/cardformats/CARDFORMAT.KEY \
               -H 'Authorization: Bearer TOKEN_GOES_HERE'
            

Get Card Formats Async

Example in C#

// Returns: IEnumerable<CardFormatInfo>
var cardFormatInfo = await client.GetCardFormatsAsync(FolderInfo folder)

Example in CURL



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

Get Card Formats For Controller Async

Example in C#

// Returns: IEnumerable<ControllerCardFormatInfo>
var controllerCardFormatInfo = await client.GetCardFormatsForControllerAsync(ControllerInfo controllerInfo)

Example in CURL



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

Remove Card Format From Controller Async

Example in C#

// Returns: nothing
await client.RemoveCardFormatFromControllerAsync(ControllerCardFormatInfo cardFormat)

Example in CURL



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

Update Card Format Async

Example in C#

// Returns: nothing
await client.UpdateCardFormatAsync(CardFormatInfo cardFormat)

Example in CURL



           curl -X PUT \
               https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/cardformats \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' \
               -H 'Content-Type: application/json' \
               -d '{
                       "$type":"Feenics.Keep.WebApi.Model.CardFormatInfo, Feenics.Keep.WebApi.Model",
                       "NumberOfBits":26,
                       "FacilityCodeStartingAt":1,
                       "FacilityCodeLength":8,
                       "CardNumberStartingAt":9,
                       "CardNumberLength":16,
                       "IssueCodeStartingAt":0,
                       "IssueCodeLength":0,
                       "EvenParityBitsStartingAt":0,
                       "EvenParityBitsLength":13,
                       "OddParityBitsStartingAt":13,
                       "OddParityBitsLength":13,
                       "Offset":0,
                       "MagneticFormat":false,
                       "FacilityCode":45,
                       "MinCardNumberDigits":0,
                       "ReverseBitStream":false,
                       "CardFieldAsLargeEncodedNumber":false,
                       "ReverseBytes":false,
                       "EnableSpecial37BitParityCheck":false,
                       "Key":"CARDFORMAT.KEY",
                       "CommonName":"cURL_Example_Format",
                       "InFolderHref":"/api/f/INSTANCE.KEY",
                       "InFolderKey":"INSTANCE.KEY",
                       "Links":
                       [
                           {
                               "$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
                               "Relation":"Meta",
                               "Anchor":
                               {
                                   "$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
                                   "Href":"meta",
                                   "Text":"Metadata"
                               }
                           },
                           {
                               "$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
                               "Relation":"Monikers",
                               "Anchor":
                               {
                                   "$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
                                   "Href":"monikers",
                                   "Text":"Monikers"
                               }
                           },
                           {
                               "$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
                               "Relation":"CommonName",
                               "Anchor":
                               {
                                   "$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
                                   "Href":"commonname",
                                   "Text":"Common Name"
                               }
                           },
                           {
                               "$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
                               "Relation":"Images",
                               "Anchor":
                               {
                                   "$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
                                   "Href":"images",
                                   "Text":"Images"
                               }
                           },
                           {
                               "$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
                               "Relation":"TakeOwnership",
                               "Anchor":
                               {
                                   "$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
                                   "Href":"takeownership",
                                   "Text":"Take Ownership"
                               }
                           },
                           {
                               "$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
                               "Relation":"Connections",
                               "Anchor":
                               {
                                   "$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
                                   "Href":"connections",
                                   "Text":"Connected Objects"
                               }
                           },
                           {
                               "$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
                               "Relation":"References",
                               "Anchor":
                               {
                                   "$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
                                   "Href":"references",
                                   "Text":"Referencing Objects"
                               }
                           },
                           {
                               "$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
                               "Relation":"Notes",
                               "Anchor":
                               {
                                   "$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
                                   "Href":"notes",
                                   "Text":"Notes"
                               }
                           }
                       ],
                       "ObjectLinks":
                       [
                           {
                               "$type":"Feenics.Keep.WebApi.Model.ObjectLinkItem, Feenics.Keep.WebApi.Model",
                               "Href":null,
                               "LinkedObjectKey":"INSTANCE.KEY",
                               "CommonName":"INSTANCE_NAME",
                               "Relation":"InInstance",
                               "MetaDataBson":
                               {
                                   "$type":"System.Byte[], mscorlib",
                                   "$value":""
                               }
                           },
                           {
                               "$type":"Feenics.Keep.WebApi.Model.ObjectLinkItem, Feenics.Keep.WebApi.Model",
                               "Href":null,
                               "LinkedObjectKey":"INSTANCE.KEY",
                               "CommonName":"INSTANCE_NAME",
                               "Relation":"InstanceScope",
                               "MetaDataBson":
                               {
                                   "$type":"System.Byte[], mscorlib",
                                   "$value":""
                               }
                           }
                       ],
                       "Metadata":[],
                       "Notes":[],
                       "Tags":[],
                       "Monikers":[],
                       "Href":"/api/f/INSTANCE.KEY/cardformats/CARDFORMAT.KEY"
                   }'