POST api/bitrix24/ContactInfo
Получение информации о контакте из Битрикс24 по его идентификатору
Request Information
URI Parameters
None.
Body Parameters
ContactInfoRequestName | Description | Type | Additional information |
---|---|---|---|
ApiURL |
Адрес метода Bitrix24, который нужно вызвать |
string |
None. |
ContactId |
Идентификатор контакта в Битрикс24 |
string |
None. |
Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
Sample:
{ "ApiURL": "sample string 1", "ContactId": "sample string 2", "Operator": 1, "Token": 1, "SiteCode": "sample string 3" }
application/xml, text/xml
Sample:
<ContactInfoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.Bitrix24Request"> <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 3</SiteCode> <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token> <ApiURL>sample string 1</ApiURL> <ContactId>sample string 2</ContactId> </ContactInfoRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ContactInfoResponseName | Description | Type | Additional information |
---|---|---|---|
Data |
Массив данных из Битрикс24 |
Collection of ContactInfoData |
None. |
ErrorCode |
Код ошибки |
integer |
None. |
Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "Id": 1, "Name": "sample string 1", "Value": "sample string 2", "Type": "sample string 3", "TypeId": "sample string 4" }, { "Id": 1, "Name": "sample string 1", "Value": "sample string 2", "Type": "sample string 3", "TypeId": "sample string 4" } ], "ErrorCode": 1, "Message": "sample string 2" }
application/xml, text/xml
Sample:
<ContactInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.Bitrix24Response"> <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> <ContactInfoData> <Id>1</Id> <Name>sample string 1</Name> <Type>sample string 3</Type> <TypeId>sample string 4</TypeId> <Value>sample string 2</Value> </ContactInfoData> <ContactInfoData> <Id>1</Id> <Name>sample string 1</Name> <Type>sample string 3</Type> <TypeId>sample string 4</TypeId> <Value>sample string 2</Value> </ContactInfoData> </Data> </ContactInfoResponse>