POST api/v1/authentication/login

Request for authentication for the given username/password using the specified client application and retrieves the session details on successful authentication

Request Information

URI Parameters

None.

Body Parameters

LoginInfo

Name	Description	Type	Additional information
UserName	User Name for the Login operation	string	None.
Password	Password for the Login operation	string	None.
ApplicationID	Application Id	integer	None.
ApplicationVersion	Application Version	string	None.
LocaleCode	Locale code for login	string	None.

Request Formats

application/json, text/json

Sample:

{
  "UserName": "sample string 1",
  "Password": "sample string 2",
  "ApplicationID": 3,
  "ApplicationVersion": "sample string 4",
  "LocaleCode": "sample string 5"
}

application/xml, text/xml

Sample:

<LoginInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2WebAPIController.Models.V1.Authentication">
  <ApplicationID>3</ApplicationID>
  <ApplicationVersion>sample string 4</ApplicationVersion>
  <LocaleCode>sample string 5</LocaleCode>
  <Password>sample string 2</Password>
  <UserName>sample string 1</UserName>
</LoginInfo>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SessionDetailResultsEx

Name	Type	Additional information
ModuleFlags	string	None.
SessionID	string	None.
UserInfo	UserInfoBasic	None.
Locations	Collection of LocationInfoBasicEx	None.
InterfaceSchemaConfigInfo	InterfaceSchemaConfigInfo	None.
ResultCode	integer	None.
ResultData	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ModuleFlags": "sample string 1",
  "SessionID": "sample string 2",
  "UserInfo": {
    "UserID": 1,
    "Username": "sample string 2",
    "Fullname": "sample string 3",
    "Language": 4,
    "LocaleID": 5,
    "UserFeatureList": "sample string 6",
    "ClientPreferences": "sample string 7",
    "IsEulaAccepted": true,
    "IsSMSEulaAccepted": true,
    "DateFormatID": 10,
    "TimeFormatID": 11,
    "PushNotificationStatus": 12,
    "HasResetPassword": true,
    "IsRootedDeviceAccepted": true,
    "IsLocalyticsEnabled": 15,
    "IsAppStoreLogEnabled": 16,
    "IsMarketingOptionEnabled": 17,
    "IsMarketingDefaultValue": 18,
    "IsMonitoringDefaultValue": 19,
    "IsOtpSupported": 20,
    "IsOtpEnabled": 21,
    "UserOtpEmail": "sample string 22",
    "ForceResetPassword": true,
    "UserCodeDirectPushEnabled": true
  },
  "Locations": [
    {
      "LocationID": 1,
      "LocationName": "sample string 2",
      "PhotoURL": "sample string 3",
      "LocationModuleFlags": "sample string 4",
      "SecurityDeviceID": 5,
      "LocationInfoSimple": {
        "LocationId": 1,
        "LocationName": "sample string 2",
        "AccountId": 3,
        "PhotoId": 4,
        "TimeZoneId": 5,
        "PhotoURL": "sample string 6",
        "SetDefaultLocationName": true,
        "SecuritySystemAlias": "sample string 8",
        "SecuritySystemPanelDeviceID": 9,
        "CountryID": 10,
        "StreetNumber": "sample string 11",
        "StreetName": "sample string 12",
        "City": "sample string 13",
        "StateID": 14,
        "PostalCode": "sample string 15",
        "TemperatureUnits": "sample string 16",
        "Latitude": "sample string 17",
        "Longitude": "sample string 18"
      },
      "PanelConnectionStatusInfo": [
        {
          "LocationID": 1,
          "LocationName": "sample string 2",
          "PhotoURL": "sample string 3",
          "ConnectionStatus": 4,
          "SyncStatus": 5,
          "SyncStatusMessage": "sample string 6",
          "ConnectionType": 7,
          "SingnalStrength": 1
        },
        {
          "LocationID": 1,
          "LocationName": "sample string 2",
          "PhotoURL": "sample string 3",
          "ConnectionStatus": 4,
          "SyncStatus": 5,
          "SyncStatusMessage": "sample string 6",
          "ConnectionType": 7,
          "SingnalStrength": 1
        }
      ],
      "DeviceList": [
        {
          "DeviceID": 1,
          "DeviceName": "sample string 2",
          "DeviceClassID": 3,
          "DeviceSerialNumber": "sample string 4",
          "DeviceFlags": "sample string 5",
          "DeviceSerialText": "sample string 7",
          "DeviceType": "sample string 8",
          "DeviceVariants": "sample string 9",
          "RestrictedPanel": 10
        },
        {
          "DeviceID": 1,
          "DeviceName": "sample string 2",
          "DeviceClassID": 3,
          "DeviceSerialNumber": "sample string 4",
          "DeviceFlags": "sample string 5",
          "DeviceSerialText": "sample string 7",
          "DeviceType": "sample string 8",
          "DeviceVariants": "sample string 9",
          "RestrictedPanel": 10
        }
      ]
    },
    {
      "LocationID": 1,
      "LocationName": "sample string 2",
      "PhotoURL": "sample string 3",
      "LocationModuleFlags": "sample string 4",
      "SecurityDeviceID": 5,
      "LocationInfoSimple": {
        "LocationId": 1,
        "LocationName": "sample string 2",
        "AccountId": 3,
        "PhotoId": 4,
        "TimeZoneId": 5,
        "PhotoURL": "sample string 6",
        "SetDefaultLocationName": true,
        "SecuritySystemAlias": "sample string 8",
        "SecuritySystemPanelDeviceID": 9,
        "CountryID": 10,
        "StreetNumber": "sample string 11",
        "StreetName": "sample string 12",
        "City": "sample string 13",
        "StateID": 14,
        "PostalCode": "sample string 15",
        "TemperatureUnits": "sample string 16",
        "Latitude": "sample string 17",
        "Longitude": "sample string 18"
      },
      "PanelConnectionStatusInfo": [
        {
          "LocationID": 1,
          "LocationName": "sample string 2",
          "PhotoURL": "sample string 3",
          "ConnectionStatus": 4,
          "SyncStatus": 5,
          "SyncStatusMessage": "sample string 6",
          "ConnectionType": 7,
          "SingnalStrength": 1
        },
        {
          "LocationID": 1,
          "LocationName": "sample string 2",
          "PhotoURL": "sample string 3",
          "ConnectionStatus": 4,
          "SyncStatus": 5,
          "SyncStatusMessage": "sample string 6",
          "ConnectionType": 7,
          "SingnalStrength": 1
        }
      ],
      "DeviceList": [
        {
          "DeviceID": 1,
          "DeviceName": "sample string 2",
          "DeviceClassID": 3,
          "DeviceSerialNumber": "sample string 4",
          "DeviceFlags": "sample string 5",
          "DeviceSerialText": "sample string 7",
          "DeviceType": "sample string 8",
          "DeviceVariants": "sample string 9",
          "RestrictedPanel": 10
        },
        {
          "DeviceID": 1,
          "DeviceName": "sample string 2",
          "DeviceClassID": 3,
          "DeviceSerialNumber": "sample string 4",
          "DeviceFlags": "sample string 5",
          "DeviceSerialText": "sample string 7",
          "DeviceType": "sample string 8",
          "DeviceVariants": "sample string 9",
          "RestrictedPanel": 10
        }
      ]
    }
  ],
  "InterfaceSchemaConfigInfo": {
    "AppleDownloadURL": "sample string 1",
    "AndroidDownloadURL": "sample string 2",
    "LatestSupportedAppVersion": "sample string 3",
    "Whatsnew": "sample string 4",
    "SignalrHubUrl": "sample string 5",
    "GatewayUrl": "sample string 6",
    "SignalrHubUrlV2": "sample string 7",
    "GatewayUrlV2": "sample string 8",
    "SupportedVersion": 9,
    "UtilityUrl": "sample string 10"
  },
  "ResultCode": 3,
  "ResultData": "sample string 4"
}

