POST api/Customers/Login

user login

Request Information

URI Parameters

None.

Body Parameters

LoginRequest
NameDescriptionTypeAdditional information
LoginDetails

LoginDetails

None.
UserName

The provided user name.

 string

Required
Salt

A random number(at least 9 digits)

 integer

Required
Digest

A digest of the user credentials and the request

 string

Required

Request Formats

application/json, text/json

Sample: 
{
  "LoginDetails": {
    "UserName": "sample string 1",
    "Password": "sample string 2"
  },
  "UserName": "sample string 1",
  "Salt": 2,
  "Digest": "sample string 3"
}

application/xml, text/xml

Sample: 
<LoginRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" UserName="sample string 1" Salt="2" Digest="sample string 3">
  <LoginDetails>
    <UserName>sample string 1</UserName>
    <Password>sample string 2</Password>
  </LoginDetails>
</LoginRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

returns login object

LoginResponse
NameDescriptionTypeAdditional information
UserDetails

UserDetails

None.
UserPermissions

UserPermissions

None.
Success

Indicate if the operation was success

 boolean

None.
Message

Return of errors or indicated return message/data

 string

None.
Extra1

Additional info 1 to return

 string

None.
Extra2

Additional info 2 to return

 string

None.
Extra3

Additional info 3 to return

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "UserDetails": null,
  "UserPermissions": {
    "ValidUser": true,
    "ShowInvoice": true,
    "ShowReceipt": true,
    "InvoiceConfirmation": true
  },
  "Success": true,
  "Message": "sample string 2",
  "Extra1": "sample string 3",
  "Extra2": "sample string 4",
  "Extra3": "sample string 5"
}