DigiOffice API Services Services

GetAnalyticsInfo


// @DataContract
export class AnalyticsLogInfo
{
    // @DataMember(Order=1)
    public Id: number;

    // @DataMember(Order=2)
    public DateTime: string;

    // @DataMember(Order=3)
    public Browser: string;

    // @DataMember(Order=4)
    public Device: string;

    // @DataMember(Order=5)
    public Bot: string;

    // @DataMember(Order=6)
    public Op: string;

    // @DataMember(Order=7)
    public UserId: string;

    // @DataMember(Order=8)
    public UserName: string;

    // @DataMember(Order=9)
    public ApiKey: string;

    // @DataMember(Order=10)
    public Ip: string;

    public constructor(init?: Partial<AnalyticsLogInfo>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GetAnalyticsInfoResponse
{
    // @DataMember(Order=1)
    public Months: string[];

    // @DataMember(Order=2)
    public Result: AnalyticsLogInfo;

    // @DataMember(Order=3)
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<GetAnalyticsInfoResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GetAnalyticsInfo implements IGet
{
    // @DataMember(Order=1)
    public Month?: string;

    // @DataMember(Order=2)
    public Type: string;

    // @DataMember(Order=3)
    public Op: string;

    // @DataMember(Order=4)
    public ApiKey: string;

    // @DataMember(Order=5)
    public UserId: string;

    // @DataMember(Order=6)
    public Ip: string;

    public constructor(init?: Partial<GetAnalyticsInfo>) { (Object as any).assign(this, init); }
}

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