Express Connect

Dokumentation för API-funktioner

GET Report/Task/{customerId}/Comeback Hämta rapport över återkomster Request Information URI Parameters

Namn	Beskrivning	Typ	Information
customerId	Kund-id	string	Krävs
from	Från och med datum och tid	date
to	Till och med datum och tid	date
date	Vilket datum som från och till ska göra urval på	TaskDateCriteria

Response Information Resource Description Hämta rapport över återkomster Collection of ComebackTaskReportRow

Namn	Beskrivning	Typ	Information
Id	Id	string
Contact	Kontakt som återkomsten gäller	TaskContact
BookedBy	Bokad av	TaskUser
AssignedTo	Vem som uppgiften är tilldelad	TaskAssignment
State	Status på uppgiften	CrmTaskState
Origin	Källa till uppgiften	CrmTaskOrigin
OccursAt	När återkomsten inträffar	date
BookedDate	Bokad datum	date

Kodexempel

CURL kommando
Powershell
.NET c#
PHP


curl "https://connect.maklare.vitec.net/Report/Task/StringValue/Comeback?from=2015-01-01T12:00:00&to=2015-01-01T12:00:00&date=Occurrence" -X GET -H "Authorization: basic {Base64 kodad användarnamn och lösenord}"


$URL = "https://connect.maklare.vitec.net/Report/Task/StringValue/Comeback?from=2015-01-01T12:00:00&to=2015-01-01T12:00:00&date=Occurrence"
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("Report/Task/StringValue/Comeback?from=2015-01-01T12:00:00&to=2015-01-01T12:00:00&date=Occurrence")) {
    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 firstInArray = result[0];
    var id = firstInArray.id.Value;
    // TODO: Gör något med resultatet
}


$URL = "https://connect.maklare.vitec.net/Report/Task/StringValue/Comeback?from=2015-01-01T12:00:00&to=2015-01-01T12:00:00&date=Occurrence";

$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
}

$first = $result[0];
$field_on_result = $first["id"];
// TODO: Gör något med resultatet

Testformulär Text input

Username

Password

customerId

from

date

Response Formats

application/json, text/json
application/xml, text/xml

[
  {
    "id": "sample string 1",
    "contact": {
      "id": "sample string 1",
      "name": "sample string 2"
    },
    "bookedBy": {
      "id": "sample string 1",
      "name": "sample string 2"
    },
    "assignedTo": {
      "user": {
        "id": "sample string 1",
        "name": "sample string 2"
      },
      "userGroup": {
        "id": "sample string 1",
        "name": "sample string 2"
      },
      "office": {
        "customerId": "sample string 1",
        "name": "sample string 2"
      }
    },
    "state": "New",
    "origin": "User",
    "occursAt": "2024-04-28T22:58:37.5691339+02:00",
    "bookedDate": "2024-04-28T22:58:37.5691339+02:00"
  },
  {
    "id": "sample string 1",
    "contact": {
      "id": "sample string 1",
      "name": "sample string 2"
    },
    "bookedBy": {
      "id": "sample string 1",
      "name": "sample string 2"
    },
    "assignedTo": {
      "user": {
        "id": "sample string 1",
        "name": "sample string 2"
      },
      "userGroup": {
        "id": "sample string 1",
        "name": "sample string 2"
      },
      "office": {
        "customerId": "sample string 1",
        "name": "sample string 2"
      }
    },
    "state": "New",
    "origin": "User",
    "occursAt": "2024-04-28T22:58:37.5691339+02:00",
    "bookedDate": "2024-04-28T22:58:37.5691339+02:00"
  }
]

<ArrayOfComebackTaskReportRow xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Express.Connect.Api.Models.Reports">
  <ComebackTaskReportRow>
    <AssignedTo>
      <Office>
        <CustomerId>sample string 1</CustomerId>
        <Name>sample string 2</Name>
      </Office>
      <User>
        <Id>sample string 1</Id>
        <Name>sample string 2</Name>
      </User>
      <UserGroup>
        <Id>sample string 1</Id>
        <Name>sample string 2</Name>
      </UserGroup>
    </AssignedTo>
    <BookedBy>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </BookedBy>
    <BookedDate>2024-04-28T22:58:37.5691339+02:00</BookedDate>
    <Contact>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </Contact>
    <Id>sample string 1</Id>
    <OccursAt>2024-04-28T22:58:37.5691339+02:00</OccursAt>
    <Origin>User</Origin>
    <State>New</State>
  </ComebackTaskReportRow>
  <ComebackTaskReportRow>
    <AssignedTo>
      <Office>
        <CustomerId>sample string 1</CustomerId>
        <Name>sample string 2</Name>
      </Office>
      <User>
        <Id>sample string 1</Id>
        <Name>sample string 2</Name>
      </User>
      <UserGroup>
        <Id>sample string 1</Id>
        <Name>sample string 2</Name>
      </UserGroup>
    </AssignedTo>
    <BookedBy>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </BookedBy>
    <BookedDate>2024-04-28T22:58:37.5691339+02:00</BookedDate>
    <Contact>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </Contact>
    <Id>sample string 1</Id>
    <OccursAt>2024-04-28T22:58:37.5691339+02:00</OccursAt>
    <Origin>User</Origin>
    <State>New</State>
  </ComebackTaskReportRow>
</ArrayOfComebackTaskReportRow>