GetActivitiesV4

Interface overview

The web service is used to retrieve event information from Nepton. The web service also returns events for deactivated people (those deleted in Nepton using the Remove User function) when a user filter (e.g. personal identification number) is included in the query.

The WSDL schema of the web service is publicly available here. The interfaces are described in general here.

The occurrences column in the description determines whether a piece of information is mandatory in the call or not. Occurrences 0 means that the information in question does not need to be passed in the call. Occurrences 1 means that the information must appear once in the call. Occurrences 0..n means that the information in question can appear any number of times in the call. Occurrences 1..n means that the information in question must appear in the data at least once, but can appear more often.

Changes from the previous version (GetActivitiesV3)

New features and fields

• Accrual and annual leave reset values are returned
  • ResetValue-element added to the response
• Accrual and annual leave change values are returned
  • ChangeValue-element added to the response

Sent data

Call example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tyo="http://tyoaika.tyoteho.fi">
  <soapenv:Header/>
  <soapenv:Body>
    <tyo:ParametersForGetActivitiesV4>
      <CallerAuthentication /> <!-- Autentikoituminen vaaditaan, mutta on jätetty tässä esimerkissä pois --> 
      <FilterByActivityTypeIds>
        <ActivityTypeId>1</ActivityTypeId>
      </FilterByActivityTypeIds>
      <FilterByExternalIdentifiers>
        <ExternalIdentifier>
          <Identifier>c2d816bc-bf67-11eb-8529-0242ac130003</Identifier>
          <IdentifierType>External</IdentifierType>
        </ExternalIdentifier>
        <ExternalIdentifier>
          <Identifier>4a700e90-c754-4d1d-ac9a-bfdc011fc2c1</Identifier>
          <IdentifierType>External</IdentifierType>
        </ExternalIdentifier>
      </FilterByExternalIdentifiers>
      <FilterPeriodBeginDateTime>2021-01-01T00:00:00</FilterPeriodBeginDateTime>
      <FilterPeriodEndDateTime>2021-01-31T23:59:59</FilterPeriodEndDateTime>
      <IncludeDeleted>false</IncludeDeleted>
      <OrderResultsFirstBy>ActivityBeginDatetime</OrderResultsFirstBy>
    </tyo:ParametersForGetActivitiesV4>
  </soapenv:Body>
</soapenv:Envelope>

Response

Response example

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tyo="http://tyoaika.tyoteho.fi">
  <SOAP-ENV:Body>
    <tyo:ReturnValueForGetActivitiesV4>
      <ResponseCode>1000</ResponseCode>
      <ResponseString>All clear. No errors.</ResponseString>
      <ActivityList>
        <Activity>
          <Id>12345678</Id>
          <UserId>9001</UserId>
          <UserFirstName>Maija</UserFirstName>
          <UserLastName>Meikäläinen</UserLastName>
          <UserUsername>maija.meikäläinen</UserUsername>
          <UserPersonnelNumber>1111</UserPersonnelNumber>
          <ActivityTypeId>1</ActivityTypeId>
          <ActivityTypeName>Työ</ActivityTypeName>
          <ActivityTypeCategoryId>1</ActivityTypeCategoryId>
          <ActivityTypeCategoryName>Työ</ActivityTypeCategoryName>
          <BeginDateTime>2021-01-19T08:00:00</BeginDateTime>
          <EndDateTime>2021-01-19T16:00:00</EndDateTime>
          <ModifiedDateTime>2021-01-20T09:12:23</ModifiedDateTime>
          <ModifiedByUserId>9001</ModifiedByUserId>
          <ModifiedFromIp>127.0.0.1</ModifiedFromIp>
          <Comment>Työtapahtuma</Comment>
          <IsClockedEvent>false</IsClockedEvent>
          <IsCreatedWithPinCode>false</IsCreatedWithPinCode>
          <OvertimeBasePartTargetedTo>salary</OvertimeBasePartTargetedTo>
          <OvertimeIncrementPartTargetedTo>salary</OvertimeIncrementPartTargetedTo>
          <RelatedProjects>
            <ActivityToProjectRelation>
              <Id>12345</Id>
              <Duration>450</Duration>
              <Name>Asiakaspalvelu</Name>
              <Code>ASPA</Code>
            </ActivityToProjectRelation>
          </RelatedProjects>
          <IsDeleted>false</IsDeleted>
        </Activity>
      </ActivityList>
    </tyo:ReturnValueForGetActivitiesV4>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>