Express Connect

Dokumentation för API-funktioner

GET BusinessIntelligence/OfficeStatisticsByMonth Hämtar information, sorterad på år och månad, för ett eller flera kontor. Går även att selektera på datumintervall. Ersatt av CommissionOfficeReportByMonth/{customerId} Request Information URI Parameters

Namn	Beskrivning	Typ	Information
licenseId	Kund-id (kontor eller grupp)	string	Krävs
dateFrom	Datum från	date
dateTo	Datum till	date
assignment	Uppdragstyp	BI_Enum_AssignmentType

Response Information Resource Description Ersatt av GET BusinessIntelligence/CommissionOfficeReportByMonth/{customerId} OfficeStatisticsByMonth

Namn	Beskrivning	Typ	Information
OfficeStatistics	Lista på statistik per kontor	Collection of CustomerStatistics

Kodexempel

CURL kommando
Powershell
.NET c#
PHP


curl "https://connect.maklare.vitec.net/BusinessIntelligence/OfficeStatisticsByMonth?licenseId=StringValue&dateFrom=2015-01-01T12:00:00&dateTo=2015-01-01T12:00:00&assignment=0" -X GET -H "Authorization: basic {Base64 kodad användarnamn och lösenord}"


$URL = "https://connect.maklare.vitec.net/BusinessIntelligence/OfficeStatisticsByMonth?licenseId=StringValue&dateFrom=2015-01-01T12:00:00&dateTo=2015-01-01T12:00:00&assignment=0"
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("BusinessIntelligence/OfficeStatisticsByMonth?licenseId=StringValue&dateFrom=2015-01-01T12:00:00&dateTo=2015-01-01T12:00:00&assignment=0")) {
    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 officeStatistics = result.officeStatistics.Value;
    // TODO: Gör något med resultatet
}


$URL = "https://connect.maklare.vitec.net/BusinessIntelligence/OfficeStatisticsByMonth?licenseId=StringValue&dateFrom=2015-01-01T12:00:00&dateTo=2015-01-01T12:00:00&assignment=0";

$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["officeStatistics"];
// TODO: Gör något med resultatet

Testformulär Text input

Username

Password

licenseId

dateFrom

dateTo

assignment

Response Formats

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

{
  "officeStatistics": [
    {
      "customerId": "sample string 1",
      "name": "sample string 2",
      "years": [
        {
          "year": 1,
          "months": [
            {
              "month": 1,
              "commission": 2.1,
              "totalSales": 3.1,
              "commissionPercentage": 4.1,
              "averageCommission": 5.1,
              "attemptedIntakes": 6,
              "sold": 7
            },
            {
              "month": 1,
              "commission": 2.1,
              "totalSales": 3.1,
              "commissionPercentage": 4.1,
              "averageCommission": 5.1,
              "attemptedIntakes": 6,
              "sold": 7
            }
          ]
        },
        {
          "year": 1,
          "months": [
            {
              "month": 1,
              "commission": 2.1,
              "totalSales": 3.1,
              "commissionPercentage": 4.1,
              "averageCommission": 5.1,
              "attemptedIntakes": 6,
              "sold": 7
            },
            {
              "month": 1,
              "commission": 2.1,
              "totalSales": 3.1,
              "commissionPercentage": 4.1,
              "averageCommission": 5.1,
              "attemptedIntakes": 6,
              "sold": 7
            }
          ]
        }
      ]
    },
    {
      "customerId": "sample string 1",
      "name": "sample string 2",
      "years": [
        {
          "year": 1,
          "months": [
            {
              "month": 1,
              "commission": 2.1,
              "totalSales": 3.1,
              "commissionPercentage": 4.1,
              "averageCommission": 5.1,
              "attemptedIntakes": 6,
              "sold": 7
            },
            {
              "month": 1,
              "commission": 2.1,
              "totalSales": 3.1,
              "commissionPercentage": 4.1,
              "averageCommission": 5.1,
              "attemptedIntakes": 6,
              "sold": 7
            }
          ]
        },
        {
          "year": 1,
          "months": [
            {
              "month": 1,
              "commission": 2.1,
              "totalSales": 3.1,
              "commissionPercentage": 4.1,
              "averageCommission": 5.1,
              "attemptedIntakes": 6,
              "sold": 7
            },
            {
              "month": 1,
              "commission": 2.1,
              "totalSales": 3.1,
              "commissionPercentage": 4.1,
              "averageCommission": 5.1,
              "attemptedIntakes": 6,
              "sold": 7
            }
          ]
        }
      ]
    }
  ]
}

