POST api/v1/Users/SP1CheckIn
Looks up a person by a criterion specified and assigns a card to her/him. If a card not exists a new one is created
Request Information
URI Parameters
None.
Body Parameters
SP1CheckInRequestName | Description | Type | Additional information |
---|---|---|---|
MatchUserByInternalCardNumber |
Represents the internal/encoded number of the card to lookup a User by |
integer |
None. |
MatchUserByEmployeeNumber |
Represents the Employee number to look upa User by |
string |
None. |
MatchUserByUserId |
Represents the UserId for the User to look up |
globally unique identifier |
None. |
MatchUserByByEmail |
Represents the email address to look up a User by |
string |
None. |
NewCardInternalCardNumber |
Represents the internal/encoded number of the card to assign to the User |
integer |
None. |
NewCardExternalCardNumber |
Represents the serial number of the smart card being added dynamically |
string |
None. |
NewCardFacilityCode |
Represents the facility code of the card to assign to the User /// |
integer |
None. |
NewCardCardType |
Represents the type of the card to assign to the User |
integer |
None. |
NewCardCardACSystemId |
Represents the ID of the System to create the card in |
globally unique identifier |
None. |
NewCardEnforceOccupancySystem |
Optional: Requests to verify if the CardACSystemId matches the system the User's Occupancy belongs to |
boolean |
None. |
Request Formats
application/json, text/json
{ "MatchUserByInternalCardNumber": 1, "MatchUserByEmployeeNumber": "sample string 1", "MatchUserByUserId": "022813b1-7bf0-4028-9429-ec4e9e07f9f3", "MatchUserByByEmail": "sample string 2", "NewCardInternalCardNumber": 3, "NewCardExternalCardNumber": "sample string 4", "NewCardFacilityCode": 5, "NewCardCardType": 6, "NewCardCardACSystemId": "c43af46a-0175-4e28-aef7-4063de3b7713", "NewCardEnforceOccupancySystem": true }
application/xml, text/xml
<SP1CheckInRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers"> <MatchUserByByEmail>sample string 2</MatchUserByByEmail> <MatchUserByEmployeeNumber>sample string 1</MatchUserByEmployeeNumber> <MatchUserByInternalCardNumber>1</MatchUserByInternalCardNumber> <MatchUserByUserId>022813b1-7bf0-4028-9429-ec4e9e07f9f3</MatchUserByUserId> <NewCardCardACSystemId>c43af46a-0175-4e28-aef7-4063de3b7713</NewCardCardACSystemId> <NewCardCardType>6</NewCardCardType> <NewCardEnforceOccupancySystem>true</NewCardEnforceOccupancySystem> <NewCardExternalCardNumber>sample string 4</NewCardExternalCardNumber> <NewCardFacilityCode>5</NewCardFacilityCode> <NewCardInternalCardNumber>3</NewCardInternalCardNumber> </SP1CheckInRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
SP1CheckInResultName | Description | Type | Additional information |
---|---|---|---|
PreviousUserId |
Represents a UserId for a user the card previously belonged to |
globally unique identifier |
None. |
CurrentUserId |
Represents a UserId for a user the card has been assigned to |
globally unique identifier |
None. |
ExternalCardNumber |
Represents the serial number of the smart card being added dynamically |
string |
None. |
InternalCardNumber |
Represents the internal/encoded number of the card being added dynamically. |
integer |
None. |
FacilityCode |
Represents the facility code of the smart card being added dynamically. |
integer |
None. |
CardType |
Represents the type of card being added dynamically. Retrieve possible values from /Card/GetAllCardTypes |
integer |
None. |
Value |
Represents the PK value that was created as a result of an add |
globally unique identifier |
None. |
ResultCode |
Represents the result code |
integer |
None. |
Description |
Represents a description of the result code |
string |
None. |
Response Formats
application/json, text/json
{ "PreviousUserId": "e3bc8108-460b-4ba9-ae71-8d7b2abaea22", "CurrentUserId": "7f8bb9f0-4361-40ff-adb2-320cd6717bbf", "ExternalCardNumber": "sample string 1", "InternalCardNumber": 1, "FacilityCode": 1, "CardType": 1, "Value": "f162fff7-c3b5-488d-9f29-4f4da86aab89", "ResultCode": 3, "Description": "sample string 4" }
application/xml, text/xml
<SP1CheckInResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers"> <Description>sample string 4</Description> <HttpStatusCode>Continue</HttpStatusCode> <ResultCode>3</ResultCode> <Value>f162fff7-c3b5-488d-9f29-4f4da86aab89</Value> <CardType>1</CardType> <CurrentUserId>7f8bb9f0-4361-40ff-adb2-320cd6717bbf</CurrentUserId> <ExternalCardNumber>sample string 1</ExternalCardNumber> <FacilityCode>1</FacilityCode> <InternalCardNumber>1</InternalCardNumber> <PreviousUserId>e3bc8108-460b-4ba9-ae71-8d7b2abaea22</PreviousUserId> </SP1CheckInResult>