Versions Compared

Old Version 71

changes.mady.by.user Remo Räber

Saved on

compared with

New Version 72

changes.mady.by.user Susanne Schlegel

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The following sections are currently available in accordance with our Swagger schema definition:

NameContents
AGNCYAGENCY_INFOAgency information:

  • uuid

  • name

CONTACT_DATA

Company contact data:

  • street

  • street2

  • zipCode

  • place

  • countryCode

  • phone

  • fax

  • E-Mail (email, email2, email3)

  • receiveDocs

PARENT_COMPANY

Parent company settings:

  • company (reference)
  • adminShareOption (only relevant if parent company is set)
MEMBERSHIPS

Corporate alliance Memberships

  • airline

    • alliance (2-Letter code)

    • memberNumber

    • type

  • hotel

    • alliance (2-Letter code)

    • memberNumber

    • customerRequest

  • rentalCar

    • alliance (2-Letter code)

    • memberNumber

    • customerRequest

    • billingNumber

    • preferredProvider (boolean, can only be set on one at a time)

GENERIC_FIELD_VALUES

Values (where filled) from the generic setup

  • field (name, uuid)
  • value

Note: Updates to generic field values are possible using either the field name or field uuid. Using the uuid is preferred since it is guaranteed to be unique, whereas name may not be unique or simply not set in some edge cases.

CREDIT_CARDS

Credit card related information:

  • creditCards
    • type (DC, AX, VI, CA, TP, JC, DS)
    • maskedNumber
    • expiratoin
    • remark
    • publishAsFop
  • webCard reference
  • hotelGuarantee reference
  • carGuarantee reference
  • railFormOfPayment reference - only available if rail feature is active in agency configuration
  • additionalFormOfPayment
  • travellerCardOptions
    • fopOption
    • hotelGuaranteeUsage
    • carGuaranteeUsage
    • webPaymentUsage
COMMENTComment on profile - only available to agency managers
HISTORY

History (Read Only):

  • lastModified (timestamp)
  • history (Only available to agency managers)
PUBLISH_STATES

Publish States (Read Only):

  • label
  • lastPublished (timestamp)
  • recordLocator
  • lastPublishState
  • faultIndicator

The Fault indicator will be one of

  • OK (Everything in order, no special state)
  • QUEUED (Everything in order, but profile is currently queued for publishing)
  • INTENTIONALLY_NOT_PUBLISHED (Profile is in a "desired" fault state (Publishing rejected / Profile processed by remote endpoint with warnings))
  • TIMESTAMP_ISSUE (Profile has an error which is based on timestamp mismatches)
  • GENERAL_ERROR (The publish state is in error.)
INTERFACE_SETUP
Note

This section is read only and must not be included in updates.
Sensitive properties (i.e. Concur Refresh Tokens) will not be returned by the API

  • travelGroups (only relevant for Cytric)
    • id
    • name
  • targetSystems
    • agencyInterface
    • attribute1 (interface-specific configuration; available depending on interface type)
    • attribute2 (interface-specific configuration; available depending on interface type)
    • attribute3 (interface-specific configuration; available depending on interface type)
    • attribute4 (interface-specific configuration; available depending on interface type)
  • reportingOfficeId
  • gwsAgencyLocation
TRAVELLER_SETTINGS
  • defaultArranger
  • defaultTraveller
  • selfApprovalAllowed
  • approverSelectableByTraveller
GENERAL_SETTINGS
  • emailDelivery
  • profileRemindersOption - only available if profile reminders feature is active on agency
  • enableSelfRegistration - only available if self registration feature is active on agency

...