• Post category:Профили
  • Запись изменена:03.11.2022

POST api/2.0/people

Для этой функции требуется аутентификация.

Описание
Добавляет нового пользователя портала с именем, фамилией, адресом электронной почты и несколькими необязательными параметрами, указанными в запросе.

Параметры

Название Описание Тип Пример
isVisitor

sent in body
Указывает, является ли это гостем (true) или пользователем (false) Bool value true
email

sent in body
Электронная почта пользователя string some text
firstname

sent in body
Имя пользователя string some text
lastname

sent in body
Фамилия пользователя string some text
department

sent in body
Пользовательский отдел

необязательно
Collection of Guids
title

sent in body
Название пользователя

необязательно
string some text
location

sent in body
Местонахождение пользователя

необязательно
string some text
sex

sent in body
Пол пользователя (мужской или женский)

необязательно
string some text
birthday

sent in body
День рождения пользователя

необязательно
Date and Time Roundtrip format: 2008-04-10T06-30-00.000Z
worksfrom

sent in body
Дата регистрации пользователя. Если она не указана, то будет установлена текущая дата

необязательно
Date and Time Roundtrip format: 2008-04-10T06-30-00.000Z
comment

sent in body
Комментарии пользователя

необязательно
string some text
contacts

sent in body
Список контактов Collection of Contacts

collection
contacts[0][Type]=GTalk&contacts[0][Value]=my@gmail.com
files

sent in body
URL фоографии пользователя string some text
password

sent in body
Пароль пользователя

необязательно
string some text
Пример
POST api/2.0/people
Host: yourportal.r7-office.ru
Content-Type: application/json
Accept: application/json

{
  "isVisitor": true,
  "email": "some text",
  "firstname": "some text",
  "lastname": "some text",
  "department": [
    "9924256a-739c-462b-af15-e652a3b1b6eb",
    "98777e9c-f2a7-4e97-b314-ba9f92c2e882"
  ],
  "title": "some text",
  "location": "some text",
  "sex": "some text",
  "birthday": "2008-04-10T06-30-00.000Z",
  "worksfrom": "2008-04-10T06-30-00.000Z",
  "comment": "some text",
  "contacts": [
    {
      "Type": "GTalk",
      "Value": "my@gmail.com"
    }
  ],
  "files": "some text",
  "password": "some text"
}

Возвращает
Недавно добавленный пользователь

Пример Ответа

application/json

{
  "status": 0,
  "response": {
    "id": "00000000-0000-0000-0000-000000000000",
    "userName": "Mike.Zanyatski",
    "isVisitor": false,
    "firstName": "Mike",
    "lastName": "Zanyatski",
    "email": "my@domain.com",
    "birthday": "2022-10-12T08:51:51.7508377Z",
    "sex": "male",
    "status": 1,
    "activationStatus": 0,
    "terminated": null,
    "department": "Marketing",
    "workFrom": "2022-10-12T08:51:51.7508377Z",
    "location": "Palo Alto",
    "notes": "Notes to worker",
    "displayName": null,
    "title": "Manager",
    "contacts": [
      {
        "type": "GTalk",
        "value": "my@gmail.com"
      }
    ],
    "groups": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "Group Name",
        "manager": "Jake.Zazhitski"
      }
    ],
    "avatarMedium": "url to medium avatar",
    "avatar": "url to big avatar",
    "isAdmin": false,
    "isLDAP": false,
    "listAdminModules": [
      "projects",
      "crm"
    ],
    "isOwner": false,
    "cultureName": "en-EN",
    "isSSO": false,
    "avatarSmall": "url to small avatar",
    "profileUrl": ""
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <id>00000000-0000-0000-0000-000000000000</id>
    <userName>Mike.Zanyatski</userName>
    <isVisitor>false</isVisitor>
    <firstName>Mike</firstName>
    <lastName>Zanyatski</lastName>
    <email>my@domain.com</email>
    <birthday>2022-10-12T08:51:51.7508377Z</birthday>
    <sex>male</sex>
    <status>1</status>
    <activationStatus>0</activationStatus>
    <terminated />
    <department>Marketing</department>
    <workFrom>2022-10-12T08:51:51.7508377Z</workFrom>
    <location>Palo Alto</location>
    <notes>Notes to worker</notes>
    <displayName />
    <title>Manager</title>
    <contacts>
      <type>GTalk</type>
      <value>my@gmail.com</value>
    </contacts>
    <groups>
      <id>00000000-0000-0000-0000-000000000000</id>
      <name>Group Name</name>
      <manager>Jake.Zazhitski</manager>
    </groups>
    <avatarMedium>url to medium avatar</avatarMedium>
    <avatar>url to big avatar</avatar>
    <isAdmin>false</isAdmin>
    <isLDAP>false</isLDAP>
    <listAdminModules>projects</listAdminModules>
    <listAdminModules>crm</listAdminModules>
    <isOwner>false</isOwner>
    <cultureName>en-EN</cultureName>
    <isSSO>false</isSSO>
    <avatarSmall>url to small avatar</avatarSmall>
    <profileUrl></profileUrl>
  </response>
</result>