GET api/customers/{id}

Метод для получения информации о "Клиенте"

Полный URL-адрес запроса: https://sfa-api.ddapp.biz/api/customers/{id}

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

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

URL параметры

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

Уникальный идентификатор "Клиента"

 string

Required
fields

Список дополнительных полей, которые необходимо вернуть

 string

Нет

Тело запроса

Нет параметров в теле запроса

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

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

globally unique identifier

Нет
VendorId

string

Нет
Name

string

Поддерживает сортировку
TaxNumber

string

Нет
Location

LocationModel

Дополнительное поле
TradeNetwork

TradeNetworkModel

Дополнительное поле
Office

OfficeModel

Дополнительное поле
Properties

Collection of EntityPropertyValueModel

Дополнительное поле

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

{
  "id": "e01bcc40-424f-44ad-909a-9ff382f8eb58",
  "vendorId": "sample string 2",
  "name": "sample string 3",
  "taxNumber": "sample string 4",
  "location": {
    "country": {
      "id": "7d00246e-f140-4c56-8f42-e736e8fe6f1c",
      "isoCode": "sample string 2",
      "name": "sample string 3"
    },
    "province": {
      "id": "dfcdd12b-617e-4364-8856-5f1791c2c969",
      "name": "sample string 2"
    },
    "settlement": "sample string 1",
    "addressLine": "sample string 2",
    "geoCoordinate": {
      "latitude": 1.1,
      "longitude": 1.1
    }
  },
  "tradeNetwork": {
    "id": "52555b7e-8dd9-47d4-9a63-b9ac5e21bc3f",
    "vendorId": "sample string 2",
    "name": "sample string 3",
    "properties": [
      {
        "entityProperty": {
          "id": "60ebb43b-17cf-4612-bd87-570218f237fa",
          "vendorId": "sample string 2",
          "name": "sample string 3",
          "entityDataType": "string",
          "valueLookup": "contacts",
          "required": true
        },
        "value": "sample string 1"
      },
      {
        "entityProperty": {
          "id": "60ebb43b-17cf-4612-bd87-570218f237fa",
          "vendorId": "sample string 2",
          "name": "sample string 3",
          "entityDataType": "string",
          "valueLookup": "contacts",
          "required": true
        },
        "value": "sample string 1"
      }
    ]
  },
  "office": {
    "id": "d3aef1ee-5d2d-48a2-b5f6-0b7c707fbc4a",
    "vendorId": "sample string 2",
    "name": "sample string 3",
    "responsible": {
      "id": "0d1bb5fa-4c00-4d3b-934b-a7e55db33229",
      "vendorId": "sample string 2",
      "firstName": "sample string 3",
      "lastName": "sample string 4",
      "middleName": "sample string 5",
      "fullName": "sample string 6",
      "imageUrl": "sample string 7",
      "email": "sample string 8",
      "emailConfirmed": true,
      "phoneNumber": "sample string 10",
      "phoneNumberConfirmed": true,
      "twoFactorEnabled": true,
      "lockoutEndDateUtc": "2024-11-21T23:27:48.5043173Z",
      "lockoutEnabled": true,
      "roles": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "location": {
      "country": {
        "id": "7d00246e-f140-4c56-8f42-e736e8fe6f1c",
        "isoCode": "sample string 2",
        "name": "sample string 3"
      },
      "province": {
        "id": "dfcdd12b-617e-4364-8856-5f1791c2c969",
        "name": "sample string 2"
      },
      "settlement": "sample string 1",
      "addressLine": "sample string 2",
      "geoCoordinate": {
        "latitude": 1.1,
        "longitude": 1.1
      }
    },
    "timeZoneId": "sample string 4"
  },
  "properties": [
    {
      "entityProperty": {
        "id": "60ebb43b-17cf-4612-bd87-570218f237fa",
        "vendorId": "sample string 2",
        "name": "sample string 3",
        "entityDataType": "string",
        "valueLookup": "contacts",
        "required": true
      },
      "value": "sample string 1"
    },
    {
      "entityProperty": {
        "id": "60ebb43b-17cf-4612-bd87-570218f237fa",
        "vendorId": "sample string 2",
        "name": "sample string 3",
        "entityDataType": "string",
        "valueLookup": "contacts",
        "required": true
      },
      "value": "sample string 1"
    }
  ]
}

<CustomerModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V1.Customers">
  <Id>e01bcc40-424f-44ad-909a-9ff382f8eb58</Id>
  <Location xmlns:d2p1="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V1.Geo">
    <d2p1:AddressLine>sample string 2</d2p1:AddressLine>
    <d2p1:Country>
      <d2p1:Id>7d00246e-f140-4c56-8f42-e736e8fe6f1c</d2p1:Id>
      <d2p1:IsoCode>sample string 2</d2p1:IsoCode>
      <d2p1:Name>sample string 3</d2p1:Name>
    </d2p1:Country>
    <d2p1:GeoCoordinate>
      <d2p1:Latitude>1.1</d2p1:Latitude>
      <d2p1:Longitude>1.1</d2p1:Longitude>
    </d2p1:GeoCoordinate>
    <d2p1:Province>
      <d2p1:Id>dfcdd12b-617e-4364-8856-5f1791c2c969</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:Province>
    <d2p1:Settlement>sample string 1</d2p1:Settlement>
  </Location>
  <Name>sample string 3</Name>
  <Office xmlns:d2p1="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V1.Offices">
    <d2p1:Id>d3aef1ee-5d2d-48a2-b5f6-0b7c707fbc4a</d2p1:Id>
    <d2p1:Location xmlns:d3p1="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V1.Geo">
      <d3p1:AddressLine>sample string 2</d3p1:AddressLine>
      <d3p1:Country>
        <d3p1:Id>7d00246e-f140-4c56-8f42-e736e8fe6f1c</d3p1:Id>
        <d3p1:IsoCode>sample string 2</d3p1:IsoCode>
        <d3p1:Name>sample string 3</d3p1:Name>
      </d3p1:Country>
      <d3p1:GeoCoordinate>
        <d3p1:Latitude>1.1</d3p1:Latitude>
        <d3p1:Longitude>1.1</d3p1:Longitude>
      </d3p1:GeoCoordinate>
      <d3p1:Province>
        <d3p1:Id>dfcdd12b-617e-4364-8856-5f1791c2c969</d3p1:Id>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:Province>
      <d3p1:Settlement>sample string 1</d3p1:Settlement>
    </d2p1:Location>
    <d2p1:Name>sample string 3</d2p1:Name>
    <d2p1:Responsible xmlns:d3p1="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V1.Users">
      <d3p1:Email>sample string 8</d3p1:Email>
      <d3p1:EmailConfirmed>true</d3p1:EmailConfirmed>
      <d3p1:FirstName>sample string 3</d3p1:FirstName>
      <d3p1:FullName>sample string 6</d3p1:FullName>
      <d3p1:Id>0d1bb5fa-4c00-4d3b-934b-a7e55db33229</d3p1:Id>
      <d3p1:ImageUrl>sample string 7</d3p1:ImageUrl>
      <d3p1:LastName>sample string 4</d3p1:LastName>
      <d3p1:LockoutEnabled>true</d3p1:LockoutEnabled>
      <d3p1:LockoutEndDateUtc>2024-11-21T23:27:48.5043173+00:00</d3p1:LockoutEndDateUtc>
      <d3p1:MiddleName>sample string 5</d3p1:MiddleName>
      <d3p1:PhoneNumber>sample string 10</d3p1:PhoneNumber>
      <d3p1:PhoneNumberConfirmed>true</d3p1:PhoneNumberConfirmed>
      <d3p1:Roles xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d3p1:Roles>
      <d3p1:TwoFactorEnabled>true</d3p1:TwoFactorEnabled>
      <d3p1:VendorId>sample string 2</d3p1:VendorId>
    </d2p1:Responsible>
    <d2p1:TimeZoneId>sample string 4</d2p1:TimeZoneId>
    <d2p1:VendorId>sample string 2</d2p1:VendorId>
  </Office>
  <Properties xmlns:d2p1="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V1.EntityProperties.Values">
    <d2p1:EntityPropertyValueModel>
      <d2p1:EntityProperty xmlns:d4p1="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V1.EntityProperties">
        <d4p1:EntityDataType>String</d4p1:EntityDataType>
        <d4p1:Id>60ebb43b-17cf-4612-bd87-570218f237fa</d4p1:Id>
        <d4p1:Name>sample string 3</d4p1:Name>
        <d4p1:Required>true</d4p1:Required>
        <d4p1:ValueLookup>Contacts</d4p1:ValueLookup>
        <d4p1:VendorId>sample string 2</d4p1:VendorId>
      </d2p1:EntityProperty>
      <d2p1:Value>sample string 1</d2p1:Value>
    </d2p1:EntityPropertyValueModel>
    <d2p1:EntityPropertyValueModel>
      <d2p1:EntityProperty xmlns:d4p1="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V1.EntityProperties">
        <d4p1:EntityDataType>String</d4p1:EntityDataType>
        <d4p1:Id>60ebb43b-17cf-4612-bd87-570218f237fa</d4p1:Id>
        <d4p1:Name>sample string 3</d4p1:Name>
        <d4p1:Required>true</d4p1:Required>
        <d4p1:ValueLookup>Contacts</d4p1:ValueLookup>
        <d4p1:VendorId>sample string 2</d4p1:VendorId>
      </d2p1:EntityProperty>
      <d2p1:Value>sample string 1</d2p1:Value>
    </d2p1:EntityPropertyValueModel>
  </Properties>
  <TaxNumber>sample string 4</TaxNumber>
  <TradeNetwork xmlns:d2p1="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V1.TradeNetworks">
    <d2p1:Id>52555b7e-8dd9-47d4-9a63-b9ac5e21bc3f</d2p1:Id>
    <d2p1:Name>sample string 3</d2p1:Name>
    <d2p1:Properties xmlns:d3p1="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V1.EntityProperties.Values">
      <d3p1:EntityPropertyValueModel>
        <d3p1:EntityProperty xmlns:d5p1="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V1.EntityProperties">
          <d5p1:EntityDataType>String</d5p1:EntityDataType>
          <d5p1:Id>60ebb43b-17cf-4612-bd87-570218f237fa</d5p1:Id>
          <d5p1:Name>sample string 3</d5p1:Name>
          <d5p1:Required>true</d5p1:Required>
          <d5p1:ValueLookup>Contacts</d5p1:ValueLookup>
          <d5p1:VendorId>sample string 2</d5p1:VendorId>
        </d3p1:EntityProperty>
        <d3p1:Value>sample string 1</d3p1:Value>
      </d3p1:EntityPropertyValueModel>
      <d3p1:EntityPropertyValueModel>
        <d3p1:EntityProperty xmlns:d5p1="http://schemas.datacontract.org/2004/07/DDApp.Shared.Api.Models.V1.EntityProperties">
          <d5p1:EntityDataType>String</d5p1:EntityDataType>
          <d5p1:Id>60ebb43b-17cf-4612-bd87-570218f237fa</d5p1:Id>
          <d5p1:Name>sample string 3</d5p1:Name>
          <d5p1:Required>true</d5p1:Required>
          <d5p1:ValueLookup>Contacts</d5p1:ValueLookup>
          <d5p1:VendorId>sample string 2</d5p1:VendorId>
        </d3p1:EntityProperty>
        <d3p1:Value>sample string 1</d3p1:Value>
      </d3p1:EntityPropertyValueModel>
    </d2p1:Properties>
    <d2p1:VendorId>sample string 2</d2p1:VendorId>
  </TradeNetwork>
  <VendorId>sample string 2</VendorId>
</CustomerModel>