POST api/Users/DoLogin

Request Information

URI Parameters

None.

Body Parameters

cEntityLogin
NameDescriptionTypeAdditional information
id

integer

None.

user_name

string

None.

user_short_name

string

None.

user_photo

string

None.

user_email

string

None.

user_password

string

None.

user_whatsupbot

string

None.

user_sendwhatsupbot

string

None.

_isok

integer

None.

user_isusingbot

integer

None.

user_phone_number

string

None.

user_profile

integer

None.

aplicationMenu

Collection of cEntity_pro_menus

None.

notificatiosList

Collection of cEntity_pro_user_notification

None.

_SendCredentials

string

None.

_Action

string

None.

hasError

boolean

None.

hasErrorMessage

string

None.

Request Formats

application/json, text/json

Sample:
{
  "id": 1,
  "user_name": "sample string 2",
  "user_short_name": "sample string 3",
  "user_photo": "sample string 4",
  "user_email": "sample string 5",
  "user_password": "sample string 6",
  "user_whatsupbot": "sample string 7",
  "user_sendwhatsupbot": "sample string 8",
  "_isok": 9,
  "user_isusingbot": 10,
  "user_phone_number": "sample string 11",
  "user_profile": 12,
  "aplicationMenu": [
    {
      "id": 1,
      "icon": "sample string 2",
      "designacao": "sample string 3",
      "link": "sample string 4",
      "_Action": "sample string 5",
      "hasError": true,
      "List_options": [
        {
          "id": 1,
          "menu_id": 2,
          "designacao": "sample string 3",
          "page_link": "sample string 4",
          "_Action": "sample string 5",
          "menu_read": 6,
          "menu_write": 7,
          "menu_delete": 8,
          "icon": "sample string 9",
          "hasError": true,
          "hasErrorMessage": "sample string 11",
          "_SendCredentials": "sample string 12"
        },
        {
          "id": 1,
          "menu_id": 2,
          "designacao": "sample string 3",
          "page_link": "sample string 4",
          "_Action": "sample string 5",
          "menu_read": 6,
          "menu_write": 7,
          "menu_delete": 8,
          "icon": "sample string 9",
          "hasError": true,
          "hasErrorMessage": "sample string 11",
          "_SendCredentials": "sample string 12"
        }
      ],
      "hasErrorMessage": "sample string 7",
      "_SendCredentials": "sample string 8"
    },
    {
      "id": 1,
      "icon": "sample string 2",
      "designacao": "sample string 3",
      "link": "sample string 4",
      "_Action": "sample string 5",
      "hasError": true,
      "List_options": [
        {
          "id": 1,
          "menu_id": 2,
          "designacao": "sample string 3",
          "page_link": "sample string 4",
          "_Action": "sample string 5",
          "menu_read": 6,
          "menu_write": 7,
          "menu_delete": 8,
          "icon": "sample string 9",
          "hasError": true,
          "hasErrorMessage": "sample string 11",
          "_SendCredentials": "sample string 12"
        },
        {
          "id": 1,
          "menu_id": 2,
          "designacao": "sample string 3",
          "page_link": "sample string 4",
          "_Action": "sample string 5",
          "menu_read": 6,
          "menu_write": 7,
          "menu_delete": 8,
          "icon": "sample string 9",
          "hasError": true,
          "hasErrorMessage": "sample string 11",
          "_SendCredentials": "sample string 12"
        }
      ],
      "hasErrorMessage": "sample string 7",
      "_SendCredentials": "sample string 8"
    }
  ],
  "notificatiosList": [
    {
      "id": 1,
      "notification_from": 2,
      "notification_to": 3,
      "notification_type": 4,
      "notification_origin": 5,
      "notification_from_name": "sample string 6",
      "notification_to_name": "sample string 7",
      "notification_status": 8,
      "notification_open": 9,
      "notification_date": "sample string 10",
      "notification_date_open": "sample string 11",
      "notification_ticket": 12,
      "notification_subject": "sample string 13",
      "_Action": "sample string 14",
      "hasError": true,
      "hasErrorMessage": "sample string 16",
      "_SendCredentials": "sample string 17"
    },
    {
      "id": 1,
      "notification_from": 2,
      "notification_to": 3,
      "notification_type": 4,
      "notification_origin": 5,
      "notification_from_name": "sample string 6",
      "notification_to_name": "sample string 7",
      "notification_status": 8,
      "notification_open": 9,
      "notification_date": "sample string 10",
      "notification_date_open": "sample string 11",
      "notification_ticket": 12,
      "notification_subject": "sample string 13",
      "_Action": "sample string 14",
      "hasError": true,
      "hasErrorMessage": "sample string 16",
      "_SendCredentials": "sample string 17"
    }
  ],
  "_SendCredentials": "sample string 13",
  "_Action": "sample string 14",
  "hasError": true,
  "hasErrorMessage": "sample string 16"
}

