Persons API

Username

The username of a person configured in the Nepton service. The permissions for adding and modifying data in person import are the same as for this person.

For testing and automated use, we recommend setting up a dedicated person that is not used for other purposes. See guidance for adding a person.

UserPassword

The password of the above person.

DeploymentId

A numeric value identifying your working community. Please contact support for the correct value.

WebServicePassword

A password related to the working community data. Please contact support for the correct value.

IgnoreEmptyValues

Possible values for this field are "1" or "0"

1: an empty value in the import file will not affect any existing data in Nepton service

0: empty value in the import file will delete an existing value in Nepton service

More details here.

ImportType

Indicates the person import type. In general, Nepton recommends using the Default import type. See Person import type for more details.

Possible values are:

ImportColumnNames

A pipe "|" character separated list of columns which are being imported. Note that this parameter is NOT required if the importData has a header row or if the selected ImportType has an fixed import column order.

ImportEncoding

The name of the encoding used in the file you wish to import (e.g. utf-8). More details here.

ImportData

The string representation of the import file data. Make sure it is HTML encoded.

Username

The username of a person configured in the Nepton service. The permissions for adding and modifying data in person import are the same as for this person.

For testing and automated use, we recommend setting up a dedicated person that is not used for other purposes. See guidance for adding a person.

UserPassword

The password of the above person.

DeploymentId

A numeric value identifying your working community. Please contact support for the correct value.

WebServicePassword

A password related to the working community data. Please contact support for the correct value.

IgnoreEmptyValues

Possible values for this field are "1" or "0"

1: an empty value in the import file will not affect any existing data in Nepton service

0: empty value in the import file will delete an existing value in Nepton service

More details here.

ImportType

Indicates the person import type. In general, Nepton recommends using the Default import type. See Person import type for more details.

Possible values are:

ImportNodeNames

A pipe "|" character separated list of nodes which should be parsed for import.

In the example below:

ImportNodeNames = "First_name|Last_name|Username|Email"

Note that <OtherField> is not included in ImportNodeNames, so it is not imported.

<Persons>
    <ImportUserData>
        <First_name>User</First_name>
        <Last_name>1</Last_name>
        <Username>User 1</Username>
        <Email>testuser1@test.com</Email>
        <OtherField>We do not want to include this in person import</OtherField>
    </ImportUserData>
    <ImportUserData>
        <First_name>User</First_name>
        <Last_name>2</Last_name>
        <Username>User 2</Username>
        <Email>testuser2@test.com</Email>
        <OtherField>We do not want to include this in person import</OtherField>
    </ImportUserData>
</Persons>

SeparatorNodeName

The name of the XML node which separates each person's data in the import file.
NB! The difference between uppercase and lowecase characters is significant.

In the example below:

SeparatorNodeName = "ImportUserData"

<Persons>
    <ImportUserData>
        <First_name>User</First_name>
        <Last_name>1</Last_name>
        <Username>User 1</Username>
        <Email>testuser1@test.com</Email>
    </ImportUserData>
    <ImportUserData>
        <First_name>User</First_name>
        <Last_name>2</Last_name>
        <Username>User 2</Username>
        <Email>testuser2@test.com</Email>
    </ImportUserData>
</Persons>

ImportEncoding

The name of the encoding used in the file you wish to import (e.g. utf-8). More details here.

ImportData

The HTML encoded string representation of the import XML data.

More information of the content structure can be found here. The list of available fields are described here.

For example, the XML representation of the payload can be like this inside the ImportData element:

<Persons>
    <ImportUserData>
        <First_name>User</First_name>
        <Last_name>1</Last_name>
        <Username>User 1</Username>
        <Email>testuser1@test.com</Email>
    </ImportUserData>
    <ImportUserData>
        <First_name>User</First_name>
        <Last_name>2</Last_name>
        <Username>User 2</Username>
        <Email>testuser2@test.com</Email>
    </ImportUserData>
</Persons>

As this field is sent as HTML encoded the text contents of the ImportData element in the import file would be

<Persons>
    <ImportUserData>
        <First_name>User</First_name>
        <Last_name>1</Last_name>
        <Username>User 1</Username>
        <Email>testuser1@test.com</Email>
    </ImportUserData>
    <ImportUserData>
        <First_name>User</First_name>
        <Last_name>2</Last_name>
        <Username>User 2</Username>
        <Email>testuser2@test.com</Email>
    </ImportUserData>
</Persons>

UserName

Username of the person to get the working contracts of

BeginDate

Working contract search period start date

EndDate

Working contract search period end date

WebServicePassword

A password related to the working community data. Please contact support for the correct value.

DeploymentID

A numeric value identifying your working community. Please contact support for the correct value.

Document type id. Possible values are 1, 2, 5, 6, 7, 8 or 9

1 Working contract
2 Working contract attachment
5 Working reference
6 Salary receipt
7 Salary provision receipt
8 User document
9 Event attachment

Document file type id. Possible values are 1, 3, 4, 5, 6, 7, 8, 9, 10 or 11

1 Fillable form (HTML)
3 PDF file
4 Prefilled HTML file
5 Word document (.doc)
6 Excel file (.xls)
7 Other
8 PowerPoint (.pptx)
9 Zip files (.zip,.rar)
10 Image files (.gif,.jpeg, .jpg, .png)
11 Text (.txt)

Possible value are True or False.

True: If a document exists with Filename, then delete the old one and insert the new one.

False: If a document exists with Filename, don't replace the old one.

FirstName

First name for which we need the total person count

LastName

Last name for which we need the total person count

WebServicePassword

A password related to the working community data. Please contact support for the correct value.

DeploymentID

A numeric value identifying your working community. Please contact support for the correct value.

Error code can return the following values:

Empty / Unknown_Errors / No_Error / Invalid_Password / Invalid_DeploymentId / AccessDenied / InvalidParameters / NotSupported / NotFound / DeploymentSettingsNotFound / CollectionContainsErrors / EncodingFailure / NotRecognised / IntegrationNotRecognizedReturnedUserId / AccessDenied_DueTo_RequestIPIsNotInWhiteList