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

export enum ProgramName
{
    DO4Outlook = 'DO4Outlook',
    DO4Word = 'DO4Word',
    DO4Excel = 'DO4Excel',
    DO4PowerPoint = 'DO4PowerPoint',
    ITS = 'ITS',
    Other = 'Other',
}

export enum Action
{
    Start = 'Start',
    Command = 'Command',
    Other = 'Other',
}

/**
* Add a statistic entity.
*/
// @Api(Description="Add a statistic entity.")
export class AddStatistic
{
    /**
    * Computername
    */
    // @ApiMember(Description="Computername", IsRequired=true)
    public Computer?: string;

    /**
    * Program for the statistic entry
    */
    // @ApiMember(Description="Program for the statistic entry", IsRequired=true)
    public ProgramName: ProgramName;

    /**
    * Version of the program
    */
    // @ApiMember(Description="Version of the program")
    public ProgramVersion?: string;

    /**
    * Action of statistic
    */
    // @ApiMember(Description="Action of statistic", IsRequired=true)
    public Action: Action;

    /**
    * First parameter
    */
    // @ApiMember(Description="First parameter", IsRequired=true)
    public Param1?: string;

    /**
    * Second parameter
    */
    // @ApiMember(Description="Second parameter")
    public Param2?: string;

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

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