GET api/authenticate/user/{passcode}

Authentication User API

Request Information

URI Parameters

Name	Description	Type	Additional information
passcode	Passcode of user want to login	integer	Required

Body Parameters

None.

Response Information

Resource Description

UserAuthentication

Name	Description	Type	Additional information
User	User's data	SubUserDto	None.
Setting	Data related to settings	SettingDto	None.
Receipt	Receipt Information	ReceiptDto	None.
Taxes	Taxes of users	Collection of TaxDto	None.
Merchants		Collection of MerchantDto	None.
Status	Status for response	RStatus	None.
Desc	description of response	string	None.

Response Formats

application/json

Sample:

{
  "User": {
    "SubUserId": 1,
    "UserType": "App",
    "Designation": "Manager",
    "FirstName": "Muhammad",
    "LastName": "Ahsan",
    "Passcode": 1234,
    "Rights": [
      {
        "RightId": 159,
        "Name": "Dashboard",
        "Access": true
      },
      {
        "RightId": 160,
        "Name": "Hold Orders",
        "Access": true
      },
      {
        "RightId": 161,
        "Name": "Delivery Orders",
        "Access": true
      },
      {
        "RightId": 162,
        "Name": "Web Orders",
        "Access": true
      },
      {
        "RightId": 163,
        "Name": "Checkout Orders",
        "Access": true
      },
      {
        "RightId": 164,
        "Name": "Edit Order",
        "Access": true
      },
      {
        "RightId": 165,
        "Name": "Add Customer",
        "Access": true
      },
      {
        "RightId": 166,
        "Name": "Sliding Checkout",
        "Access": true
      },
      {
        "RightId": 167,
        "Name": "New Order",
        "Access": false
      },
      {
        "RightId": 168,
        "Name": "Punch Items",
        "Access": false
      },
      {
        "RightId": 169,
        "Name": "Hold",
        "Access": false
      },
      {
        "RightId": 170,
        "Name": "Checkout",
        "Access": false
      },
      {
        "RightId": 171,
        "Name": "Add Customer",
        "Access": false
      },
      {
        "RightId": 172,
        "Name": "Add Agent",
        "Access": false
      },
      {
        "RightId": 173,
        "Name": "Add Table",
        "Access": false
      },
      {
        "RightId": 174,
        "Name": "Tables",
        "Access": false
      },
      {
        "RightId": 175,
        "Name": "Reports",
        "Access": false
      },
      {
        "RightId": 176,
        "Name": "X Report",
        "Access": false
      },
      {
        "RightId": 177,
        "Name": "Z Report",
        "Access": false
      },
      {
        "RightId": 178,
        "Name": "Cash Drawer",
        "Access": false
      },
      {
        "RightId": 179,
        "Name": "Refund",
        "Access": false
      },
      {
        "RightId": 180,
        "Name": "Settings",
        "Access": false
      },
      {
        "RightId": 181,
        "Name": "General",
        "Access": false
      },
      {
        "RightId": 182,
        "Name": "Hardware",
        "Access": false
      },
      {
        "RightId": 183,
        "Name": "Receipt",
        "Access": false
      },
      {
        "RightId": 184,
        "Name": "Quick Pay",
        "Access": false
      },
      {
        "RightId": 185,
        "Name": "Database",
        "Access": false
      },
      {
        "RightId": 186,
        "Name": "Language",
        "Access": false
      },
      {
        "RightId": 187,
        "Name": "Right Top Menu",
        "Access": false
      },
      {
        "RightId": 188,
        "Name": "Sync Orders",
        "Access": false
      },
      {
        "RightId": 189,
        "Name": "Checkout Process",
        "Access": false
      },
      {
        "RightId": 190,
        "Name": "Cash",
        "Access": false
      },
      {
        "RightId": 191,
        "Name": "Gratuity",
        "Access": false
      },
      {
        "RightId": 192,
        "Name": "Discount",
        "Access": false
      },
      {
        "RightId": 193,
        "Name": "Email",
        "Access": false
      },
      {
        "RightId": 194,
        "Name": "Card",
        "Access": false
      },
      {
        "RightId": 195,
        "Name": "Gift Card",
        "Access": false
      },
      {
        "RightId": 196,
        "Name": "Loyalty",
        "Access": false
      },
      {
        "RightId": 197,
        "Name": "Voucher",
        "Access": false
      },
      {
        "RightId": 198,
        "Name": "Bill Split",
        "Access": false
      },
      {
        "RightId": 199,
        "Name": "Void",
        "Access": false
      },
      {
        "RightId": 200,
        "Name": "Reprint",
        "Access": false
      },
      {
        "RightId": 211,
        "Name": "Complementary Item",
        "Access": false
      }
    ]
  },
  "Setting": {
    "Currency": "SAR",
    "IndustryType": "Restaurant",
    "ServiceCharges": 0.0,
    "Tax": 0.0,
    "TaxId": "-",
    "PriceIncludeTax": false,
    "OpeningTime": "11:00:00",
    "ClosingTime": "01:00:00"
  },
  "Taxes": [
    {
      "Name": "Tobacco Tax",
      "Value": 100.0,
      "IsActive": true
    }
  ],
  "OrderNoPrefix": "51",
  "Status": 1,
  "Desc": "Success"
}

