three.MF.V3.Tasks.UploadProject 

 1from MF.V3.Task import TaskState as MF_V3_Task_TaskState, Task as MF_V3_Task_Task
 2
 3
 4class UploadProject:
 5    """*
 6    Upload a project to the scanner.  The project must be archived in a ZIP file.
 7
 8    > Request example:
 9
10    ```json
11    {
12    "Task":{
13    "Index":1,
14    "Type":"UploadProject"
15    }
16    }
17    ```
18
19    > Buffer message from client.
20
21    ```json
22    {
23    "Buffer":{
24    "Index":0,
25    "Size":15682096,
26    "Task":{
27    "Index":1,
28    "Type":"UploadProject"
29    }
30    }
31    }
32    ```
33
34    > Binary data transfer from client: The project zip file [15682096 bytes].
35    > Response example:
36
37    ```json
38    {
39    "Task":{
40    "Index":1,
41    "Type":"UploadProject"
42    "State":"Completed"
43    }
44    }
45    ```
46    """
47    class Request:
48
49        """
50         Client request for the `UploadProject` task.
51        """
52        def __init__(self, Index: int, Type: str):
53            # A unique identifier generated by the client.
54            self.Index = Index
55            # "UploadProject"
56            self.Type = Type
57
58    class Response:
59
60        """
61         Server response for the `UploadProject` task.
62        """
63        def __init__(self, Index: int, Type: str, State: MF_V3_Task_TaskState = None, Error: str = None):
64            # The unique identifier generated by the client.
65            self.Index = Index
66            # "UploadProject"
67            self.Type = Type
68            # The current state of the task.
69            self.State = State
70            # A string describing the error if the task has failed.
71            self.Error = Error
72
73    class Buffer:
74
75        """
76         Client buffer message for the `UploadProject` task.
77        """
78        def __init__(self, Index: int, Size: int, Task: MF_V3_Task_Task):
79            # The zero-based index identifying the data buffer.
80            self.Index = Index
81            # The size of the incoming data buffer in bytes.
82            self.Size = Size
83            # The requested UploadProject task.
84            self.Task = Task
85
86    def __init__(self):
87        pass
class UploadProject: 
 5class UploadProject:
 6    """*
 7    Upload a project to the scanner.  The project must be archived in a ZIP file.
 8
 9    > Request example:
10
11    ```json
12    {
13    "Task":{
14    "Index":1,
15    "Type":"UploadProject"
16    }
17    }
18    ```
19
20    > Buffer message from client.
21
22    ```json
23    {
24    "Buffer":{
25    "Index":0,
26    "Size":15682096,
27    "Task":{
28    "Index":1,
29    "Type":"UploadProject"
30    }
31    }
32    }
33    ```
34
35    > Binary data transfer from client: The project zip file [15682096 bytes].
36    > Response example:
37
38    ```json
39    {
40    "Task":{
41    "Index":1,
42    "Type":"UploadProject"
43    "State":"Completed"
44    }
45    }
46    ```
47    """
48    class Request:
49
50        """
51         Client request for the `UploadProject` task.
52        """
53        def __init__(self, Index: int, Type: str):
54            # A unique identifier generated by the client.
55            self.Index = Index
56            # "UploadProject"
57            self.Type = Type
58
59    class Response:
60
61        """
62         Server response for the `UploadProject` task.
63        """
64        def __init__(self, Index: int, Type: str, State: MF_V3_Task_TaskState = None, Error: str = None):
65            # The unique identifier generated by the client.
66            self.Index = Index
67            # "UploadProject"
68            self.Type = Type
69            # The current state of the task.
70            self.State = State
71            # A string describing the error if the task has failed.
72            self.Error = Error
73
74    class Buffer:
75
76        """
77         Client buffer message for the `UploadProject` task.
78        """
79        def __init__(self, Index: int, Size: int, Task: MF_V3_Task_Task):
80            # The zero-based index identifying the data buffer.
81            self.Index = Index
82            # The size of the incoming data buffer in bytes.
83            self.Size = Size
84            # The requested UploadProject task.
85            self.Task = Task
86
87    def __init__(self):
88        pass

* Upload a project to the scanner. The project must be archived in a ZIP file.

Request example:

{
"Task":{
"Index":1,
"Type":"UploadProject"
}
}

Buffer message from client.

{
"Buffer":{
"Index":0,
"Size":15682096,
"Task":{
"Index":1,
"Type":"UploadProject"
}
}
}

Binary data transfer from client: The project zip file [15682096 bytes]. Response example:

{
"Task":{
"Index":1,
"Type":"UploadProject"
"State":"Completed"
}
}
class UploadProject.Request: 
48    class Request:
49
50        """
51         Client request for the `UploadProject` task.
52        """
53        def __init__(self, Index: int, Type: str):
54            # A unique identifier generated by the client.
55            self.Index = Index
56            # "UploadProject"
57            self.Type = Type

Client request for the UploadProject task.

UploadProject.Request(Index: int, Type: str) 
53        def __init__(self, Index: int, Type: str):
54            # A unique identifier generated by the client.
55            self.Index = Index
56            # "UploadProject"
57            self.Type = Type
Index
Type
class UploadProject.Response: 
59    class Response:
60
61        """
62         Server response for the `UploadProject` task.
63        """
64        def __init__(self, Index: int, Type: str, State: MF_V3_Task_TaskState = None, Error: str = None):
65            # The unique identifier generated by the client.
66            self.Index = Index
67            # "UploadProject"
68            self.Type = Type
69            # The current state of the task.
70            self.State = State
71            # A string describing the error if the task has failed.
72            self.Error = Error

Server response for the UploadProject task.

UploadProject.Response( Index: int, Type: str, State: MF.V3.Task.TaskState = None, Error: str = None) 
64        def __init__(self, Index: int, Type: str, State: MF_V3_Task_TaskState = None, Error: str = None):
65            # The unique identifier generated by the client.
66            self.Index = Index
67            # "UploadProject"
68            self.Type = Type
69            # The current state of the task.
70            self.State = State
71            # A string describing the error if the task has failed.
72            self.Error = Error
Index
Type
State
Error
class UploadProject.Buffer: 
74    class Buffer:
75
76        """
77         Client buffer message for the `UploadProject` task.
78        """
79        def __init__(self, Index: int, Size: int, Task: MF_V3_Task_Task):
80            # The zero-based index identifying the data buffer.
81            self.Index = Index
82            # The size of the incoming data buffer in bytes.
83            self.Size = Size
84            # The requested UploadProject task.
85            self.Task = Task

Client buffer message for the UploadProject task.

UploadProject.Buffer(Index: int, Size: int, Task: MF.V3.Task.Task) 
79        def __init__(self, Index: int, Size: int, Task: MF_V3_Task_Task):
80            # The zero-based index identifying the data buffer.
81            self.Index = Index
82            # The size of the incoming data buffer in bytes.
83            self.Size = Size
84            # The requested UploadProject task.
85            self.Task = Task
Index
Size
Task