Skip to end of banner
Go to start of banner

AIWS_CU_Person

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Version History

« Previous Version 23 Next »

URL Versioning

V1 is a fundamental method with the basic information needed from a person’s record.

sample URL request: http://yourcompany.com/AIWS_APP/AdonisIntegrationWebService.svc/v1/AIWS_CU_PERSON

In the V2, AddressState, PersonalPIN, and AlternativePIN were added. If you think that you need the following parameters for your crewlist then you should use this version.

sample URL request: http://yourcompany.com/AIWS_APP/AdonisIntegrationWebService.svc/v2/AIWS_CU_PERSON

Name

Format

Mandatory

Version

Example

APM XREF

Description

Interface

string

Y

V1

companyname_import

Identified in APM > Setup > General Codes > Miscellaneous > Interfaces

This is unique identifier and mandatory for each request.

ExternalPIN

string

Y

V1

AAA-9999999

Automatically mapped with the Adonis PIN.

This is the UID/PIN of the seaman inside your company/organization.

FirstName

string

Y

V1

JOHN

MiddleName

string

V1

DOE

LastName

string

Y

V1

SMITH

CallingName

string

V1

JOE

SuffixName

string

V1

JR / MBA

Initials

string

V1

JDS

Title

string

V1

Mr

Limited to Mr, Mrs, Miss, Ms, Dr, Capt

Gender

M,F,U,N

Y

V1

M

Limited to M=Male; F=Female; U=Unknown; N=Non-binary,

ExternalMaritalStatus

string

V1

MARRIED

Identified in APM > Setup > General Codes > Family > Marital Status Codes

Nationality

2 letters

Y

V1

DK

2 letter country code

NativeLangauge

2 letters

V1

FI (Finnish)

ISO 639 Set 1 (2 letter code)

BirthDate

YYYY-MM-DD

V1

1974-12-25

PlaceOfBirth

string

V1

AALBORG

City or town of birth

CountryOfBirth

2 letters

V1

DK

2 letter country code

ExternalHairColor

string

V1

LIGHT BLONDE

Identified in APM > Setup > General Codes > Miscellaneous > Colors

hair color

ExternalEyeColor

string

V1

BLUE

Identified in APM > Setup > General Codes > Miscellaneous > Colors

eye color

Height

number in cm

V1

174

in centimeters

Weight

number in kg

V1

90

in kilogram

HomeAirport

3 letters

V1

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

V1

06:00

preferred 1st option travel time

HomeAirport2

string

V1

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

V1

08:00

preferred 2nd option travel time

AddressLine1

string

Y

V1

16 Tinglykke

Address of the seaman

AddressLine2

string

V1

AddressLine3

string

V1

AddressCountry

2 letters

V1

DK

2 letter country code

AddressPostcode

string

V1

9210A

Postal code

AddressPlace

string

V1

AALBORG

City

AddressState

string

V2

New York

Country should be mandatory if AddressState ≠ NULL

Email

string

V1

johnsmith@email.com

Mobile

number

V1

80001234

Mobile number of the seaman

Telephone

number

V1

80004321

Organization

int

Y

V1

100000018

Identified in the APM > Organization Structure

Adonis generated NUMORGID

PersonalID

int

V2

16108012345

(SSN) Personal Number

AlternativePIN

string

V2

AAA-9999999

Alternative PIN

ExternalRank

string

V1

CHENG

Seaman’s Rank

ExternalContractType

string

V1

FULL

Seaman’s Contract Type

  • No labels