/
5.4.1. Список стартовых заставок

5.4.1. Список стартовых заставок

Sept 08, 2023

Описание

Получение списка не удаленных стартовых заставок.


НаименованиеStartPictureRead
НазначениеСписок стартовых заставок
Дневной лимит (опер/час)50
Ночной лимит (опер/час)250
Максимум объектов в пакете-

Запрос

Параметр, выделенный жирным, является обязательным к заполнению!

ПараметрТипNULLОписание
EnabledToShowБулево
Отбор по признаку отображения стартовой заставки
OwnProductБулево
Отбор по своим или общим стартовым заставкам
StartPictureTypeБулево

Отбор по типу заставки. Значения:

  • "CLIENTS"
  • "SPECIALISTS"
  • "BIRTHDAYS"
Пример
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:par="http://buhphone.com/PartnerWebAPI2" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:core="http://v8.1c.ru/8.1/data/core" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soap:Header/>
   <soap:Body>
      <par:StartPictureRead>
         <par:Params>
            <Property name="EnabledToShow" xmlns="http://v8.1c.ru/8.1/data/core">
               <Value xsi:type="xs:boolean">true</Value>
            </Property>
            <Property name="OwnProduct" xmlns="http://v8.1c.ru/8.1/data/core">
               <Value xsi:type="xs:boolean">true</Value>
            </Property>
            <Property name="Булево" xmlns="http://v8.1c.ru/8.1/data/core">
               <Value xsi:type="xs:boolean">true</Value>
            </Property>
         </par:Params>
      </par:StartPictureRead>
   </soap:Body>
</soap:Envelope>

Ответ (структура ResultData)

ПараметрТипОписание
StartPictureIDUUIDUUID стартовой заставки
NameСтрока(50)Наименование продукта витрины
OwnStartPictureБулевоФлаг принадлежности стартовой заставки. Истина, если стартовая заставка создана самой организацией
EnabledToShowБулевоПризнак отображения стартовой заставки
StartPictureTypeСтрока

Тип заставки:

  • "CLIENTS" - Заставка для пользователей клиентов
  • "SPECIALISTS" - Заставка для специалистов
  • "BIRTHDAYS" - Заставка ко дню рождения
