Merchanter API - User Accounts
Written by Ian Oldrey
Updated at December 21st, 2022
User Accounts
-
GET operations
-
/Accounts/me – Retrieve information relating to the current user account
- Parameters – none
- Response schema & body (JSON)
-
/Accounts/me – Retrieve information relating to the current user account
Attribute Name |
Data Type |
Max Length |
Notes |
Response Body (JSON) |
|---|---|---|---|---|
FullName |
String |
200 |
Full name of the user account |
{ "FullName": "", “EmailAddress”: “”, "IsLocalUser": false, "IsMultiLedgerUser": false, "IsSharedLogin": false, "Name": "", "IsWebServiceUser": false } |
EmailAddress |
String |
200 |
|
|
IsLocalUser |
Boolean |
|
Is this a local (normal login) user account? |
|
IsMultiLedgerUser |
Boolean |
|
Do we need to show the name of the user’s ledger in the user profile on screen? |
|
IsSharedLogin |
Boolean |
|
User account to be accessed from a shared terminal? |
|
Name |
String |
100 |
Shorter name of the user account |
|
IsWebServiceUser |
Boolean |
|
Is this a web service user account? |
Authentication
At the time of writing this document, the Merchanter API service uses basic authentication. This allows the clients to authenticate themselves by providing a username and password in the Authorization HTTP header.
Operations
Content Types
GET operations can send data in either XML (the default) or JSON format. If JSON is required, the request must be sent with an Accept HTTP header and the value “application/json”.
POST/PUT operations can receive data in either XML (the default) or JSON format. If JSON is required, the request must be sent with a Content-Type HTTP header and the value “application/json”.
Endpoints
The URL of every endpoint always starts with a base url:-
{Merchanter application url}/rest/api.merch/v1
Only the relative URL is shown for each endpoint.