application/xml, text/xml

Sample:
<RhClass.cEntityLogin xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/wsgest">
  <_Action>sample string 14</_Action>
  <_SendCredentials>sample string 13</_SendCredentials>
  <_isok>9</_isok>
  <aplicationMenu>
    <cTables.cEntity_pro_menus>
      <List_options>
        <cTables.cEntity_pro_menus_sub>
          <_Action>sample string 5</_Action>
          <_SendCredentials>sample string 12</_SendCredentials>
          <designacao>sample string 3</designacao>
          <hasError>true</hasError>
          <hasErrorMessage>sample string 11</hasErrorMessage>
          <icon>sample string 9</icon>
          <id>1</id>
          <menu_delete>8</menu_delete>
          <menu_id>2</menu_id>
          <menu_read>6</menu_read>
          <menu_write>7</menu_write>
          <page_link>sample string 4</page_link>
        </cTables.cEntity_pro_menus_sub>
        <cTables.cEntity_pro_menus_sub>
          <_Action>sample string 5</_Action>
          <_SendCredentials>sample string 12</_SendCredentials>
          <designacao>sample string 3</designacao>
          <hasError>true</hasError>
          <hasErrorMessage>sample string 11</hasErrorMessage>
          <icon>sample string 9</icon>
          <id>1</id>
          <menu_delete>8</menu_delete>
          <menu_id>2</menu_id>
          <menu_read>6</menu_read>
          <menu_write>7</menu_write>
          <page_link>sample string 4</page_link>
        </cTables.cEntity_pro_menus_sub>
      </List_options>
      <_Action>sample string 5</_Action>
      <_SendCredentials>sample string 8</_SendCredentials>
      <designacao>sample string 3</designacao>
      <hasError>true</hasError>
      <hasErrorMessage>sample string 7</hasErrorMessage>
      <icon>sample string 2</icon>
      <id>1</id>
      <link>sample string 4</link>
    </cTables.cEntity_pro_menus>
    <cTables.cEntity_pro_menus>
      <List_options>
        <cTables.cEntity_pro_menus_sub>
          <_Action>sample string 5</_Action>
          <_SendCredentials>sample string 12</_SendCredentials>
          <designacao>sample string 3</designacao>
          <hasError>true</hasError>
          <hasErrorMessage>sample string 11</hasErrorMessage>
          <icon>sample string 9</icon>
          <id>1</id>
          <menu_delete>8</menu_delete>
          <menu_id>2</menu_id>
          <menu_read>6</menu_read>
          <menu_write>7</menu_write>
          <page_link>sample string 4</page_link>
        </cTables.cEntity_pro_menus_sub>
        <cTables.cEntity_pro_menus_sub>
          <_Action>sample string 5</_Action>
          <_SendCredentials>sample string 12</_SendCredentials>
          <designacao>sample string 3</designacao>
          <hasError>true</hasError>
          <hasErrorMessage>sample string 11</hasErrorMessage>
          <icon>sample string 9</icon>
          <id>1</id>
          <menu_delete>8</menu_delete>
          <menu_id>2</menu_id>
          <menu_read>6</menu_read>
          <menu_write>7</menu_write>
          <page_link>sample string 4</page_link>
        </cTables.cEntity_pro_menus_sub>
      </List_options>
      <_Action>sample string 5</_Action>
      <_SendCredentials>sample string 8</_SendCredentials>
      <designacao>sample string 3</designacao>
      <hasError>true</hasError>
      <hasErrorMessage>sample string 7</hasErrorMessage>
      <icon>sample string 2</icon>
      <id>1</id>
      <link>sample string 4</link>
    </cTables.cEntity_pro_menus>
  </aplicationMenu>
  <hasError>true</hasError>
  <hasErrorMessage>sample string 16</hasErrorMessage>
  <id>1</id>
  <notificatiosList>
    <RhClass.cEntity_pro_user_notification>
      <_Action>sample string 14</_Action>
      <_SendCredentials>sample string 17</_SendCredentials>
      <hasError>true</hasError>
      <hasErrorMessage>sample string 16</hasErrorMessage>
      <id>1</id>
      <notification_date>sample string 10</notification_date>
      <notification_date_open>sample string 11</notification_date_open>
      <notification_from>2</notification_from>
      <notification_from_name>sample string 6</notification_from_name>
      <notification_open>9</notification_open>
      <notification_origin>5</notification_origin>
      <notification_status>8</notification_status>
      <notification_subject>sample string 13</notification_subject>
      <notification_ticket>12</notification_ticket>
      <notification_to>3</notification_to>
      <notification_to_name>sample string 7</notification_to_name>
      <notification_type>4</notification_type>
    </RhClass.cEntity_pro_user_notification>
    <RhClass.cEntity_pro_user_notification>
      <_Action>sample string 14</_Action>
      <_SendCredentials>sample string 17</_SendCredentials>
      <hasError>true</hasError>
      <hasErrorMessage>sample string 16</hasErrorMessage>
      <id>1</id>
      <notification_date>sample string 10</notification_date>
      <notification_date_open>sample string 11</notification_date_open>
      <notification_from>2</notification_from>
      <notification_from_name>sample string 6</notification_from_name>
      <notification_open>9</notification_open>
      <notification_origin>5</notification_origin>
      <notification_status>8</notification_status>
      <notification_subject>sample string 13</notification_subject>
      <notification_ticket>12</notification_ticket>
      <notification_to>3</notification_to>
      <notification_to_name>sample string 7</notification_to_name>
      <notification_type>4</notification_type>
    </RhClass.cEntity_pro_user_notification>
  </notificatiosList>
  <user_email>sample string 5</user_email>
  <user_isusingbot>10</user_isusingbot>
  <user_name>sample string 2</user_name>
  <user_password>sample string 6</user_password>
  <user_phone_number>sample string 11</user_phone_number>
  <user_photo>sample string 4</user_photo>
  <user_profile>12</user_profile>
  <user_sendwhatsupbot>sample string 8</user_sendwhatsupbot>
  <user_short_name>sample string 3</user_short_name>
  <user_whatsupbot>sample string 7</user_whatsupbot>
