POST api/external-users/{ecommerceName}/signin

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ecommerceName

string

None.

Body Parameters

SigninData
NameDescriptionTypeAdditional information
Username

string

None.

Password

string

None.

AppID

globally unique identifier

None.

AppBranchOfficeID

integer

None.

TerminalID

integer

None.

SoftwareName

string

None.

SoftwareVersion

string

None.

WindowsUserName

string

None.

TerminalMacAddress

Collection of string

None.

Request Formats

application/json, text/json

Sample:
{
  "Username": "sample string 1",
  "Password": "sample string 2",
  "AppID": "943cc671-e7f1-44a0-a86d-19b97a1663c0",
  "AppBranchOfficeID": 1,
  "TerminalID": 1,
  "SoftwareName": "sample string 3",
  "SoftwareVersion": "sample string 4",
  "WindowsUserName": "sample string 5",
  "TerminalMacAddress": [
    "sample string 1",
    "sample string 2"
  ]
}

text/xml

Sample:
<SigninData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StackBase.Common.Data">
  <AppBranchOfficeID>1</AppBranchOfficeID>
  <AppID>943cc671-e7f1-44a0-a86d-19b97a1663c0</AppID>
  <Password>sample string 2</Password>
  <SoftwareName>sample string 3</SoftwareName>
  <SoftwareVersion>sample string 4</SoftwareVersion>
  <TerminalID>1</TerminalID>
  <TerminalMacAddress xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </TerminalMacAddress>
  <Username>sample string 1</Username>
  <WindowsUserName>sample string 5</WindowsUserName>
</SigninData>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

string

Response Formats

application/json, text/json

Sample:
"sample string 1"

text/xml

Sample:
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>