DigiOffice Gateway Web Services

<back to all web services

AddFileDocumentQueuedForRegistration

Requires Authentication
The following routes are available for this service:
POST/api/documentuploads
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class DocumentQueuedForRegistration implements IConvertible
{
    int? DocumentuploadID;

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

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

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

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

class AddFileDocumentQueuedForRegistration implements IConvertible
{
    String? Note;
    String? Description;
    String? UploadOrigin;
    int? AssignToUserID;
    int? AssignToGroupID;
    String? DocumentInfo;

    AddFileDocumentQueuedForRegistration({this.Note,this.Description,this.UploadOrigin,this.AssignToUserID,this.AssignToGroupID,this.DocumentInfo});
    AddFileDocumentQueuedForRegistration.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Note = json['Note'];
        Description = json['Description'];
        UploadOrigin = json['UploadOrigin'];
        AssignToUserID = json['AssignToUserID'];
        AssignToGroupID = json['AssignToGroupID'];
        DocumentInfo = json['DocumentInfo'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Note': Note,
        'Description': Description,
        'UploadOrigin': UploadOrigin,
        'AssignToUserID': AssignToUserID,
        'AssignToGroupID': AssignToGroupID,
        'DocumentInfo': DocumentInfo
    };

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

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

Dart AddFileDocumentQueuedForRegistration 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/documentuploads HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddFileDocumentQueuedForRegistration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <AssignToGroupID>0</AssignToGroupID>
  <AssignToUserID>0</AssignToUserID>
  <Description>String</Description>
  <DocumentInfo>String</DocumentInfo>
  <Note>String</Note>
  <UploadOrigin>String</UploadOrigin>
</AddFileDocumentQueuedForRegistration>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DocumentQueuedForRegistration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document">
  <DocumentuploadID>0</DocumentuploadID>
</DocumentQueuedForRegistration>