<<

NAME

Distributor - Methods for distributors.

FORMAL SPECIFICATION

WSDL: https://api.cloudmonit.pl/2.0.0/wsdl/Distributor.wsdl

JSON: https://api.cloudmonit.pl/2.0.0/json/Distributor.json

METHODS

Create

Creates a new distributor account. The new account has the free "demo" package enabled by default.

Arguments

• address (string or NULL) - optional

  The distributor's address.

• contact_person (string)

  The name of the person to contact with about distributor-related issues.

• contact_phone (string)

  The contact person's phone number.

• email (string)

  The distributor's e-mail address.

  This value must be a valid e-mail address.

• login (string)

  The distributor's login.

  This value cannot be an empty string.

• password (string)

  The distributor's password. To update the password, you have to authenticate by providing the current login and password (not using session).

• tax_id (string or NULL) - optional

  The distributor's tax identification number.

Returns

• id (unsigned integer) - optional

  The distributor's identifier.

Find

This method allows you to fetch information about selected Distributor objects.

Arguments

• filters - optional

  Filters to apply to the results.

  An array of objects, each containg the fields:

  • argument (string)

    The filter argument (the text to be contained in the field, or value to be compared). The argument must be of the same type as the field you filter by.

  • field (string)

    The field to filter the results by.

    Allowed values are: address, contact_person, contact_phone, email, id, login, tax_id.

  • type (string)

    The type of filter. Filters (not_)greater_than and (not_)lower_than compare numbers numerically and string lexicographically. Defaults to "equals".

    Allowed values are: contains, equals, greater_than, lower_than, not_greater_than, not_lower_than.

  Maximum array length: 10.

• limit (unsigned integer or NULL) - optional

  Items per page. If not specified, NULL or 0, all elements will be fetched. You should probably specify results ordering as well, if you want the results to be consistent.

• offset (unsigned integer) - optional

  The index of the first element to show on page. Items are numbered starting from 0. Default is 0. Only meaningful if limit is specified as well.

• order - optional

  Fields to order the results by, starting from the most significant.

  An array of objects, each containg the fields:

  • direction (string) - optional

    The ordering direction, "ascending" or "descending".

    Allowed values are: ascending, descending.

    Defaults to "ascending" if not specified.

  • field (string)

    The field to order by. If not specified, the results can be returned in any order.

    Allowed values are: address, contact_person, contact_phone, email, id, login, tax_id.

  Maximum array length: 10.

• with - optional

  The groups of fields to be returned with each object.

  An array of strings.

  No values are supported at the moment.

  This array cannot contain duplicate values.

  Defaults to [] if not specified.

Returns

• elements

  An array of objects, each containg the fields:

  • address (string or NULL)

    The distributor's address.

  • contact_person (string)

    The name of the person to contact with about distributor-related issues.

  • contact_phone (string)

    The contact person's phone number.

  • email (string)

    The distributor's e-mail address.

    This value must be a valid e-mail address.

  • id (unsigned integer)

    The distributor's identifier.

  • login (string)

    The distributor's login.

    This value cannot be an empty string.

  • tax_id (string or NULL)

    The distributor's tax identification number.

• total (unsigned integer)

  The total number of results (not including pagination).

Authorization

This method can be called by read-only users.

Meta

Returns the JSON or WSDL specification of the Distributor API module.

WARNING

This method is meant for internal usage in API clients. Unless you are writing one, you probably do not need it.

Arguments

• format (string) - optional

  The specification format you want to use. If omitted, defaults to json if you call this method using JSON request ot wsdl if you call this method with SOAP.

  Allowed values are: json, wsdl.

Returns

• encoded_meta (string)

  The specification of the module.

• format (string)

  The specification format used.

  Allowed values are: json, wsdl.

Authorization

This method can be called by read-only users.

Read

This method allows you to get information about a single Distributor object.

Arguments

• id (unsigned integer) - optional

  The distributor's identifier.

• with - optional

  The groups of fields to be returned with the object.

  An array of strings.

  No values are supported at the moment.

  This array cannot contain duplicate values.

  Defaults to [] if not specified.

Returns

• address (string or NULL)

  The distributor's address.

• contact_person (string)

  The name of the person to contact with about distributor-related issues.

• contact_phone (string)

  The contact person's phone number.

• email (string)

  The distributor's e-mail address.

  This value must be a valid e-mail address.

• id (unsigned integer)

  The distributor's identifier.

• login (string)

  The distributor's login.

  This value cannot be an empty string.

• tax_id (string or NULL)

  The distributor's tax identification number.

Authorization

This method can be called by read-only users.

Update

This method updates an existing Distributor object.

Arguments

• address (string or NULL) - optional

  The distributor's address.

• contact_person (string) - optional

  The name of the person to contact with about distributor-related issues.

• contact_phone (string) - optional

  The contact person's phone number.

• email (string) - optional

  The distributor's e-mail address.

  This value must be a valid e-mail address.

• id (unsigned integer) - optional

  The distributor's identifier.

• password (string) - optional

  The distributor's password. To update the password, you have to authenticate by providing the current login and password (not using session).

• tax_id (string or NULL) - optional

  The distributor's tax identification number.

Returns

Nothing.

<<