5.4.1. Список стартовых заставок
Описание
Получение списка не удаленных стартовых заставок.
Запрос
Параметр, выделенный жирным, является обязательным к заполнению!
Параметр | Тип | NULL | Описание |
---|---|---|---|
EnabledToShow | Булево | Отбор по признаку отображения стартовой заставки | |
OwnProduct | Булево | Отбор по своим или общим стартовым заставкам | |
StartPictureType | Булево | Отбор по типу заставки. Значения:
|
Пример
<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)
Параметр | Тип | Описание |
---|---|---|
StartPictureID | UUID | UUID стартовой заставки |
Name | Строка(50) | Наименование продукта витрины |
OwnStartPicture | Булево | Флаг принадлежности стартовой заставки. Истина, если стартовая заставка создана самой организацией |
EnabledToShow | Булево | Признак отображения стартовой заставки |
StartPictureType | Строка | Тип заставки:
|
DescriptionURL | URL | Ссылка, на которую переходит пользователь или специалист по клику на стартовую заставку |
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>