DigiOffice Gateway Web Services

<back to all web services

AddStatistic

Add a statistic entity.

Requires Authentication
The following routes are available for this service:
POST/api/statistics
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


class ProgramName(str, Enum):
    D_O4_OUTLOOK = 'DO4Outlook'
    D_O4_WORD = 'DO4Word'
    D_O4_EXCEL = 'DO4Excel'
    D_O4_POWER_POINT = 'DO4PowerPoint'
    ITS = 'ITS'
    OTHER = 'Other'


class Action(str, Enum):
    START = 'Start'
    COMMAND = 'Command'
    OTHER = 'Other'


# @Api(Description="Add a statistic entity.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddStatistic:
    """
    Add a statistic entity.
    """

    # @ApiMember(Description="Computername", IsRequired=true)
    computer: Optional[str] = None
    """
    Computername
    """


    # @ApiMember(Description="Program for the statistic entry", IsRequired=true)
    program_name: Optional[ProgramName] = None
    """
    Program for the statistic entry
    """


    # @ApiMember(Description="Version of the program")
    program_version: Optional[str] = None
    """
    Version of the program
    """


    # @ApiMember(Description="Action of statistic", IsRequired=true)
    action: Optional[Action] = None
    """
    Action of statistic
    """


    # @ApiMember(Description="First parameter", IsRequired=true)
    param1: Optional[str] = None
    """
    First parameter
    """


    # @ApiMember(Description="Second parameter")
    param2: Optional[str] = None
    """
    Second parameter
    """

Python AddStatistic 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 /api/statistics HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Computer: String,
	ProgramName: DO4Outlook,
	ProgramVersion: String,
	Action: Start,
	Param1: String,
	Param2: String
}