TrakIT API‎ > ‎Pending API‎ > ‎

Get Entity

The below API is used to get Entity.


Request: GET

Signature: /api/mobile/GetEntityV2?Token={Login_Token}&EntID={Entity_ID}


Sample: /api/mobile/GetEntityV2?Token=P7pTwGldPWzxvDcmYCQ==&EntID=13

Response: 

{
    "Code": 1,
    "Info": null,
    "RowsAffected": 0,
    "Scalar": null,
    "Identity": 0,
    "RetInfo": [
        {
            "Type": "Field",
            "Name": "Entity ID",
            "Value": "1602",
            "Active": true,
            "IsEditable": false,
            "Code": "ENTITYID",
            "DataType": "Text",
            "Remarks": null,
            "MultiSelect": null,
            "ListValues": null,
            "AutoComplete": null
        },
        {
            "Type": "Field",
            "Name": "Entity Code",
            "Value": "OV5",
            "Active": true,
            "IsEditable": true,
            "Code": "CODE",
            "DataType": "Text",
            "Remarks": null,
            "MultiSelect": null,
            "ListValues": null,
            "AutoComplete": null
        },
        {
            "Type": "Field",
            "Name": "Entity Name",
            "Value": "Tov_5",
            "Active": true,
            "IsEditable": true,
            "Code": "NAME",
            "DataType": "Text",
            "Remarks": null,
            "MultiSelect": null,
            "ListValues": null,
            "AutoComplete": null
        },
        {
            "Type": "Field",
            "Name": "Country",
            "Value": "South Africa",
            "Active": true,
            "IsEditable": true,
            "Code": "COUNTRY",
            "DataType": "Text",
            "Remarks": null,
            "MultiSelect": null,
            "ListValues": null,
            "AutoComplete": true
        },
        {
            "Type": "Field",
            "Name": "Account Number",
            "Value": "43647657658",
            "Active": true,
            "IsEditable": true,
            "Code": "ACCOUNTNUMBER",
            "DataType": "Text",
            "Remarks": null,
            "MultiSelect": null,
            "ListValues": null,
            "AutoComplete": null
        },
        {
            "Type": "Field",
            "Name": "Postal Address",
            "Value": "Random Address",
            "Active": true,
            "IsEditable": true,
            "Code": "POSTALADDRESS",
            "DataType": "Text",
            "Remarks": null,
            "MultiSelect": null,
            "ListValues": null,
            "AutoComplete": null
        },
        {
            "Type": "Field",
            "Name": "Email Address(es)",
            "Value": "a2@gmail.com;b2@gmail.com;c2@gmail.com",
            "Active": true,
            "IsEditable": true,
            "Code": "EMAIL",
            "DataType": "Text",
            "Remarks": null,
            "MultiSelect": null,
            "ListValues": null,
            "AutoComplete": null
        },
        {
            "Type": "Field",
            "Name": "TIN",
            "Value": "gddyy54ytrhghgf",
            "Active": true,
            "IsEditable": true,
            "Code": "TIN",
            "DataType": "Text",
            "Remarks": null,
            "MultiSelect": null,
            "ListValues": null,
            "AutoComplete": null
        },
        {
            "Type": "Field",
            "Name": "Enable API Access",
            "Value": "No",
            "Active": true,
            "IsEditable": true,
            "Code": "ENABLEAPIACCESS",
            "DataType": "Boolean",
            "Remarks": null,
            "MultiSelect": null,
            "ListValues": null,
            "AutoComplete": null
        },
        {
            "Type": "Field",
            "Name": "Phone Numbers",
            "Value": "3434536456,5756786798679;7897809980",
            "Active": true,
            "IsEditable": true,
            "Code": "PHONE",
            "DataType": "Text",
            "Remarks": null,
            "MultiSelect": null,
            "ListValues": null,
            "AutoComplete": null
        },
        {
            "Type": "Field",
            "Name": "Contact Person(s)",
            "Value": "John,Alfred,Mathew;New",
            "Active": true,
            "IsEditable": true,
            "Code": "CONTACTPERSON",
            "DataType": "Text",
            "Remarks": null,
            "MultiSelect": null,
            "ListValues": null,
            "AutoComplete": null
        },
        {
            "Type": "Field",
            "Name": "Currency",
            "Value": "United States Dollar",
            "Active": true,
            "IsEditable": true,
            "Code": "CURRENCY",
            "DataType": "Text",
            "Remarks": null,
            "MultiSelect": null,
            "ListValues": null,
            "AutoComplete": true
        },
        {
            "Type": "Field",
            "Name": "Remarks",
            "Value": "This is remarks",
            "Active": true,
            "IsEditable": true,
            "Code": "REMARKS",
            "DataType": "Text",
            "Remarks": null,
            "MultiSelect": null,
            "ListValues": null,
            "AutoComplete": null
        },
        {
            "Type": "Field",
            "Name": "Disable",
            "Value": "Yes",
            "Active": true,
            "IsEditable": true,
            "Code": "DISABLE",
            "DataType": "Boolean",
            "Remarks": null,
            "MultiSelect": null,
            "ListValues": null,
            "AutoComplete": null
        }
    ]
}


Things to know about this API:
    • Token - You can use Login API to get token displayed under Info

    • EntID

    • Definition of each attribute for Field:

    • Attribute  Description
      Name Name of the field
      Value Current value stored in it
      Active It is a Boolean field. All the fields will be default True
      IsEditable It is a Boolean field. It will be True if the user has access to Update action. It will be by default False  where code is ENTITYID
      Code Unique code assigned to the Field
      DataType It will be by Text or Boolean
      Remarks It will be by default null
      MultiSelect It will be by default null
      ListValues If ListValues has some values, then it is single select list
      AutoComplete

    • Definition of each attribute for Data:

    • Attribute  Description
      Name Name of the field
      Value Current value stored in it
      Active It is a Boolean field.
      IsEditable It is a Boolean field. It will be True if the user has access to Update Entity Data action.
      Code Unique code assigned to the Data
      DataType Possible values will be Text, Date, Number, Currency and HyperLink
      Remarks Current remarks store in it.
      MultiSelect Possible values are null or greater than 0.

      • When MultiSelect is Null and ListValues is also Null, then it can be a Text or Numeric Field
      • When MultiSelect is Null and ListValues has some list in it, then it is Single Select
      • When MultiSelect is greater than 0 and ListValues has some list in it, then it is Multi Select

      ListValues It will have a list in case of Single Select Or Multi Select
      AutoComplete


    Comments