Navigation:  Integration via SOAP web services > Published web services > Document >

newProtocolPrintedCopy

Previous  Top  Next

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's ID.

CopyStationID

 

Copy station ID #.

Copystationresp

 

ID of the user responsible for the station.

Company

 

Company.

Companyresp

 

Company's responsible party.

Observation

 

Comments

Status

X

Protocol status:

1 – Awaiting receipt confirmation;

2 – Receipt 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

X1

Copy station ID #.

DepartmentId

X2

Organizational unit ID #.

UserId

X3

User ID #.

 

X1 - Required when DestType is equal to 1;

X2 - Required when DestType is equal to 2;

X3 - Required when DestType is equal to 3.

 

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 #. The category must be specified.

• -13 – Inexistent category;

• -14 – The entered category is inactive;

• -15 – QtdCopy field must contain a whole numeric value;

• -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.