POST api/system/OperatorDocumentsAction

Создание, изменение, получение информации о документах оператора (правила, политики, согласия и т.д.)

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
ActionType	Тип действия (Create, Update, Info)	string	None.
DocumentId	Идентификатор документа для изменения	integer	None.
IsMobile	Признак, что запрос идёт из мобильного приложения	boolean	None.
Name	Наименование документа	string	None.
DocumentType	Тип документа	integer	None.
DocumentText	Текст документа	string	None.
DocumentUrl	Ссылка на текст документа	string	None.
NoShownMobile	Признак не отображения в мобильном приложении	boolean	None.
NoActive	Признак неактивности документа	boolean	None.
Operator	Идентификатор оператора программы лояльности	integer	None.
Token	Токен пользователя, который инициирует данный запрос	integer	None.
SiteCode	Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ActionType": "sample string 1",
  "DocumentId": 1,
  "IsMobile": true,
  "Name": "sample string 2",
  "DocumentType": 1,
  "DocumentText": "sample string 3",
  "DocumentUrl": "sample string 4",
  "NoShownMobile": true,
  "NoActive": true,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 5"
}

application/xml, text/xml

Sample:

<OperatorDocumentsActionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.SystemRequest">
  <Operator xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Operator>
  <SiteCode xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 5</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <ActionType>sample string 1</ActionType>
  <DocumentId>1</DocumentId>
  <DocumentText>sample string 3</DocumentText>
  <DocumentType>1</DocumentType>
  <DocumentUrl>sample string 4</DocumentUrl>
  <IsMobile>true</IsMobile>
  <Name>sample string 2</Name>
  <NoActive>true</NoActive>
  <NoShownMobile>true</NoShownMobile>
</OperatorDocumentsActionRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OperatorDocumentsActionResponse

Name	Description	Type	Additional information
Document	Идентификатор созданного документа	integer	None.
Data	Массив данных	Collection of OperatorDocumentsActionDataRow	None.
ErrorCode	Код ошибки	integer	None.
Message	Сообщение об ошибке	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Document": 1,
  "Data": [
    {
      "DocumentId": 1,
      "Name": "sample string 1",
      "Type": 1,
      "TypeName": "sample string 2",
      "DocumentText": "sample string 3",
      "DocumentUrl": "sample string 4",
      "NoShownMobile": true,
      "NoActive": true
    },
    {
      "DocumentId": 1,
      "Name": "sample string 1",
      "Type": 1,
      "TypeName": "sample string 2",
      "DocumentText": "sample string 3",
      "DocumentUrl": "sample string 4",
      "NoShownMobile": true,
      "NoActive": true
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:

<OperatorDocumentsActionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.SystemResponse">
  <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</ErrorCode>
  <Message xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 2</Message>
  <Data>
    <OperatorDocumentsActionResponse.OperatorDocumentsActionDataRow>
      <DocumentId>1</DocumentId>
      <DocumentText>sample string 3</DocumentText>
      <DocumentUrl>sample string 4</DocumentUrl>
      <Name>sample string 1</Name>
      <NoActive>true</NoActive>
      <NoShownMobile>true</NoShownMobile>
      <Type>1</Type>
      <TypeName>sample string 2</TypeName>
    </OperatorDocumentsActionResponse.OperatorDocumentsActionDataRow>
    <OperatorDocumentsActionResponse.OperatorDocumentsActionDataRow>
      <DocumentId>1</DocumentId>
      <DocumentText>sample string 3</DocumentText>
      <DocumentUrl>sample string 4</DocumentUrl>
      <Name>sample string 1</Name>
      <NoActive>true</NoActive>
      <NoShownMobile>true</NoShownMobile>
      <Type>1</Type>
      <TypeName>sample string 2</TypeName>
    </OperatorDocumentsActionResponse.OperatorDocumentsActionDataRow>
  </Data>
  <Document>1</Document>
</OperatorDocumentsActionResponse>