DigiOffice API Services Services

<back to all web services

GetAnalyticsInfo

"use strict";
export class AnalyticsLogInfo {
    /** @param {{Id?:number,DateTime?:string,Browser?:string,Device?:string,Bot?:string,Op?:string,UserId?:string,UserName?:string,ApiKey?:string,Ip?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    DateTime;
    /** @type {string} */
    Browser;
    /** @type {string} */
    Device;
    /** @type {string} */
    Bot;
    /** @type {string} */
    Op;
    /** @type {string} */
    UserId;
    /** @type {string} */
    UserName;
    /** @type {string} */
    ApiKey;
    /** @type {string} */
    Ip;
}
export class GetAnalyticsInfoResponse {
    /** @param {{Months?:string[],Result?:AnalyticsLogInfo,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string[]} */
    Months;
    /** @type {AnalyticsLogInfo} */
    Result;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetAnalyticsInfo {
    /** @param {{Month?:string,Type?:string,Op?:string,ApiKey?:string,UserId?:string,Ip?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    Month;
    /** @type {string} */
    Type;
    /** @type {string} */
    Op;
    /** @type {string} */
    ApiKey;
    /** @type {string} */
    UserId;
    /** @type {string} */
    Ip;
}

JavaScript GetAnalyticsInfo 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 /jsv/reply/GetAnalyticsInfo HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Month: 0001-01-01,
	Type: String,
	Op: String,
	ApiKey: String,
	UserId: String,
	Ip: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Months: 
	[
		String
	],
	Result: 
	{
		Id: 0,
		DateTime: 0001-01-01,
		Browser: String,
		Device: String,
		Bot: String,
		Op: String,
		UserId: String,
		UserName: String,
		ApiKey: String,
		Ip: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}