Overview of interface
The interface is used for exporting project information from Nepton.
Web service WSDL-schema is available publicly 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 (GetProjects)
Structural changes
| Old | New | Information |
<tyo:ParametersForGetProjects> |
<tyo:ParametersForGetProjectsV2> |
Root element name in request has changed |
<tyo:ParametersForGetProjects> |
<tyo:ParametersForGetProjectsV2> |
Root element name in response has changed |
New properties and elements
- Projects can be filtered by an external identifier
- Added FilterByExternalIdentifiers element to the request
- The projects' external identifiers are available in the response
- Added ExternalIdentifier element to response
Request data
| Level | Field name | Type | Occurences | Description |
| 0 | ParametersForGetProjectsV2 | XML element | 1 | Root element under SOAP body |
| 1 | CallerAuthentication | XML element | 1 | Authentication details. More information about authentication here. |
| 1 | FilterByProjectIds | string | 0..1 | Filters by Nepton identifier (can be seen in the Project details URL). Multiple indentifiers can be given separated by a comma (,). |
| 1 | FilterByExternalIdentifiers | string | 0..1 | Filters by external identifier. Multiple indentifiers can be given separated by a comma (,). |
| 1 | FilterByProjectName | string | 0..1 | Filters by project name, an asterisk '*' can be used. |
| 1 | FilterByProjectCode | string | 0..1 | Filters by project code, an asterisk '*' can be used. |
| 1 | FilterByUserGroupId | integer | 0..1 |
Filters projects attached to a person group, filtering by person group identifier (can be seen in the Person groupinformation URL). |
| 1 | FilterByTerminalProjectsOnly | boolean | 0..1 | Filters out projects which are not shown on a terminal. |
| 1 | FilterByProjectTypeInternalName | string | 0..1 | Filters by project type name. |
| 1 | FilterActiveProjectsByStartDate | date | 0..1 | Use this with the FilterActiveProjectsByEndDate element to filter out projects which have not been active during the selected period. |
| 1 | FilterActiveProjectsByEndDate | date | 0..1 | Use this with the FilterActiveProjectsByStartDate element to filter out projects which have not been active during the selected period. |
| 1 | OrderResultsFirstBy | string | 0..1 |
The primary ordering basis for results. The options are:
|
| 1 | OrderResultsSecondBy | string | 0..1 |
The 2nd ordering basis for results. Same options as in the primary ordering. |
| 1 | OrderResultsThirdBy | string | 0..1 |
The 3rd ordering basis for results. Same options as in the primary and 2nd ordering. |
| 1 | ReturnFormat | string | 0..1 |
Result format. The only option at the moment is the default format, flat_list.
|
Request example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tyo="http://tyoaika.tyoteho.fi">
<soapenv:Header/>
<soapenv:Body>
<tyo:ParametersForGetProjectsV2>
<CallerAuthentication /> <!-- Authentication is required but is left out in this example -->
<FilterByExternalIdentifiers>external-12345</FilterByExternalIdentifiers>
</tyo:ParametersForGetProjectsV2>
</soapenv:Body>
</soapenv:Envelope>
Response
| Level | Field name | Type | Occurences | Description |
| 0 | ReturnValueForGetProjectsV2 | XML element | 1 | Root element under SOAP body |
| 1 | ResponseCode | int | 1 | |
| 1 | ResponseString | string | 1 | |
| 1 | ProjectList | XML element | 1 | |
| 2 | Project | XML element | 0..n | Project info |
| 3 | Id | integer | 0..1 | Project's Nepton identifier |
| 3 | ExternalIdentifier | XML element | 0..n | Project's external identifier. Several identifiers are possible. |
| 4 | Identifier | string | 1 | Identifier |
| 4 | IdentifierType | string | 1 | Identifier type. Only 'ExternalIdentifier' is currently suported. |
| 3 | Name | string | 0..1 | Project name |
| 3 | Deleted | boolean | 0..1 | Is project deleted (true/false) |
| 3 | Active | boolean | 0..1 | Is project active (end date has not passed) |
| 3 | Code | string | 0..1 |
Project code |
| 3 | TypeInternalName | string | 0..1 |
Project type name |
| 3 | Description | string | 0..1 | Project description |
| 3 | StartDate | date | 0..1 | Project start date (YYYY-MM-DD) |
| 3 | EndDate | date | 0..1 | Project end date päättymispäivä (YYYY-MM-DD) |
| 3 | ParentProjectId | int | 0..1 | Parent project's Nepton identifier. This is zero (0) for top level projects. |
| 3 | ParentProjectCode | string | 0..1 | Parent project code |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tyo="http://tyoaika.tyoteho.fi">
<soapenv:Header/>
<soapenv:Body>
<tyo:ReturnValueForGetProjectsV2>
<ResponseCode>?</ResponseCode>
<ResponseString>?</ResponseString>
<ProjectList>
<Project>
<Id>?</Id>
<ExternalIdentifier>
<Identifier>?</Identifier>
<IdentifierType>?</IdentifierType>
</ExternalIdentifier>
<Name>?</Name>
<Deleted>?</Deleted>
<Code>?</Code>
<TypeInternalName>?</TypeInternalName>
<Description>?</Description>
<StartDate>?</StartDate>
<EndDate>?</EndDate>
<ParentProjectId>?</ParentProjectId>
<ParentProjectCode>?</ParentProjectCode>
</Project>
</ProjectList>
</tyo:ReturnValueForGetProjectsV2>
</soapenv:Body>
</soapenv:Envelope>
Comments
0 comments
Please sign in to leave a comment.