text/json

Sample:

{
  "User": {
    "SubUserId": 1,
    "UserType": "sample string 2",
    "Designation": "sample string 3",
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "Passcode": 6,
    "OrderNoPrefix": "sample string 7",
    "StartingOrderNo": 1,
    "Rights": [
      {
        "RightId": 1,
        "Name": "sample string 2",
        "Access": true
      },
      {
        "RightId": 1,
        "Name": "sample string 2",
        "Access": true
      }
    ]
  },
  "Setting": {
    "Currency": "sample string 1",
    "IndustryType": "sample string 2",
    "ServiceCharges": 3.1,
    "Tax": 4.1,
    "TaxId": "sample string 5",
    "PriceIncludeTax": true,
    "OpeningTime": "sample string 7",
    "ClosingTime": "sample string 8",
    "Brand": "sample string 9",
    "Location": "sample string 10"
  },
  "Receipt": {
    "CompanyTitle": "sample string 1",
    "CompanyAddress": "sample string 2",
    "CompanyPhones": "sample string 3",
    "CompanyFax": "sample string 4",
    "CompanyEmail": "sample string 5",
    "CompanyWebsite": "sample string 6",
    "PromotionTagLine": "sample string 7",
    "CompanyTagLine": "sample string 8",
    "CompanyLogoUrl": "sample string 9",
    "Footer": "sample string 10",
    "FacebookLink": "sample string 11",
    "TwitterLink": "sample string 12",
    "InstagramLink": "sample string 13",
    "SnapchatLink": "sample string 14"
  },
  "Taxes": [
    {
      "TaxID": 1,
      "Name": "sample string 2",
      "ArabicName": "sample string 3",
      "PriceIncludedVAT": true,
      "Percentage": 1.1,
      "TaxNumber": "sample string 5",
      "CalculationBy": 0,
      "Type": 0,
      "Status": 1
    },
    {
      "TaxID": 1,
      "Name": "sample string 2",
      "ArabicName": "sample string 3",
      "PriceIncludedVAT": true,
      "Percentage": 1.1,
      "TaxNumber": "sample string 5",
      "CalculationBy": 0,
      "Type": 0,
      "Status": 1
    }
  ],
  "Merchants": [
    {
      "MerchantID": "sample string 1",
      "MerchantName": "sample string 2",
      "MerchantUrl": "sample string 3",
      "MerchantCategory": "sample string 4",
      "Company": "sample string 5",
      "StatusID": 1
    },
    {
      "MerchantID": "sample string 1",
      "MerchantName": "sample string 2",
      "MerchantUrl": "sample string 3",
      "MerchantCategory": "sample string 4",
      "Company": "sample string 5",
      "StatusID": 1
    }
  ],
  "Status": 1,
  "Desc": "sample string 1"
}

text/xml

Sample:

