Package: imio.pm.ws
IntroductionSOAP webservices for Products.PloneMeeting.Version 2.x is for Products.PloneMeeting 4.1 and version 3.x is for Products.PloneMeeting 4.2.WS4PM filesThese files are generated using a static WSDL file.Adaptations must be done in file soap/ws4pmwsdl.pt, then the static WSDL file dumpedWSDL.txt
is generated by callinghttp://portal_url/@@ws4pm.wsdl?dump_wsdl:boolean=True.After that, call ZSI wsdl2py script with following syntax : /path_to_ZSI_package/bin/wsdl2py dumpedWSDL.txt -o . -bChangelog3.9 (2023-12-11)Adapted code asProducts.PloneMeeting.utils.add_wf_history_actionwas moved
toimio.history.utils.add_event_to_wf_historyandToolPloneMeeting.getUserNameis removed, we useimio.helpers.content.get_user_fullnameinstead.
[gbastien]3.8 (2023-10-19)Make surecreateItemRequestreturns a response status of200or
it raises aSOAPException(even if item is created anyway?!).
[gbastien]FixedSOAPView._getItemInfoswhen computingpreferred_meeting_date, it was
alwaysNonebecause using theuid_catalogand Meeting is a DX content type.
[gbastien]3.7 (2023-03-06)Fixedtest_ws_getItemInfosWithShowAssemblyregarding changes in default
contacts gender in PloneMeeting testing profileimport_data.
[gbastien]Completedtest_ws_meetingAcceptingItemsto check that it works when usinginTheNameOf(was actually not working beforeProducts.PloneMeeting==4.2rc30).
[gbastien]Adapted code regarding removal ofMeetingConfig.useGroupsAsCategories.
[gbastien]3.6 (2022-03-10)Whenever aZSI.Faulterror is raised, display also the message in the log manually
becausez3c.soapwill not display the error string, only the traceback…
[gbastien]3.5 (2022-01-14)Fixed bug in_createItemwhere it could happen that user usedinTheNameOfhad cached_listAllowedRolesAndUsersresulting in seeing too much or not
enough in the dashboard.  Accessing an item that should not be displayed ended
in an Unauthorized though.
Every method using inTheName of now usesetup_user_in_the_name_of/teardown_user_in_the_name_ofto handle it correctly.
[gbastien]3.4 (2022-01-07)Fixed call totool.isManagerand handleutils.get_current_user_id.
[gbastien]3.3 (2022-01-04)FixedSOAPView._mayAccessAdvancedFunctionnalities, callToolPloneMeeting.isManagerwithToolPloneMeetinginstance as first arg,
required now for caching reasons.
[gbastien]3.2 (2021-11-26)CallToolPloneMeeting.get_orgs_for_userwiththe_objects=True/Falsewhen relevant as default value changed inProducts.PloneMeeting.
[gbastien]3.1 (2021-11-10)In_meetingsAcceptingItems, log only one time in the Zope log at the end or
we have the impression that the method was called many times.
[gbastien]3.0 (2021-07-16)Fixedtest_ws_getItemInfosRequestnow that observers may access item since
WF initial state, make sure we use a member that does not have access to item
at all and fixedtest_ws_getConfigInfosItemPositiveDecidedStates, fieldMeetingConfig.itemPositiveDecidedStateswas removed and is now managed byMeetingConfig.getItemPositiveDecidedStatesmethod.
[gbastien]FixedgetItemInfosRequest/getSingleItemInfosRequestthat was breaking when
no result andshowEmptyValues=0.
[gbastien]Adapted tests and code regarding fact that Meeting was moved from AT to DX
(linkedMeetingUIDindex is renamed tomeeting_uid,Meeting.dateattribute
holds adatetimeinstead aDateTime,attendeesrelated methods use
snake_case instead camelCase on bothMeetingandMeetingItem,
every methods on Meeting use snake_case).
[gbastien]Adapted code now thatMeetingItem.getCategorydoes only return the real
category and not theproposingGroupwhen category not used.
[gbastien]2.16 (2020-06-11)When addingwf_transition_triggered_by_applicationcomment toworkflow_history, do not use azope.i18nmessageid.message.Messageor
it is stored this way in workflow_history, use a simple string and
it will be translated byimio.history.
[gbastien]2.15 (2020-05-28)Fixedtest_ws_getItemInfosWithShowAssemblyas default value inPloneMeetingtesting profile changed to test held position having a&character (non XHTML character).
[gbastien]When librarychardetis available, it wrongly detect utf-8 passed string toBeautifulSoupas beingiso-8859-1leading to incorrect special characters.chardetis now availabe because a dependency ofcollective.zamqp.
So passunicodestring toBeautifulSoupto avoid this.
[gbastien]2.14 (2020-03-17)Added methodgetSingleItemInfosthat return a single item informations,
not a list ofItemInfoinstances.
Result and paramaters are exactly same asgetItemInfos.
[gbastien]Make most most of data returned bygetItemInfosnillable.
[gbastien]Added parametershowEmptyValues=1by default togetItemInfos,
making it possible to remove empty values from returned result.
[gbastien]2.13 (2020-02-18)Manage fieldtoDiscusswhile creating new item.
[gbastien]Changed the waywfTransitionsare managed increateItem: if a transition
is not available, it is ignored and next transition is tried, this way it is
easier to manage cases where item validation WF is different for proposing
groups.
[gbastien]2.12 (2019-10-14)Do not fail in ‘getItemInfos’ when returning POD templates if a POD template
is using the odt_file of another POD template.
[gbastien]2.11 (2019-10-01)Make it easier to detect if an item was created using the createItem SOAP WS
by adding a specific line to the item workflow_history like it is the case
when creating an item from an item template or from a recurring item.
[gbastien]2.10 (2019-09-30)‘getItemInfos’ returns ‘meeting’ containing the meeting UID if any.
[gbastien]‘searchItems’ now accepts an additional search parameter ‘linkedMeetingUID’.
[gbastien]2.9 (2019-09-24)In ‘getItemInfos’ when ‘showAssembly=True’, changed separator between list of
assembly members from ‘|’ to ‘n’ so it is easier to parse as ‘|’ is already
the separator between types of attendees (attendees, absents, excused, …).
[gbastien]2.8 (2019-09-23)In createItem, added possibility to define associatedGroups and
groupsInCharge as lists of organization UIDs.
[gbastien]Added parameter ‘wfTransitions’ to createItem making it possible to trigger
given WF transitions on the newly created item.
[gbastien]In createItem, added possibility to define optionalAdvisers.
[gbastien]Force catalog query in getItemInfos to use ‘sort_on=created’.
[gbastien]In getItemInfos, added ‘showAssembly=False’ parameter making it possible to
receive the item assembly in the _item_assembly attribute when item is in a
meeting.
[gbastien]Removed manual handling of currentWSDL.txt.  Now dumpedWSDL.txt is generated
by calling ‘http://portal_url/@@ws4pm.wsdl?dump_wsdl:boolean=True’.
[gbastien]Added parameter ‘allowed_annexes_types’ and ‘include_annex_binary’ to
getItemInfos() method.
[sdelcourt]Add attribute ‘id’ to the AnnexInfo data type.
[sdelcourt]2.7 (2019-05-16)Override plone.transformchain transformer to not apply on SOAP request.
[gbastien]Jenkinsfile for CI [odelaere]Removed dependency on unittest2.
[gbastien]2.6 (2018-12-04)Adapted to changes in Products.PloneMeeting following integration of
collective.contact.
[gbastien]Manage ‘category_title’ using MeetingItem.getCategory(theObject=True).
[gbastien]2.5 (2018-01-15)Use a simpleType ‘List’ for the ‘ConfigInfo.itemPositiveDecidedStates’ data
to avoid using a ‘xsd:Array’ type that is not recognized correctly by ‘soapUI’.
[gbastien]2.4 (2017-10-24)testConnection.version now returns the distribution version (2.4) and not
the GenericSetup version (2000) that only changes when an upgrade step is
required.
[gbastien]2.3 (2017-10-13)Add preferred_meeting_date attribute on ItemInfos.
[sdelcourt]2.2 (2017-08-04)Fixed tests regarding new format used for annex.content_category.
[gbastien]2.1 (2017-03-27)Adapted code now that ToolPloneMeeting.userIsAmong receives a list of suffixes
instead one single suffix before.
[gbastien]Added parameter ‘cleanHtml’ to createItem method that is True by default and
that will enable or disable Html cleaning when item is created.
[gbastien]getConfigInfos now returns also MeetingConfig.itemPositiveDecidedStates as an
array.
[gbastien]Refactored getConfigInfos to manage groups using GroupInfo complexType instead
ConfigInfo complexType.
[gbastien]2.0 (2017-01-25)Adapted code regarding integration of imio.annex into Products.PloneMeeting1.8 (2016-08-17)Make sure history is saved when we patch it to change the creation commentDo no more create the item before checking for category validity, this could lead
to problem where item was not deletable (validated while created for example)1.7 (2016-08-03)Added possibility to pass aribitraty extra attributes when creating an item,
for now it must correspond to an existing RichText field1.6 (2016-05-13)Adapted code regarding changes in Products.PloneMeeting 41.5 (2015-04-01)If no ‘preferredMeeting’ is provided when creating an item, use ‘whatever’
or created item is not consistent1.4 (2015-03-06)Calling getItemInfos will now also return the ‘detailedDescription’
as it can be used when creating an itemAdded parameter ‘attribute’ to CreationData and ItemInfo so we can specify
a preferredMeeting when creating an item and we get the preferredMeeting when
using getItemInfos1.3 (2015-03-05)Added item creation date and modification date in ItemInfo (getItemInfo and searchItems)Added package version in the testConnection callAdded SOAP call to getMeetingsAcceptingItems1.2 (2015-02-27)Use with Products.PloneMeeting 3.3+Adapted tests to use IAnnexable.getAnnexesInOrder as IAnnexable.getAnnexes was removed1.1 (2014-02-12)Use with Products.PloneMeeting 3.2+Handle case where libmagic could not determinate annex mimetype correctly (and added test)1.0 (2014-01-07)Renamed package from communesplone.ws4plonemeeting to imio.pm.wsMoved to Plone 4.3Use ZSI 2.1a1Avoid error if item created without a description or a decision (empty HTML field)0.1 (2012-10-15)Initial releaseAdded methods to ‘getItemInfos’, ‘createItem’, ‘getConfigInfos’, ‘searchItems’