v3/AIWS_CU_Person

Added more employment-related fields: PersonalIDCountry, EmploymentStart, EmploymentEnd, ContractStart, ContractEnd, PayLeaveFact1Earn, and PayLeaveFact1Deduct.

Name	Format	Mandatory	Example	APM XREF	Description

Name	Format	Mandatory	Example	APM XREF	Description
Interface	string	Y	companyname_import	Identified in APM > Setup > General Codes > Miscellaneous > Interfaces	This is unique identifier and mandatory for each request.
ExternalPIN	string	Y	AAA-9999999	Automatically mapped with the Adonis PIN.	This is the UID/PIN of the seaman inside your company/organization.
FirstName	string	Y	JOHN
MiddleName	string		DOE
LastName	string	Y	SMITH
CallingName	string		JOE
SuffixName	string		JR / MBA
Initials	string		JDS
Title	string		Mr		Limited to Mr, Mrs, Miss, Ms, Dr, Capt
Gender	M,F,U,N		M		Limited to M=Male; F=Female; U=Unknown; N=Non-binary,
ExternalMaritalStatus	string		MARRIED	Identified in APM > Setup > General Codes > Family > Marital Status Codes
Nationality	2 letters	Y	DK		ISO 3166-1 Set A-2 (2 letter country code)
NativeLangauge	2 letters		FI (Finnish)		ISO 639 Set 1 (2 letter code)
BirthDate	YYYY-MM-DD		1974-12-25
PlaceOfBirth	string		AALBORG		City or town of birth
CountryOfBirth	2 letters		DK		ISO 3166-1 Set A-2 (2 letter country code)
ExternalHairColor	string		LIGHT BLONDE	Identified in APM > Setup > General Codes > Miscellaneous > Colors	hair color
ExternalEyeColor	string		BLUE	Identified in APM > Setup > General Codes > Miscellaneous > Colors	eye color
Height	number in cm		174		in centimeters
Weight	number in kg		90		in kilogram
HomeAirport	3 letters		AAL	Identified in APM > Setup > General Codes > Travel > Airport Or use the 3 letter IATA airport codes	IATA code of the closest airport for the seaman.
TravelTime	00:00		06:00		preferred 1st option travel time
HomeAirport2	string		BLL	Identified in APM > Setup > General Codes > Travel > Airport Or use the 3 letter IATA airport codes	IATA code of the 2nd closest airport for the seaman.
TravelTime2	00:00		08:00		preferred 2nd option travel time
AddressLine1	string		16 Tinglykke		Address of the seaman
AddressLine2	string
AddressLine3	string
AddressCountry	2 letters		DK		ISO 3166-1 Set A-2 (2 letter country code)
AddressPostcode	string		9210A		Postal code
AddressPlace	string		AALBORG		City
AddressState	string		New York		Country should be mandatory if AddressState ≠ NULL
Email	string		johnsmith@email.com
Mobile	number		80001234		Mobile number of the seaman
Telephone	number		80004321
Organization	int	Y	100000018	Identified in the APM > Organization Structure	Adonis generated NUMORGID
PersonalID	int		16108012345		(SSN) Personal Number
AlternativePIN	string		AAA-9999999		Alternative PIN
ExternalRank	string		CHENG		Seaman’s Rank
ExternalContractType	string		FULL		Seaman’s Contract Type
PersonalIDCountry	numeric		12345121260		Seaman’s personal ID provided by his/her residence country.
EmploymentStart	datetime		2019-01-23		Date of the employment started.
EmploymentEnd	datetime				Date of the termination.
ContractStart	datetime		2019-04-23		Date when the contract started.
ContractEnd	datetime		2025-04-23		Date when the contract ended.
PayLeaveFact1Earn	string		@@LVE:001 or 1.0		This value can be set in the Payroll Module of the APM or a decimal value.
PayLeaveFact1Deduct	string		@@ADD:001 or 0.12		This value can be set in the Payroll Module of the APM or a decimal value.

Example Value in JSON

{
  "request": {
    "PersonalIDCountry": "US-535341S",
    "EmploymentStart": "2022-12-25",
    "EmploymentEnd": "",
    "ContractStart": "2022-12-25",
    "ContractEnd": "2027-12-25",
    "PayLeaveFact1Earn": "1.3",
    "PayLeaveFact1Deduct": "1.2",
    "PersonalID": "12345241163",
    "AlternativePIN": "",
    "AddressState": "FLORIDA",
    "Interface": "SHIPADMIN",
    "ExternalPin": "SH-09",
    "FirstName": "Jonathan",
    "MiddleName": "Garcia",
    "LastName": "Davis",
    "CallingName": "Jon",
    "SuffixName": "",
    "Initials": "JD",
    "Title": "",
    "Gender": "",
    "Nationality": "US",
    "NativeLangauge": "en",
    "BirthDate": "1970-12-25",
    "PlaceOfBirth": "",
    "CountryOfBirth": "US",
    "ExternalHairColor": "Black",
    "ExternalEyeColor": "Hazel",
    "Height": 172,
    "Weight": 98,
    "HomeAirport": "JFK",
    "TravelTime": "12:00",
    "HomeAirport2": "",
    "TravelTime2": "",
    "ExternalMaritalStatus": "Married",
    "ExternalRank": "1ST MATE",
    "ExternalContractType": "TEMP",
    "AddressLine1": "13 Rainbow St.",
    "AddressLine2": "",
    "AddressLine3": "",
    "AddressCountry": "US",
    "AddressPostcode": "00650",
    "AddressPlace": "",
    "Email": "jondavis@email.com",
    "Mobile": "",
    "Telephone": "80002030",
    "Organization": "AmericanLines" 
  }
}

Adonis HR Plug-ins User Documentation

v3/AIWS_CU_Person

Example Value in JSON

Related content