curl "https://connect.maklare.vitec.net/CRM/Contact/StringValue?AgentId=StringValue&CreatedAtFrom=2015-01-01T12:00:00&CreatedAtTo=2015-01-01T12:00:00&ChangedAtFrom=2015-01-01T12:00:00&ChangedAtTo=2015-01-01T12:00:00&CustomFieldName=StringValue&CustomFieldValue=StringValue&LeadScore=0&ContactScheduledOrderType=0&NewsletterListId=StringValue" -X GET -H "Authorization: basic {Base64 kodad användarnamn och lösenord}"
Dokumentation för API-funktioner
GET CRM/Contact/{customerId}
Hämta lista av kontakter som matchar ett kriterie.
Request Information
URI Parameters
Response Information
Resource Description
Hämta lista av kontakter som matchar ett kriterie.
CrmContactList
Kodexempel
Testformulär
Text input
Response Formats
Namn | Beskrivning | Typ | Information |
customerId | Kund-id. | string |
Krävs |
AgentId | Urval på användareid | string | |
CreatedAtFrom | Skapad från och med | date | |
CreatedAtTo | Skapad till och med | date | |
ChangedAtFrom | Ändrad från och med | date | |
ChangedAtTo | Ändrad till och med | date | |
CustomFieldName | Egendefinerat fältnamn | string | |
CustomFieldValue | Egendefinerat fältvärde | string | |
LeadScore | Antal lead score stjärnor | integer | |
ContactScheduledOrderType | Typ av aktiv tjänst på kontakten | ContactScheduledOrderType | |
NewsletterListId | Nyhetsbrevslista kontakten tillhör | string |
Namn | Beskrivning | Typ | Information |
Persons | Personer som matchats | Collection of CrmContactReference | |
Companies | Företag som matchats | Collection of CrmContactReference | |
DeceasedEstates | Dödsbon som matchats | Collection of CrmContactReference |
$URL = "https://connect.maklare.vitec.net/CRM/Contact/StringValue?AgentId=StringValue&CreatedAtFrom=2015-01-01T12:00:00&CreatedAtTo=2015-01-01T12:00:00&ChangedAtFrom=2015-01-01T12:00:00&ChangedAtTo=2015-01-01T12:00:00&CustomFieldName=StringValue&CustomFieldValue=StringValue&LeadScore=0&ContactScheduledOrderType=0&NewsletterListId=StringValue"
Invoke-WebRequest -Uri $URL -Method GET -Headers @{"authorization" = "basic {Base64 kodad användarnamn och lösenord}"}
// HttpClientInstance ska deklareras som en singleton
// public static readonly HttpClient HttpClientInstance = new HttpClient {
// BaseAddress = new Uri("https://connect.maklare.vitec.net"),
// DefaultRequestHeaders = {
// Authorization = new AuthenticationHeaderValue("Basic", "{Base64 kodad användarnamn och lösenord}")
// }
// }
using (var response = await HttpClientInstance.GetAsync("CRM/Contact/StringValue?AgentId=StringValue&CreatedAtFrom=2015-01-01T12:00:00&CreatedAtTo=2015-01-01T12:00:00&ChangedAtFrom=2015-01-01T12:00:00&ChangedAtTo=2015-01-01T12:00:00&CustomFieldName=StringValue&CustomFieldValue=StringValue&LeadScore=0&ContactScheduledOrderType=0&NewsletterListId=StringValue")) {
if (response.StatusCode == HttpStatusCode.Unauthorized) {
// Authorization headern är inte korrekt
}
if (response.StatusCode == HttpStatusCode.Forbidden) {
// Begärt data som det saknas åtkomst till
}
if (response.StatusCode == HttpStatusCode.InternalServerError) {
// Oväntat fel, kontakta Vitec
}
if (response.StatusCode == HttpStatusCode.BadRequest) {
var json = await response.Content.ReadAsStringAsync();
var result = JsonConvert.DeserializeObject<dynamic>(json);
// Hantera valideringsfel, presenteras i resultatet
}
var json = await response.Content.ReadAsStringAsync();
// JsonConvert finns i biblioteket Newtonsoft.Json
var result = JsonConvert.DeserializeObject<dynamic>(json);
var persons = result.persons.Value ;
// TODO: Gör något med resultatet
}
$URL = "https://connect.maklare.vitec.net/CRM/Contact/StringValue?AgentId=StringValue&CreatedAtFrom=2015-01-01T12:00:00&CreatedAtTo=2015-01-01T12:00:00&ChangedAtFrom=2015-01-01T12:00:00&ChangedAtTo=2015-01-01T12:00:00&CustomFieldName=StringValue&CustomFieldValue=StringValue&LeadScore=0&ContactScheduledOrderType=0&NewsletterListId=StringValue";
$ch = curl_init();
curl_setopt($ch, CURLOPT_USERNAME, "{Användarnamn}");
curl_setopt($ch, CURLOPT_PASSWORD, "{Lösenord}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_URL, $URL);
$result = curl_exec($ch);
if (curl_errno($ch)) {
die(curl_getinfo($ch));
}
$info = curl_getinfo($ch);
curl_close($ch);
$http_code = $info["http_code"];
if ($http_code == 401) {
// Användarnamnet eller lösenordet är felaktigt
}
if ($http_code == 403) {
// Begärt data som det saknas åtkomst till
}
if ($http_code == 500) {
// Oväntat fel, kontakta Vitec
}
if ($http_code == 400) {
$json = json_decode($result, true);
// Hantera valideringsfel, presenteras i $json
}
$field_on_result = $result["persons"];
// TODO: Gör något med resultatet
Resultat av begäran
{ "persons": [ { "id": "sample string 1", "changedAt": "2024-11-21T11:13:17.501382+01:00", "customerId": "sample string 3" }, { "id": "sample string 1", "changedAt": "2024-11-21T11:13:17.501382+01:00", "customerId": "sample string 3" } ], "companies": [ { "id": "sample string 1", "changedAt": "2024-11-21T11:13:17.501382+01:00", "customerId": "sample string 3" }, { "id": "sample string 1", "changedAt": "2024-11-21T11:13:17.501382+01:00", "customerId": "sample string 3" } ], "deceasedEstates": [ { "id": "sample string 1", "changedAt": "2024-11-21T11:13:17.501382+01:00", "customerId": "sample string 3" }, { "id": "sample string 1", "changedAt": "2024-11-21T11:13:17.501382+01:00", "customerId": "sample string 3" } ] }
<CrmContactList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.Contact.Crm"> <Companies> <CrmContactReference> <ChangedAt>2024-11-21T11:13:17.501382+01:00</ChangedAt> <CustomerId>sample string 3</CustomerId> <Id>sample string 1</Id> </CrmContactReference> <CrmContactReference> <ChangedAt>2024-11-21T11:13:17.501382+01:00</ChangedAt> <CustomerId>sample string 3</CustomerId> <Id>sample string 1</Id> </CrmContactReference> </Companies> <DeceasedEstates> <CrmContactReference> <ChangedAt>2024-11-21T11:13:17.501382+01:00</ChangedAt> <CustomerId>sample string 3</CustomerId> <Id>sample string 1</Id> </CrmContactReference> <CrmContactReference> <ChangedAt>2024-11-21T11:13:17.501382+01:00</ChangedAt> <CustomerId>sample string 3</CustomerId> <Id>sample string 1</Id> </CrmContactReference> </DeceasedEstates> <Persons> <CrmContactReference> <ChangedAt>2024-11-21T11:13:17.501382+01:00</ChangedAt> <CustomerId>sample string 3</CustomerId> <Id>sample string 1</Id> </CrmContactReference> <CrmContactReference> <ChangedAt>2024-11-21T11:13:17.501382+01:00</ChangedAt> <CustomerId>sample string 3</CustomerId> <Id>sample string 1</Id> </CrmContactReference> </Persons> </CrmContactList>