farmerswife Support

Welcome
Login  Sign up
  1. Solution home
  2. IT Admin Configurations
  3. 3rd Party Integrations

farmerswife REST Api Release Notes



Below you will find listed all our swagger.json versions, including all the release notes and farmerswife versions needed to run them.


TABLE OF CONTENTS



Swagger.json 0.8.19

  • Added support for updating more fields through the PUT /contact:id endpoint [fw 7.2 Beta 1]

"This requires to upgrade past 7.1 Release.

And you need to use the updated Swagger.json file latest version *0.8.19*.


These fields are now available on the PUT /contact:id endpoint, now the same as on POST /contact:


  "contactFirstName": "<string>",

  "contactLastName": "<string>",

  "contactActive": "<boolean>",

  "contactTitle": "<string>",

  "contactEmail": "<string>",

  "contactTelHome": "<string>",

  "contactTelMobile": "<string>",

  "contactTelWork": "<string>",

  "contactNote": "<string>",

  "contactOther": "<string>",

  "contactIsResource": "<boolean>",

  "contactIsClient": "<boolean>",

  "companyId": "<string>",

  "companyName": "<string>",

  "companyWebsite": "<string>",

  "companyFax": "<string>",

  "companyAddress": "<string>",

  "companyDivisionId": "<string>",

  "resourceUserName": "<string>",

  "resourceBuyRate": "<int>",

  "resourceSellRate": "<int>",

  "resourceDaybased": "<boolean>",

  "customs":"


  • Fixed a bug when using POST /contact on the fwRESTapi which wrongly returned the info “Contact name already exists” in some cases.

  • When creating or editing Contacts via the fwRESTapi now the Contact's "Activity" gets populated with info.

  • Improved the PUT /contact:id endpoint to support 3 use cases: Move a Contact to a different existing Company, move to a new Company or Rename an existing Company for all member Contacts.


Swagger.json 0.8.17

  • Added "contactEmail" parameter in GET/companies endpoint and "contactActive" to the PUT/contacts/:id endpoint [fw 7.2 Beta 1] 

  • Added validation for booleans in contact POST Api and fixed swagger doc [fw 7.2 Beta 1]



Swagger.json 0.8.16

  • Added POST endpoint for creating Contacts [fw 7.1 Beta 6]

  • Fixed a bug in Rest API returning “empty value” and “boolean” where farmerswife was expecting a 0 or a 1 value [fw 7.1 Beta 5]

There was a bug in the Rest API giving an “empty value” and “boolean”, which means farmerswife was expecting a 0 or a 1 value, but the data was simply empty.

This is now corrected.

  • Improved REST Api log file in `/system/customlog.restapi.log` based on a new server.cfg var [fw 7.1 Beta 5]

`HTTP_REST_LOG_LEVEL` (1 = ON)

Improved REST Api log file in `/system/customlog.restapi.log` based on a new server.cfg var `HTTP_REST_LOG_LEVEL` (1 = ON), with request duration in milliseconds, http method, url with GET params, and a transaction id value for traceability in log lines. Also logging internal server/unexpected errors




Swagger.json 0.8.13


  • Added support for adding/updating/deleting Personnel Events via the fwRESTapi on multiple endpoints [fw 7.1 Beta 3]
    Before, it was only possibly to create (POST), modify (PUT) or delete (DELETE) so call Project Bookings. 

Now, Personnel events are also supported by the following end-points:


*Create Personnel event:* 

Use the "POST /event" endpoint with these parameters; the following example is using the DemoDB and the user "Peter" to create a Personnel event type "Sick" (1):


{

"objectType": "Booking",

  "object": {

    "parentType": "personnel",

    "day": "2023-11-28",

    "personnelTypeNumber": "1",

    "note": "",

    "objectID": "id201603101456090000000635",

        "days": [

        {

        "occursOnDay": "2023-11-28"

        }

        ],

        "timeIn": "09:00",

        "timeOut": "12:00"

        }

}


NOTE: For the parameter "personnelTypeNumber" also verify via the fw Client desktop app, which Personnel Type is configured on the farmerswife system you are using; create each one you need by drag&drop on the Hourline and in the main pop-up windows > Personnel Management.


The Personnel Type Numbers are:

0=Shift

1=Sick

2=Vacation

3=Day In Lieu

4=Other

5=Sabbatical

6=Free-day

7=Inactive

20=Unavailable

21=Training

100+=Manual types


*Modify Personnel event:*

Use the "PUT /event/:id" endpoint with these parameters; the following example is using the DemoDB and the user "Peter":


{

"objectType": "Booking",

  "object": {

    "parentType": "personnel",

    "day": "2023-11-28",

    "personnelTypeNumber": "2",

    "note": "A new Note was added for Peter and his Vacation is now on 2 days from 12h-18h",

    "objectID": "id201603101456090000000635",

        "days": [

        {

        "occursOnDay": "2023-11-28"

        },

        {

        "occursOnDay": "2023-11-29"

        }

        ],

        "timeIn": "12:00",

        "timeOut": "18:00"

        }

}


