DigiOffice Gateway Web Services

<back to all web services

GetDocumentUrl

Requires Authentication
The following routes are available for this service:
GET POST/api/documents/{DocumentID}/wopipreviewurl
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class GetDocumentUrlResponse implements IConvertible
{
    String? Url;
    bool? IsSharePointOnlineDocument;

    GetDocumentUrlResponse({this.Url,this.IsSharePointOnlineDocument});
    GetDocumentUrlResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Url = json['Url'];
        IsSharePointOnlineDocument = json['IsSharePointOnlineDocument'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Url': Url,
        'IsSharePointOnlineDocument': IsSharePointOnlineDocument
    };

    getTypeName() => "GetDocumentUrlResponse";
    TypeContext? context = _ctx;
}

class GetDocumentUrl implements IConvertible
{
    String? DocumentID;

    GetDocumentUrl({this.DocumentID});
    GetDocumentUrl.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        DocumentID = json['DocumentID'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'DocumentID': DocumentID
    };

    getTypeName() => "GetDocumentUrl";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'digiofficeapigateway.deltares.nl', types: <String, TypeInfo> {
    'GetDocumentUrlResponse': TypeInfo(TypeOf.Class, create:() => GetDocumentUrlResponse()),
    'GetDocumentUrl': TypeInfo(TypeOf.Class, create:() => GetDocumentUrl()),
});

Dart GetDocumentUrl 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/documents/{DocumentID}/wopipreviewurl HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetDocumentUrl xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <DocumentID>00000000-0000-0000-0000-000000000000</DocumentID>
</GetDocumentUrl>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetDocumentUrlResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <IsSharePointOnlineDocument>false</IsSharePointOnlineDocument>
  <Url>String</Url>
</GetDocumentUrlResponse>