PUT api/v100/users/{userguid}

Update User Information and Reset PIN and or password.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
userguid

User Guid.

string

Required

Headers

NameDescriptionTypeAdditional information
appkey

Ej. abcdefghijk

None.

session

Ej. 1234567890

None.

Body Parameters

RqUsersInformationAndPIN
NameDescriptionTypeAdditional information
userName

User Display for Receipts and emails

string

None.

requestClearPIN

Flag to request to start a PIN reset process.

boolean

None.

requestClearPassword

Flag to request to start a PSW reset process.

boolean

None.

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.

numberSitesToLocate

Quantity of sites displayed on each search.

integer

None.

language

Language ISO Code.

string

String length: inclusive between 0 and 5

idCountry

FK al IDCountry

integer

Required

networkAccounts

List of Network Accounts associated to the user

Collection of NetworkAccounts

None.

Request Formats

application/json, text/json

Sample:
{
  "userName": "sample string 1",
  "requestClearPIN": true,
  "requestClearPassword": true,
  "displayReceiptOnSale": true,
  "emailReceiptOnSale": true,
  "receiptEmail": "sample string 2",
  "lowBalanceThreshold": 1.0,
  "fullTankAmount": 1.0,
  "receiptPageSize": 3,
  "numberSitesToLocate": 4,
  "language": "sample string 5",
  "idCountry": 6,
  "networkAccounts": [
    {
      "id": 1,
      "providerID": "sample string 2",
      "name": "sample string 3"
    },
    {
      "id": 1,
      "providerID": "sample string 2",
      "name": "sample string 3"
    }
  ]
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'RqUsersInformationAndPIN'.

Response Information

Resource Description

RsUsersInformationAndPIN
NameDescriptionTypeAdditional information
result

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

Result

Required

Response Formats

application/json, text/json

Sample:
{
  "result": null
}