DigiOffice Gateway Web Services

<back to all web services

UpdateDocumentRegistration

Requires Authentication
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using IDB.API.DTO.Document.Operations;
using IDB.API.DTO.Registrationprofile;
using IDB.API.DTO.Workflow;

namespace IDB.API.DTO.Document.Operations
{
    public partial class RegisterDocumentResponse
    {
        public RegisterDocumentResponse()
        {
            ErrorMessages = new List<string>{};
        }

        public virtual bool IsSucces { get; set; }
        public virtual Guid DocumentId { get; set; }
        public virtual List<string> ErrorMessages { get; set; }
        public virtual string Ooxml { get; set; }
        ///<summary>
        ///Is it a corporate identity document?
        ///</summary>
        [ApiMember(Description="Is it a corporate identity document?", IsRequired=true)]
        public virtual bool IsCorporateIdentity { get; set; }

        public virtual IDictionary<string, string> DocumentVariables { get; set; }
    }

    public partial class UpdateDocumentRegistration
    {
        public UpdateDocumentRegistration()
        {
            Values = new List<RegistrationValue>{};
            Processes = new List<Process>{};
        }

        public virtual Guid DocumentID { get; set; }
        public virtual List<RegistrationValue> Values { get; set; }
        public virtual List<Process> Processes { get; set; }
        public virtual bool GenerateOoxml { get; set; }
    }

}

namespace IDB.API.DTO.Registrationprofile
{
    public partial class RegistrationValue
    {
        public virtual Guid Key { get; set; }
        public virtual string Value { get; set; }
        public virtual string ShadowValue { get; set; }
    }

}

namespace IDB.API.DTO.Workflow
{
    public partial class Process
    {
        public Process()
        {
            Transitions = new List<Transition>{};
        }

        public virtual int ID { get; set; }
        public virtual string Title { get; set; }
        public virtual string Description { get; set; }
        public virtual string Note { get; set; }
        public virtual string Coordinator { get; set; }
        public virtual bool Urgent { get; set; }
        public virtual List<Transition> Transitions { get; set; }
    }

    public partial class Transition
    {
        public Transition()
        {
            UserIDs = new List<int>{};
            GroupIDs = new List<int>{};
        }

        public virtual Guid ID { get; set; }
        public virtual string Reason { get; set; }
        public virtual DateTime? DelayDate { get; set; }
        public virtual string DelayReason { get; set; }
        public virtual List<int> UserIDs { get; set; }
        public virtual List<int> GroupIDs { get; set; }
    }

}

C# UpdateDocumentRegistration 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 /jsv/reply/UpdateDocumentRegistration HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Values: 
	[
		{
			Value: String,
			ShadowValue: String
		}
	],
	Processes: 
	[
		{
			ID: 0,
			Title: String,
			Description: String,
			Note: String,
			Coordinator: String,
			Urgent: False,
			Transitions: 
			[
				{
					Reason: String,
					DelayDate: 0001-01-01,
					DelayReason: String,
					UserIDs: 
					[
						0
					],
					GroupIDs: 
					[
						0
					]
				}
			]
		}
	],
	GenerateOoxml: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	IsSucces: False,
	ErrorMessages: 
	[
		String
	],
	Ooxml: String,
	IsCorporateIdentity: False
}