UpdateActivitiesV5

Overview of interface

Interface is used in updating event information to Nepton.

Web service WSDL-schema is available publicly here. Interfaces are described generally here.

Occurrences - column in request description defines whether a field is mandatory in a request or not. 0 occurrences means that field is not mandatory in the request. 1 occurrence means that the field must be present in the request once. 0..n occurrences means that the request may contain any number of those fields or none at all. Occurrences 1..n means that the request may contain any number of those fields but there must be at least one instance of that field.

Changes to earlier version (UpdateActivitiesV4)

New properties and elements

• Event person can be identified by person's external identifier
  • UserPersonExternalIdentifier-element added to request
• Person who has approved an event can be identied by approving person's external identifier
  • ApproverUserPersonExternalIdentifier-element added to request
• UserPersonExternalIdentifier and ApproverUserPersonExternalIdentifier contain Identifier- and FieldName-fields

Person references

In creating an event it is mandatory to have information about the person the event belongs to and a non-mandatory information about the person who has approved the event. Both of these person informations can be referred to with one of these identifiers: Nepton unique person id, username, social security number, personnelnumber or person's external identifier. If approver of event is set, the event will be marked as approved.  If approval needs to be removed, it can be removed by setting empty (nil) value for the identifier of approver. See request data - table for more information about elements used in providing event data.

Request data

ExternalIdentifier1

ExternalIdentifier1

Request example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:tyo="http://tyoaika.tyoteho.fi"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Header/>
  <soapenv:Body>
    <tyo:ParametersForUpdateActivitiesV5>
      <CallerAuthentication /><!-- Authentication is required but is omitted from this example -->
      <ActivityList>
        <Activity>
          <ExistingExternalIdentifier>
            <Identifier>27ae3e08-bfa0-11eb-8529-0242ac130003</Identifier>
            <IdentifierType>External</IdentifierType>
          </ExistingExternalIdentifier>
          <EndDateTime>2021-01-19T16:00:00</EndDateTime>
          <ApproverUserId xsi:nil="true" /><!-- Removal of approval and approver from event -->
          <RelatedProjects>
            <ActivityToProjectRelation>
              <Id>1234567890</Id><!-- Refers to a project with Nepton internal identifier 1234567890 -->
              <Duration>120</Duration>
            </ActivityToProjectRelation>
            <ActivityToProjectRelation>
              <Code>ExampleProjectCode</Code><!-- Referes to a project with code ExampleProjectCode -->
              <Duration>60</Duration>
            </ActivityToProjectRelation>
          </RelatedProjects>
        </Activity>
      </ActivityList>
    </tyo:ParametersForUpdateActivitiesV5>
  </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:ReturnValueForUpdateActivitiesV5>
      <ResponseCode>1000</ResponseCode>
      <ResponseString>All clear. No errors.</ResponseString>
      <ActivityList>
        <Activity>
          <Id>12345678</Id>
          <ExternalIdentifiers>
            <ExternalIdentifier>
              <Identifier>27ae3e08-bfa0-11eb-8529-0242ac130003</Identifier>
              <IdentifierType>External</IdentifierType>
            </ExternalIdentifier>
          </ExternalIdentifiers>
          <Success>true</Success>
        </Activity>
      </ActivityList>
    </tyo:ReturnValueForUpdateActivitiesV5>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>