Overview of the interface
Interface is used in retrieving event type information from 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.
Request data
| LEVEL | FIELD NAME | TYPE | OCCURRENCES | DESCRIPTION |
|---|---|---|---|---|
| 0 | ParametersForGetActivityTypes | XML element | 1 | Root element under SOAP body |
| 1 | CallerAuthentication | XML element | More information about authentication here | |
| 1 | FilterByIds | XML element | 0..1 | Filter by Nepton unique identifiers of event types |
| 2 | Id | integer | 0..n | Nepton unique identifier |
| 1 | FilterByInternalNames | 0..1 | Filter by event type internal names | |
| 2 | InternalName | string | 0..n | Event type internal name |
Request example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tyo="http://tyoaika.tyoteho.fi">
<soapenv:Header/>
<soapenv:Body>
<tyo:ParametersForGetActivityTypes>
<CallerAuthentication / > <!-- Authentication is required but is omitted from this example -->
<FilterByIds>
<Id>1</Id>
</FilterByIds>
<FilterByInternalNames>
<InternalName>work</InternalName>
</FilterByInternalNames>
</tyo:ParametersForGetActivityTypes>
</soapenv:Body>
</soapenv:Envelope>
Response
| LEVEL | FIELD NAME | TYPE | OCCURRENCES | SELITE | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 0 | ReturnValueForGetActivityTypes | XML element | 1 | Root element under SOAP body | ||||||||
| 1 | ResponseCode | integer | 1 | Response code of handling the request. List of response codes can be found here. | ||||||||
| 1 | ResponseString | string | 1 | Response description | ||||||||
| 1 | ActivityTypeList | XML element | 1 | List of event type | ||||||||
| 2 | ActivityType | XML element | 0..n | Element containing information of single event type | ||||||||
| 3 | Id | integer | 1 | Nepton identifier of event type | ||||||||
| 3 | InternalName | string | 1 | Internal name of event type | ||||||||
| 3 | TranslatedName | XML element | 0..n | Translated names for event type. The number of elements is the same as the number of supported languages in Nepton. See supported languages and their codes here. | ||||||||
| 4 | Locale | string | 1 | Language code for translation | ||||||||
| 4 | Name | string | 1 | Translation of event type name | ||||||||
| 3 | Code | string | 0..1 | Event type code | ||||||||
| 3 | Visible | boolean | 0..1 | true if event type is set as visible in Nepton, false if not | ||||||||
| 3 | CanAssignWorkIncrements | boolean | 0..1 | Can supplements be assigned for event type (true/false) | ||||||||
| 3 | CanHaveRelatedProjects | boolean | 0..1 | Can projects be targeted for event type (true/false) | ||||||||
| 3 | CategoryInternalName | string | 0..1 | Event type category internal name | ||||||||
| 3 | TranslatedCategoryName | XML element | 0..n | Translated names for event type category. The number of elements is the same as the number of supported languages in Nepton. See supported languages and their codes here. | ||||||||
| 4 | Locale | string |
1 |
Language code for translation |
||||||||
| 4 | Name | string |
1 |
Translation of event type category name |
||||||||
| 3 | BeginDateTimeInput | string | 0..1 |
Setting for inserting begin time for event type Possible values:
|
||||||||
| 3 | EndDateTimeInput | string | 0..1 | Setting for inserting end time for event type. Options are same as with BeginDateTimeInput - element. |
Response example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tyo="http://tyoaika.tyoteho.fi">
<soapenv:Header/>
<soapenv:Body>
<tyo:ReturnValueForGetActivityTypes>
<ResponseCode>1000</ResponseCode>
<ResponseString>All clear. No errors</ResponseString>
<ActivityTypeList>
<ActivityType>
<Id>1</Id>
<InternalName>work</InternalName>
<TranslatedName>
<Locale>fi_FI</Locale>
<Name>työ</Name>
</TranslatedName>
<TranslatedName>
<Locale>en_US</Locale>
<Name>work</Name>
</TranslatedName>
<Code>456/w</Code>
<Visible>true</Visible>
<CanAssignWorkIncrements>true</CanAssignWorkIncrements>
<CanHaveRelatedProjects>true</CanHaveRelatedProjects>
<CategoryInternalName>test</CategoryInternalName>
<TranslatedCategoryName>
<Locale>fi_FI</Locale>
<Name>testausta</Name>
</TranslatedCategoryName>
<TranslatedCategoryName>
<Locale>en_US</Locale>
<Name>testing</Name>
</TranslatedCategoryName>
<BeginDateTimeInput>mandatory</BeginDateTimeInput>
<EndDateTimeInput>optional</EndDateTimeInput>
</ActivityType>
</ActivityTypeList>
</tyo:ReturnValueForGetActivityTypes>
</soapenv:Body>
</soapenv:Envelope>
Comments
0 comments
Please sign in to leave a comment.