| POST | /api/documentuploads/registerdocuments |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
/**
* 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)
public static class AddDocumentsForBackgroundRegistration
{
/**
* List of queued documents to register in background
*/
@ApiMember(Description="List of queued documents to register in background", IsRequired=true)
public ArrayList<RegisterDocument> Documents = null;
public ArrayList<RegisterDocument> getDocuments() { return Documents; }
public AddDocumentsForBackgroundRegistration setDocuments(ArrayList<RegisterDocument> value) { this.Documents = value; return this; }
}
public static class RegisterDocument
{
public UUID RegistrationProfileID = null;
public ArrayList<RegistrationValue> Values = null;
public ArrayList<Process> Processes = null;
public String DocumentUploadId = null;
public UUID DocumentId = null;
public UUID StandardDocumentID = null;
public Boolean HasUnsavedChangesInDocument = null;
public Boolean IsOpenedFromNonDMSLocation = null;
public UUID getRegistrationProfileID() { return RegistrationProfileID; }
public RegisterDocument setRegistrationProfileID(UUID value) { this.RegistrationProfileID = value; return this; }
public ArrayList<RegistrationValue> getValues() { return Values; }
public RegisterDocument setValues(ArrayList<RegistrationValue> value) { this.Values = value; return this; }
public ArrayList<Process> getProcesses() { return Processes; }
public RegisterDocument setProcesses(ArrayList<Process> value) { this.Processes = value; return this; }
public String getDocumentUploadId() { return DocumentUploadId; }
public RegisterDocument setDocumentUploadId(String value) { this.DocumentUploadId = value; return this; }
public UUID getDocumentId() { return DocumentId; }
public RegisterDocument setDocumentId(UUID value) { this.DocumentId = value; return this; }
public UUID getStandardDocumentID() { return StandardDocumentID; }
public RegisterDocument setStandardDocumentID(UUID value) { this.StandardDocumentID = value; return this; }
public Boolean isHasUnsavedChangesInDocument() { return HasUnsavedChangesInDocument; }
public RegisterDocument setHasUnsavedChangesInDocument(Boolean value) { this.HasUnsavedChangesInDocument = value; return this; }
public Boolean getIsOpenedFromNonDMSLocation() { return IsOpenedFromNonDMSLocation; }
public RegisterDocument setIsOpenedFromNonDMSLocation(Boolean value) { this.IsOpenedFromNonDMSLocation = value; return this; }
}
public static class RegistrationValue
{
public UUID Key = null;
public String Value = null;
public String ShadowValue = null;
public UUID getKey() { return Key; }
public RegistrationValue setKey(UUID value) { this.Key = value; return this; }
public String getValue() { return Value; }
public RegistrationValue setValue(String value) { this.Value = value; return this; }
public String getShadowValue() { return ShadowValue; }
public RegistrationValue setShadowValue(String value) { this.ShadowValue = value; return this; }
}
public static class Process
{
public Integer ID = null;
public String Title = null;
public String Description = null;
public String Note = null;
public String Coordinator = null;
public Boolean Urgent = null;
public ArrayList<Transition> Transitions = null;
public Integer getId() { return ID; }
public Process setId(Integer value) { this.ID = value; return this; }
public String getTitle() { return Title; }
public Process setTitle(String value) { this.Title = value; return this; }
public String getDescription() { return Description; }
public Process setDescription(String value) { this.Description = value; return this; }
public String getNote() { return Note; }
public Process setNote(String value) { this.Note = value; return this; }
public String getCoordinator() { return Coordinator; }
public Process setCoordinator(String value) { this.Coordinator = value; return this; }
public Boolean isUrgent() { return Urgent; }
public Process setUrgent(Boolean value) { this.Urgent = value; return this; }
public ArrayList<Transition> getTransitions() { return Transitions; }
public Process setTransitions(ArrayList<Transition> value) { this.Transitions = value; return this; }
}
public static class Transition
{
public UUID ID = null;
public String Reason = null;
public Date DelayDate = null;
public String DelayReason = null;
public ArrayList<Integer> UserIDs = null;
public ArrayList<Integer> GroupIDs = null;
public UUID getId() { return ID; }
public Transition setId(UUID value) { this.ID = value; return this; }
public String getReason() { return Reason; }
public Transition setReason(String value) { this.Reason = value; return this; }
public Date getDelayDate() { return DelayDate; }
public Transition setDelayDate(Date value) { this.DelayDate = value; return this; }
public String getDelayReason() { return DelayReason; }
public Transition setDelayReason(String value) { this.DelayReason = value; return this; }
public ArrayList<Integer> getUserIDs() { return UserIDs; }
public Transition setUserIDs(ArrayList<Integer> value) { this.UserIDs = value; return this; }
public ArrayList<Integer> getGroupIDs() { return GroupIDs; }
public Transition setGroupIDs(ArrayList<Integer> value) { this.GroupIDs = value; return this; }
}
public static class AddDocumentsForBackgroundRegistrationResponse
{
public ArrayList<RegisteredDocumentUpload> RegisteredDocumentUploads = null;
public ArrayList<RegisteredDocumentUpload> getRegisteredDocumentUploads() { return RegisteredDocumentUploads; }
public AddDocumentsForBackgroundRegistrationResponse setRegisteredDocumentUploads(ArrayList<RegisteredDocumentUpload> value) { this.RegisteredDocumentUploads = value; return this; }
}
public static class RegisteredDocumentUpload
{
public Integer DocumentUploadID = null;
public Boolean IsSuccess = null;
public String Message = null;
public Integer getDocumentUploadID() { return DocumentUploadID; }
public RegisteredDocumentUpload setDocumentUploadID(Integer value) { this.DocumentUploadID = value; return this; }
public Boolean getIsSuccess() { return IsSuccess; }
public RegisteredDocumentUpload setIsSuccess(Boolean value) { this.IsSuccess = value; return this; }
public String getMessage() { return Message; }
public RegisteredDocumentUpload setMessage(String value) { this.Message = value; return this; }
}
}
Java AddDocumentsForBackgroundRegistration DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Documents:
[
{
Values:
[
{
Value: String,
ShadowValue: String
}
],
Processes:
[
{
ID: 0,
Title: String,
Description: String,
Note: String,
Coordinator: String,
Urgent: False,
Transitions:
[
{
Reason: String,
DelayDate: 0001-01-01,
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: text/jsv
Content-Length: length
{
RegisteredDocumentUploads:
[
{
DocumentUploadID: 0,
IsSuccess: False,
Message: String
}
]
}