POST api/v100/users

Request Information

URI Parameters

None.

Headers

Name	Description	Type	Additional information
appkey	Ej. abcdefghijk		None.
session	Ej. 1234567890		None.

Body Parameters

RqUsers

Name	Description	Type	Additional information
name	User Name	string	Required String length: inclusive between 0 and 100
email	Email	string	Required String length: inclusive between 0 and 50
pin	PIN	string	Required String length: inclusive between 0 and 15
password	Password	string	Required String length: inclusive between 0 and 15
idCountry	FK idCountry	integer	Required
language	Language	string	Required String length: inclusive between 0 and 2
providerID	Provider ID	string	Required
ownerID	ownerID used on the network selected, or null if ubipay	string	String length: inclusive between 0 and 100
ownerAccount	ownerAccount used on the network selected, or null if ubipay	string	String length: inclusive between 0 and 100

Request Formats

application/json, text/json

Sample:

{
  "name": "sample string 1",
  "email": "sample string 2",
  "pin": "sample string 3",
  "password": "sample string 4",
  "idCountry": 5,
  "language": "sample string 6",
  "providerID": "sample string 7",
  "ownerID": "sample string 8",
  "ownerAccount": "sample string 9"
}

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 'RqUsers'.

Response Information

Resource Description

RsUsers

Name	Description	Type	Additional 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"
    }
  ]
}