POST | /api/documentuploads/registerdocuments |
---|
import Foundation
import ServiceStack
/**
* 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 class AddDocumentsForBackgroundRegistration : Codable
{
/**
* List of queued documents to register in background
*/
// @ApiMember(Description="List of queued documents to register in background", IsRequired=true)
public var documents:[RegisterDocument] = []
required public init(){}
}
public class RegisterDocument : Codable
{
public var registrationProfileID:String?
public var values:[RegistrationValue] = []
public var processes:[Process] = []
public var documentUploadId:String?
public var documentId:String?
public var standardDocumentID:String?
public var hasUnsavedChangesInDocument:Bool?
public var isOpenedFromNonDMSLocation:Bool?
required public init(){}
}
public class RegistrationValue : Codable
{
public var key:String?
public var value:String?
public var shadowValue:String?
required public init(){}
}
public class Process : Codable
{
public var id:Int?
public var title:String?
public var Description:String?
public var note:String?
public var coordinator:String?
public var urgent:Bool?
public var transitions:[Transition] = []
required public init(){}
}
public class Transition : Codable
{
public var id:String?
public var reason:String?
public var delayDate:Date?
public var delayReason:String?
public var userIDs:[Int] = []
public var groupIDs:[Int] = []
required public init(){}
}
public class AddDocumentsForBackgroundRegistrationResponse : Codable
{
public var registeredDocumentUploads:[RegisteredDocumentUpload] = []
required public init(){}
}
public class RegisteredDocumentUpload : Codable
{
public var documentUploadID:Int?
public var isSuccess:Bool?
public var message:String?
required public init(){}
}
Swift AddDocumentsForBackgroundRegistration DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
Content-Type: text/csv
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: text/csv Content-Length: length {"RegisteredDocumentUploads":[{"DocumentUploadID":0,"IsSuccess":false,"Message":"String"}]}