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": "32352275-b9c5-4cb1-b13c-94a8211c7d4c",
"vendorId": "sample string 2",
"name": "sample string 3",
"taxNumber": "sample string 4",
"location": {
"country": {
"id": "cc7a9ca7-0142-4350-8341-33cf3332cc09",
"isoCode": "sample string 2",
"name": "sample string 3"
},
"province": {
"id": "1d42252f-b5ef-4564-8e01-e482144eed0f",
"name": "sample string 2"
},
"settlement": "sample string 1",
"addressLine": "sample string 2",
"geoCoordinate": {
"latitude": 1.1,
"longitude": 1.1
}
},
"tradeNetwork": {
"id": "0440852e-f720-49e9-b8bd-f35bd384924d",
"vendorId": "sample string 2",
"name": "sample string 3",
"properties": [
{
"entityProperty": {
"id": "e2c7c76b-0b4b-4f0f-9dba-e700d8a47612",
"vendorId": "sample string 2",
"name": "sample string 3",
"entityDataType": "string",
"valueLookup": "contacts",
"required": true
},
"value": "sample string 1"
},
{
"entityProperty": {
"id": "e2c7c76b-0b4b-4f0f-9dba-e700d8a47612",
"vendorId": "sample string 2",
"name": "sample string 3",
"entityDataType": "string",
"valueLookup": "contacts",
"required": true
},
"value": "sample string 1"
}
]
},
"office": {
"id": "9b47c5c7-5a6e-4eb3-a639-1bebe25352ce",
"vendorId": "sample string 2",
"name": "sample string 3",
"responsible": {
"id": "63e2577d-d223-4089-a521-dbdc12ebccb2",
"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": "2025-11-03T21:55:20.4722687Z",
"lockoutEnabled": true,
"roles": [
"sample string 1",
"sample string 2"
]
},
"location": {
"country": {
"id": "cc7a9ca7-0142-4350-8341-33cf3332cc09",
"isoCode": "sample string 2",
"name": "sample string 3"
},
"province": {
"id": "1d42252f-b5ef-4564-8e01-e482144eed0f",
"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": "e2c7c76b-0b4b-4f0f-9dba-e700d8a47612",
"vendorId": "sample string 2",
"name": "sample string 3",
"entityDataType": "string",
"valueLookup": "contacts",
"required": true
},
"value": "sample string 1"
},
{
"entityProperty": {
"id": "e2c7c76b-0b4b-4f0f-9dba-e700d8a47612",
"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>32352275-b9c5-4cb1-b13c-94a8211c7d4c</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>cc7a9ca7-0142-4350-8341-33cf3332cc09</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>1d42252f-b5ef-4564-8e01-e482144eed0f</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>9b47c5c7-5a6e-4eb3-a639-1bebe25352ce</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>cc7a9ca7-0142-4350-8341-33cf3332cc09</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>1d42252f-b5ef-4564-8e01-e482144eed0f</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>63e2577d-d223-4089-a521-dbdc12ebccb2</d3p1:Id>
<d3p1:ImageUrl>sample string 7</d3p1:ImageUrl>
<d3p1:LastName>sample string 4</d3p1:LastName>
<d3p1:LockoutEnabled>true</d3p1:LockoutEnabled>
<d3p1:LockoutEndDateUtc>2025-11-03T21:55:20.4722687+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>e2c7c76b-0b4b-4f0f-9dba-e700d8a47612</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>e2c7c76b-0b4b-4f0f-9dba-e700d8a47612</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>0440852e-f720-49e9-b8bd-f35bd384924d</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>e2c7c76b-0b4b-4f0f-9dba-e700d8a47612</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>e2c7c76b-0b4b-4f0f-9dba-e700d8a47612</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>