Reporting Services

<back to all web services

LocationSummaryRequest

Requires Authentication
The following routes are available for this service:
All Verbs/CompanyLocations/Summary/{CompanyId}
All Verbs/CompanyLocations/Summary/{CompanyId}/{UserId}
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class LocationSummaryRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $CompanyId=0,
        /** @var string|null */
        public ?string $UserId=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
        if (isset($o['UserId'])) $this->UserId = $o['UserId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
        if (isset($this->UserId)) $o['UserId'] = $this->UserId;
        return empty($o) ? new class(){} : $o;
    }
}

PHP LocationSummaryRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /CompanyLocations/Summary/{CompanyId} HTTP/1.1 
Host: cip-reporting-dev.chargeitpro.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<LocationSummaryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ReportingService.Services.Rest.Locations">
  <CompanyId>0</CompanyId>
  <UserId>String</UserId>
</LocationSummaryRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfLocationSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ReportingService.Data.Models.Location">
  <LocationSummary>
    <AX>0</AX>
    <AllCC>0</AllCC>
    <AllCards>0</AllCards>
    <CU>0</CU>
    <Count>0</Count>
    <DB>0</DB>
    <DC>0</DC>
    <DeviceSummaries>
      <LocationSummary.DeviceSummary>
        <AX>0</AX>
        <AllCC>0</AllCC>
        <AllCards>0</AllCards>
        <CU>0</CU>
        <Count>0</Count>
        <DB>0</DB>
        <DC>0</DC>
        <JC>0</JC>
        <MC>0</MC>
        <SerialNumber>String</SerialNumber>
        <VS>0</VS>
        <VSMCDC>0</VSMCDC>
        <XX>0</XX>
      </LocationSummary.DeviceSummary>
    </DeviceSummaries>
    <JC>0</JC>
    <LocationKey>0</LocationKey>
    <LocationName>String</LocationName>
    <MC>0</MC>
    <VS>0</VS>
    <VSMCDC>0</VSMCDC>
    <XX>0</XX>
  </LocationSummary>
</ArrayOfLocationSummary>