Задания

1. Метод GETJOBS

Возвращает информацию о заданиях.

URL: http://gateway.workaud.com/extapi/getjobs

Параметры

Название параметраОписание
id Перечисленные через запятую ID заданий
name Название задания
Number Номер задания

CreatedAfter

Дата создания заданий >= указанной даты

CreatedBefore

Дата создания заданий <= указанной даты

UserID

Код пользователя исполнителя, нескольких значений через запятую

CreatedBy

Код Администратора, нескольких значений через запятую

TaskShablonID

Код шаблона, нескольких значений через запятую

Repeatable

Признак повторяемости (1 - повторяемое)

Details

Числовой параметр:0 – Возвращать только заголовки заданий без детализации(по умолчанию);1 - возвращать содержимое заданий без прикрепленных файлов; 2 – возвращать содержимое заданий вместе с файлами(фотографии, аудио записи и прикрепленные к заданию файлы).

fields

Перечислены поля через запятую которые нужно вернуть. Доступные поля: id, name, statusid, Number, Description, UserID, UserLogin, UserFirstName, UserLastName, CreatedOn, CompletedOn

 

Ответ

XML

<Result>
  <ErrorCode> int | код ошибки </ErrorCode>
  <Data>
    <Job>
      <Id> int | идентификатор </Id>
      <StatusId> int | статус (140-выполнено)</StatusId>
      <Number>string | номер</Number>
      <Name>string | название</Name>
      <Description>string | описание</Description>
      <UserId> int | идентификатор  пользователя</UserId>
      <UserLogin> string | логин  пользователя </UserLogin>
      <UserFirstName> string | имя  пользователя </UserFirstName>
      <UserLastName> string | фамилия  пользователя </UserLastName>
      <CreatedOn>date | дата создания</CreatedOn>
      <CompletedOn>date | дата выполения</CompletedOn>

      <JobFiles>
        <File>
          <Id> int | идентификатор </Id>
          <Name>string | имя файла</Name>
          <Url>string | Url файла</Url>
          <Length>int | длина в байтах</Length>
        </File>
         …
      </JobFiles>
      <JobDetails>
        <JobDetail>
          <Id> int | идентификатор блока</Id>
          <Caption> string | заголовок блока </Caption>
          <TypeId> int | тип блока*</TypeId>
          <Value>В зависимости от типа блока*</Value>
        </JobDetail>
         …
      </JobDetails>
    </Job>
     …
  </Data>
</Result>

 

JSON

{"ErrorCode":<int | код ошибки>, "Data":[{"Id":<int|идентификатор>, "StatusId":<int|статус (140-выполнено)>, "Number":<string|номер>, "Name":<string|название>, "Description":<string|описание>, "UserId":<int|идентификатор  пользователя>, "UserLogin":<string|логин  пользователя>, "UserFirstName":<string|имя  пользователя>, "UserLastName":<string|фамилия  пользователя>, "CreatedOn":<date | дата создания>, "CompletedOn":<date | дата выполения>,
"JobFiles": [{"Id":<int|идентификатор>, "Name":<string | имя файла>, "Url":<string | Url файла>,"Length":<int | длина в байтах>},…],
"JobDetails":[{"Value":<В зависимости от типа блока*>, "Id":<int | идентификатор блока>, "Caption":<string|заголовок блока>, "TypeId":<int|тип блока*>},…]},…]}

 

Содержимое тега Value в зависимости от типа блока:

1. Чекбокс

XML

<Value>string | Да, нет или не определено</Value>

 

JSON

"Value":< string | Да, нет или не определено>

2. Список

XML

<Value>
           <Item>
            <Name> string | название выбранного пункта</Name>
            <Url> string | Url изображения</Url>
    </Item>
     …
              </Value>

 

JSON

"Value":[{"Name":<string | название выбранного пункта>, "Url":<string | Url изображения>},…]

3. Текст

XML

<Value>string | Текст</Value>

JSON

"Value":< string | Текст>

4. Цифры

XML

<Value>double | Значение</Value>

JSON

"Value":< double | Значение >

5. Дата

XML

<Value>date | Дата</Value>

JSON

"Value":<date | Дата>

6. Мультимедиа

XML

<Value>
 <File>
                <Id> int | идентификатор </Id>
                <Name> string | имя файла </Name>
                <Format> int | формат (1-изображение, 2-аудио)</Format >
                <Url> string | Url файла </Url>
                <Length> int | длина в байтах </Length>
                <Comment> string | комментарий </Comment>
                <DateCreate> date? | Дата создания </DateCreate>
            </File>
              …
          </Value>

JSON

"Value":[{"Id":<int|идентификатор>, "Name":<string | имя файла>, "Format":<int | формат (1-изображение, 2-аудио)>, "Url":<string | Url файла>, "Length":<int | длина в байтах>, "Comment":<string | комментарий>, "DateCreate":<date? | Дата создания>},...]

7. Оценка

XML

<Value>double | Значение</Value>

JSON

"Value":< double | Значение >

8. Подпись

XML

<Value> string | Url файла </Value>

JSON

"Value":< string | Url файла >

9. Телефон

XML

<Value> string | Телефон</Value>

JSON

"Value":< string | Телефон >

10. Адрес

XML

<Value>
  <Text>string | Адрес</Text>
  <Latitude>double? | Широта</ Latitude >
  <Longitude>double? | Долгота</ Longitude >
</Value>

JSON

"Value":{"Text":<string|Адрес>, "Latitude":<double? | Широта>, "Longitude":<double?|Долгота>}

11. SKU

XML

<Value>
               <ShopId> int | идентификатор ТТ</ShopId>
               <ShopName> string | Наименование ТТ</ShopName>
               <ShopAddress> string | Адрес ТТ</ShopAddress>
               <Products>
                 <Product>
                   <Id> int | идентификатор номенклатуры</Id>
                   <Name> string | Наименование номенклатуры </Name>
                   <SKU> string | SKU номенклатуры </SKU>
                   <Stock> int? | учет</Stock>
                   <Price> double? | Цена </Price>
                   <Fact> int? | факт (присутствует, если нет разделения по складам)</Fact>
                   <Warehouses>
                     <Warehouse>
                       <Id> int | идентификатор склада</Id>
                       <Name> string | Наименование склада </Name>
                       <Fact> int | факт </Fact>
                     </Warehouse>
         …
                   </Warehouses>
       …
                 </Product>
               </Value>

JSON

"Value":{"ShopId":<int | идентификатор ТТ>,  "ShopName":<string | Наименование ТТ>, "ShopAddress": <string | Адрес ТТ>,
"Products":[{"Id":<int|идентификатор номенклатуры>, "Name":<string | Наименование номенклатуры>, "SKU":<string | SKU номенклатуры>, "Stock":<int? | учет>, "Price":<double? | Цена>, "Fact":<int? | факт (присутствует, если нет разделения по складам)>,
"Warehouses":[{"Id":<int | идентификатор склада>, "Name":<string | Наименование склада>, "Fact":<int | факт>}, …]}, …]}

12. Время

XML

<Value>string | Время в формате часы:минуты</Value>>

JSON

"Value":< string | Время в формате часы:минуты >

 

Формат даты ISO_8601: YYYY-MM-DDThh:mm:ss[.mmm].

Тип данных со знаком вопрос, например date? означает, что возможно значение null.