DescriptionURLURLСсылка, на которую переходит пользователь или специалист по клику на стартовую заставку
ShowsLimitЧислоЛимит на показы
EMailForNotificationСтрока(300)E-mail для уведомлений о клике. Может быть указано несколько значений через запятую
PublicationDateДатаВремяДата публикации. В часовом поясе пользователя API
PublicationEndDateДатаВремяДата окончания публикации. В часовом поясе пользователя API
ShowsCountЧислоКоличество показов
UniqueShowsCountЧислоКоличество показов уникальным пользователям
ClicksCountЧислоКоличество переходов уникальных пользователей
CreateTimeДатаВремяДата создания. В часовом поясе пользователя API
Пример ответа
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
   <soap:Body>
      <m:StartPictureReadResponse xmlns:m="http://buhphone.com/PartnerWebAPI2">
         <m:return xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <Property name="ResultCode" xmlns="http://v8.1c.ru/8.1/data/core">
               <Value xsi:type="xs:string">SUCCESS</Value>
            </Property>
            <Property name="ResultData" xmlns="http://v8.1c.ru/8.1/data/core">
               <Value xsi:type="ValueTable">
                  <column>
                     <Name>StartPictureID</Name>
                     <ValueType>
                        <Type>xs:string</Type>
                        <Type>Null</Type>
                        <StringQualifiers>
                           <Length>0</Length>
                           <AllowedLength>Variable</AllowedLength>
                        </StringQualifiers>
                     </ValueType>
                  </column>
                  <column>
                     <Name>Name</Name>
                     <ValueType>
                        <Type>xs:string</Type>
                        <StringQualifiers>
                           <Length>50</Length>
                           <AllowedLength>Variable</AllowedLength>
                        </StringQualifiers>
                     </ValueType>
                  </column>
                  <column>
                     <Name>OwnStartPicture</Name>
                     <ValueType>
                        <Type>xs:boolean</Type>
                     </ValueType>
                  </column>
                  <column>
                     <Name>EnabledToShow</Name>
                     <ValueType>
                        <Type>xs:boolean</Type>
                     </ValueType>
                  </column>
                  <column>
                     <Name>DescriptionURL</Name>
                     <ValueType>
                        <Type>xs:string</Type>
                        <StringQualifiers>
                           <Length>0</Length>
                           <AllowedLength>Variable</AllowedLength>
                        </StringQualifiers>
                     </ValueType>
                  </column>
                  <column>
                     <Name>StartPictureType</Name>
                     <ValueType>
                        <Type>xs:string</Type>
                        <StringQualifiers>
                           <Length>11</Length>
                           <AllowedLength>Variable</AllowedLength>
                        </StringQualifiers>
                     </ValueType>
                  </column>
                  <column>
                     <Name>ShowsLimit</Name>
                     <ValueType>
                        <Type>xs:decimal</Type>
                        <NumberQualifiers>
                           <Digits>2</Digits>
                           <FractionDigits>0</FractionDigits>
                           <AllowedSign>Nonnegative</AllowedSign>
                        </NumberQualifiers>
                     </ValueType>
                  </column>
                  <column>
                     <Name>EMailForNotification</Name>
                     <ValueType>
                        <Type>xs:string</Type>
                        <StringQualifiers>
                           <Length>300</Length>
                           <AllowedLength>Variable</AllowedLength>
                        </StringQualifiers>
                     </ValueType>
                  </column>
                  <column>
                     <Name>PublicationDate</Name>
                     <ValueType>
                        <Type>xs:dateTime</Type>
                        <DateQualifiers>
                           <DateFractions>Date</DateFractions>
                        </DateQualifiers>
                     </ValueType>
                  </column>
                  <column>
                     <Name>PublicationEndDate</Name>
                     <ValueType>
                        <Type>xs:dateTime</Type>
                        <DateQualifiers>
                           <DateFractions>Date</DateFractions>
                        </DateQualifiers>
                     </ValueType>
                  </column>
                  <column>
                     <Name>ShowsCount</Name>
                     <ValueType>
                        <Type>xs:decimal</Type>
                        <NumberQualifiers>
                           <Digits>0</Digits>
                           <FractionDigits>0</FractionDigits>
                           <AllowedSign>Any</AllowedSign>
                        </NumberQualifiers>
                     </ValueType>
                  </column>
                  <column>
                     <Name>UniqueShowsCount</Name>
                     <ValueType>
                        <Type>xs:decimal</Type>
                        <NumberQualifiers>
                           <Digits>0</Digits>
                           <FractionDigits>0</FractionDigits>
                           <AllowedSign>Any</AllowedSign>
                        </NumberQualifiers>
                     </ValueType>
                  </column>
                  <column>
                     <Name>ClicksCount</Name>
                     <ValueType>
                        <Type>xs:decimal</Type>
                        <NumberQualifiers>
                           <Digits>0</Digits>
                           <FractionDigits>0</FractionDigits>
                           <AllowedSign>Any</AllowedSign>
                        </NumberQualifiers>
                     </ValueType>
                  </column>
                  <column>
                     <Name>CreateTime</Name>
                     <ValueType>
                        <Type>xs:dateTime</Type>
                        <DateQualifiers>
                           <DateFractions>DateTime</DateFractions>
                        </DateQualifiers>
                     </ValueType>
                  </column>
                  <row>
                     <Value xsi:type="xs:string">d4cf2003-f011-11e5-80e1-0025904f970d</Value>
                     <Value xsi:type="xs:string">С днем рождения!</Value>
                     <Value xsi:type="xs:boolean">false</Value>
                     <Value xsi:type="xs:boolean">true</Value>
                     <Value xsi:type="xs:string"/>
                     <Value xsi:type="xs:string">BIRTHDAYS</Value>
                     <Value xsi:type="xs:decimal">0</Value>
                     <Value xsi:type="xs:string"/>
                     <Value xsi:type="xs:dateTime">2016-03-22T00:00:00</Value>
                     <Value xsi:type="xs:dateTime">0001-01-01T00:00:00</Value>
                     <Value xsi:type="xs:decimal">0</Value>
                     <Value xsi:type="xs:decimal">0</Value>
                     <Value xsi:type="xs:decimal">0</Value>
                     <Value xsi:type="xs:dateTime">2016-03-22T02:00:00</Value>
                  </row>
                  <row>
                     <Value xsi:type="xs:string">2003c38e-a4fe-11e7-80e6-0025904f970f</Value>
                     <Value xsi:type="xs:string">Будьте мобильны!</Value>
                     <Value xsi:type="xs:boolean">false</Value>
                     <Value xsi:type="xs:boolean">true</Value>
                     <Value xsi:type="xs:string">https://1c-connect.com/forcustomers/#7</Value>
                     <Value xsi:type="xs:string">CLIENTS</Value>
                     <Value xsi:type="xs:decimal">7</Value>
                     <Value xsi:type="xs:string"/>
                     <Value xsi:type="xs:dateTime">2019-07-04T00:00:00</Value>
                     <Value xsi:type="xs:dateTime">0001-01-01T00:00:00</Value>
                     <Value xsi:type="xs:decimal">0</Value>
                     <Value xsi:type="xs:decimal">0</Value>
                     <Value xsi:type="xs:decimal">0</Value>
                     <Value xsi:type="xs:dateTime">2017-09-29T15:07:46</Value>
                  </row>
                  <row>
                     <Value xsi:type="xs:string">06c92003-f012-11e5-80e1-0025904f970d</Value>
                     <Value xsi:type="xs:string">Расписание работы</Value>
                     <Value xsi:type="xs:boolean">false</Value>
                     <Value xsi:type="xs:boolean">true</Value>
                     <Value xsi:type="xs:string"/>
                     <Value xsi:type="xs:string">SPECIALISTS</Value>
                     <Value xsi:type="xs:decimal">0</Value>
                     <Value xsi:type="xs:string"/>
                     <Value xsi:type="xs:dateTime">2018-04-11T00:00:00</Value>
                     <Value xsi:type="xs:dateTime">0001-01-01T00:00:00</Value>
                     <Value xsi:type="xs:decimal">0</Value>
                     <Value xsi:type="xs:decimal">0</Value>
                     <Value xsi:type="xs:decimal">0</Value>
                     <Value xsi:type="xs:dateTime">2016-03-22T02:00:00</Value>
                  </row>
               </Value>
            </Property>
         </m:return>
      </m:StartPictureReadResponse>
   </soap:Body>
</soap:Envelope>