Tails

Tail Properties

The data model for synchronizing a tail.

Field	Type	Constraints	Detail
tailId	Mapped ID	Required
tailNumber	String 20	Required
registrationNumber	String 50
icaoTypeName	String
sabreTypeName	String
countryCode	String		If present, validated against ISO 3166-1 alpha-2 standard.
passengerSeating	Integer

/Tails/

HTTP PUT Service Accounts

Creates a new tail, or potentially adds a new mapping to it if the tail already exists.

Request

See Tail Properties.

Example Payload

        {
          "tailId": "callers_ID_12345",
          "tailNumber": "N12345",
          "registrationNumber": "N12345",
          "icaoTypeName": "C500",
          "sabreTypeName": "CE-500",
          "passengerSeating": 100,
          "countryCode": "FR"
        }

Response

See HTTP Response Codes

HTTP Status

Data

201

Field	Type	Detail
tailId	Integer	VOCUS' ID for the tail.

200

Field	Type	Detail
tailId	Integer	VOCUS' ID for the tail.
newSourceMappingAdded	Boolean	If true, the object was located by a "soft match", not by ID. A mapping was added for the ID provided by the caller.

/Tails/Deactivate/{tailId}

HTTP POST Service Accounts

Deactivates a tail with an active status.

/Tails/Reactivate/{tailId}

HTTP POST Service Accounts

Reactivates a tail that has an inactive status.

/Tails/ChangeTailNumber

HTTP POST Service Accounts

Changes the tail number of an existing tail.

Request

Field	Type	Constraints	Detail
tailId	string 50	Required	This is the Mapped ID of an existing tail.
newTailNumber	string 50	Required	The new tail number to associate with the tail ID.

Example Payload

        {
          "tailId": "callers_ID_12345",
          "newTailNumber": "N12345"
        }

Response

See HTTP Response Codes

HTTP Status	Data
200

/Tails/Bulk

HTTP PUT Service Accounts

Creates or maps multiple tails.

Input

Field	Type	Constraints	Detail
tails	Array	Required	An array of tails. See Tail Properties.

Field

Type

Constraints

Detail

tails

Array

Required

An array of tails.

See Tail Properties.

Example Payload

        {
          "tails": [
            {
              "tailId": "callers_ID_12345",
              "tailNumber": "N12345",
              "registrationNumber": "N12345",
              "icaoTypeName": "C500",
              "sabreTypeName": "CE-500",
              "passengerSeating": 5,
              "countryCode": "FR"
            },
            {
              "tailId": "callers_ID_67890",
              "tailNumber": "N67890",
              "registrationNumber": "N67890",
              "icaoTypeName": "C500",
              "sabreTypeName": "CE-500",
              "passengerSeating": 5,
              "countryCode": "US"
            }
          ]
        }

Response

See HTTP Response Codes

Because this is a bulk operation, some tails may be created, others have a new mapping applied, others have no action taken. It is also possible for one or more tails to have failed validation.

The response code will still be HTTP 200 even when creation occurs, or validation failures occur.

Field Type Detail

operations

Array

An array containing one entry per tail submitted.

Field	Type	Detail
operationId	String	This will contain the caller's ID for the tail. If the ID was missing (and thus caused a validation failure), this value will be blank.
isValid	Boolean	Indicates whether validation was successful for this tail in the batch.
validation	Object	If `isValid` is true, this property will be missing or null. However, if validation failed, this property will contain detail about the failed validation operation.
tailId	Integer	VOCUS' ID for the tail. If `isValid` is false, this property will be missing or null.
wasCreated	Boolean	Indicates whether the tail was created in VOCUS. If `isValid` is false, this property will be missing or null.
newSourceMappingAdded	Boolean	If true, the object was located by a "soft match", not by ID. A mapping was added for the ID provided by the caller. If `isValid` is false, this property will be missing or null.

Example Bulk Request and Response Payloads

This example shows 2 valid and 2 invalid operations.

Request

        {
          "tails": [
            {
              "tailId": "bulk_0",
              "tailNumber": "tail_number_0"
            },
            {
              "tailId": "bulk_1",
              "tailNumber": "tail_number_1"
            },
            {
              "tailId": "bulk_2",
              // left blank to trigger validation
              "tailNumber": ""
            },
            {
              "tailId": "bulk_3",
              // left blank to trigger validation
              "tailNumber": ""
            }
          ]
        }

Response

        {
          "operations": [
            {
              "isValid": true,
              "operationId": "bulk_0",
              "tailId": 32715,
              "wasCreated": false,
              "newSourceMappingAdded": false
            },
            {
              "isValid": true,
              "operationId": "bulk_1",
              "tailId": 32716,
              "wasCreated": false,
              "newSourceMappingAdded": false
            },
            {
              "operationId": "bulk_2",
              "isValid": false,
              "validation": {
                "fieldErrors": {
                  "tailNumber": [
                    "Tail number is required."
                  ]
                },
                "generalErrors": [],
                "isValid": false,
                "title": "Error Validating Input Data",
                "instance": "de8d595d-7a20-4c30-9c33-19ece0d672bb",
                "type": "http://api.polarisaerodev.com/Help/Home/RestConcepts#validation-errors",
                "detail": "Tail number is required."
              }
            },
            {
              "operationId": "bulk_3",
              "isValid": false,
              "validation": {
                "fieldErrors": {
                  "tailNumber": [
                    "Tail number is required."
                  ]
                },
                "generalErrors": [],
                "isValid": false,
                "title": "Error Validating Input Data",
                "instance": "de8d595d-7a20-4c30-9c33-19ece0d672bb",
                "type": "http://api.polarisaerodev.com/Help/Home/RestConcepts#validation-errors",
                "detail": "Tail number is required."
              }
            }
          ]
        }

API Version 14.1.9203.25249