DigiOffice Gateway Web Services

<back to all web services

AddDocumentQueuedForRegistration

Requires Authentication 

export class DocumentQueuedForRegistrationResponse
{
    public DocumentQueuedForRegistrationID?: number;

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

// @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 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 class AddDocumentQueuedForRegistration
{
    public RegistrationProfileID?: string;
    public FileID?: string;
    public Description?: string;
    public Note?: string;
    public UploadOrigin?: string;
    public DocumentID?: string;
    public RootDocumentID?: string;
    public AssignToUserID?: number;
    public AssignToGroupID?: number;
    public MetaData?: MetaDataField[];
    public Mailings?: Mailings;
    public AttachmentsMailings?: AttachmentMailing[];

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

TypeScript AddDocumentQueuedForRegistration DTOs

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

HTTP + CSV

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

POST /csv/reply/AddDocumentQueuedForRegistration HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"RegistrationProfileID":"00000000-0000-0000-0000-000000000000","FileID":"00000000-0000-0000-0000-000000000000","Description":"String","Note":"String","UploadOrigin":"String","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":[{}]}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"DocumentQueuedForRegistrationID":0}