Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Authenticate the user with the system and obtain the GUID


Endpoint URL

Wiki Markup
{BaseURL would be provided by admin}/api/UserLogin/Login

base URL address should be before the URL, check the example

MethodURL
POST{base url}/api/UserLogin/Login


Query parameters

Type

Params

Values

POST

Dbid

database ID would be provided by admin

POST

Username

The user you want to login into the system with

POST

Password

Password would be Evolution password of the user

Example requests

https://backend/api/UserLogin/Login

Body:

{
    "dbid"8,
    "username""Admin",
    "password""<<PASSWORD HERE>>"
}

Example responses

{
    "username""Administrator",
    "userId"1,
    "guid""57cda7c9-a138-4ac5-98e1-37b82ef0a90f",
    "supplierId"7430,
    "defaultWFEC"0,
    "defaultWFCA"0,
    "isSuperUser"true,
    "isForeign"false,
    "currentDatabase""Demo - Asamco BV - EPO - Evo",
    "companyName""Asamco BV",
    "permissions": {
        "evolutionUserId"0,
        "agentType"null,
        "sU"false,
        "canChangeTax"true,
        "canSubmitPO"true,
        "canSubmitCN"true,
        "canSubmitCA"true,
        "canSubmitEC"true,
        "canSubmitRTS"true,
        "canSubmitSO"true,
        "canAuthorizePOBatches"false,
        "canSubmitRequisition"true,
        "canSubmitRFQ"true,
        "canRequestSupplier"true,
        "canProcessRequisition"true,
        "canConfirmQty"true,
        "canEditApprovedDocuments"false,
        "isAuditProfile"false,
        "canViewAllPendingRequisitions"false,
        "canViewAllPendingDocuments"false,
        "canViewAllHistoryDocuments"false,
        "canEditAllPendingRequisitions"false,
        "canEditAllPendingDocuments"false,
        "canChangeApplicationSettings"false,
        "canProcessEpoRequests"false,
        "allow_Edit_On_Approval"true,
        "allow_Process_RFQ_To_PO"true,
        "allow_Process_RFQ_To_SOQ"true,
        "allow_Evaluating_RFQ"true,
        "allow_Approval_RFQ"true,
        "canChangeQty"true,
        "allow_to_Override_Price_PO"true,
        "allow_to_Override_Price_SO"true,
        "allow_to_Override_Price_CN"true,
        "allow_to_Override_Price_RTS"true,
        "canRequestPaymentBatch"true,
        "canAuthorizePaymentBatch"true,
        "canAddNewSupplier"true,
        "canDebitBatch"true,
        "allow_Receive_Stock"false,
        "goods_Receive_Voucher_Permissions"true,
        "allow_To_Place_Order_When_Supplier_On_Hold"true,
        "allow_To_Place_Order_When_Customer_On_Hold"true,
        "canChangeUserDefinedFields"true,
        "canChangeWorkflows"true,
        "purchase_Invoice_Processing"true,
        "return_to_Supplier_Processing"true,
        "credit_Note_Processing"true,
        "sales_Invoice_Processing"true,
        "gRV_Processing"true,
        "allow_to_Cancel_Purchase_Orders"true,
        "allow_to_Cancel_Sales_Orders"true,
        "credit_Note_Allow_to_Override_Exchange_Rate"true,
        "purchase_Order_Allow_to_Override_Exchange_Rate"true,
        "return_to_Supplier_Allow_to_Override_Exchange_Rate"true,
        "sales_Order_Allow_to_Override_Exchange_Rate"true,
        "random_Supplier_Selection_Override"false,
        "generate_RFQ_For_Supplier"false,
        "prospective_Supplier"false,
        "sector_Management"false,
        "access_General_Ledger_Reports"true,
        "allow_to_Override_PO_Incident_Type"false,
        "allow_Requisition_to_PO_Supplier_Override"false,
        "allow_to_Post_Requisition_when_Supplier_On_Hold"false,
        "accounts_Receivable_Process_Batch"true,
        "accounts_Payable_Process_Batch"true,
        "accounts_Receivable_Allow_Allocation"true,
        "accounts_Payable_Allow_Allocation"true,
        "allow_to_Create_Purchase_Order_from_Sales_Order"true,
        "systemAdmin"true
    },
    "hRAvailable"false,
    "showAllBranches"false,
    "defaultBranchId"0,
    "isSupplierGateway"false,
    "allowedViewWorkflows"null,
    "defaultSalesRepId"0,
    "defaultWarehouseId"9,
    "defaultClientId"0
}


Response fields

in response you get the list of permissions and 

The most important one is the GUID which would be used to authenticate the other calls