DigiOffice Gateway Web Services

<back to all web services

UpdateDocumentRegistration

Requires Authentication
namespace IDB.API.DTO.Document.Operations

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type RegisterDocumentResponse() = 
        member val IsSucces:Boolean = new Boolean() with get,set
        member val DocumentId:Guid = new Guid() with get,set
        member val ErrorMessages:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Ooxml:String = null with get,set
        ///<summary>
        ///Is it a corporate identity document?
        ///</summary>
        [<ApiMember(Description="Is it a corporate identity document?", IsRequired=true)>]
        member val IsCorporateIdentity:Boolean = new Boolean() with get,set

        member val DocumentVariables:IDictionary<String, String> = null with get,set

    [<AllowNullLiteral>]
    type RegistrationValue() = 
        member val Key:Guid = new Guid() with get,set
        member val Value:String = null with get,set
        member val ShadowValue:String = null with get,set

    [<AllowNullLiteral>]
    type Transition() = 
        member val ID:Guid = new Guid() with get,set
        member val Reason:String = null with get,set
        member val DelayDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DelayReason:String = null with get,set
        member val UserIDs:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set
        member val GroupIDs:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set

    [<AllowNullLiteral>]
    type Process() = 
        member val ID:Int32 = new Int32() with get,set
        member val Title:String = null with get,set
        member val Description:String = null with get,set
        member val Note:String = null with get,set
        member val Coordinator:String = null with get,set
        member val Urgent:Boolean = new Boolean() with get,set
        member val Transitions:ResizeArray<Transition> = new ResizeArray<Transition>() with get,set

    [<AllowNullLiteral>]
    type UpdateDocumentRegistration() = 
        member val DocumentID:Guid = new Guid() with get,set
        member val Values:ResizeArray<RegistrationValue> = new ResizeArray<RegistrationValue>() with get,set
        member val Processes:ResizeArray<Process> = new ResizeArray<Process>() with get,set
        member val GenerateOoxml:Boolean = new Boolean() with get,set

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

<UpdateDocumentRegistration 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>
  <GenerateOoxml>false</GenerateOoxml>
  <Processes xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Workflow">
    <d2p1:Process>
      <d2p1:Coordinator>String</d2p1:Coordinator>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:ID>0</d2p1:ID>
      <d2p1:Note>String</d2p1:Note>
      <d2p1:Title>String</d2p1:Title>
      <d2p1:Transitions>
        <d2p1:Transition>
          <d2p1:DelayDate>0001-01-01T00:00:00</d2p1:DelayDate>
          <d2p1:DelayReason>String</d2p1:DelayReason>
          <d2p1:GroupIDs xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>0</d6p1:int>
          </d2p1:GroupIDs>
          <d2p1:ID>00000000-0000-0000-0000-000000000000</d2p1:ID>
          <d2p1:Reason>String</d2p1:Reason>
          <d2p1:UserIDs xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>0</d6p1:int>
          </d2p1:UserIDs>
        </d2p1:Transition>
      </d2p1:Transitions>
      <d2p1:Urgent>false</d2p1:Urgent>
    </d2p1:Process>
  </Processes>
  <Values xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Registrationprofile">
    <d2p1:RegistrationValue>
      <d2p1:Key>00000000-0000-0000-0000-000000000000</d2p1:Key>
      <d2p1:ShadowValue>String</d2p1:ShadowValue>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:RegistrationValue>
  </Values>
</UpdateDocumentRegistration>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RegisterDocumentResponse 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>
  <DocumentVariables xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <ErrorMessages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ErrorMessages>
  <IsCorporateIdentity>false</IsCorporateIdentity>
  <IsSucces>false</IsSucces>
  <Ooxml>String</Ooxml>
</RegisterDocumentResponse>