application/xml, text/xml

Sample:

<SessionDetailResultsEx xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2WebAPIController.Models.V1.Authentication">
  <ResultCode xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">3</ResultCode>
  <ResultData xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">sample string 4</ResultData>
  <InterfaceSchemaConfigInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain">
    <d2p1:AndroidDownloadURL>sample string 2</d2p1:AndroidDownloadURL>
    <d2p1:AppleDownloadURL>sample string 1</d2p1:AppleDownloadURL>
    <d2p1:GatewayUrl>sample string 6</d2p1:GatewayUrl>
    <d2p1:GatewayUrlV2>sample string 8</d2p1:GatewayUrlV2>
    <d2p1:LatestSupportedAppVersion>sample string 3</d2p1:LatestSupportedAppVersion>
    <d2p1:SignalrHubUrl>sample string 5</d2p1:SignalrHubUrl>
    <d2p1:SignalrHubUrlV2>sample string 7</d2p1:SignalrHubUrlV2>
    <d2p1:SupportedVersion>9</d2p1:SupportedVersion>
    <d2p1:UtilityUrl>sample string 10</d2p1:UtilityUrl>
    <d2p1:Whatsnew>sample string 4</d2p1:Whatsnew>
  </InterfaceSchemaConfigInfo>
  <Locations xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain">
    <d2p1:LocationInfoBasicEx>
      <d2p1:DeviceList>
        <d2p1:DeviceInfoBasic>
          <d2p1:DeviceClassID>3</d2p1:DeviceClassID>
          <d2p1:DeviceFlags>sample string 5</d2p1:DeviceFlags>
          <d2p1:DeviceID>1</d2p1:DeviceID>
          <d2p1:DeviceName>sample string 2</d2p1:DeviceName>
          <d2p1:DeviceSerialNumber>sample string 4</d2p1:DeviceSerialNumber>
          <d2p1:DeviceSerialText>sample string 7</d2p1:DeviceSerialText>
          <d2p1:DeviceType>sample string 8</d2p1:DeviceType>
          <d2p1:DeviceVariants>sample string 9</d2p1:DeviceVariants>
          <d2p1:RestrictedPanel>10</d2p1:RestrictedPanel>
          <d2p1:SecurityPanelTypeID>6</d2p1:SecurityPanelTypeID>
        </d2p1:DeviceInfoBasic>
        <d2p1:DeviceInfoBasic>
          <d2p1:DeviceClassID>3</d2p1:DeviceClassID>
          <d2p1:DeviceFlags>sample string 5</d2p1:DeviceFlags>
          <d2p1:DeviceID>1</d2p1:DeviceID>
          <d2p1:DeviceName>sample string 2</d2p1:DeviceName>
          <d2p1:DeviceSerialNumber>sample string 4</d2p1:DeviceSerialNumber>
          <d2p1:DeviceSerialText>sample string 7</d2p1:DeviceSerialText>
          <d2p1:DeviceType>sample string 8</d2p1:DeviceType>
          <d2p1:DeviceVariants>sample string 9</d2p1:DeviceVariants>
          <d2p1:RestrictedPanel>10</d2p1:RestrictedPanel>
          <d2p1:SecurityPanelTypeID>6</d2p1:SecurityPanelTypeID>
        </d2p1:DeviceInfoBasic>
      </d2p1:DeviceList>
      <d2p1:LocationID>1</d2p1:LocationID>
      <d2p1:LocationInfoSimple>
        <d2p1:AccountId>3</d2p1:AccountId>
        <d2p1:City>sample string 13</d2p1:City>
        <d2p1:CountryID>10</d2p1:CountryID>
        <d2p1:Latitude>sample string 17</d2p1:Latitude>
        <d2p1:LocationId>1</d2p1:LocationId>
        <d2p1:LocationName>sample string 2</d2p1:LocationName>
        <d2p1:Longitude>sample string 18</d2p1:Longitude>
        <d2p1:PhotoId>4</d2p1:PhotoId>
        <d2p1:PhotoURL>sample string 6</d2p1:PhotoURL>
        <d2p1:PostalCode>sample string 15</d2p1:PostalCode>
        <d2p1:SecuritySystemAlias>sample string 8</d2p1:SecuritySystemAlias>
        <d2p1:SecuritySystemPanelDeviceID>9</d2p1:SecuritySystemPanelDeviceID>
        <d2p1:SetDefaultLocationName>true</d2p1:SetDefaultLocationName>
        <d2p1:StateID>14</d2p1:StateID>
        <d2p1:StreetName>sample string 12</d2p1:StreetName>
        <d2p1:StreetNumber>sample string 11</d2p1:StreetNumber>
        <d2p1:TemperatureUnits>sample string 16</d2p1:TemperatureUnits>
        <d2p1:TimeZoneId>5</d2p1:TimeZoneId>
      </d2p1:LocationInfoSimple>
      <d2p1:LocationModuleFlags>sample string 4</d2p1:LocationModuleFlags>
      <d2p1:LocationName>sample string 2</d2p1:LocationName>
      <d2p1:PanelConnectionStatusInfo xmlns:d4p1="http://schemas.datacontract.org/2004/07/TC2Domain.Security">
        <d4p1:PanelConnectionStatusInfo>
          <d4p1:ConnectionStatus>4</d4p1:ConnectionStatus>
          <d4p1:ConnectionType>7</d4p1:ConnectionType>
          <d4p1:LocationID>1</d4p1:LocationID>
          <d4p1:LocationName>sample string 2</d4p1:LocationName>
          <d4p1:PhotoURL>sample string 3</d4p1:PhotoURL>
          <d4p1:SingnalStrength>1</d4p1:SingnalStrength>
          <d4p1:SyncStatus>5</d4p1:SyncStatus>
          <d4p1:SyncStatusMessage>sample string 6</d4p1:SyncStatusMessage>
        </d4p1:PanelConnectionStatusInfo>
        <d4p1:PanelConnectionStatusInfo>
          <d4p1:ConnectionStatus>4</d4p1:ConnectionStatus>
          <d4p1:ConnectionType>7</d4p1:ConnectionType>
          <d4p1:LocationID>1</d4p1:LocationID>
          <d4p1:LocationName>sample string 2</d4p1:LocationName>
          <d4p1:PhotoURL>sample string 3</d4p1:PhotoURL>
          <d4p1:SingnalStrength>1</d4p1:SingnalStrength>
          <d4p1:SyncStatus>5</d4p1:SyncStatus>
          <d4p1:SyncStatusMessage>sample string 6</d4p1:SyncStatusMessage>
        </d4p1:PanelConnectionStatusInfo>
      </d2p1:PanelConnectionStatusInfo>
      <d2p1:PhotoURL>sample string 3</d2p1:PhotoURL>
      <d2p1:SecurityDeviceID>5</d2p1:SecurityDeviceID>
    </d2p1:LocationInfoBasicEx>
    <d2p1:LocationInfoBasicEx>
      <d2p1:DeviceList>
        <d2p1:DeviceInfoBasic>
          <d2p1:DeviceClassID>3</d2p1:DeviceClassID>
          <d2p1:DeviceFlags>sample string 5</d2p1:DeviceFlags>
          <d2p1:DeviceID>1</d2p1:DeviceID>
          <d2p1:DeviceName>sample string 2</d2p1:DeviceName>
          <d2p1:DeviceSerialNumber>sample string 4</d2p1:DeviceSerialNumber>
          <d2p1:DeviceSerialText>sample string 7</d2p1:DeviceSerialText>
          <d2p1:DeviceType>sample string 8</d2p1:DeviceType>
          <d2p1:DeviceVariants>sample string 9</d2p1:DeviceVariants>
          <d2p1:RestrictedPanel>10</d2p1:RestrictedPanel>
          <d2p1:SecurityPanelTypeID>6</d2p1:SecurityPanelTypeID>
        </d2p1:DeviceInfoBasic>
        <d2p1:DeviceInfoBasic>
          <d2p1:DeviceClassID>3</d2p1:DeviceClassID>
          <d2p1:DeviceFlags>sample string 5</d2p1:DeviceFlags>
          <d2p1:DeviceID>1</d2p1:DeviceID>
          <d2p1:DeviceName>sample string 2</d2p1:DeviceName>
          <d2p1:DeviceSerialNumber>sample string 4</d2p1:DeviceSerialNumber>
          <d2p1:DeviceSerialText>sample string 7</d2p1:DeviceSerialText>
          <d2p1:DeviceType>sample string 8</d2p1:DeviceType>
          <d2p1:DeviceVariants>sample string 9</d2p1:DeviceVariants>
          <d2p1:RestrictedPanel>10</d2p1:RestrictedPanel>
          <d2p1:SecurityPanelTypeID>6</d2p1:SecurityPanelTypeID>
        </d2p1:DeviceInfoBasic>
      </d2p1:DeviceList>
      <d2p1:LocationID>1</d2p1:LocationID>
      <d2p1:LocationInfoSimple>
        <d2p1:AccountId>3</d2p1:AccountId>
        <d2p1:City>sample string 13</d2p1:City>
        <d2p1:CountryID>10</d2p1:CountryID>
        <d2p1:Latitude>sample string 17</d2p1:Latitude>
        <d2p1:LocationId>1</d2p1:LocationId>
        <d2p1:LocationName>sample string 2</d2p1:LocationName>
        <d2p1:Longitude>sample string 18</d2p1:Longitude>
        <d2p1:PhotoId>4</d2p1:PhotoId>
        <d2p1:PhotoURL>sample string 6</d2p1:PhotoURL>
        <d2p1:PostalCode>sample string 15</d2p1:PostalCode>
        <d2p1:SecuritySystemAlias>sample string 8</d2p1:SecuritySystemAlias>
        <d2p1:SecuritySystemPanelDeviceID>9</d2p1:SecuritySystemPanelDeviceID>
        <d2p1:SetDefaultLocationName>true</d2p1:SetDefaultLocationName>
        <d2p1:StateID>14</d2p1:StateID>
        <d2p1:StreetName>sample string 12</d2p1:StreetName>
        <d2p1:StreetNumber>sample string 11</d2p1:StreetNumber>
        <d2p1:TemperatureUnits>sample string 16</d2p1:TemperatureUnits>
        <d2p1:TimeZoneId>5</d2p1:TimeZoneId>
      </d2p1:LocationInfoSimple>
      <d2p1:LocationModuleFlags>sample string 4</d2p1:LocationModuleFlags>
      <d2p1:LocationName>sample string 2</d2p1:LocationName>
      <d2p1:PanelConnectionStatusInfo xmlns:d4p1="http://schemas.datacontract.org/2004/07/TC2Domain.Security">
        <d4p1:PanelConnectionStatusInfo>
          <d4p1:ConnectionStatus>4</d4p1:ConnectionStatus>
          <d4p1:ConnectionType>7</d4p1:ConnectionType>
          <d4p1:LocationID>1</d4p1:LocationID>
          <d4p1:LocationName>sample string 2</d4p1:LocationName>
          <d4p1:PhotoURL>sample string 3</d4p1:PhotoURL>
          <d4p1:SingnalStrength>1</d4p1:SingnalStrength>
          <d4p1:SyncStatus>5</d4p1:SyncStatus>
          <d4p1:SyncStatusMessage>sample string 6</d4p1:SyncStatusMessage>
        </d4p1:PanelConnectionStatusInfo>
        <d4p1:PanelConnectionStatusInfo>
          <d4p1:ConnectionStatus>4</d4p1:ConnectionStatus>
          <d4p1:ConnectionType>7</d4p1:ConnectionType>
          <d4p1:LocationID>1</d4p1:LocationID>
          <d4p1:LocationName>sample string 2</d4p1:LocationName>
          <d4p1:PhotoURL>sample string 3</d4p1:PhotoURL>
          <d4p1:SingnalStrength>1</d4p1:SingnalStrength>
          <d4p1:SyncStatus>5</d4p1:SyncStatus>
          <d4p1:SyncStatusMessage>sample string 6</d4p1:SyncStatusMessage>
        </d4p1:PanelConnectionStatusInfo>
      </d2p1:PanelConnectionStatusInfo>
      <d2p1:PhotoURL>sample string 3</d2p1:PhotoURL>
      <d2p1:SecurityDeviceID>5</d2p1:SecurityDeviceID>
    </d2p1:LocationInfoBasicEx>
  </Locations>
  <ModuleFlags>sample string 1</ModuleFlags>
  <SessionID>sample string 2</SessionID>
  <UserInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain">
    <d2p1:ClientPreferences>sample string 7</d2p1:ClientPreferences>
    <d2p1:DateFormatID>10</d2p1:DateFormatID>
    <d2p1:ForceResetPassword>true</d2p1:ForceResetPassword>
    <d2p1:Fullname>sample string 3</d2p1:Fullname>
    <d2p1:HasResetPassword>true</d2p1:HasResetPassword>
    <d2p1:IsAppStoreLogEnabled>16</d2p1:IsAppStoreLogEnabled>
    <d2p1:IsEulaAccepted>true</d2p1:IsEulaAccepted>
    <d2p1:IsLocalyticsEnabled>15</d2p1:IsLocalyticsEnabled>
    <d2p1:IsMarketingDefaultValue>18</d2p1:IsMarketingDefaultValue>
    <d2p1:IsMarketingOptionEnabled>17</d2p1:IsMarketingOptionEnabled>
    <d2p1:IsMonitoringDefaultValue>19</d2p1:IsMonitoringDefaultValue>
    <d2p1:IsOtpEnabled>21</d2p1:IsOtpEnabled>
    <d2p1:IsOtpSupported>20</d2p1:IsOtpSupported>
    <d2p1:IsRootedDeviceAccepted>true</d2p1:IsRootedDeviceAccepted>
    <d2p1:IsSMSEulaAccepted>true</d2p1:IsSMSEulaAccepted>
    <d2p1:Language>4</d2p1:Language>
    <d2p1:LocaleID>5</d2p1:LocaleID>
    <d2p1:PushNotificationStatus>12</d2p1:PushNotificationStatus>
    <d2p1:TimeFormatID>11</d2p1:TimeFormatID>
    <d2p1:UserCodeDirectPushEnabled>true</d2p1:UserCodeDirectPushEnabled>
    <d2p1:UserFeatureList>sample string 6</d2p1:UserFeatureList>
    <d2p1:UserID>1</d2p1:UserID>
    <d2p1:UserOtpEmail>sample string 22</d2p1:UserOtpEmail>
    <d2p1:Username>sample string 2</d2p1:Username>
  </UserInfo>
</SessionDetailResultsEx>