DigiOffice Gateway Web Services

<back to all web services

AddDocument

Requires Authentication 

// @DataContract
export class MetaDataField
{
    // @DataMember
    public ID?: string;

    // @DataMember
    public DocumentVeldID?: string;

    // @DataMember
    public Name?: string;

    // @DataMember
    public Label?: string;

    // @DataMember
    public Datatype?: string;

    // @DataMember
    public PrintLabel?: string;

    // @DataMember
    public Entity?: string;

    // @DataMember
    public PrintValue?: string;

    // @DataMember
    public RegistrationValue?: string;

    // @DataMember
    public SPSiteColumnName?: string;

    // @DataMember
    public ShadowName?: string;

    // @DataMember
    public ShadowDatatype?: string;

    // @DataMember
    public ShadowSPSiteColumnName?: string;

    // @DataMember
    public ShadowSPSiteColumnRegistrationValue?: string;

    // @DataMember
    public ShadowRegistrationValue?: string;

    // @DataMember
    public IsKeyField?: boolean;

    // @DataMember
    public KopierenBijNieuweVersie?: boolean;

    public constructor(init?: Partial<MetaDataField>) { (Object as any).assign(this, init); }
}

export class Bookmark
{
    public RemoveLastBreak?: boolean;
    public ReplaceOnChange?: boolean;
    public IsDynamic?: boolean;

    public constructor(init?: Partial<Bookmark>) { (Object as any).assign(this, init); }
}

export class Mailings
{

    public constructor(init?: Partial<Mailings>) { (Object as any).assign(this, init); }
}

export class AttachmentMailing
{

    public constructor(init?: Partial<AttachmentMailing>) { (Object as any).assign(this, init); }
}

export interface IInformationMessages
{
}

export class DocumentResponse
{
    public DocumentID?: string;
    public DocumentNr?: string;
    public RootDocumentID?: string;
    public MetaData?: MetaDataField[];
    public Bookmarks?: Bookmark[];
    public Mailings?: Mailings;
    public AttachmentsMailings?: AttachmentMailing[];
    public Messages?: IInformationMessages;
    public SourceDocumentPath?: string;
    public DestinationDocumentPath?: string;
    public SharePointContentTypeName?: string;
    public ZIPAttachments?: boolean;

    public constructor(init?: Partial<DocumentResponse>) { (Object as any).assign(this, init); }
}

export enum DocInfoSilentMode
{
    Off = 'Off',
    AllowUserInteraction = 'AllowUserInteraction',
    DoNotAllowUserInteraction = 'DoNotAllowUserInteraction',
}

export class AddDocument
{
    public RegistrationProfileID?: string;
    public DocumentID?: string;
    public RootDocumentID?: string;
    public AssignToUserID?: number;
    public AssignToGroupID?: number;
    public MetaData?: MetaDataField[];
    public Mailings?: Mailings;
    public AttachmentsMailings?: AttachmentMailing[];
    public FileID?: string;
    public SilentMode?: DocInfoSilentMode;
    public updateStorageSystem?: boolean;
    public MessageQueueId?: number;

    public constructor(init?: Partial<AddDocument>) { (Object as any).assign(this, init); }
}

TypeScript AddDocument DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/AddDocument HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"RegistrationProfileID":"00000000-0000-0000-0000-000000000000","DocumentID":"00000000-0000-0000-0000-000000000000","RootDocumentID":"00000000-0000-0000-0000-000000000000","AssignToUserID":0,"AssignToGroupID":0,"MetaData":[{"ID":"00000000-0000-0000-0000-000000000000","DocumentVeldID":"00000000-0000-0000-0000-000000000000","Name":"String","Label":"String","Datatype":"String","PrintLabel":"String","Entity":"String","PrintValue":"String","RegistrationValue":"String","SPSiteColumnName":"String","ShadowName":"String","ShadowDatatype":"String","ShadowSPSiteColumnName":"String","ShadowSPSiteColumnRegistrationValue":"String","ShadowRegistrationValue":"String","IsKeyField":false,"KopierenBijNieuweVersie":false}],"Mailings":{},"AttachmentsMailings":[{}],"FileID":"00000000-0000-0000-0000-000000000000","SilentMode":"Off","updateStorageSystem":false,"MessageQueueId":0}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"DocumentID":"00000000-0000-0000-0000-000000000000","DocumentNr":"String","RootDocumentID":"00000000-0000-0000-0000-000000000000","MetaData":[{"ID":"00000000-0000-0000-0000-000000000000","DocumentVeldID":"00000000-0000-0000-0000-000000000000","Name":"String","Label":"String","Datatype":"String","PrintLabel":"String","Entity":"String","PrintValue":"String","RegistrationValue":"String","SPSiteColumnName":"String","ShadowName":"String","ShadowDatatype":"String","ShadowSPSiteColumnName":"String","ShadowSPSiteColumnRegistrationValue":"String","ShadowRegistrationValue":"String","IsKeyField":false,"KopierenBijNieuweVersie":false}],"Bookmarks":[{"RemoveLastBreak":false,"ReplaceOnChange":false,"IsDynamic":false}],"Mailings":{},"AttachmentsMailings":[{}],"Messages":null,"SourceDocumentPath":"String","DestinationDocumentPath":"String","SharePointContentTypeName":"String","ZIPAttachments":false}