POST api/miclasone/login

Request Information

URI Parameters

None.

Body Parameters

EmployeeRequest
NameDescriptionTypeAdditional information
UserID

string

None.

Password

string

None.

TerminalIdentString

string

None.

Module

integer

None.

HardwareDeviceID

string

None.

Request Formats

application/json, text/json

Sample:
{
  "UserID": "sample string 1",
  "Password": "sample string 2",
  "TerminalIdentString": "sample string 3",
  "Module": 4,
  "HardwareDeviceID": "sample string 5"
}

text/xml

Sample:
<EmployeeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MiCLAS.WebAPI.Models">
  <HardwareDeviceID>sample string 5</HardwareDeviceID>
  <Module>4</Module>
  <Password>sample string 2</Password>
  <TerminalIdentString>sample string 3</TerminalIdentString>
  <UserID>sample string 1</UserID>
</EmployeeRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'EmployeeRequest'.

Response Information

Resource Description

Employee
NameDescriptionTypeAdditional information
EmployeeEntry

EmployeeEntry

None.

HttpStatusCode

HttpStatusCode

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "EmployeeEntry": {
    "ID": "sample string 1",
    "Name": "sample string 2",
    "InternalID": 3,
    "Exists": true,
    "InternalUserID": 5,
    "MobileDevice": {
      "DeviceID": 1,
      "DeviceName": "sample string 2",
      "StorageCodeTarget": "sample string 3"
    }
  },
  "HttpStatusCode": 100,
  "Message": "sample string 1"
}

text/xml

Sample:
<Employee xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MiCLAS.WebAPI.Models">
  <HttpStatusCode xmlns="http://schemas.datacontract.org/2004/07/MiCLAS.WebAPI.Models.Base">Continue</HttpStatusCode>
  <Message xmlns="http://schemas.datacontract.org/2004/07/MiCLAS.WebAPI.Models.Base">sample string 1</Message>
  <EmployeeEntry>
    <Exists>true</Exists>
    <ID>sample string 1</ID>
    <InternalID>3</InternalID>
    <InternalUserID>5</InternalUserID>
    <MobileDevice xmlns:d3p1="http://schemas.datacontract.org/2004/07/MiCLAS.WebAPI.Models.Base">
      <d3p1:DeviceID>1</d3p1:DeviceID>
      <d3p1:DeviceName>sample string 2</d3p1:DeviceName>
      <d3p1:StorageCodeTarget>sample string 3</d3p1:StorageCodeTarget>
    </MobileDevice>
    <Name>sample string 2</Name>
  </EmployeeEntry>
</Employee>