Export persons - JSON data format

Person data can be exported from Nepton into an external service. This article describes the person export fields contained when exporting in JSON data format. A detailed description about person export can be found here.

Fields in person export file in JSON format

Data format details

• Character encoding of the exported file is always UTF-8 (a common Unicode encoding).
• Line separator is standard Windows line separator (CR+LF 0x0D 0x0A).
• In JSON data format person information is exported as an array of person objects.
• Each person object represents one person.
• Person object consists of name–value pairs where each name represents field name and value is an array of one or more value objects.
• Each value object consists of three name–value pairs:
  

  Name	Value
  Valid from	null or date "YYYY-MM-DD" of first date the value was or is valid
  Valid to	null or date "YYYY-MM-DD" of last date the value was or is valid
  Value	Decimal number or boolean value (true/false) without quotes or any other value enclosed in quotes (")

• If a field is not in use or not set yet the field is not included at all.
• Nepton Id (field name NeptonPersonGUID), username and employee number are all unique fields within the working community and can be used to identify the person. We recommend using the Nepton Id as it is guaranteed not to change.
• Date fields are using the format "YYYY-MM-DD" (year, month and day separated by hyphens (-), enclosed in quotes).
• Possible additional fields of type Date and time are using the format "YYYY-MM-DD HH:MM:SS" (year, month and day separated by hyphens (-), a space, hours, minutes and seconds separated by colon (:), enclosed in quotes).
• Decimal number fields are using dot (.) as decimal separator when the decimal part is not zero. Otherwise value is only integer number. Negative numbers are prefixed with hyphen (-).
• UUID fields are represented as strings consisting of 32 hexadecimal digits separated by four hyphens: 8 digits - 4 digits - 4-digits - 4 digits - 12 digits. Letters are in upper case. The code is enclosed in quotes (").
• Any other values than true, false, null or decimal numbers are always enclosed in quotes. Certain characters are escaped with a backslash (\):
  

  Escaped character	Original character
  \"	"
  \\	\
  \/	/
  \b	backspace
  \f	form feed
  \r	carriage return
  \n	line feed
  \u hexadecimal code	any Unicode character out of valid range 0x0020 - 0x10FFFF is displayed with \u prefix and hexadecimal code of 4 digits or more

Example file

[
	{
		"Email": [
			{
				"Valid from": null,
				"Valid to": null,
				"Value": "email@compa.ny"
			}
		],
		"Last name": [
			{
				"Valid from": null,
				"Valid to": null,
				"Value": "Last"
			}
		],
		"First name": [
			{
				"Valid from": null,
				"Valid to": null,
				"Value": "First"
			}
		],
		"Username": [
			{
				"Valid from": null,
				"Valid to": null,
				"Value": "First Last"
			}
		],
		"Street address": [
			{
				"Valid from": null,
				"Valid to": null,
				"Value": "Street address 1"
			}
		],
		"Postcode": [
			{
				"Valid from": null,
				"Valid to": null,
				"Value": "01234"
			}
		],
		"Phone number": [
			{
				"Valid from": null,
				"Valid to": "2022-10-28",
				"Value": "019581928"
			},
			{
				"Valid from": "2022-10-29",
				"Valid to": null,
				"Value": "08855150015"
			}
		],
		"City": [
			{
				"Valid from": null,
				"Valid to": null,
				"Value": "City"
			}
		],
		"Employee number": [
			{
				"Valid from": null,
				"Valid to": null,
				"Value": "1"
			}
		],
		"Personal identity code": [
			{
				"Valid from": null,
				"Valid to": null,
				"Value": "111111-111C"
			}
		],
		"Employment start date": [
			{
				"Valid from": null,
				"Valid to": null,
				"Value": "2022-11-01"
			}
		],
		"Full name": [
			{
				"Valid from": null,
				"Valid to": null,
				"Value": "Last, First"
			}
		],
		"Role": [
			{
				"Valid from": null,
				"Valid to": null,
				"Value": "Employee"
			}
		],
		"User account enabled": [
			{
				"Valid from": null,
				"Valid to": null,
				"Value": true
			}
		],
		"Service usage language": [
			{
				"Valid from": null,
				"Valid to": null,
				"Value": "en-GB"
			}
		],
		"Weekly hours MIN": [
			{
				"Valid from": null,
				"Valid to": "2022-11-15",
				"Value": 40
			},
			{
				"Valid from": "2022-11-16",
				"Valid to": null,
				"Value": 37.55
			}
		],
		"Weekly hours MAX": [
			{
				"Valid from": null,
				"Valid to": null,
				"Value": 40
			}
		],
		"Work time percentage": [
			{
				"Valid from": "2022-12-01",
				"Valid to": null,
				"Value": 50
			}
		],
		"Worktime roles": [
			{
				"Valid from": null,
				"Valid to": null,
				"Value": "Omien sekä alaisten tietojen muokkausoikeus"
			}
		],
		"NeptonPersonGUID": "37F7EAFE-046F-ED11-81FD-A0510B65B142",
		"AdditionalDecimal": [
			{
				"Valid from": null,
				"Valid to": null,
				"Value": 4.5
			}
		],
		"AdditionalDateTime": [
			{
				"Valid from": null,
				"Valid to": null,
				"Value": "2022-11-20 12:20:00"
			}
		]
	},
	{
		"Last name": [
			{
				"Valid from": null,
				"Valid to": null,
				"Value": "Account"
			}
		],
		"First name": [
			{
				"Valid from": null,
				"Valid to": null,
				"Value": "Disabled"
			}
		],
		"Username": [
			{
				"Valid from": null,
				"Valid to": null,
				"Value": "Disabled Account"
			}
		],
		"Full name": [
			{
				"Valid from": null,
				"Valid to": null,
				"Value": "Account, Disabled"
			}
		],
		"Role": [
			{
				"Valid from": null,
				"Valid to": null,
				"Value": "Employee"
			}
		],
		"User account enabled": [
			{
				"Valid from": null,
				"Valid to": null,
				"Value": false
			}
		],
		"Service usage language": [
			{
				"Valid from": null,
				"Valid to": null,
				"Value": "fi-FI"
			}
		],
		"Worktime roles": [
			{
				"Valid from": null,
				"Valid to": null,
				"Value": "Omien sekä alaisten tietojen muokkausoikeus"
			}
		],
		"NeptonPersonGUID": "FA1A79A9-126F-ED11-81FD-A0511B65B142"
	}
]