Examples

Search query

If the API has a query parameter (q), then you can use this to get the resources you are searching for. Use the API catalog to see what fields you can use in the search. The value of the query parameter must be URL encoded.

For string, use single quotes, e.g. PersonId='19800101TF01'

For date, use RFC 3339 and single quotes, e.g. StartTime>'2019-01-01T12:00:00'

For boolean, use true och false, e.g. IsActive=true

The following operators can be used:

  • AND
  • OR
  • IN
  • NOT IN
  • =
  • !=
  • >
  • <
  • >=
  • <=
  • ()

Get clients and services the first time

If you want to get all the clients and services for a specific service, for example laundry.
NOTE! This is just an example! The values of the parameters domain and key must be replaced with the actual values.

1. Get the service type identifier for laundry by calling the service configuration API (q=TypeName = 'Tvätt').

https://prod-lcsse.service.tieto.com/WE.EC.Integration.Host/api/v1/service_configurations?domain=KommunA&key=123&q=TypeName%20%3D%20%27Tv%C3%A4tt%27

2. Get all the ongoing and future services with that service type identifier by calling the service period API (q=ServiceTypeId=129 AND EndDate>'2026-11-16T23:59:59').

https://prod-lcsse.service.tieto.com/WE.EC.Integration.Host/api/v1/service_periods?domain=KommunA&key=123&q=ServiceTypeId%3D129%20AND%20EndDate%3E%272026-11-16T23%3a59%3a59%27

3a. Collect all the unique client identifiers (PersonId) from previous step and call the client API for every identifier.

https://prod-lcsse.service.tieto.com/WE.EC.Integration.Host/api/v1/clients/19800101TF01?domain=KommunA&key=123

3b. Collect all the unique client identifiers (PersonId) from previous step and call the client API with the IN operator (q=PersonId IN ('19800101TF01','19800102TF01','19800103TF01')).

https://prod-lcsse.service.tieto.com/WE.EC.Integration.Host/api/v1/clients?domain=KommunA&key=123&q=PersonId%20IN%20(%2719800101TF01%27%2C%2719800102TF01%27%2C%2719800103TF01%27)

Delta functionality

For example, get modified clients (new, updated, deleted) since a specific time with the gt parameter (gt=2026-11-15T18:10:24).
NOTE! The time must be in UTC (Coordinated Universal Time).

https://prod-lcsse.service.tieto.com/WE.EC.Integration.Host/api/v1/clients?domain=KommunA&key=123&gt=2026-11-15T18%3a10%3a24