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 Foundation
import ServiceStack

/**
* Add a statistic entity.
*/
// @Api(Description="Add a statistic entity.")
public class AddStatistic : Codable
{
    /**
    * Computername
    */
    // @ApiMember(Description="Computername", IsRequired=true)
    public var computer:String?

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

    /**
    * Version of the program
    */
    // @ApiMember(Description="Version of the program")
    public var programVersion:String?

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

    /**
    * First parameter
    */
    // @ApiMember(Description="First parameter", IsRequired=true)
    public var param1:String?

    /**
    * Second parameter
    */
    // @ApiMember(Description="Second parameter")
    public var param2:String?

    required public init(){}
}

public enum ProgramName : String, Codable
{
    case DO4Outlook
    case DO4Word
    case DO4Excel
    case DO4PowerPoint
    case ITS
    case Other
}

public enum Action : String, Codable
{
    case Start
    case Command
    case Other
}


Swift AddStatistic DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<AddStatistic xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Statistics.Operations">
  <Action>Start</Action>
  <Computer>String</Computer>
  <Param1>String</Param1>
  <Param2>String</Param2>
  <ProgramName>DO4Outlook</ProgramName>
  <ProgramVersion>String</ProgramVersion>
</AddStatistic>