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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 0,
	UserId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		LocationName: String,
		LocationKey: 0,
		Count: 0,
		AllCards: 0,
		AllCC: 0,
		DB: 0,
		VSMCDC: 0,
		AX: 0,
		VS: 0,
		MC: 0,
		DC: 0,
		JC: 0,
		CU: 0,
		XX: 0,
		DeviceSummaries: 
		[
			{
				SerialNumber: String,
				Count: 0,
				AllCards: 0,
				AllCC: 0,
				DB: 0,
				VSMCDC: 0,
				AX: 0,
				VS: 0,
				MC: 0,
				DC: 0,
				JC: 0,
				CU: 0,
				XX: 0
			}
		]
	}
]