<UserAuthentication xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.Response">
  <Desc>sample string 1</Desc>
  <Status>Success</Status>
  <Merchants xmlns:d2p1="http://schemas.datacontract.org/2004/07/BusinessEntities.Terminal">
    <d2p1:MerchantDto>
      <d2p1:Company>sample string 5</d2p1:Company>
      <d2p1:MerchantCategory>sample string 4</d2p1:MerchantCategory>
      <d2p1:MerchantID>sample string 1</d2p1:MerchantID>
      <d2p1:MerchantName>sample string 2</d2p1:MerchantName>
      <d2p1:MerchantUrl>sample string 3</d2p1:MerchantUrl>
      <d2p1:StatusID>Active</d2p1:StatusID>
    </d2p1:MerchantDto>
    <d2p1:MerchantDto>
      <d2p1:Company>sample string 5</d2p1:Company>
      <d2p1:MerchantCategory>sample string 4</d2p1:MerchantCategory>
      <d2p1:MerchantID>sample string 1</d2p1:MerchantID>
      <d2p1:MerchantName>sample string 2</d2p1:MerchantName>
      <d2p1:MerchantUrl>sample string 3</d2p1:MerchantUrl>
      <d2p1:StatusID>Active</d2p1:StatusID>
    </d2p1:MerchantDto>
  </Merchants>
  <Receipt xmlns:d2p1="http://schemas.datacontract.org/2004/07/BusinessEntities">
    <d2p1:CompanyAddress>sample string 2</d2p1:CompanyAddress>
    <d2p1:CompanyEmail>sample string 5</d2p1:CompanyEmail>
    <d2p1:CompanyFax>sample string 4</d2p1:CompanyFax>
    <d2p1:CompanyLogoUrl>sample string 9</d2p1:CompanyLogoUrl>
    <d2p1:CompanyPhones>sample string 3</d2p1:CompanyPhones>
    <d2p1:CompanyTagLine>sample string 8</d2p1:CompanyTagLine>
    <d2p1:CompanyTitle>sample string 1</d2p1:CompanyTitle>
    <d2p1:CompanyWebsite>sample string 6</d2p1:CompanyWebsite>
    <d2p1:FacebookLink>sample string 11</d2p1:FacebookLink>
    <d2p1:Footer>sample string 10</d2p1:Footer>
    <d2p1:InstagramLink>sample string 13</d2p1:InstagramLink>
    <d2p1:PromotionTagLine>sample string 7</d2p1:PromotionTagLine>
    <d2p1:SnapchatLink>sample string 14</d2p1:SnapchatLink>
    <d2p1:TwitterLink>sample string 12</d2p1:TwitterLink>
  </Receipt>
  <Setting xmlns:d2p1="http://schemas.datacontract.org/2004/07/BusinessEntities">
    <d2p1:Brand>sample string 9</d2p1:Brand>
    <d2p1:ClosingTime>sample string 8</d2p1:ClosingTime>
    <d2p1:Currency>sample string 1</d2p1:Currency>
    <d2p1:IndustryType>sample string 2</d2p1:IndustryType>
    <d2p1:Location>sample string 10</d2p1:Location>
    <d2p1:OpeningTime>sample string 7</d2p1:OpeningTime>
    <d2p1:PriceIncludeTax>true</d2p1:PriceIncludeTax>
    <d2p1:ServiceCharges>3.1</d2p1:ServiceCharges>
    <d2p1:Tax>4.1</d2p1:Tax>
    <d2p1:TaxId>sample string 5</d2p1:TaxId>
  </Setting>
  <Taxes xmlns:d2p1="http://schemas.datacontract.org/2004/07/BusinessEntities">
    <d2p1:TaxDto>
      <d2p1:ArabicName>sample string 3</d2p1:ArabicName>
      <d2p1:CalculationBy>Invoice</d2p1:CalculationBy>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Percentage>1.1</d2p1:Percentage>
      <d2p1:PriceIncludedVAT>true</d2p1:PriceIncludedVAT>
      <d2p1:Status>Active</d2p1:Status>
      <d2p1:TaxID>1</d2p1:TaxID>
      <d2p1:TaxNumber>sample string 5</d2p1:TaxNumber>
      <d2p1:Type>VAT</d2p1:Type>
    </d2p1:TaxDto>
    <d2p1:TaxDto>
      <d2p1:ArabicName>sample string 3</d2p1:ArabicName>
      <d2p1:CalculationBy>Invoice</d2p1:CalculationBy>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Percentage>1.1</d2p1:Percentage>
      <d2p1:PriceIncludedVAT>true</d2p1:PriceIncludedVAT>
      <d2p1:Status>Active</d2p1:Status>
      <d2p1:TaxID>1</d2p1:TaxID>
      <d2p1:TaxNumber>sample string 5</d2p1:TaxNumber>
      <d2p1:Type>VAT</d2p1:Type>
    </d2p1:TaxDto>
  </Taxes>
  <User xmlns:d2p1="http://schemas.datacontract.org/2004/07/BusinessEntities">
    <d2p1:Designation>sample string 3</d2p1:Designation>
    <d2p1:FirstName>sample string 4</d2p1:FirstName>
    <d2p1:LastName>sample string 5</d2p1:LastName>
    <d2p1:OrderNoPrefix>sample string 7</d2p1:OrderNoPrefix>
    <d2p1:Passcode>6</d2p1:Passcode>
    <d2p1:Rights>
      <d2p1:RightsDto>
        <d2p1:Access>true</d2p1:Access>
        <d2p1:Name>sample string 2</d2p1:Name>
        <d2p1:RightId>1</d2p1:RightId>
      </d2p1:RightsDto>
      <d2p1:RightsDto>
        <d2p1:Access>true</d2p1:Access>
        <d2p1:Name>sample string 2</d2p1:Name>
        <d2p1:RightId>1</d2p1:RightId>
      </d2p1:RightsDto>
    </d2p1:Rights>
    <d2p1:StartingOrderNo>1</d2p1:StartingOrderNo>
    <d2p1:SubUserId>1</d2p1:SubUserId>
    <d2p1:UserType>sample string 2</d2p1:UserType>
  </User>
</UserAuthentication>