POST api/tradeOutlets

Метод для создания "Торговой точки"

Полный URL-адрес запроса: https://sfa-api.ddapp.biz/api/tradeOutlets?api-version=2.0

  Для этого метода требуется авторизация

Информация о запросе

URL параметры

Нет

Тело запроса

"Торговой точка"

CreateTradeOutletModel2
НазваниеОписаниеТип данныхДополнительная информация
VendorId

string

Длина: от 1 до 100

Соответствует регулярному выражению: ^[a-zA-Zа-яА-Я0-9_-]+$
Name

string

Обязательное поле

Длина: от 1 до 100
Location

CreateLocationModel

Обязательное поле
CategoryId

string

Обязательное поле

Длина: от 1 до 100
FormatId

string

Обязательное поле

Длина: от 1 до 100
FreeVisit

boolean

Нет
IsBlocked

boolean

Нет
BlockReason

string

Длина: от 0 до 1000
CreatedByUserId

globally unique identifier

Нет
Relationships

Collection of CreateTradeOutletRelationshipModel2

Нет
Properties

Collection of CreateEntityPropertyValueModel

Нет

Форматы запросов

{
  "vendorId": "sample string 1",
  "name": "sample string 2",
  "location": {
    "countryId": "sample string 1",
    "provinceId": "bb129244-1531-4d4b-8b20-faf2f416f7ca",
    "addressLine": "sample string 3",
    "geoCoordinate": {
      "latitude": 1.1,
      "longitude": 1.1
    },
    "settlement": "sample string 4"
  },
  "categoryId": "sample string 3",
  "formatId": "sample string 4",
  "freeVisit": true,
  "isBlocked": true,
  "blockReason": "sample string 5",
  "createdByUserId": "0013c3b8-f7f2-4d72-8b58-0eb7156971a1",
  "relationships": [
    {
      "relationshipId": "sample string 1",
      "routeId": "sample string 2",
      "orderIndex": 1,
      "isBlocked": true,
      "blockReason": "sample string 3"
    },
    {
      "relationshipId": "sample string 1",
      "routeId": "sample string 2",
      "orderIndex": 1,
      "isBlocked": true,
      "blockReason": "sample string 3"
    }
  ],
  "properties": [
    {
      "propertyId": "sample string 1",
      "value": "sample string 2"
    },
    {
      "propertyId": "sample string 1",
      "value": "sample string 2"
    }
  ]
}

<CreateTradeOutletModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V2.TradeOutlets">
  <BlockReason>sample string 5</BlockReason>
  <CategoryId>sample string 3</CategoryId>
  <CreatedByUserId>0013c3b8-f7f2-4d72-8b58-0eb7156971a1</CreatedByUserId>
  <FormatId>sample string 4</FormatId>
  <FreeVisit>true</FreeVisit>
  <IsBlocked>true</IsBlocked>
  <Location xmlns:d2p1="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V1.Geo">
    <d2p1:AddressLine>sample string 3</d2p1:AddressLine>
    <d2p1:CountryId>sample string 1</d2p1:CountryId>
    <d2p1:GeoCoordinate>
      <d2p1:Latitude>1.1</d2p1:Latitude>
      <d2p1:Longitude>1.1</d2p1:Longitude>
    </d2p1:GeoCoordinate>
    <d2p1:ProvinceId>bb129244-1531-4d4b-8b20-faf2f416f7ca</d2p1:ProvinceId>
    <d2p1:Settlement>sample string 4</d2p1:Settlement>
  </Location>
  <Name>sample string 2</Name>
  <Properties xmlns:d2p1="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V1.EntityProperties.Values">
    <d2p1:CreateEntityPropertyValueModel>
      <d2p1:PropertyId>sample string 1</d2p1:PropertyId>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:CreateEntityPropertyValueModel>
    <d2p1:CreateEntityPropertyValueModel>
      <d2p1:PropertyId>sample string 1</d2p1:PropertyId>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:CreateEntityPropertyValueModel>
  </Properties>
  <Relationships>
    <CreateTradeOutletRelationshipModel>
      <BlockReason>sample string 3</BlockReason>
      <IsBlocked>true</IsBlocked>
      <OrderIndex>1</OrderIndex>
      <RelationshipId>sample string 1</RelationshipId>
      <RouteId>sample string 2</RouteId>
    </CreateTradeOutletRelationshipModel>
    <CreateTradeOutletRelationshipModel>
      <BlockReason>sample string 3</BlockReason>
      <IsBlocked>true</IsBlocked>
      <OrderIndex>1</OrderIndex>
      <RelationshipId>sample string 1</RelationshipId>
      <RouteId>sample string 2</RouteId>
    </CreateTradeOutletRelationshipModel>
  </Relationships>
  <VendorId>sample string 1</VendorId>
</CreateTradeOutletModel>

Sample not available.

Информация об ответе

ResourceIdModel
НазваниеОписаниеТип данныхДополнительная информация
Id

globally unique identifier

Нет

Форматы ответа

{
  "id": "43e0add5-e047-44d4-aaec-cfcd9b202b78"
}

<ResourceIdModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DDApp.Alt.Api.Models.Response">
  <Id>43e0add5-e047-44d4-aaec-cfcd9b202b78</Id>
</ResourceIdModel>