POST api/authenticate/terminal

Authenticate code for terminal

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Code	terminal unique code	string	None.
IdentifierForVendor	Unique Identity of device	string	None.

Request Formats

application/json

Sample:

{
  "Code": "224124851",
  "IdentifierForVendor": "sample"
}

text/json

Sample:

{
  "Code": "sample string 1",
  "IdentifierForVendor": "sample string 2"
}

text/xml

Sample:

<RTerminal xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.Requests">
  <Code>sample string 1</Code>
  <IdentifierForVendor>sample string 2</IdentifierForVendor>
</RTerminal>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AuthenticationDto

Name	Description	Type	Additional information
Terminal	Terminal details with users	TerminalDto	None.
Receipt	Receipt data	ReceiptDto	None.
Setting	Setting from admin panel	SettingDto	None.
Status	Status for response	RStatus	None.
Desc	description of response	string	None.

Response Formats

application/json

Sample:

{
    "Status": 1,
    "Desc": "Success",
  "Terminal": {
    "TerminalID": 2,
    "RefCode": "C02",
    "TerminalName": "Cashier # 2",
    "DeviceType": "POS",
    "StatusID": 1,
    "IsUsed": true,
    "CompanyCode": "POS-87RCHB",
    "AuthenticatedCode": "POS-87RCHB2112636797136891707973",
    "TransactionPrefix": "MarnBL1C02",
    "Users": [
      {
        "SubUserID": 1,
        "UserType": "App",
        "Designation": "Manager",
        "FirstName": "Muhammad",
        "LastName": "Ahsan",
        "Passcode": 1234,
        "Rights": []
      },
      {
        "SubUserID": 4,
        "UserType": "App",
        "Designation": "Manager",
        "FirstName": "Muhammad",
        "LastName": "Bilal",
        "Passcode": 3456,
        "Rights": []
      }
    ]
  },
    "Receipt": {
        "CompanyTitle": null,
        "CompanyAddress": null,
        "CompanyPhones": null,
        "CompanyFax": null,
        "CompanyEmail": null,
        "CompanyWebsite": null,
        "PromotionTagLine": null,
        "CompanyTagLine": null,
        "CompanyLogoUrl": null,
        "Footer": null,
        "FacebookLink": null,
        "TwitterLink": null,
        "InstagramLink": null,
        "SnapchatLink": null
    },
    "Setting": {
        "Currency": "SAR",
        "IndustryType": "Restaurant",
        "ServiceCharges": 0,
        "Tax": 0,
        "TaxId": "-",
        "PriceIncludeSetting": false
    }
}

text/json

Sample:

{
  "Terminal": {
    "TerminalId": 1,
    "RefCode": "sample string 2",
    "TerminalName": "sample string 3",
    "DeviceType": "sample string 4",
    "StatusId": 5,
    "IsUsed": true,
    "CompanyCode": "sample string 7",
    "AuthenticatedCode": "sample string 8",
    "TransactionPrefix": "sample string 9",
    "Users": [
      {
        "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
          }
        ]
      },
      {
        "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
          }
        ]
      }
    ]
  },
  "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"
  },
  "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"
  },
  "Status": 1,
  "Desc": "sample string 1"
}

text/xml

Sample:

<AuthenticationDto 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>
  <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>
  <Terminal xmlns:d2p1="http://schemas.datacontract.org/2004/07/BusinessEntities">
    <d2p1:AuthenticatedCode>sample string 8</d2p1:AuthenticatedCode>
    <d2p1:CompanyCode>sample string 7</d2p1:CompanyCode>
    <d2p1:DeviceType>sample string 4</d2p1:DeviceType>
    <d2p1:IsUsed>true</d2p1:IsUsed>
    <d2p1:RefCode>sample string 2</d2p1:RefCode>
    <d2p1:StatusId>5</d2p1:StatusId>
    <d2p1:TerminalId>1</d2p1:TerminalId>
    <d2p1:TerminalName>sample string 3</d2p1:TerminalName>
    <d2p1:TransactionPrefix>sample string 9</d2p1:TransactionPrefix>
    <d2p1:Users>
      <d2p1:SubUserDto>
        <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>
      </d2p1:SubUserDto>
      <d2p1:SubUserDto>
        <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>
      </d2p1:SubUserDto>
    </d2p1:Users>
  </Terminal>
</AuthenticationDto>