POST api/Login/Login

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
username	string	None.
password	string	None.
tenantId	string	None.
access_token	string	None.
IFAID	string	None.
statusCode	string	None.
statusMessage	string	None.

Request Formats

application/json, text/json

Sample:

{
  "username": "sample string 1",
  "password": "sample string 2",
  "tenantId": "sample string 3",
  "access_token": "sample string 4",
  "IFAID": "sample string 5",
  "statusCode": "sample string 6",
  "statusMessage": "sample string 7"
}

application/xml, text/xml

Sample:

<LoginInputInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WMFinauraAPIwrapper.Models">
  <IFAID>sample string 5</IFAID>
  <access_token>sample string 4</access_token>
  <statusCode>sample string 6</statusCode>
  <statusMessage>sample string 7</statusMessage>
  <tenantId>sample string 3</tenantId>
  <password>sample string 2</password>
  <username>sample string 1</username>
</LoginInputInfo>

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

Response Information

Resource Description

LoginOutputInfo

Name	Type	Additional information
finResult	FinResult	None.
access_token	string	None.
statusMessage	string	None.
statusCode	string	None.
error	string	None.

Response Formats

application/json, text/json

Sample:

{
  "finResult": {
    "count": 1,
    "start": 2,
    "result": {
      "userID": 1,
      "firstName": "sample string 2",
      "lastName": "sample string 3",
      "entityName": "sample string 4",
      "photoURL": "sample string 5",
      "sessionID": "sample string 6",
      "userName": "sample string 7",
      "entityType": "sample string 8",
      "admin": "sample string 9",
      "isfirstTimeLogin": true,
      "isRetiretmentFlag": true,
      "isTaxPlanningFlag": true,
      "isRetiretmentPortfolioGenerated": "sample string 13",
      "kyc": "sample string 14",
      "pan": "sample string 15",
      "kycMessgae": "sample string 16",
      "dob": "sample string 17",
      "emailId": "sample string 18",
      "mobile": "sample string 19",
      "userRoles": [
        {
          "rollId": "sample string 1",
          "user": "sample string 2",
          "userRole": "sample string 3"
        },
        {
          "rollId": "sample string 1",
          "user": "sample string 2",
          "userRole": "sample string 3"
        }
      ],
      "organization": {
        "tenantid": 1,
        "orgName": "sample string 2",
        "description": "sample string 3",
        "address": "sample string 4",
        "country": "sample string 5",
        "city": "sample string 6",
        "state": "sample string 7",
        "pinCode": "sample string 8",
        "superAdminLoginnId": "sample string 9",
        "createdByOid": "sample string 10",
        "createdOn": "sample string 11",
        "lastModifiedByOid": "sample string 12",
        "lastModifiedOn": "sample string 13",
        "subDomain": "sample string 14",
        "status": "sample string 15",
        "logoUrl": "sample string 16",
        "noOfUser": "sample string 17",
        "permissions": {
          "rebalancer": true,
          "analytics": {
            "analytics": true,
            "searchScheme": true,
            "mfTools": {
              "stockSearch": true,
              "creditQuality": true,
              "mostPopularStocks": true,
              "mfTools": true,
              "detailedPortfolio": true,
              "equitySector": true
            },
            "advSearchScheme": true
          },
          "portfolioGeneration": {
            "blackliterman": true,
            "portfolioGeneration": true,
            "mvo": true
          },
          "ranking": true,
          "settings": true,
          "retirement": true,
          "thematic": true,
          "casUpload": true
        },
        "subDomainType": "sample string 18"
      },
      "authTokenInfo": {
        "access_token": "sample string 1",
        "token_type": "sample string 2",
        "refresh_token": "sample string 3",
        "expires_in": 4,
        "scope": "sample string 5"
      },
      "income": "sample string 20",
      "investorId": "sample string 21",
      "riskAssessmentClassResponse": {
        "MaxRiskScore": 1,
        "RiskCategoryDescription": "sample string 2",
        "MinRiskScore": 3,
        "RiskCategoryName": "sample string 4",
        "AvgRiskScore": 5,
        "RiskCategoryId": 6,
        "RiskCategoryAbbreviation": "sample string 7"
      },
      "isSelfKycFlag": true,
      "userType": "sample string 23",
      "isResetPassword": true,
      "isNri": true,
      "isin": "sample string 26",
      "color": "sample string 27",
      "quartile": "sample string 28"
    }
  },
  "access_token": "sample string 1",
  "statusMessage": "sample string 2",
  "statusCode": "sample string 3",
  "error": "sample string 4"
}

application/xml, text/xml

Sample:

<LoginOutputInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WMFinauraAPIwrapper.Models">
  <access_token>sample string 1</access_token>
  <error>sample string 4</error>
  <statusCode>sample string 3</statusCode>
  <statusMessage>sample string 2</statusMessage>
  <finResult>
    <count>1</count>
    <result>
      <admin>sample string 9</admin>
      <authTokenInfo>
        <access_token>sample string 1</access_token>
        <expires_in>4</expires_in>
        <refresh_token>sample string 3</refresh_token>
        <scope>sample string 5</scope>
        <token_type>sample string 2</token_type>
      </authTokenInfo>
      <color>sample string 27</color>
      <dob>sample string 17</dob>
      <emailId>sample string 18</emailId>
      <entityName>sample string 4</entityName>
      <entityType>sample string 8</entityType>
      <firstName>sample string 2</firstName>
      <income>sample string 20</income>
      <investorId>sample string 21</investorId>
      <isNri>true</isNri>
      <isResetPassword>true</isResetPassword>
      <isRetiretmentFlag>true</isRetiretmentFlag>
      <isRetiretmentPortfolioGenerated>sample string 13</isRetiretmentPortfolioGenerated>
      <isSelfKycFlag>true</isSelfKycFlag>
      <isTaxPlanningFlag>true</isTaxPlanningFlag>
      <isfirstTimeLogin>true</isfirstTimeLogin>
      <isin>sample string 26</isin>
      <kyc>sample string 14</kyc>
      <kycMessgae>sample string 16</kycMessgae>
      <lastName>sample string 3</lastName>
      <mobile>sample string 19</mobile>
      <organization>
        <address>sample string 4</address>
        <city>sample string 6</city>
        <country>sample string 5</country>
        <createdByOid>sample string 10</createdByOid>
        <createdOn>sample string 11</createdOn>
        <description>sample string 3</description>
        <lastModifiedByOid>sample string 12</lastModifiedByOid>
        <lastModifiedOn>sample string 13</lastModifiedOn>
        <logoUrl>sample string 16</logoUrl>
        <noOfUser>sample string 17</noOfUser>
        <orgName>sample string 2</orgName>
        <permissions>
          <analytics>
            <advSearchScheme>true</advSearchScheme>
            <analytics>true</analytics>
            <mfTools>
              <creditQuality>true</creditQuality>
              <detailedPortfolio>true</detailedPortfolio>
              <equitySector>true</equitySector>
              <mfTools>true</mfTools>
              <mostPopularStocks>true</mostPopularStocks>
              <stockSearch>true</stockSearch>
            </mfTools>
            <searchScheme>true</searchScheme>
          </analytics>
          <casUpload>true</casUpload>
          <portfolioGeneration>
            <blackliterman>true</blackliterman>
            <mvo>true</mvo>
            <portfolioGeneration>true</portfolioGeneration>
          </portfolioGeneration>
          <ranking>true</ranking>
          <rebalancer>true</rebalancer>
          <retirement>true</retirement>
          <settings>true</settings>
          <thematic>true</thematic>
        </permissions>
        <pinCode>sample string 8</pinCode>
        <state>sample string 7</state>
        <status>sample string 15</status>
        <subDomain>sample string 14</subDomain>
        <subDomainType>sample string 18</subDomainType>
        <superAdminLoginnId>sample string 9</superAdminLoginnId>
        <tenantid>1</tenantid>
      </organization>
      <pan>sample string 15</pan>
      <photoURL>sample string 5</photoURL>
      <quartile>sample string 28</quartile>
      <riskAssessmentClassResponse>
        <AvgRiskScore>5</AvgRiskScore>
        <MaxRiskScore>1</MaxRiskScore>
        <MinRiskScore>3</MinRiskScore>
        <RiskCategoryAbbreviation>sample string 7</RiskCategoryAbbreviation>
        <RiskCategoryDescription>sample string 2</RiskCategoryDescription>
        <RiskCategoryId>6</RiskCategoryId>
        <RiskCategoryName>sample string 4</RiskCategoryName>
      </riskAssessmentClassResponse>
      <sessionID>sample string 6</sessionID>
      <userID>1</userID>
      <userName>sample string 7</userName>
      <userRoles>
        <UserRoles>
          <rollId>sample string 1</rollId>
          <user>sample string 2</user>
          <userRole>sample string 3</userRole>
        </UserRoles>
        <UserRoles>
          <rollId>sample string 1</rollId>
          <user>sample string 2</user>
          <userRole>sample string 3</userRole>
        </UserRoles>
      </userRoles>
      <userType>sample string 23</userType>
    </result>
    <start>2</start>
  </finResult>
</LoginOutputInfo>