DELETE api/v1/Users/SP1CheckOut

Checks out a user by un-assigning all cards and/or deleting a user record

Request Information

URI Parameters

None.

Body Parameters

SP1CheckOutRequest
NameDescriptionTypeAdditional 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.
DeleteUser

Specifies whether to delete a User record

 boolean

None.
DeleteUserCards

Specifies whether to delete all card assignments for the User

 boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "MatchUserByInternalCardNumber": 1,
  "MatchUserByEmployeeNumber": "sample string 1",
  "MatchUserByUserId": "ba5ea453-a4f0-4a1a-be2b-d6caa4c86c73",
  "MatchUserByByEmail": "sample string 2",
  "DeleteUser": true,
  "DeleteUserCards": true
}

application/xml, text/xml

Sample: 
<SP1CheckOutRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers">
  <DeleteUser>true</DeleteUser>
  <DeleteUserCards>true</DeleteUserCards>
  <MatchUserByByEmail>sample string 2</MatchUserByByEmail>
  <MatchUserByEmployeeNumber>sample string 1</MatchUserByEmployeeNumber>
  <MatchUserByInternalCardNumber>1</MatchUserByInternalCardNumber>
  <MatchUserByUserId>ba5ea453-a4f0-4a1a-be2b-d6caa4c86c73</MatchUserByUserId>
</SP1CheckOutRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Result
NameDescriptionTypeAdditional information
ResultCode

Represents the result code

 integer

None.
Description

Represents a description of the result code

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "ResultCode": 1,
  "Description": "sample string 2"
}

application/xml, text/xml

Sample: 
<Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers">
  <Description>sample string 2</Description>
  <HttpStatusCode>Continue</HttpStatusCode>
  <ResultCode>1</ResultCode>
</Result>