<OfficeStatisticsByMonth xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Connect.Models.BusinessIntelligence">
  <OfficeStatistics>
    <CustomerStatistics>
      <CustomerId>sample string 1</CustomerId>
      <Name>sample string 2</Name>
      <Years>
        <YearStatisticsSummary>
          <Months>
            <MonthStatisticsSummary>
              <AttemptedIntakes>6</AttemptedIntakes>
              <AverageCommission>5.1</AverageCommission>
              <Commission>2.1</Commission>
              <CommissionPercentage>4.1</CommissionPercentage>
              <Month>1</Month>
              <Sold>7</Sold>
              <TotalSales>3.1</TotalSales>
            </MonthStatisticsSummary>
            <MonthStatisticsSummary>
              <AttemptedIntakes>6</AttemptedIntakes>
              <AverageCommission>5.1</AverageCommission>
              <Commission>2.1</Commission>
              <CommissionPercentage>4.1</CommissionPercentage>
              <Month>1</Month>
              <Sold>7</Sold>
              <TotalSales>3.1</TotalSales>
            </MonthStatisticsSummary>
          </Months>
          <Year>1</Year>
        </YearStatisticsSummary>
        <YearStatisticsSummary>
          <Months>
            <MonthStatisticsSummary>
              <AttemptedIntakes>6</AttemptedIntakes>
              <AverageCommission>5.1</AverageCommission>
              <Commission>2.1</Commission>
              <CommissionPercentage>4.1</CommissionPercentage>
              <Month>1</Month>
              <Sold>7</Sold>
              <TotalSales>3.1</TotalSales>
            </MonthStatisticsSummary>
            <MonthStatisticsSummary>
              <AttemptedIntakes>6</AttemptedIntakes>
              <AverageCommission>5.1</AverageCommission>
              <Commission>2.1</Commission>
              <CommissionPercentage>4.1</CommissionPercentage>
              <Month>1</Month>
              <Sold>7</Sold>
              <TotalSales>3.1</TotalSales>
            </MonthStatisticsSummary>
          </Months>
          <Year>1</Year>
        </YearStatisticsSummary>
      </Years>
    </CustomerStatistics>
    <CustomerStatistics>
      <CustomerId>sample string 1</CustomerId>
      <Name>sample string 2</Name>
      <Years>
        <YearStatisticsSummary>
          <Months>
            <MonthStatisticsSummary>
              <AttemptedIntakes>6</AttemptedIntakes>
              <AverageCommission>5.1</AverageCommission>
              <Commission>2.1</Commission>
              <CommissionPercentage>4.1</CommissionPercentage>
              <Month>1</Month>
              <Sold>7</Sold>
              <TotalSales>3.1</TotalSales>
            </MonthStatisticsSummary>
            <MonthStatisticsSummary>
              <AttemptedIntakes>6</AttemptedIntakes>
              <AverageCommission>5.1</AverageCommission>
              <Commission>2.1</Commission>
              <CommissionPercentage>4.1</CommissionPercentage>
              <Month>1</Month>
              <Sold>7</Sold>
              <TotalSales>3.1</TotalSales>
            </MonthStatisticsSummary>
          </Months>
          <Year>1</Year>
        </YearStatisticsSummary>
        <YearStatisticsSummary>
          <Months>
            <MonthStatisticsSummary>
              <AttemptedIntakes>6</AttemptedIntakes>
              <AverageCommission>5.1</AverageCommission>
              <Commission>2.1</Commission>
              <CommissionPercentage>4.1</CommissionPercentage>
              <Month>1</Month>
              <Sold>7</Sold>
              <TotalSales>3.1</TotalSales>
            </MonthStatisticsSummary>
            <MonthStatisticsSummary>
              <AttemptedIntakes>6</AttemptedIntakes>
              <AverageCommission>5.1</AverageCommission>
              <Commission>2.1</Commission>
              <CommissionPercentage>4.1</CommissionPercentage>
              <Month>1</Month>
              <Sold>7</Sold>
              <TotalSales>3.1</TotalSales>
            </MonthStatisticsSummary>
          </Months>
          <Year>1</Year>
        </YearStatisticsSummary>
      </Years>
    </CustomerStatistics>
  </OfficeStatistics>
</OfficeStatisticsByMonth>