Interface overview
The interface sets the projects that are visible for user when registering events.
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 (SetVisibleProjectsForUserV2)
Structural changes
| Old | New | Additional info |
<tyo:ParametersForSetVisibleProjectsForUser> |
<tyo:ParametersForSetVisibleProjectsForUserV3> |
Root element name changed in call |
<tyo:ReturnValueForSetVisibleProjectsForUser> |
<tyo:ReturnValueForSetVisibleProjectsForUserV3> |
Root element name changed in response |
<SetVisibleProjectsForUserList> |
<SetVisibleProjectsForUserListV2> |
In call SetVisibleProjectsForUserList-element and below it SetVisibleProjectsForUser element names have changed, version number removed |
<SetVisibleProjectsForUserResultList> |
<SetVisibleProjectsForUserResultList> |
In response SetVisibleProjectsForUserResultList-element and below it setVisibleProjectsForUserResult-element names have changed, version number removed |
New features and elements
- Person can be filtered with external identifier
- PersonExternalIdentifier-element to the call
- PersonExternalIdentifier-element contains Identifier- and FieldName-fields
- PersonExternalIdentifier-element to the call
Sent Data
| Level | Field name | Format | Occurences | Description |
|---|---|---|---|---|
| 0 | ParametersForSetVisibleProjectsForUserV2 | XML element | 1 | Root, below SOAP body |
| 1 | CallerAuthentication | XML element | 1 | Authentication details. More information about authentication here. |
| 1 | SetVisibleProjectsForUserList | XML element | 1 | List of project visibility settings for one user, so a list of SetVisibleProjectForUser-elements |
| 2 | SetVisibleProjectForUser | XML element | 1..n | Setting the visibility of one project for one person. |
| 3 | ProjectId | unsignedIntt | 0..1 | Unique project identifier provided by Nepton |
| 3 | ProjectCode | string | 0..1 | Project code |
| 3 | ProjectIdentifier | XML element | 0..1 | Project identifier |
| 4 | Identifier | string | 1 | Project identifier string |
| 4 | IdentifierType | string | 1 | Project identifier type. Can be either ProjectCode or ExternalIdentifier
|
| 3 | UserId | unsignedInt | 0..1 | Unique personal identifier provided by Nepton |
| 3 | Username | string | 0..1 | Person's username |
| 3 | PersonnelNumber | string | 0..1 | Person's personnel number |
| 3 | PersonExternalIdentifier | XML element | 0..1 | Person's external identifier information |
| 4 | Identifier | string | 1 | Person's external identifier value |
| 4 | FieldName | string | 1 | Person's external identifier name |
| 3 | ProjectVisible | boolean | 1 | Can person see project (true) or not (false) |
Call example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tyo="http://tyoaika.tyoteho.fi">
<soapenv:Header/>
<soapenv:Body>
<tyo:ParametersForSetVisibleProjectsForUserV3>
<CallerAuthentication /> <!-- Autentikoituminen vaaditaan, mutta on jätetty tässä esimerkissä pois -->
<SetVisibleProjectsForUserList>
<SetVisibleProjectForUser>
<ProjectIdentifier>
<Identifier>4a78611d-4a00-4c4a-a987-865664d732ce</Identifier>
<IdentifierType>ExternalIdentifier</IdentifierType>
</ProjectIdentifier>
<PersonnelNumber>9001</PersonnelNumber>
<ProjectVisible>true</ProjectVisible>
</SetVisibleProjectForUser>
<SetVisibleProjectForUser>
<ProjectCode>PRJ-001</ProjectCode>
<PersonExternalIdentifier>
<Identifier>EMP-12345</Identifier>
<FieldName>ExternalIdentifier1</FieldName>
</PersonExternalIdentifier>
</SetVisibleProjectForUser>
</SetVisibleProjectsForUserList>
</tyo:ParametersForSetVisibleProjectsForUserV3>
</soapenv:Body>
</soapenv:Envelope>
Response
| Level | Field name | Format | Occurrences | Description |
|---|---|---|---|---|
| Root, under SOAP body | ReturnValueForSetVisibleProjectsForUserV3 | XML element | 1 | |
| 1 | ResponseCode | integer | 1 | Response code of handling the request. List of response codes can be found here. |
| 1 | ResponseString | string | 1 | Code description |
| 1 | SetVisibleProjectsForUserV2ResultList | XML element | 1 | |
| 2 | SetVisibleProjectsForUserV2Result | XML element | 0..n | Result for setting project visibility for user |
| 3 | ResponseCode | integer | 1 | Response code. List of response codes can be found here. |
| 3 | ResponseString | string | 1 | Response code description |
| 3 | ProjectId | unsignedInt | 0..1 |
The unique project identifier provided by Nepton. The value can also be <ProjectId xsi:nil="true" /> In error situations, the value is not returned if it was not provided in the query. |
| 3 | ProjectCode | string | 0..1 |
Project's code. The value can also be <ProjectCode xsi:nil="true" /> In error situations, the value is not returned if it was not provided in the query. |
| 3 | ProjectIdentifier | XML element | 0..1 | Project identifier. The value is not returned if it is not provided in the query. |
| 4 | Identifier | string | 1 | Project identifier string |
| 4 | IdentifierType | string | 1 |
Project identifier type. Can be either The value is not returned if it is not provided in the query. |
| 3 | UserId | unsignedInt | 0..1 |
The unique identifier of the person given by Nepton. The value can also be <UserId xsi:nil="true" /> The value is not returned if it is not provided in the query. |
| 3 | Username | string | 0..1 |
Person's username. The value can also be <Username xsi:nil="true" /> The value is not returned if it is not provided in the query. |
| 3 | PersonnelNumber | string | 0..1 |
Person's personnel number. The value can also be <PersonnelNumber xsi:nil="true" /> The value is not returned if it is not provided in the query. |
Response example
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://tyoaika.tyoteho.fi">
<SOAP-ENV:Body>
<ns1:ReturnValueForSetVisibleProjectsForUserV3>
<ResponseCode>1000</ResponseCode>
<ResponseString>All clear. No errors.</ResponseString>
<SetVisibleProjectsForUserResultList>
<SetVisibleProjectsForUserResult>
<ResponseCode>1000</ResponseCode>
<ResponseString>All clear. No errors.</ResponseString>
<ProjectId>76254</ProjectId>
<ProjectCode>1000/9001</ProjectCode>
<ProjectIdentifier>
<Identifier>4a78611d-4a00-4c4a-a987-865664d732ce</Identifier>
<IdentifierType>ExternalIdentifier</IdentifierType>
</ProjectIdentifier>
<UserId>1234</UserId>
<Username>matti.meikäläinen</Username>
<PersonnelNumber>9001</PersonnelNumber>
</SetVisibleProjectsForUserResult>
</SetVisibleProjectsForUserResultList>
</ns1:ReturnValueForSetVisibleProjectsForUserV3>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>