POST v1/Authenticate/activechecks/{storeIdentifier}

POST Active Checks Validate Employee

Validate Login for employees' for Active Checks. Need either the employee number and password or mag card data

URI template

v1/Authenticate/activechecks/{storeIdentifier}

Request Information

URI Parameters

Name	Type	Additional information	Description
storeIdentifier	integer	Required	Store at which the employee is being authenticated

Body Parameters

EmployeeNumber, EmployeePassword and MagCardData

ActiveChecksEmployeeCredentials

Name	Type	Additional information	Description
EmployeeNumber	integer	None.	Identifier for the employee
EmployeePassword	string	None.	Password for the employee
MagCardData	string	None.	Data that represents both Id and password. Can be used instead of EmployeeNumber and Password

Request Formats

application/json, text/json

Sample:

{
  "EmployeeNumber": 1,
  "EmployeePassword": "sample string 2",
  "MagCardData": "sample string 3"
}

application/xml, text/xml

Sample:

<ActiveChecksEmployeeCredentials xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Inbound">
  <EmployeeNumber>1</EmployeeNumber>
  <EmployeePassword>sample string 2</EmployeePassword>
  <MagCardData>sample string 3</MagCardData>
</ActiveChecksEmployeeCredentials>

Response Information

Resource Description

ActiveChecksAuthenticateResponse

Name	Type	Additional information	Description
IsValidated	boolean	None.	Describes whether the employee is authenticated
EmployeeNumber	integer	None.	The EmployeeNumber that has been validated
NickName	string	None.	Describes the nickname for the employee
ApiResult	StoreApiResponse	None.	The result returned by the Api

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.