GET api/v100/users/{userguid}

Get a previously registered user.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
userguid

User Guid.

string

Required

Headers

NameDescriptionTypeAdditional information
appkey

Ej. abcdefghijk

None.

session

Ej. 1234567890

None.

Body Parameters

None.

Response Information

Resource Description

RsUsers
NameDescriptionTypeAdditional information
id

Identifier

integer

Required

userGuid

User Guid

string

Required

name

User Name

string

Required

email

Email

string

Required

displayReceiptOnSale

Display automatically a receipt after each transaction on mobile device.

boolean

None.

emailReceiptOnSale

Send automatically a receipt after each transaction.

boolean

None.

receiptEmail

List of users that will receive the receipt email is EmailReceiptOnSale is true.

string

None.

lowBalanceThreshold

If the user account balance is below this threshold, an email will be sent to the user.

decimal number

None.

fullTankAmount

Dafault value for each transaction.

decimal number

None.

receiptPageSize

Quantity of receipts displayed on each page.

integer

None.

language

Language ISO Code.

string

String length: inclusive between 0 and 5

numberSitesToLocate

Language ISO Code.

integer

String length: inclusive between 0 and 5

idCountry

id Country of the Country

integer

Required

status

User Status

integer

Required

rsSessionTK

User Status

RsSessionTK

Required

result

Includes Result Code Information. See Return Codes Section below. RsResultUsed

Result

Required

debug

Returns the FEP URL, allow null

string

String length: inclusive between 0 and 50

networkAccounts

List of Network Accounts associated to the user

None.

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "userGuid": "sample string 2",
  "name": "sample string 3",
  "email": "sample string 4",
  "displayReceiptOnSale": true,
  "emailReceiptOnSale": true,
  "receiptEmail": "sample string 5",
  "lowBalanceThreshold": 1.0,
  "fullTankAmount": 1.0,
  "receiptPageSize": 1,
  "language": "sample string 6",
  "numberSitesToLocate": 7,
  "idCountry": 8,
  "status": 9,
  "rsSessionTK": {
    "sessionTK": "sample string 1",
    "userGuid": "sample string 2"
  },
  "result": null,
  "debug": "sample string 10",
  "networkAccounts": [
    {
      "id": 1,
      "providerID": "sample string 2",
      "name": "sample string 3"
    },
    {
      "id": 1,
      "providerID": "sample string 2",
      "name": "sample string 3"
    }
  ]
}