DigiOffice Gateway Web Services

AddDocumentsForBackgroundRegistration

Register documents queueud for registration in background

The following routes are available for this service:
POST	/api/documentuploads/registerdocuments


export class RegisteredDocumentUpload
{
    public DocumentUploadID?: number;
    public IsSuccess?: boolean;
    public Message?: string;

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

export class AddDocumentsForBackgroundRegistrationResponse
{
    public RegisteredDocumentUploads?: RegisteredDocumentUpload[];

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

export class RegistrationValue
{
    public Key?: string;
    public Value?: string;
    public ShadowValue?: string;

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

export class Transition
{
    public ID?: string;
    public Reason?: string;
    public DelayDate?: string;
    public DelayReason?: string;
    public UserIDs?: number[];
    public GroupIDs?: number[];

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

export class Process
{
    public ID?: number;
    public Title?: string;
    public Description?: string;
    public Note?: string;
    public Coordinator?: string;
    public Urgent?: boolean;
    public Transitions?: Transition[];

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

export class RegisterDocument
{
    public RegistrationProfileID?: string;
    public Values?: RegistrationValue[];
    public Processes?: Process[];
    public DocumentUploadId?: string;
    public DocumentId?: string;
    public StandardDocumentID?: string;
    public HasUnsavedChangesInDocument?: boolean;
    public IsOpenedFromNonDMSLocation?: boolean;

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

/**
* Register documents queueud for registration in background
*/
// @Api(Description="Register documents queueud for registration in background")
// @ApiResponse(Description="All queued documents are linked to a systemtask for background processing", StatusCode=200)
export class AddDocumentsForBackgroundRegistration
{
    /**
    * List of queued documents to register in background
    */
    // @ApiMember(Description="List of queued documents to register in background", IsRequired=true)
    public Documents: RegisterDocument[];

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

TypeScript AddDocumentsForBackgroundRegistration 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/documentuploads/registerdocuments HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Documents":[{"RegistrationProfileID":"00000000-0000-0000-0000-000000000000","Values":[{"Key":"00000000-0000-0000-0000-000000000000","Value":"String","ShadowValue":"String"}],"Processes":[{"ID":0,"Title":"String","Description":"String","Note":"String","Coordinator":"String","Urgent":false,"Transitions":[{"ID":"00000000-0000-0000-0000-000000000000","Reason":"String","DelayDate":"0001-01-01T00:00:00.0000000","DelayReason":"String","UserIDs":[0],"GroupIDs":[0]}]}],"DocumentUploadId":"String","DocumentId":"00000000-0000-0000-0000-000000000000","StandardDocumentID":"00000000-0000-0000-0000-000000000000","HasUnsavedChangesInDocument":false,"IsOpenedFromNonDMSLocation":false}]}

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

{"RegisteredDocumentUploads":[{"DocumentUploadID":0,"IsSuccess":false,"Message":"String"}]}