</RhClass.cEntityLogin>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

cEntityLogin
NameDescriptionTypeAdditional information
id

integer

None.

user_name

string

None.

user_short_name

string

None.

user_photo

string

None.

user_email

string

None.

user_password

string

None.

user_whatsupbot

string

None.

user_sendwhatsupbot

string

None.

_isok

integer

None.

user_isusingbot

integer

None.

user_phone_number

string

None.

user_profile

integer

None.

aplicationMenu

Collection of cEntity_pro_menus

None.

notificatiosList

Collection of cEntity_pro_user_notification

None.

_SendCredentials

string

None.

_Action

string

None.

hasError

boolean

None.

hasErrorMessage

string

None.

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "user_name": "sample string 2",
  "user_short_name": "sample string 3",
  "user_photo": "sample string 4",
  "user_email": "sample string 5",
  "user_password": "sample string 6",
  "user_whatsupbot": "sample string 7",
  "user_sendwhatsupbot": "sample string 8",
  "_isok": 9,
  "user_isusingbot": 10,
  "user_phone_number": "sample string 11",
  "user_profile": 12,
  "aplicationMenu": [
    {
      "id": 1,
      "icon": "sample string 2",
      "designacao": "sample string 3",
      "link": "sample string 4",
      "_Action": "sample string 5",
      "hasError": true,
      "List_options": [
        {
          "id": 1,
          "menu_id": 2,
          "designacao": "sample string 3",
          "page_link": "sample string 4",
          "_Action": "sample string 5",
          "menu_read": 6,
          "menu_write": 7,
          "menu_delete": 8,
          "icon": "sample string 9",
          "hasError": true,
          "hasErrorMessage": "sample string 11",
          "_SendCredentials": "sample string 12"
        },
        {
          "id": 1,
          "menu_id": 2,
          "designacao": "sample string 3",
          "page_link": "sample string 4",
          "_Action": "sample string 5",
          "menu_read": 6,
          "menu_write": 7,
          "menu_delete": 8,
          "icon": "sample string 9",
          "hasError": true,
          "hasErrorMessage": "sample string 11",
          "_SendCredentials": "sample string 12"
        }
      ],
      "hasErrorMessage": "sample string 7",
      "_SendCredentials": "sample string 8"
    },
    {
      "id": 1,
      "icon": "sample string 2",
      "designacao": "sample string 3",
      "link": "sample string 4",
      "_Action": "sample string 5",
      "hasError": true,
      "List_options": [
        {
          "id": 1,
          "menu_id": 2,
          "designacao": "sample string 3",
          "page_link": "sample string 4",
          "_Action": "sample string 5",
          "menu_read": 6,
          "menu_write": 7,
          "menu_delete": 8,
          "icon": "sample string 9",
          "hasError": true,
          "hasErrorMessage": "sample string 11",
          "_SendCredentials": "sample string 12"
        },
        {
          "id": 1,
          "menu_id": 2,
          "designacao": "sample string 3",
          "page_link": "sample string 4",
          "_Action": "sample string 5",
          "menu_read": 6,
          "menu_write": 7,
          "menu_delete": 8,
          "icon": "sample string 9",
          "hasError": true,
          "hasErrorMessage": "sample string 11",
          "_SendCredentials": "sample string 12"
        }
      ],
      "hasErrorMessage": "sample string 7",
      "_SendCredentials": "sample string 8"
    }
  ],
  "notificatiosList": [
    {
      "id": 1,
      "notification_from": 2,
      "notification_to": 3,
      "notification_type": 4,
      "notification_origin": 5,
      "notification_from_name": "sample string 6",
      "notification_to_name": "sample string 7",
      "notification_status": 8,
      "notification_open": 9,
      "notification_date": "sample string 10",
      "notification_date_open": "sample string 11",
      "notification_ticket": 12,
      "notification_subject": "sample string 13",
      "_Action": "sample string 14",
      "hasError": true,
      "hasErrorMessage": "sample string 16",
      "_SendCredentials": "sample string 17"
    },
    {
      "id": 1,
      "notification_from": 2,
      "notification_to": 3,
      "notification_type": 4,
      "notification_origin": 5,
      "notification_from_name": "sample string 6",
      "notification_to_name": "sample string 7",
      "notification_status": 8,
      "notification_open": 9,
      "notification_date": "sample string 10",
      "notification_date_open": "sample string 11",
      "notification_ticket": 12,
      "notification_subject": "sample string 13",
      "_Action": "sample string 14",
      "hasError": true,
      "hasErrorMessage": "sample string 16",
      "_SendCredentials": "sample string 17"
    }
  ],
  "_SendCredentials": "sample string 13",
  "_Action": "sample string 14",
  "hasError": true,
  "hasErrorMessage": "sample string 16"
}

