Create Pax

Creates a new passenger in the system

POST api/external/user

When creating a new user, you have the option to include a reference in the request payload. If a reference is provided, the created user will be identified by that reference so is important

However, if no reference is included, a unique random identifier will be generated and used as the reference.

Important to note

References must be unique and cannot be used more than once.
Save the reference, whether provided or generated, for future use.

Here is an example of a simple request payload

{
  "address": {
      "city": "Rome",
      "country": "Italy",
      "street": "Viale dei Gladiatori",
      "type": "WORK",
      "zip": "00135"
    },
  "birthDate": "1976-09-27",
  "birthPlace": "Rome",
  "email": "[email protected]",
  "firstName": "Francesco",
  "gender": "MALE",
  "lastName": "Totti",
  "salutation": "Mr",
  "logName": "Pupone"
}

Example Response created passenger

{
    "externalReference": "fl3xx_107800",
    "internalId": 107800,
    "firstName": "Francesco",
    "lastName": "Totti",
    "logName": "Pupone",
    "email": "[email protected]",
    "salutation": "Mr",
    "gender": "MALE",
    "birthDate": "1976-09-27",
    "birthPlace": "Rome",
    "nationality": "IT",
    "address": {
        "type": "WORK",
        "street": "Viale dei Gladiatori",
        "city": "Rome",
        "zip": "00135",
        "country": "IT",
        "latitude": 0.0,
        "longitude": 0.0,
        "links": []
    },
    "status": "ACTIVE",
    "links": []
}

Here is the complete JSON Payload with the data field available for creating a passenger

{
  "account": {
    "accountNumber": "string",
    "accountid": 0,
    "address": {
      "buildingDetails": "string",
      "city": "string",
      "country": "string",
      "externalReference": "string",
      "internalId": 0,
      "latitude": 0,
      "links": [
        {
          "deprecation": "string",
          "href": "string",
          "hreflang": "string",
          "media": "string",
          "name": "string",
          "profile": "string",
          "rel": {},
          "title": "string",
          "type": "string"
        }
      ],
      "longitude": 0,
      "recipient": "string",
      "street": "string",
      "type": "WORK",
      "zip": "string"
    },
    "email": "string",
    "externalReference": "string",
    "internalId": 0,
    "links": [
      {
        "deprecation": "string",
        "href": "string",
        "hreflang": "string",
        "media": "string",
        "name": "string",
        "profile": "string",
        "rel": {},
        "title": "string",
        "type": "string"
      }
    ],
    "mobile": "string",
    "name": "string",
    "notes": "string",
    "phone": "string",
    "vatNumber": "string"
  },
  "acronym": "string",
  "address": {
    "buildingDetails": "string",
    "city": "string",
    "country": "string",
    "externalReference": "string",
    "internalId": 0,
    "latitude": 0,
    "links": [
      {
        "deprecation": "string",
        "href": "string",
        "hreflang": "string",
        "media": "string",
        "name": "string",
        "profile": "string",
        "rel": {},
        "title": "string",
        "type": "string"
      }
    ],
    "longitude": 0,
    "recipient": "string",
    "street": "string",
    "type": "WORK",
    "zip": "string"
  },
  "birthDate": "2023-01-16",
  "birthPlace": "string",
  "documentExpiration": "2023-01-16",
  "documentExternalReference": 0,
  "documentNumber": "string",
  "documentType": "PASSPORT",
  "email": "string",
  "externalReference": "string",
  "firstName": "string",
  "gender": "FEMALE",
  "internalId": 0,
  "issueCountry": "string",
  "issueDate": "2023-01-16",
  "lastName": "string",
  "links": [
    {
      "deprecation": "string",
      "href": "string",
      "hreflang": "string",
      "media": "string",
      "name": "string",
      "profile": "string",
      "rel": {},
      "title": "string",
      "type": "string"
    }
  ],
  "logName": "string",
  "mobile": "string",
  "nationality": "string",
  "personnelNumber": "string",
  "phone": "string",
  "salutation": "Mr",
  "siflType": "CONTROL",
  "status": "ACTIVE"
}