Breadcrumbs

RemoveContractPrinter

  • Web Service URL: https://[SERVER_ADDRESS]/ContractsWS/ContractsData.asmx

  • MPS Version: Starting from 5.5.0

Description

Removes a printer from the contract flow. If the printer is in a single contract, it will be removed from both if specified. The printer's movement history between contracts is also removed.

Syntax

public string RemoveContractPrinter(string properties)

Assembling properties

The content of string properties must be text in JSON format containing the properties below. For example:

{"DealerName":"dealer","DealerUserEmail":"user@example.com","DealerUserPassword":"k1BAv1w=="}

There is no need to worry about uppercase or lowercase property names, as the Web Service is Case-Insensitive.

Properties accepted by the method

Property

Type

Required

Allows null

Allows empty

Maximum size

Description

DealerName

Text

Yes

-

-

-

Provider name

DealerUserEmail

Text

Yes

-

-

-

Provider user email

DealerUserPassword

Text

Yes

-

-

-

Encrypted user password

EnterpriseID

Number

Yes

-

-

-

Company ID number. Obtained using the GetEnterprises method

PrinterDeviceID

Number

Yes

-

-

-

Printer serial number. Obtained using the GetPrinters method

RemoveFromContract¹

Logical

No

Yes

-

-

Unlink the printer contract to remove it from the flow (if not specified, it will be interpreted as ‘false’)

¹ Only from version 5.11.0 onwards.

Return

If successful, the return is: [{“Result”:true}].

Click here to learn more about the format of returns.

Possible errors returned

Click here to check the possible errors that may be returned and learn about their reasons.

Restrictions

To execute this method, the user specified must be an Administrator at the provider.