application/xml, text/xml

Sample:
<RhClass.cEntityLogin xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/wsgest">
  <_Action>sample string 14</_Action>
  <_SendCredentials>sample string 13</_SendCredentials>
  <_isok>9</_isok>
  <aplicationMenu>
    <cTables.cEntity_pro_menus>
      <List_options>
        <cTables.cEntity_pro_menus_sub>
          <_Action>sample string 5</_Action>
          <_SendCredentials>sample string 12</_SendCredentials>
          <designacao>sample string 3</designacao>
          <hasError>true</hasError>
          <hasErrorMessage>sample string 11</hasErrorMessage>
          <icon>sample string 9</icon>
          <id>1</id>
          <menu_delete>8</menu_delete>
          <menu_id>2</menu_id>
          <menu_read>6</menu_read>
          <menu_write>7</menu_write>
          <page_link>sample string 4</page_link>
        </cTables.cEntity_pro_menus_sub>
        <cTables.cEntity_pro_menus_sub>
          <_Action>sample string 5</_Action>
          <_SendCredentials>sample string 12</_SendCredentials>
          <designacao>sample string 3</designacao>
          <hasError>true</hasError>
          <hasErrorMessage>sample string 11</hasErrorMessage>
          <icon>sample string 9</icon>
          <id>1</id>
          <menu_delete>8</menu_delete>
          <menu_id>2</menu_id>
          <menu_read>6</menu_read>
          <menu_write>7</menu_write>
          <page_link>sample string 4</page_link>
        </cTables.cEntity_pro_menus_sub>
      </List_options>
      <_Action>sample string 5</_Action>
      <_SendCredentials>sample string 8</_SendCredentials>
      <designacao>sample string 3</designacao>
      <hasError>true</hasError>
      <hasErrorMessage>sample string 7</hasErrorMessage>
      <icon>sample string 2</icon>
      <id>1</id>
      <link>sample string 4</link>
    </cTables.cEntity_pro_menus>
    <cTables.cEntity_pro_menus>
      <List_options>
        <cTables.cEntity_pro_menus_sub>
          <_Action>sample string 5</_Action>
          <_SendCredentials>sample string 12</_SendCredentials>
          <designacao>sample string 3</designacao>
          <hasError>true</hasError>
          <hasErrorMessage>sample string 11</hasErrorMessage>
          <icon>sample string 9</icon>
          <id>1</id>
          <menu_delete>8</menu_delete>
          <menu_id>2</menu_id>
          <menu_read>6</menu_read>
          <menu_write>7</menu_write>
          <page_link>sample string 4</page_link>
        </cTables.cEntity_pro_menus_sub>
        <cTables.cEntity_pro_menus_sub>
          <_Action>sample string 5</_Action>
          <_SendCredentials>sample string 12</_SendCredentials>
          <designacao>sample string 3</designacao>
          <hasError>true</hasError>
          <hasErrorMessage>sample string 11</hasErrorMessage>
          <icon>sample string 9</icon>
          <id>1</id>
          <menu_delete>8</menu_delete>
          <menu_id>2</menu_id>
          <menu_read>6</menu_read>
          <menu_write>7</menu_write>
          <page_link>sample string 4</page_link>
        </cTables.cEntity_pro_menus_sub>
      </List_options>
      <_Action>sample string 5</_Action>
      <_SendCredentials>sample string 8</_SendCredentials>
      <designacao>sample string 3</designacao>
      <hasError>true</hasError>
      <hasErrorMessage>sample string 7</hasErrorMessage>
      <icon>sample string 2</icon>
      <id>1</id>
      <link>sample string 4</link>
    </cTables.cEntity_pro_menus>
  </aplicationMenu>
  <hasError>true</hasError>
  <hasErrorMessage>sample string 16</hasErrorMessage>
  <id>1</id>
  <notificatiosList>
    <RhClass.cEntity_pro_user_notification>
      <_Action>sample string 14</_Action>
      <_SendCredentials>sample string 17</_SendCredentials>
      <hasError>true</hasError>
      <hasErrorMessage>sample string 16</hasErrorMessage>
      <id>1</id>
      <notification_date>sample string 10</notification_date>
      <notification_date_open>sample string 11</notification_date_open>
      <notification_from>2</notification_from>
      <notification_from_name>sample string 6</notification_from_name>
      <notification_open>9</notification_open>
      <notification_origin>5</notification_origin>
      <notification_status>8</notification_status>
      <notification_subject>sample string 13</notification_subject>
      <notification_ticket>12</notification_ticket>
      <notification_to>3</notification_to>
      <notification_to_name>sample string 7</notification_to_name>
      <notification_type>4</notification_type>
    </RhClass.cEntity_pro_user_notification>
    <RhClass.cEntity_pro_user_notification>
      <_Action>sample string 14</_Action>
      <_SendCredentials>sample string 17</_SendCredentials>
      <hasError>true</hasError>
      <hasErrorMessage>sample string 16</hasErrorMessage>
      <id>1</id>
      <notification_date>sample string 10</notification_date>
      <notification_date_open>sample string 11</notification_date_open>
      <notification_from>2</notification_from>
      <notification_from_name>sample string 6</notification_from_name>
      <notification_open>9</notification_open>
      <notification_origin>5</notification_origin>
      <notification_status>8</notification_status>
      <notification_subject>sample string 13</notification_subject>
      <notification_ticket>12</notification_ticket>
      <notification_to>3</notification_to>
      <notification_to_name>sample string 7</notification_to_name>
      <notification_type>4</notification_type>
    </RhClass.cEntity_pro_user_notification>
  </notificatiosList>
  <user_email>sample string 5</user_email>
  <user_isusingbot>10</user_isusingbot>
  <user_name>sample string 2</user_name>
  <user_password>sample string 6</user_password>
  <user_phone_number>sample string 11</user_phone_number>
  <user_photo>sample string 4</user_photo>
  <user_profile>12</user_profile>
  <user_sendwhatsupbot>sample string 8</user_sendwhatsupbot>
  <user_short_name>sample string 3</user_short_name>
  <user_whatsupbot>sample string 7</user_whatsupbot>
</RhClass.cEntityLogin>