newProtocolPrintedCopy

This method allows creating printed copy data:

Java class
Request	web/wwwroot/ws/java/document/NewProtocolPrintedCopyRequestType.java
Return	web/wwwroot/ws/java/document/NewProtocolPrintedCopyResponseType.java

Request:

ID #	Required	Description
ProtocolID	X	Protocol ID #.
Copytype	X	Copy type: 1 - controlled; 2 - uncontrolled.
Date		Issue date (if it is not entered, the current date will be considered). The date format must be Y-M-D (Year-Month-Day).
ReasonID		Distribution reason ID #.
Responsible	X	Issuer ID.
CopyStationID		Copy station ID #.
Copystationresp		ID of the user responsible for the station.
Company		Company.
Companyresp		Company responsible party.
Observation		Comments
Status	X	Protocol status: 1 - Awaiting receiving confirmation; 2 - Receiving confirmed.
Receivingresp		ID of the user responsible for receiving (if it is not entered, and STATUS is 2, RESPONSIBLE will be considered).
Receivingdate		Receiving date (if it is not entered, and STATUS is 2, the current date will be considered). The date format must be Y-M-D (Year-Month-Day).
DocumentsList	X	List of documents: • Document ID #; • Revision ID # (controlled copy: must be blank; uncontrolled copy: if it is not entered, the current revision will be considered); • Document category ID # (required when there is more than one document with the same ID # in different categories); • Number of copies.
DestType	X	Addressee type: 1 - Copy station; 2 - Organizational unit; 3 - User.
CtrlTeam	X	Default control team ID #.
CopyStationId	X¹	Copy station ID #.
DepartmentId	X²	Organizational unit ID #.
UserId	X³	User ID.

info

• X¹ - Required when DestType is equal to 1;
• X² - Required when DestType is equal to 2;
• X³ - Required when DestType is equal to 3;

Request structure:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:document">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:newProtocolPrintedCopy>
         <!--You may enter the following 18 items in any order-->
         <urn:ProtocolID>?</urn:ProtocolID>
         <urn:Copytype>?</urn:Copytype>
         <urn:Date>?</urn:Date>
         <urn:ReasonID>?</urn:ReasonID>
         <urn:Responsible>?</urn:Responsible>
         <urn:CopyStationID>?</urn:CopyStationID>
         <urn:Copystationresp>?</urn:Copystationresp>
         <urn:Company>?</urn:Company>
         <urn:Companyresp>?</urn:Companyresp>
         <urn:Observation>?</urn:Observation>
         <urn:Status>?</urn:Status>
         <urn:Receivingresp>?</urn:Receivingresp>
         <urn:Receivingdate>?</urn:Receivingdate>
         <urn:DocumentsList>
            <!--Zero or more repetitions:-->
            <urn:Documents>
               <!--You may enter the following 4 items in any order-->
               <urn:DocumentID>?</urn:DocumentID>
               <urn:RevisionID>?</urn:RevisionID>
               <urn:CategoryID>?</urn:CategoryID>
               <urn:QtdCopy>?</urn:QtdCopy>
            </urn:Documents>
         </urn:DocumentsList>
         <urn:DestType>?</urn:DestType>
         <urn:CtrlTeam>?</urn:CtrlTeam>
         <urn:DepartmentId>?</urn:DepartmentId>
         <urn:UserId>?</urn:UserId>
      </urn:newProtocolPrintedCopy>
   </soapenv:Body>
</soapenv:Envelope>

Return:

ID #	Description
Status	SUCCESS: SUCCESS FAILURE: FAILURE
Code	Displayed code: • 1 - No error (record created successfully); • -1 - Required field (field name); • -2 - Field precision (field name); • -3 - Invalid copy type; • -4 - Invalid reason; • -5 - Invalid date; • -6 - Invalid protocol status; • -7 - Copy station ID # not found; • -8 - There is no such party responsible for the copy station; • -9 - Invalid user; • -10 - Revision not found (entered revision code); • -11 - Document not found (entered document code); • -12 - There is more than one document with this ID #. It is necessary to specify the category; • -13 - Inexistent category; • -14 - The entered category is inactive; • -15 - QtdCopy field must contain an integer; • -16 - Document revision must not be entered for controlled copy; • -17 - This document cannot be associated with a copy station; • -18 - This user is not authorized to perform this operation.
Detail	Message detailing the error or success in the execution of the method.