DigiOffice Gateway Web Services

<back to all web services

AddUploadFile

Add a uploadfile with metadata.

Requires Authentication
The following routes are available for this service:
POST/api/DMS/AddUploadFile

// @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); }
}

/** @description Add a uploadfile with metadata. */
// @Api(Description="Add a uploadfile with metadata.")
export class AddUploadFile
{
    /** @description Registration profile ID */
    // @ApiMember(Description="Registration profile ID", IsRequired=true)
    public RegistrationProfileID: string;

    /** @description Registration navigation path */
    // @ApiMember(Description="Registration navigation path")
    public NavigationPath: string;

    /** @description File name */
    // @ApiMember(Description="File name", IsRequired=true)
    public FileName: string;

    /** @description File date */
    // @ApiMember(Description="File date", IsRequired=true)
    public FileDate: string;

    /** @description File content */
    // @ApiMember(Description="File content", IsRequired=true)
    public FileContent: string = [];

    /** @description File description */
    // @ApiMember(Description="File description", IsRequired=true)
    public Description: string;

    /** @description Keep document in uploads (false; register immediately) */
    // @ApiMember(Description="Keep document in uploads (false; register immediately)")
    public DocumentUpload: boolean;

    /** @description Source of the file */
    // @ApiMember(Description="Source of the file")
    public Source: string;

    /** @description MetaDataFields */
    // @ApiMember(Description="MetaDataFields")
    public MetaDataFields: MetaDataField[];

    /** @description Document ID */
    // @ApiMember(Description="Document ID")
    public DocumentID?: string;

    /** @description Main Document ID */
    // @ApiMember(Description="Main Document ID")
    public MainDocumentID?: string;

    /** @description Sub Document IDs */
    // @ApiMember(Description="Sub Document IDs")
    public SubDocumentIDs: string[];

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

export enum MessageType
{
    Information = 1,
    Warning = 2,
    Error = 3,
    Success = 4,
}

export class InformationMessageBase implements IInformationMessage
{
    public Type: MessageType;
    public Summary: string;
    public FullMessage: string;
    public FieldName: string;
    public KeepOpen: boolean;

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

export class InformationMessages extends Array<InformationMessageBase> implements IInformationMessages
{

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

// @DataContract
export class AddUploadFileResponse
{
    // @DataMember
    public DocumentId?: string;

    // @DataMember
    public DocumentUploadId?: number;

    // @DataMember
    public DocumentNr: string;

    // @DataMember
    public Messages: InformationMessages;

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

TypeScript AddUploadFile 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 /api/DMS/AddUploadFile HTTP/1.1 
Host: test-dogw.klokgroep.nl 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"RegistrationProfileID":"00000000-0000-0000-0000-000000000000","NavigationPath":"String","FileName":"String","FileDate":"0001-01-01T00:00:00.0000000","FileContent":"AA==","Description":"String","DocumentUpload":false,"Source":"String","MetaDataFields":[{"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}],"DocumentID":"00000000-0000-0000-0000-000000000000","MainDocumentID":"00000000-0000-0000-0000-000000000000","SubDocumentIDs":["00000000-0000-0000-0000-000000000000"]}

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

{"DocumentId":"00000000-0000-0000-0000-000000000000","DocumentUploadId":0,"DocumentNr":"String","Messages":[{}]}