NOTE: The information added to the "note" Parameter will show up on the Personnel Booking in farmerswife in the "Header" field.


*Delete Personnel event:*

Use the "DELETE /event/:id" endpoint with these parameters; the following example is using the DemoDB and the user "Peter":


{

"bookingID": "id202311201157550000000290",

"parentType": "personnel",

"objectID": "id201603101456090000000635"

}


IMPORTANT:


As part of this Feature the Swagger documentation was upgraded to OpenApi 3.0. OpenApi 3.0 doesn't support DELETE request with a request body. 


For this reason the following DELETE requests have been changed to support url parameters rather than a request body:


`DELETE` `/auth/token` -> Just leave body blank


`DELETE` `event/{id}` -> Booking ID is now included in the path. Also `parentType` and `objectID` url parameters can be be included when deleting Personnel events.


`DELETE` `project/{projectID}` -> Project ID is now included in the path. Also `deleteBookings` url parameter can be included.


All the above are backwards compatible. So you can still send a DELETE request the old way, with a request body.


In the `PUT` `/event/{id}` and `POST` `/event` endpoints you can now select between `Project Booking Example` and `Personnel Event Example`.


  • Added support on GET /event/:id to a pass a new option [fw 7.1 Beta 3]

“mergeInMatchingProjectCustomValues” for identical Booking Custom Fields.


"Added support for the fwRESTapi, that if a Project has a Project Custom Field called e.g. "123456" and it contains the info "abcdef", if a Booking on this Project also has a Booking Custom Field called  "123456" and via the fwRESTapi's GET /event/:id endpoint this new parameter “mergeInMatchingProjectCustomValues" with Value=1 gets passed to the system, the resulting Project Booking will contain the info from the Project Custom Field "abcdef".

On the actual Booking the Custom Field "123456" remains without this info."


  • Fixed a bug where REST API incorrectly parsed numbers in Text Custom Fields as a decimal number, when using a period to separate numbers in the string [fw 7.1 Beta 5] 

Previously, if there was a string of numbers in a text field that were being separated by a period ".", this would be parsed via the API as a decimal number.  For example, a field with the value "06.2024" to signify date, would be parsed as a number and not text.

This is now fixed to be parsed correctly.


  • Fixed a bug within the REST API in the PUT/project endpoint, where doing partial updates to certain fields would remove other stored data [fw 7.1 Beta 6]

Before, when updating "note" fields on a project in FW via the API, the data contained in fields "contact" and "email" was deleted. Now that bug has been fixed,  "contact" and "email" keeps previous data.




Swagger.json 0.8.12


  • Added new "email" filter parameter in the GET /user endpoint on the fwRESTApi [fw 7.1 Beta 1]


  • Removed trailing space in "GET /event" [fw 7.1 Beta 2] 

When a Personnel Event was "All Day", the "dateTimeInAsString" and "dateTimeOutAsString" values had a trailing space character. That is now fixed.




Swagger.json 0.8.11

  • Added a new GET, PUT /user endpoints to be able to query and update users [fw 7.0 Beta 10]


  • Removed trailing space in "GET /event" [fw 7.0 SP2]  


    When a Personnel Event was "All Day", the "dateTimeInAsString" and "dateTimeOutAsString" values had a trailing space character. That is now fixed.



Swagger.json 0.8.9


  • Fixed wrong am/pm time format in the fw REST Api [fw 7.0 Beta 2]

The fwRESTapi will now always convert "time" information into the 24h-timekeeping-system according to ISO 8601 time format.

This means, it does not matter if in fw Server app > Setup > General > Time: ... the format "21:00" or this format "09:00 pm" is being used. Time relevant results via the fwRESTapi will now always be displayed in the 24h-timekeeping-system according to ISO 8601 time format.


  • Added new fwRESTapi endpoint /server/status to get connected users, server id, timezone info and fw version [fw 7.0 Beta 3]


  • Added fwRESTapi GET parameter "expandContacts" in /company to be able to hide contacts info [fw 7.0 Beta 3]


  • Improved the fw REST API GET /event endpoint to be able to filter by projectID combined with other params like dayFrom, dayTo, ObjectType, ObjectID. [fw 7.0 Beta 4]


  •  Fixed a bug in fw REST API GET /event endpoint where querying with filter parameters was with "Bad request" response. [fw 7.0 Beta 8]


  • REST API bug fix for the /event endpoint when filtering by non existing projectID or by a projectID without Bookings [fw 7.0 Beta 10]




Previous older versions

  • v6.7 Beta 2 rev. 19746 ... swagger.json v0.8.1, contact Support to get this version.
  • v6.6 SP2 RC2 rev. 19671 ... swagger.json v0.7, contact Support to get this version.
  • v6.5 SP1 RC1 ... contact Support
  • v6.5 Beta 7 ... contact Support
  • v6.5 Beta 6 ... 



Did you find it helpful? Yes No

Related Articles