EmployeeProviderHibernateImpl Resource

An API to interact with the EmployeeInfo object.

GET /employee/andavoAdminCountProfiles

Request Parameters
name type description
searchList query
Response Body
media type data type description
application/json number (JSON)
application/xml long (XML)

Example

Request
GET /employee/andavoAdminCountProfiles
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...
                
              

GET /employee/andavoAdminSearchProfiles

Request Parameters
name type description
searchList query
Response Body
media type data type description
application/json array of SimpleConsultantProfile (JSON)
application/xml list of simpleConsultantProfile (XML)

Example

Request
GET /employee/andavoAdminSearchProfiles
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "userId" : 12345,
  "profileId" : 12345,
  "firstName" : "...",
  "lastName" : "...",
  "email" : "...",
  "phone" : "...",
  "headShot" : "...",
  "logo" : "...",
  "bio" : "...",
  "name" : "...",
  "searchable" : true,
  "active" : true,
  "pendingApproval" : true,
  "presidentsClub" : true
} ]
                
              

GET /employee/countEmployees

Count the number of agents based on a search criteria.

Request Parameters
name type description
searchList query Search criteria to search by.
Response Body
media type data type description
application/json number (JSON) The number of agents based on a search criteria.
application/xml long (XML)

Example

Request
GET /employee/countEmployees
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...
                
              

POST /employee/createAdvisorIfNull

creates an entry in the advisor tabel for a user if they are not already and advisor.

Request Body
media type data type description
application/json number (JSON) the id for the potential advisor we are checking.
application/xml long (XML)
Response Body
media type data type description
application/json AdvisorProfile (JSON)
application/xml advisorProfile (XML)

Example

Request
POST /employee/createAdvisorIfNull
Content-Type: application/json
Accept: application/json

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "name" : "...",
  "title" : "...",
  "hours" : "...",
  "website" : "...",
  "externalImage" : "...",
  "contactLine" : "...",
  "facebook" : "...",
  "linkedin" : "...",
  "flickr" : "...",
  "youtube" : "...",
  "virtuoso" : "...",
  "blog" : "...",
  "destinations" : [ {
    "name" : "...",
    "value" : "...",
    "passportOnline" : "...",
    "latitude" : 12345.0,
    "longitude" : 12345.0,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "name" : "...",
    "value" : "...",
    "passportOnline" : "...",
    "latitude" : 12345.0,
    "longitude" : 12345.0,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "interests" : [ {
    "name" : "...",
    "value" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "name" : "...",
    "value" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "phone" : "...",
  "user" : {
    "answer" : "...",
    "emailed" : true,
    "newUser" : true,
    "temporaryPassword" : "...",
    "question" : "...",
    "obeUserName" : "...",
    "obePassword" : "...",
    "obeSyncId" : "...",
    "created" : 12345,
    "emailedWhen" : 12345,
    "travelgpaLogin" : "...",
    "groups" : [ {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "active" : true,
    "prefix" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "middleName" : "...",
    "suffix" : "...",
    "email" : "...",
    "tripitAuthorized" : true,
    "supportTitle" : "...",
    "automatedNotifications" : true,
    "enableHotelAttachment" : true,
    "atHomeNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "inTravelNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "cellPhoneNumber" : "...",
    "defaultClient" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "defaultPlannerGroup" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "showWelcomeDialog" : true,
    "siteTour" : true,
    "unusedTicketEmail" : true,
    "surveyEmail" : true,
    "wt0EmailEnabled" : true,
    "wt0EmailDaily" : true,
    "wt0EmailDay" : 12345,
    "wt0EmailHour" : 12345,
    "marketingSubscribed" : true,
    "responsive" : true,
    "businessPhoneNumber" : "...",
    "homePhoneNumber" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "hidden" : true,
  "twitter" : "...",
  "twitterHandle" : "...",
  "instagramHandle" : "...",
  "email" : "...",
  "location" : {
    "code" : "...",
    "countryCode" : "...",
    "latitude" : 12345.0,
    "longitude" : 12345.0,
    "name" : "...",
    "stateOrCountry" : "...",
    "airportName" : "...",
    "region" : {
      "name" : "...",
      "code" : "...",
      "country" : { },
      "position" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "timeZone" : {
      "name" : "...",
      "offset" : 12345.0,
      "daylightSavingsOffset" : 12345.0,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "retentionOnly" : true,
    "position" : 12345,
    "unique" : true,
    "alias" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "pinterest" : "...",
  "externalBio" : "...",
  "brandLogo" : "...",
  "banner" : {
    "name" : "...",
    "image" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "awards" : [ {
    "name" : "...",
    "description" : "...",
    "dateAwarded" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "name" : "...",
    "description" : "...",
    "dateAwarded" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "testimonials" : [ {
    "content" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "state" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "content" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "state" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "freeFieldTitle" : "...",
  "freeFieldBody" : "...",
  "city" : "...",
  "extension" : "...",
  "specialties" : [ {
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "active" : true,
  "pendingApproval" : true,
  "affiliate" : true,
  "instagram" : "...",
  "presidentsClub" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}
                
              

GET /employee/getAdvisorProfiles

Search for advisor profiles.

Request Parameters
name type description
search query A search object describing a query for profiles.
Response Body
media type data type description
application/json array of SimpleAdvisor (JSON) A list of advisor profiles.
application/xml list of simpleAdvisor (XML)

Example

Request
GET /employee/getAdvisorProfiles
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "user" : {
    "clientId" : 12345,
    "clientName" : "...",
    "id" : 12345,
    "firstName" : "...",
    "lastName" : "...",
    "middleName" : "...",
    "email" : "...",
    "active" : true,
    "phone" : "...",
    "hours" : "...",
    "schedules" : [ {
      "startDay" : 12345,
      "endDay" : 12345,
      "startHour" : 12345,
      "startMinute" : 12345,
      "endHour" : 12345,
      "endMinute" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "startDay" : 12345,
      "endDay" : 12345,
      "startHour" : 12345,
      "startMinute" : 12345,
      "endHour" : 12345,
      "endMinute" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "roleName" : "...",
    "lastLogin" : 12345,
    "lastEmailed" : 12345,
    "created" : 12345,
    "obeName" : "...",
    "canProxy" : true,
    "approver" : {
      "id" : 12345,
      "manager" : { },
      "client" : { },
      "role" : { },
      "email" : "...",
      "directLine" : "...",
      "hidden" : true,
      "order" : 12345,
      "travelAlertManager" : true,
      "enrollmentApprover" : true,
      "cardExpireNotify" : true,
      "domoUser" : true
    }
  },
  "id" : 12345,
  "bio" : "...",
  "phone" : "...",
  "email" : "...",
  "imageName" : "...",
  "title" : "...",
  "location" : {
    "code" : "...",
    "countryCode" : "...",
    "latitude" : 12345.0,
    "longitude" : 12345.0,
    "name" : "...",
    "stateOrCountry" : "...",
    "airportName" : "...",
    "region" : {
      "name" : "...",
      "code" : "...",
      "country" : { },
      "position" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "timeZone" : {
      "name" : "...",
      "offset" : 12345.0,
      "daylightSavingsOffset" : 12345.0,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "retentionOnly" : true,
    "position" : 12345,
    "unique" : true,
    "alias" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "facebook" : "...",
  "twitter" : "...",
  "linkedin" : "...",
  "flickr" : "...",
  "blog" : "...",
  "schedules" : [ {
    "startDay" : 12345,
    "endDay" : 12345,
    "startHour" : 12345,
    "startMinute" : 12345,
    "endHour" : 12345,
    "endMinute" : 12345,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "startDay" : 12345,
    "endDay" : 12345,
    "startHour" : 12345,
    "startMinute" : 12345,
    "endHour" : 12345,
    "endMinute" : 12345,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "youtube" : "...",
  "hours" : "...",
  "name" : "...",
  "pinterest" : "...",
  "specialties" : [ {
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "affiliate" : true,
  "instagram" : "...",
  "presidentsClub" : true
} ]
                
              

GET /employee/getAllAdvisorBanners

Get a list of all of the banners

Response Body
media type data type description
application/json array of AdvisorBanner (JSON)
application/xml list of advisorBanner (XML)

Example

Request
GET /employee/getAllAdvisorBanners
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "name" : "...",
  "image" : "...",
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
} ]
                
              

GET /employee/getAllAdvisorDepartments

Response Body
media type data type description
application/json array of AdvisorDepartment (JSON)
application/xml list of advisorDepartment (XML)

Example

Request
GET /employee/getAllAdvisorDepartments
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "name" : "...",
  "code" : "...",
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
} ]
                
              

GET /employee/getAllEmployeeLocations

Response Body
media type data type description
application/json array of City (JSON)
application/xml list of city (XML)

Example

Request
GET /employee/getAllEmployeeLocations
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "code" : "...",
  "countryCode" : "...",
  "latitude" : 12345.0,
  "longitude" : 12345.0,
  "name" : "...",
  "stateOrCountry" : "...",
  "airportName" : "...",
  "region" : {
    "name" : "...",
    "code" : "...",
    "country" : {
      "name" : "...",
      "code" : "...",
      "codeAlt" : "...",
      "phoneCode" : 12345,
      "position" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "position" : 12345,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "timeZone" : {
    "name" : "...",
    "offset" : 12345.0,
    "daylightSavingsOffset" : 12345.0,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "retentionOnly" : true,
  "position" : 12345,
  "unique" : true,
  "alias" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
} ]
                
              

GET /employee/getEmployeesByOffice

Request Parameters
name type description constraints
officeId query long
Response Body
media type data type description
application/json array of EmployeeInfo (JSON)
application/xml list of employeeInfo (XML)

Example

Request
GET /employee/getEmployeesByOffice
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "user" : {
    "answer" : "...",
    "emailed" : true,
    "newUser" : true,
    "temporaryPassword" : "...",
    "question" : "...",
    "obeUserName" : "...",
    "obePassword" : "...",
    "obeSyncId" : "...",
    "created" : 12345,
    "emailedWhen" : 12345,
    "travelgpaLogin" : "...",
    "groups" : [ {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "active" : true,
    "prefix" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "middleName" : "...",
    "suffix" : "...",
    "email" : "...",
    "tripitAuthorized" : true,
    "supportTitle" : "...",
    "automatedNotifications" : true,
    "enableHotelAttachment" : true,
    "atHomeNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "inTravelNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "cellPhoneNumber" : "...",
    "defaultClient" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "defaultPlannerGroup" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "showWelcomeDialog" : true,
    "siteTour" : true,
    "unusedTicketEmail" : true,
    "surveyEmail" : true,
    "wt0EmailEnabled" : true,
    "wt0EmailDaily" : true,
    "wt0EmailDay" : 12345,
    "wt0EmailHour" : 12345,
    "marketingSubscribed" : true,
    "responsive" : true,
    "businessPhoneNumber" : "...",
    "homePhoneNumber" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "agentCode" : "...",
  "office" : {
    "pcc" : "...",
    "name" : "...",
    "address1" : "...",
    "address2" : "...",
    "address3" : "...",
    "city" : "...",
    "state" : "...",
    "zip" : "...",
    "parentCompany" : {
      "name" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "active" : "...",
    "branch" : "...",
    "clientPrefix" : "...",
    "profileSettings" : {
      "profileNameFormat" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "afterHoursNumber" : "...",
    "collectVoidLogs" : true,
    "gds" : {
      "code" : "...",
      "name" : "...",
      "enabled" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "arcNumber" : "...",
    "logo" : "...",
    "logoLink" : "...",
    "afterHoursInternationalNumber" : "...",
    "tollFreeNumber" : "...",
    "phoneNumber" : "...",
    "onlineOffice" : {
      "name" : "...",
      "hours" : "...",
      "phone" : "...",
      "tollFree" : "...",
      "email" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "showTmcAppLinks" : true,
    "vipTollFree" : "...",
    "vipAfterHours" : "...",
    "cityCode" : {
      "code" : "...",
      "countryCode" : "...",
      "latitude" : 12345.0,
      "longitude" : 12345.0,
      "name" : "...",
      "stateOrCountry" : "...",
      "airportName" : "...",
      "region" : { },
      "timeZone" : { },
      "retentionOnly" : true,
      "position" : 12345,
      "unique" : true,
      "alias" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "tmcHeadQuarters" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "workEmail" : "...",
  "active" : "...",
  "type" : "...",
  "emailList" : "...",
  "category" : "...",
  "directLine" : "...",
  "hours" : "...",
  "onlineAgent" : true,
  "recheckEmails" : true,
  "serviceFeesPct" : 12345.0,
  "otherServiceFeesPct" : 12345.0,
  "internationalAirCommissionPct" : 12345.0,
  "miscCommissionPct" : 12345.0,
  "airCommissionPct" : 12345.0,
  "hotelCommissionPct" : 12345.0,
  "carCommissionPct" : 12345.0,
  "employeeType" : {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "ticketingAgent" : true,
  "supportAgent" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
} ]
                
              

GET /employee/getMidOfficeAgentDetails

Endpoint to retrieve all data about agents that a system would need to issue tickets as them.

Request Parameters
name type description
accountnumber query The account number that the agent is servicing.
agentsine query The agent sine the employee books as.
branch query The branch that the agent books as.
gds query The gds the agent is in. Valid values are 1P,1W,1V
pcc query The pcc the employee should be in.
Response Body
media type data type description
application/json MidofficeAgentDetail (JSON)
application/xml midofficeAgentDetail (XML)

Example

Request
GET /employee/getMidOfficeAgentDetails
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "name" : "...",
  "email" : "...",
  "agentSine" : "...",
  "online" : true,
  "onsite" : true,
  "queues" : [ {
    "pseudoCity" : "...",
    "number" : 12345,
    "category" : "...",
    "type" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }
  }, {
    "pseudoCity" : "...",
    "number" : 12345,
    "category" : "...",
    "type" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }
  } ],
  "anonymous" : true,
  "support" : true,
  "ignore" : true,
  "id" : 12345
}
                
              

GET /employee/isMidOfficeAgent

Endpoint to determine if an agent exists or not.

Request Parameters
name type description
agentsine query The agent sine the employee uses.
branch query The branch that the agent books as.
gds query The gds the agent is in. Valid values are 1P,1W,1V.
pcc query THe pcc the employee should be in.
Response Body
media type data type description
application/json boolean (JSON) true / false if this agent exists
application/xml boolean (XML)

Example

Request
GET /employee/isMidOfficeAgent
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...
                
              

GET /employee/makeAdvisorProfilesJson

Response Body
media type data type description
application/json boolean (JSON)
application/xml boolean (XML)

Example

Request
GET /employee/makeAdvisorProfilesJson
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...
                
              

GET /employee/recheckEmployees

Get a list of agent information which is set to recheck.

Response Body
media type data type description
application/json array of EmployeeInfo (JSON) A list of agent information.
application/xml list of employeeInfo (XML)

Example

Request
GET /employee/recheckEmployees
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "user" : {
    "answer" : "...",
    "emailed" : true,
    "newUser" : true,
    "temporaryPassword" : "...",
    "question" : "...",
    "obeUserName" : "...",
    "obePassword" : "...",
    "obeSyncId" : "...",
    "created" : 12345,
    "emailedWhen" : 12345,
    "travelgpaLogin" : "...",
    "groups" : [ {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "active" : true,
    "prefix" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "middleName" : "...",
    "suffix" : "...",
    "email" : "...",
    "tripitAuthorized" : true,
    "supportTitle" : "...",
    "automatedNotifications" : true,
    "enableHotelAttachment" : true,
    "atHomeNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "inTravelNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "cellPhoneNumber" : "...",
    "defaultClient" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "defaultPlannerGroup" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "showWelcomeDialog" : true,
    "siteTour" : true,
    "unusedTicketEmail" : true,
    "surveyEmail" : true,
    "wt0EmailEnabled" : true,
    "wt0EmailDaily" : true,
    "wt0EmailDay" : 12345,
    "wt0EmailHour" : 12345,
    "marketingSubscribed" : true,
    "responsive" : true,
    "businessPhoneNumber" : "...",
    "homePhoneNumber" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "agentCode" : "...",
  "office" : {
    "pcc" : "...",
    "name" : "...",
    "address1" : "...",
    "address2" : "...",
    "address3" : "...",
    "city" : "...",
    "state" : "...",
    "zip" : "...",
    "parentCompany" : {
      "name" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "active" : "...",
    "branch" : "...",
    "clientPrefix" : "...",
    "profileSettings" : {
      "profileNameFormat" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "afterHoursNumber" : "...",
    "collectVoidLogs" : true,
    "gds" : {
      "code" : "...",
      "name" : "...",
      "enabled" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "arcNumber" : "...",
    "logo" : "...",
    "logoLink" : "...",
    "afterHoursInternationalNumber" : "...",
    "tollFreeNumber" : "...",
    "phoneNumber" : "...",
    "onlineOffice" : {
      "name" : "...",
      "hours" : "...",
      "phone" : "...",
      "tollFree" : "...",
      "email" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "showTmcAppLinks" : true,
    "vipTollFree" : "...",
    "vipAfterHours" : "...",
    "cityCode" : {
      "code" : "...",
      "countryCode" : "...",
      "latitude" : 12345.0,
      "longitude" : 12345.0,
      "name" : "...",
      "stateOrCountry" : "...",
      "airportName" : "...",
      "region" : { },
      "timeZone" : { },
      "retentionOnly" : true,
      "position" : 12345,
      "unique" : true,
      "alias" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "tmcHeadQuarters" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "workEmail" : "...",
  "active" : "...",
  "type" : "...",
  "emailList" : "...",
  "category" : "...",
  "directLine" : "...",
  "hours" : "...",
  "onlineAgent" : true,
  "recheckEmails" : true,
  "serviceFeesPct" : 12345.0,
  "otherServiceFeesPct" : 12345.0,
  "internationalAirCommissionPct" : 12345.0,
  "miscCommissionPct" : 12345.0,
  "airCommissionPct" : 12345.0,
  "hotelCommissionPct" : 12345.0,
  "carCommissionPct" : 12345.0,
  "employeeType" : {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "ticketingAgent" : true,
  "supportAgent" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
} ]
                
              

GET /employee/searchEmployees

Get a list of agent information based on a search criteria.

Request Parameters
name type description
searchList query Search criteria to search by.
Response Body
media type data type description
application/json array of EmployeeInfo (JSON) A list of agent information based on a search criteria.
application/xml list of employeeInfo (XML)

Example

Request
GET /employee/searchEmployees
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "user" : {
    "answer" : "...",
    "emailed" : true,
    "newUser" : true,
    "temporaryPassword" : "...",
    "question" : "...",
    "obeUserName" : "...",
    "obePassword" : "...",
    "obeSyncId" : "...",
    "created" : 12345,
    "emailedWhen" : 12345,
    "travelgpaLogin" : "...",
    "groups" : [ {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "active" : true,
    "prefix" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "middleName" : "...",
    "suffix" : "...",
    "email" : "...",
    "tripitAuthorized" : true,
    "supportTitle" : "...",
    "automatedNotifications" : true,
    "enableHotelAttachment" : true,
    "atHomeNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "inTravelNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "cellPhoneNumber" : "...",
    "defaultClient" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "defaultPlannerGroup" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "showWelcomeDialog" : true,
    "siteTour" : true,
    "unusedTicketEmail" : true,
    "surveyEmail" : true,
    "wt0EmailEnabled" : true,
    "wt0EmailDaily" : true,
    "wt0EmailDay" : 12345,
    "wt0EmailHour" : 12345,
    "marketingSubscribed" : true,
    "responsive" : true,
    "businessPhoneNumber" : "...",
    "homePhoneNumber" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "agentCode" : "...",
  "office" : {
    "pcc" : "...",
    "name" : "...",
    "address1" : "...",
    "address2" : "...",
    "address3" : "...",
    "city" : "...",
    "state" : "...",
    "zip" : "...",
    "parentCompany" : {
      "name" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "active" : "...",
    "branch" : "...",
    "clientPrefix" : "...",
    "profileSettings" : {
      "profileNameFormat" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "afterHoursNumber" : "...",
    "collectVoidLogs" : true,
    "gds" : {
      "code" : "...",
      "name" : "...",
      "enabled" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "arcNumber" : "...",
    "logo" : "...",
    "logoLink" : "...",
    "afterHoursInternationalNumber" : "...",
    "tollFreeNumber" : "...",
    "phoneNumber" : "...",
    "onlineOffice" : {
      "name" : "...",
      "hours" : "...",
      "phone" : "...",
      "tollFree" : "...",
      "email" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "showTmcAppLinks" : true,
    "vipTollFree" : "...",
    "vipAfterHours" : "...",
    "cityCode" : {
      "code" : "...",
      "countryCode" : "...",
      "latitude" : 12345.0,
      "longitude" : 12345.0,
      "name" : "...",
      "stateOrCountry" : "...",
      "airportName" : "...",
      "region" : { },
      "timeZone" : { },
      "retentionOnly" : true,
      "position" : 12345,
      "unique" : true,
      "alias" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "tmcHeadQuarters" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "workEmail" : "...",
  "active" : "...",
  "type" : "...",
  "emailList" : "...",
  "category" : "...",
  "directLine" : "...",
  "hours" : "...",
  "onlineAgent" : true,
  "recheckEmails" : true,
  "serviceFeesPct" : 12345.0,
  "otherServiceFeesPct" : 12345.0,
  "internationalAirCommissionPct" : 12345.0,
  "miscCommissionPct" : 12345.0,
  "airCommissionPct" : 12345.0,
  "hotelCommissionPct" : 12345.0,
  "carCommissionPct" : 12345.0,
  "employeeType" : {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "ticketingAgent" : true,
  "supportAgent" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
} ]
                
              

GET /employee/searchSimpleAgents

Get a list of agent information based on a search criteria.

Request Parameters
name type description
searchList query Query to search for agents by.
Response Body
media type data type description
application/json array of SimpleAgent (JSON) A list of agent information based on a search criteria.
application/xml list of simpleAgent (XML)

Example

Request
GET /employee/searchSimpleAgents
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "firstName" : "...",
  "lastName" : "...",
  "phone" : "...",
  "email" : "...",
  "code" : "...",
  "officeName" : "...",
  "officeCode" : "...",
  "teamName" : "...",
  "recheck" : true,
  "online" : true,
  "onlineSupport" : true,
  "support" : true
} ]
                
              

POST /employee/setAdvisorDestinationsById

Request Parameters
name type description constraints multivalued
destinations query   yes
id query long no
Response Body
media type data type description
application/json array of AdvisorDestination (JSON)
application/xml list of advisorDestination (XML)

Example

Request
POST /employee/setAdvisorDestinationsById
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
[ {
  "name" : "...",
  "value" : "...",
  "passportOnline" : "...",
  "latitude" : 12345.0,
  "longitude" : 12345.0,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
} ]
                
              

POST /employee/setAdvisorInterestsById

Request Parameters
name type description constraints multivalued
id query long no
interests query   yes
Response Body
media type data type description
application/json array of AdvisorInterest (JSON)
application/xml list of advisorInterest (XML)

Example

Request
POST /employee/setAdvisorInterestsById
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
[ {
  "name" : "...",
  "value" : "...",
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
} ]
                
              

POST /employee/setAdvisorVisitedById

Request Parameters
name type description constraints multivalued
id query long no
visited query   yes
Response Body
media type data type description
application/json array of AdvisorDestination (JSON)
application/xml list of advisorDestination (XML)

Example

Request
POST /employee/setAdvisorVisitedById
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
[ {
  "name" : "...",
  "value" : "...",
  "passportOnline" : "...",
  "latitude" : 12345.0,
  "longitude" : 12345.0,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
} ]
                
              

POST /employee/updateAdvisorProfile

Updates a User's pending advisor profile. If the user doesn't have a Pending profile, one will be created for them.

Request Body
media type data type description
application/json AdvisorProfile (JSON) A profile that will become pending until it is approved.
application/xml advisorProfile (XML)
Response Body
media type data type description
application/json AdvisorProfile (JSON) A pending profile
application/xml advisorProfile (XML)

Example

Request
POST /employee/updateAdvisorProfile
Content-Type: application/json
Accept: application/json

                
{
  "name" : "...",
  "title" : "...",
  "hours" : "...",
  "website" : "...",
  "externalImage" : "...",
  "contactLine" : "...",
  "facebook" : "...",
  "linkedin" : "...",
  "flickr" : "...",
  "youtube" : "...",
  "virtuoso" : "...",
  "blog" : "...",
  "destinations" : [ {
    "name" : "...",
    "value" : "...",
    "passportOnline" : "...",
    "latitude" : 12345.0,
    "longitude" : 12345.0,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "name" : "...",
    "value" : "...",
    "passportOnline" : "...",
    "latitude" : 12345.0,
    "longitude" : 12345.0,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "interests" : [ {
    "name" : "...",
    "value" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "name" : "...",
    "value" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "phone" : "...",
  "user" : {
    "answer" : "...",
    "emailed" : true,
    "newUser" : true,
    "temporaryPassword" : "...",
    "question" : "...",
    "obeUserName" : "...",
    "obePassword" : "...",
    "obeSyncId" : "...",
    "created" : 12345,
    "emailedWhen" : 12345,
    "travelgpaLogin" : "...",
    "groups" : [ {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "active" : true,
    "prefix" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "middleName" : "...",
    "suffix" : "...",
    "email" : "...",
    "tripitAuthorized" : true,
    "supportTitle" : "...",
    "automatedNotifications" : true,
    "enableHotelAttachment" : true,
    "atHomeNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "inTravelNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "cellPhoneNumber" : "...",
    "defaultClient" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "defaultPlannerGroup" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "showWelcomeDialog" : true,
    "siteTour" : true,
    "unusedTicketEmail" : true,
    "surveyEmail" : true,
    "wt0EmailEnabled" : true,
    "wt0EmailDaily" : true,
    "wt0EmailDay" : 12345,
    "wt0EmailHour" : 12345,
    "marketingSubscribed" : true,
    "responsive" : true,
    "businessPhoneNumber" : "...",
    "homePhoneNumber" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "hidden" : true,
  "twitter" : "...",
  "twitterHandle" : "...",
  "instagramHandle" : "...",
  "email" : "...",
  "location" : {
    "code" : "...",
    "countryCode" : "...",
    "latitude" : 12345.0,
    "longitude" : 12345.0,
    "name" : "...",
    "stateOrCountry" : "...",
    "airportName" : "...",
    "region" : {
      "name" : "...",
      "code" : "...",
      "country" : { },
      "position" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "timeZone" : {
      "name" : "...",
      "offset" : 12345.0,
      "daylightSavingsOffset" : 12345.0,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "retentionOnly" : true,
    "position" : 12345,
    "unique" : true,
    "alias" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "pinterest" : "...",
  "externalBio" : "...",
  "brandLogo" : "...",
  "banner" : {
    "name" : "...",
    "image" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "awards" : [ {
    "name" : "...",
    "description" : "...",
    "dateAwarded" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "name" : "...",
    "description" : "...",
    "dateAwarded" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "testimonials" : [ {
    "content" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "state" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "content" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "state" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "freeFieldTitle" : "...",
  "freeFieldBody" : "...",
  "city" : "...",
  "extension" : "...",
  "specialties" : [ {
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "active" : true,
  "pendingApproval" : true,
  "affiliate" : true,
  "instagram" : "...",
  "presidentsClub" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "name" : "...",
  "title" : "...",
  "hours" : "...",
  "website" : "...",
  "externalImage" : "...",
  "contactLine" : "...",
  "facebook" : "...",
  "linkedin" : "...",
  "flickr" : "...",
  "youtube" : "...",
  "virtuoso" : "...",
  "blog" : "...",
  "destinations" : [ {
    "name" : "...",
    "value" : "...",
    "passportOnline" : "...",
    "latitude" : 12345.0,
    "longitude" : 12345.0,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "name" : "...",
    "value" : "...",
    "passportOnline" : "...",
    "latitude" : 12345.0,
    "longitude" : 12345.0,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "interests" : [ {
    "name" : "...",
    "value" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "name" : "...",
    "value" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "phone" : "...",
  "user" : {
    "answer" : "...",
    "emailed" : true,
    "newUser" : true,
    "temporaryPassword" : "...",
    "question" : "...",
    "obeUserName" : "...",
    "obePassword" : "...",
    "obeSyncId" : "...",
    "created" : 12345,
    "emailedWhen" : 12345,
    "travelgpaLogin" : "...",
    "groups" : [ {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "active" : true,
    "prefix" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "middleName" : "...",
    "suffix" : "...",
    "email" : "...",
    "tripitAuthorized" : true,
    "supportTitle" : "...",
    "automatedNotifications" : true,
    "enableHotelAttachment" : true,
    "atHomeNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "inTravelNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "cellPhoneNumber" : "...",
    "defaultClient" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "defaultPlannerGroup" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "showWelcomeDialog" : true,
    "siteTour" : true,
    "unusedTicketEmail" : true,
    "surveyEmail" : true,
    "wt0EmailEnabled" : true,
    "wt0EmailDaily" : true,
    "wt0EmailDay" : 12345,
    "wt0EmailHour" : 12345,
    "marketingSubscribed" : true,
    "responsive" : true,
    "businessPhoneNumber" : "...",
    "homePhoneNumber" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "hidden" : true,
  "twitter" : "...",
  "twitterHandle" : "...",
  "instagramHandle" : "...",
  "email" : "...",
  "location" : {
    "code" : "...",
    "countryCode" : "...",
    "latitude" : 12345.0,
    "longitude" : 12345.0,
    "name" : "...",
    "stateOrCountry" : "...",
    "airportName" : "...",
    "region" : {
      "name" : "...",
      "code" : "...",
      "country" : { },
      "position" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "timeZone" : {
      "name" : "...",
      "offset" : 12345.0,
      "daylightSavingsOffset" : 12345.0,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "retentionOnly" : true,
    "position" : 12345,
    "unique" : true,
    "alias" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "pinterest" : "...",
  "externalBio" : "...",
  "brandLogo" : "...",
  "banner" : {
    "name" : "...",
    "image" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "awards" : [ {
    "name" : "...",
    "description" : "...",
    "dateAwarded" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "name" : "...",
    "description" : "...",
    "dateAwarded" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "testimonials" : [ {
    "content" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "state" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "content" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "state" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "freeFieldTitle" : "...",
  "freeFieldBody" : "...",
  "city" : "...",
  "extension" : "...",
  "specialties" : [ {
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "active" : true,
  "pendingApproval" : true,
  "affiliate" : true,
  "instagram" : "...",
  "presidentsClub" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}
                
              

POST /employee/updateEmployee

A function to update or create Employees.

Request Body
media type data type description
application/json EmployeeInfo (JSON) A zombie (unsessioned) employee object that holds data to create an employee within the database.
application/xml employeeInfo (XML)
Response Body
media type data type description
application/json EmployeeInfo (JSON) A Employees object that was updated.
application/xml employeeInfo (XML)

Example

Request
POST /employee/updateEmployee
Content-Type: application/json
Accept: application/json

                
{
  "user" : {
    "answer" : "...",
    "emailed" : true,
    "newUser" : true,
    "temporaryPassword" : "...",
    "question" : "...",
    "obeUserName" : "...",
    "obePassword" : "...",
    "obeSyncId" : "...",
    "created" : 12345,
    "emailedWhen" : 12345,
    "travelgpaLogin" : "...",
    "groups" : [ {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "active" : true,
    "prefix" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "middleName" : "...",
    "suffix" : "...",
    "email" : "...",
    "tripitAuthorized" : true,
    "supportTitle" : "...",
    "automatedNotifications" : true,
    "enableHotelAttachment" : true,
    "atHomeNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "inTravelNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "cellPhoneNumber" : "...",
    "defaultClient" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "defaultPlannerGroup" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "showWelcomeDialog" : true,
    "siteTour" : true,
    "unusedTicketEmail" : true,
    "surveyEmail" : true,
    "wt0EmailEnabled" : true,
    "wt0EmailDaily" : true,
    "wt0EmailDay" : 12345,
    "wt0EmailHour" : 12345,
    "marketingSubscribed" : true,
    "responsive" : true,
    "businessPhoneNumber" : "...",
    "homePhoneNumber" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "agentCode" : "...",
  "office" : {
    "pcc" : "...",
    "name" : "...",
    "address1" : "...",
    "address2" : "...",
    "address3" : "...",
    "city" : "...",
    "state" : "...",
    "zip" : "...",
    "parentCompany" : {
      "name" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "active" : "...",
    "branch" : "...",
    "clientPrefix" : "...",
    "profileSettings" : {
      "profileNameFormat" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "afterHoursNumber" : "...",
    "collectVoidLogs" : true,
    "gds" : {
      "code" : "...",
      "name" : "...",
      "enabled" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "arcNumber" : "...",
    "logo" : "...",
    "logoLink" : "...",
    "afterHoursInternationalNumber" : "...",
    "tollFreeNumber" : "...",
    "phoneNumber" : "...",
    "onlineOffice" : {
      "name" : "...",
      "hours" : "...",
      "phone" : "...",
      "tollFree" : "...",
      "email" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "showTmcAppLinks" : true,
    "vipTollFree" : "...",
    "vipAfterHours" : "...",
    "cityCode" : {
      "code" : "...",
      "countryCode" : "...",
      "latitude" : 12345.0,
      "longitude" : 12345.0,
      "name" : "...",
      "stateOrCountry" : "...",
      "airportName" : "...",
      "region" : { },
      "timeZone" : { },
      "retentionOnly" : true,
      "position" : 12345,
      "unique" : true,
      "alias" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "tmcHeadQuarters" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "workEmail" : "...",
  "active" : "...",
  "type" : "...",
  "emailList" : "...",
  "category" : "...",
  "directLine" : "...",
  "hours" : "...",
  "onlineAgent" : true,
  "recheckEmails" : true,
  "serviceFeesPct" : 12345.0,
  "otherServiceFeesPct" : 12345.0,
  "internationalAirCommissionPct" : 12345.0,
  "miscCommissionPct" : 12345.0,
  "airCommissionPct" : 12345.0,
  "hotelCommissionPct" : 12345.0,
  "carCommissionPct" : 12345.0,
  "employeeType" : {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "ticketingAgent" : true,
  "supportAgent" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "user" : {
    "answer" : "...",
    "emailed" : true,
    "newUser" : true,
    "temporaryPassword" : "...",
    "question" : "...",
    "obeUserName" : "...",
    "obePassword" : "...",
    "obeSyncId" : "...",
    "created" : 12345,
    "emailedWhen" : 12345,
    "travelgpaLogin" : "...",
    "groups" : [ {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "active" : true,
    "prefix" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "middleName" : "...",
    "suffix" : "...",
    "email" : "...",
    "tripitAuthorized" : true,
    "supportTitle" : "...",
    "automatedNotifications" : true,
    "enableHotelAttachment" : true,
    "atHomeNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "inTravelNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "cellPhoneNumber" : "...",
    "defaultClient" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "defaultPlannerGroup" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "showWelcomeDialog" : true,
    "siteTour" : true,
    "unusedTicketEmail" : true,
    "surveyEmail" : true,
    "wt0EmailEnabled" : true,
    "wt0EmailDaily" : true,
    "wt0EmailDay" : 12345,
    "wt0EmailHour" : 12345,
    "marketingSubscribed" : true,
    "responsive" : true,
    "businessPhoneNumber" : "...",
    "homePhoneNumber" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "agentCode" : "...",
  "office" : {
    "pcc" : "...",
    "name" : "...",
    "address1" : "...",
    "address2" : "...",
    "address3" : "...",
    "city" : "...",
    "state" : "...",
    "zip" : "...",
    "parentCompany" : {
      "name" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "active" : "...",
    "branch" : "...",
    "clientPrefix" : "...",
    "profileSettings" : {
      "profileNameFormat" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "afterHoursNumber" : "...",
    "collectVoidLogs" : true,
    "gds" : {
      "code" : "...",
      "name" : "...",
      "enabled" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "arcNumber" : "...",
    "logo" : "...",
    "logoLink" : "...",
    "afterHoursInternationalNumber" : "...",
    "tollFreeNumber" : "...",
    "phoneNumber" : "...",
    "onlineOffice" : {
      "name" : "...",
      "hours" : "...",
      "phone" : "...",
      "tollFree" : "...",
      "email" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "showTmcAppLinks" : true,
    "vipTollFree" : "...",
    "vipAfterHours" : "...",
    "cityCode" : {
      "code" : "...",
      "countryCode" : "...",
      "latitude" : 12345.0,
      "longitude" : 12345.0,
      "name" : "...",
      "stateOrCountry" : "...",
      "airportName" : "...",
      "region" : { },
      "timeZone" : { },
      "retentionOnly" : true,
      "position" : 12345,
      "unique" : true,
      "alias" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "tmcHeadQuarters" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "workEmail" : "...",
  "active" : "...",
  "type" : "...",
  "emailList" : "...",
  "category" : "...",
  "directLine" : "...",
  "hours" : "...",
  "onlineAgent" : true,
  "recheckEmails" : true,
  "serviceFeesPct" : 12345.0,
  "otherServiceFeesPct" : 12345.0,
  "internationalAirCommissionPct" : 12345.0,
  "miscCommissionPct" : 12345.0,
  "airCommissionPct" : 12345.0,
  "hotelCommissionPct" : 12345.0,
  "carCommissionPct" : 12345.0,
  "employeeType" : {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "ticketingAgent" : true,
  "supportAgent" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}
                
              

POST /employee/approveConsultantProfile/{id}

Approve the pending advisor profile and make it the One True Profile. Delete all other profiles for the user.

Request Parameters
name type description constraints
id query the ID of the profile we'll be approving long
Response Body
media type data type description
application/json AdvisorProfile (JSON)
application/xml advisorProfile (XML)

Example

Request
POST /employee/approveConsultantProfile/{id}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "name" : "...",
  "title" : "...",
  "hours" : "...",
  "website" : "...",
  "externalImage" : "...",
  "contactLine" : "...",
  "facebook" : "...",
  "linkedin" : "...",
  "flickr" : "...",
  "youtube" : "...",
  "virtuoso" : "...",
  "blog" : "...",
  "destinations" : [ {
    "name" : "...",
    "value" : "...",
    "passportOnline" : "...",
    "latitude" : 12345.0,
    "longitude" : 12345.0,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "name" : "...",
    "value" : "...",
    "passportOnline" : "...",
    "latitude" : 12345.0,
    "longitude" : 12345.0,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "interests" : [ {
    "name" : "...",
    "value" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "name" : "...",
    "value" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "phone" : "...",
  "user" : {
    "answer" : "...",
    "emailed" : true,
    "newUser" : true,
    "temporaryPassword" : "...",
    "question" : "...",
    "obeUserName" : "...",
    "obePassword" : "...",
    "obeSyncId" : "...",
    "created" : 12345,
    "emailedWhen" : 12345,
    "travelgpaLogin" : "...",
    "groups" : [ {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "active" : true,
    "prefix" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "middleName" : "...",
    "suffix" : "...",
    "email" : "...",
    "tripitAuthorized" : true,
    "supportTitle" : "...",
    "automatedNotifications" : true,
    "enableHotelAttachment" : true,
    "atHomeNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "inTravelNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "cellPhoneNumber" : "...",
    "defaultClient" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "defaultPlannerGroup" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "showWelcomeDialog" : true,
    "siteTour" : true,
    "unusedTicketEmail" : true,
    "surveyEmail" : true,
    "wt0EmailEnabled" : true,
    "wt0EmailDaily" : true,
    "wt0EmailDay" : 12345,
    "wt0EmailHour" : 12345,
    "marketingSubscribed" : true,
    "responsive" : true,
    "businessPhoneNumber" : "...",
    "homePhoneNumber" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "hidden" : true,
  "twitter" : "...",
  "twitterHandle" : "...",
  "instagramHandle" : "...",
  "email" : "...",
  "location" : {
    "code" : "...",
    "countryCode" : "...",
    "latitude" : 12345.0,
    "longitude" : 12345.0,
    "name" : "...",
    "stateOrCountry" : "...",
    "airportName" : "...",
    "region" : {
      "name" : "...",
      "code" : "...",
      "country" : { },
      "position" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "timeZone" : {
      "name" : "...",
      "offset" : 12345.0,
      "daylightSavingsOffset" : 12345.0,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "retentionOnly" : true,
    "position" : 12345,
    "unique" : true,
    "alias" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "pinterest" : "...",
  "externalBio" : "...",
  "brandLogo" : "...",
  "banner" : {
    "name" : "...",
    "image" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "awards" : [ {
    "name" : "...",
    "description" : "...",
    "dateAwarded" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "name" : "...",
    "description" : "...",
    "dateAwarded" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "testimonials" : [ {
    "content" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "state" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "content" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "state" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "freeFieldTitle" : "...",
  "freeFieldBody" : "...",
  "city" : "...",
  "extension" : "...",
  "specialties" : [ {
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "active" : true,
  "pendingApproval" : true,
  "affiliate" : true,
  "instagram" : "...",
  "presidentsClub" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}
                
              

DELETE /employee/delete/{id}

Deletes an employee from the database.

Request Parameters
name type description constraints
id path The unique identifier of the object. long

Example

Request
DELETE /employee/delete/{id}
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

DELETE /employee/deleteAdvisorProfile/{id}

Delete both the active and pending profiles.

Request Parameters
name type description constraints
id path The id of the user whose profiles you want to delete. long
Response Body
media type data type description
application/json boolean (JSON) true / false if the deletion was successful.
application/xml boolean (XML)

Example

Request
DELETE /employee/deleteAdvisorProfile/{id}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
...
                
              

DELETE /employee/deleteConsultantProfile/{id}

Delete an AdvisorProfile by id

Request Parameters
name type description constraints
id path The id of the AdvisorProfile to delete long

Example

Request
DELETE /employee/deleteConsultantProfile/{id}
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

POST /employee/deleteEmployeeDirectoryProfile/{employeeId}

delete any employee directory profile(s) for a user.

Request Parameters
name type description constraints
employeeId path long
Response Body
media type data type description
application/json boolean (JSON)
application/xml boolean (XML)

Example

Request
POST /employee/deleteEmployeeDirectoryProfile/{employeeId}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...
                
              

POST /employee/getAdvisorById/{id}

Grabs and advisor by an advisor id

Request Body
media type data type
application/json number (JSON)
application/xml long (XML)
Response Body
media type data type description
application/json AdvisorProfile (JSON)
application/xml advisorProfile (XML)

Example

Request
POST /employee/getAdvisorById/{id}
Content-Type: application/json
Accept: application/json

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "name" : "...",
  "title" : "...",
  "hours" : "...",
  "website" : "...",
  "externalImage" : "...",
  "contactLine" : "...",
  "facebook" : "...",
  "linkedin" : "...",
  "flickr" : "...",
  "youtube" : "...",
  "virtuoso" : "...",
  "blog" : "...",
  "destinations" : [ {
    "name" : "...",
    "value" : "...",
    "passportOnline" : "...",
    "latitude" : 12345.0,
    "longitude" : 12345.0,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "name" : "...",
    "value" : "...",
    "passportOnline" : "...",
    "latitude" : 12345.0,
    "longitude" : 12345.0,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "interests" : [ {
    "name" : "...",
    "value" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "name" : "...",
    "value" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "phone" : "...",
  "user" : {
    "answer" : "...",
    "emailed" : true,
    "newUser" : true,
    "temporaryPassword" : "...",
    "question" : "...",
    "obeUserName" : "...",
    "obePassword" : "...",
    "obeSyncId" : "...",
    "created" : 12345,
    "emailedWhen" : 12345,
    "travelgpaLogin" : "...",
    "groups" : [ {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "active" : true,
    "prefix" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "middleName" : "...",
    "suffix" : "...",
    "email" : "...",
    "tripitAuthorized" : true,
    "supportTitle" : "...",
    "automatedNotifications" : true,
    "enableHotelAttachment" : true,
    "atHomeNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "inTravelNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "cellPhoneNumber" : "...",
    "defaultClient" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "defaultPlannerGroup" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "showWelcomeDialog" : true,
    "siteTour" : true,
    "unusedTicketEmail" : true,
    "surveyEmail" : true,
    "wt0EmailEnabled" : true,
    "wt0EmailDaily" : true,
    "wt0EmailDay" : 12345,
    "wt0EmailHour" : 12345,
    "marketingSubscribed" : true,
    "responsive" : true,
    "businessPhoneNumber" : "...",
    "homePhoneNumber" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "hidden" : true,
  "twitter" : "...",
  "twitterHandle" : "...",
  "instagramHandle" : "...",
  "email" : "...",
  "location" : {
    "code" : "...",
    "countryCode" : "...",
    "latitude" : 12345.0,
    "longitude" : 12345.0,
    "name" : "...",
    "stateOrCountry" : "...",
    "airportName" : "...",
    "region" : {
      "name" : "...",
      "code" : "...",
      "country" : { },
      "position" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "timeZone" : {
      "name" : "...",
      "offset" : 12345.0,
      "daylightSavingsOffset" : 12345.0,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "retentionOnly" : true,
    "position" : 12345,
    "unique" : true,
    "alias" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "pinterest" : "...",
  "externalBio" : "...",
  "brandLogo" : "...",
  "banner" : {
    "name" : "...",
    "image" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "awards" : [ {
    "name" : "...",
    "description" : "...",
    "dateAwarded" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "name" : "...",
    "description" : "...",
    "dateAwarded" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "testimonials" : [ {
    "content" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "state" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "content" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "state" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "freeFieldTitle" : "...",
  "freeFieldBody" : "...",
  "city" : "...",
  "extension" : "...",
  "specialties" : [ {
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "active" : true,
  "pendingApproval" : true,
  "affiliate" : true,
  "instagram" : "...",
  "presidentsClub" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}
                
              

GET /employee/getAdvisorDestinationsById/{id}

Gets Destinations of an advisor

Request Parameters
name type description constraints
id query the User id long
Response Body
media type data type description
application/json array of AdvisorDestination (JSON)
application/xml list of advisorDestination (XML)

Example

Request
GET /employee/getAdvisorDestinationsById/{id}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "name" : "...",
  "value" : "...",
  "passportOnline" : "...",
  "latitude" : 12345.0,
  "longitude" : 12345.0,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
} ]
                
              

GET /employee/getAdvisorInterestsById/{id}

Gets interests of an advisor

Request Parameters
name type description constraints
id query the User id long
Response Body
media type data type description
application/json array of AdvisorInterest (JSON)
application/xml list of advisorInterest (XML)

Example

Request
GET /employee/getAdvisorInterestsById/{id}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "name" : "...",
  "value" : "...",
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
} ]
                
              

POST /employee/getAdvisorProfileBySubCategoryId/{subCategoryId}

Grabs all advisorProfiles for users in the group assigned to a subcategory.

Request Body
media type data type description
application/json number (JSON) the id of the subcategory
application/xml long (XML)
Response Body
media type data type description
application/json array of AdvisorProfile (JSON)
application/xml list of advisorProfile (XML)

Example

Request
POST /employee/getAdvisorProfileBySubCategoryId/{subCategoryId}
Content-Type: application/json
Accept: application/json

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
[ {
  "name" : "...",
  "title" : "...",
  "hours" : "...",
  "website" : "...",
  "externalImage" : "...",
  "contactLine" : "...",
  "facebook" : "...",
  "linkedin" : "...",
  "flickr" : "...",
  "youtube" : "...",
  "virtuoso" : "...",
  "blog" : "...",
  "destinations" : [ {
    "name" : "...",
    "value" : "...",
    "passportOnline" : "...",
    "latitude" : 12345.0,
    "longitude" : 12345.0,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "name" : "...",
    "value" : "...",
    "passportOnline" : "...",
    "latitude" : 12345.0,
    "longitude" : 12345.0,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "interests" : [ {
    "name" : "...",
    "value" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "name" : "...",
    "value" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "phone" : "...",
  "user" : {
    "answer" : "...",
    "emailed" : true,
    "newUser" : true,
    "temporaryPassword" : "...",
    "question" : "...",
    "obeUserName" : "...",
    "obePassword" : "...",
    "obeSyncId" : "...",
    "created" : 12345,
    "emailedWhen" : 12345,
    "travelgpaLogin" : "...",
    "groups" : [ {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "active" : true,
    "prefix" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "middleName" : "...",
    "suffix" : "...",
    "email" : "...",
    "tripitAuthorized" : true,
    "supportTitle" : "...",
    "automatedNotifications" : true,
    "enableHotelAttachment" : true,
    "atHomeNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "inTravelNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "cellPhoneNumber" : "...",
    "defaultClient" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "defaultPlannerGroup" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "showWelcomeDialog" : true,
    "siteTour" : true,
    "unusedTicketEmail" : true,
    "surveyEmail" : true,
    "wt0EmailEnabled" : true,
    "wt0EmailDaily" : true,
    "wt0EmailDay" : 12345,
    "wt0EmailHour" : 12345,
    "marketingSubscribed" : true,
    "responsive" : true,
    "businessPhoneNumber" : "...",
    "homePhoneNumber" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "hidden" : true,
  "twitter" : "...",
  "twitterHandle" : "...",
  "instagramHandle" : "...",
  "email" : "...",
  "location" : {
    "code" : "...",
    "countryCode" : "...",
    "latitude" : 12345.0,
    "longitude" : 12345.0,
    "name" : "...",
    "stateOrCountry" : "...",
    "airportName" : "...",
    "region" : {
      "name" : "...",
      "code" : "...",
      "country" : { },
      "position" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "timeZone" : {
      "name" : "...",
      "offset" : 12345.0,
      "daylightSavingsOffset" : 12345.0,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "retentionOnly" : true,
    "position" : 12345,
    "unique" : true,
    "alias" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "pinterest" : "...",
  "externalBio" : "...",
  "brandLogo" : "...",
  "banner" : {
    "name" : "...",
    "image" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "awards" : [ {
    "name" : "...",
    "description" : "...",
    "dateAwarded" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "name" : "...",
    "description" : "...",
    "dateAwarded" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "testimonials" : [ {
    "content" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "state" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "content" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "state" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "freeFieldTitle" : "...",
  "freeFieldBody" : "...",
  "city" : "...",
  "extension" : "...",
  "specialties" : [ {
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "active" : true,
  "pendingApproval" : true,
  "affiliate" : true,
  "instagram" : "...",
  "presidentsClub" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
} ]
                
              

GET /employee/getAdvisorProfileForUser/{id}

Get The pending profile record for the user by user id.

Request Parameters
name type description constraints
id path The user id to get a profile for. long
Response Body
media type data type description
application/json AdvisorProfile (JSON) The advisor profile for that particular user.
application/xml advisorProfile (XML)

Example

Request
GET /employee/getAdvisorProfileForUser/{id}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "name" : "...",
  "title" : "...",
  "hours" : "...",
  "website" : "...",
  "externalImage" : "...",
  "contactLine" : "...",
  "facebook" : "...",
  "linkedin" : "...",
  "flickr" : "...",
  "youtube" : "...",
  "virtuoso" : "...",
  "blog" : "...",
  "destinations" : [ {
    "name" : "...",
    "value" : "...",
    "passportOnline" : "...",
    "latitude" : 12345.0,
    "longitude" : 12345.0,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "name" : "...",
    "value" : "...",
    "passportOnline" : "...",
    "latitude" : 12345.0,
    "longitude" : 12345.0,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "interests" : [ {
    "name" : "...",
    "value" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "name" : "...",
    "value" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "phone" : "...",
  "user" : {
    "answer" : "...",
    "emailed" : true,
    "newUser" : true,
    "temporaryPassword" : "...",
    "question" : "...",
    "obeUserName" : "...",
    "obePassword" : "...",
    "obeSyncId" : "...",
    "created" : 12345,
    "emailedWhen" : 12345,
    "travelgpaLogin" : "...",
    "groups" : [ {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "active" : true,
    "prefix" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "middleName" : "...",
    "suffix" : "...",
    "email" : "...",
    "tripitAuthorized" : true,
    "supportTitle" : "...",
    "automatedNotifications" : true,
    "enableHotelAttachment" : true,
    "atHomeNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "inTravelNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "cellPhoneNumber" : "...",
    "defaultClient" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "defaultPlannerGroup" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "showWelcomeDialog" : true,
    "siteTour" : true,
    "unusedTicketEmail" : true,
    "surveyEmail" : true,
    "wt0EmailEnabled" : true,
    "wt0EmailDaily" : true,
    "wt0EmailDay" : 12345,
    "wt0EmailHour" : 12345,
    "marketingSubscribed" : true,
    "responsive" : true,
    "businessPhoneNumber" : "...",
    "homePhoneNumber" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "hidden" : true,
  "twitter" : "...",
  "twitterHandle" : "...",
  "instagramHandle" : "...",
  "email" : "...",
  "location" : {
    "code" : "...",
    "countryCode" : "...",
    "latitude" : 12345.0,
    "longitude" : 12345.0,
    "name" : "...",
    "stateOrCountry" : "...",
    "airportName" : "...",
    "region" : {
      "name" : "...",
      "code" : "...",
      "country" : { },
      "position" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "timeZone" : {
      "name" : "...",
      "offset" : 12345.0,
      "daylightSavingsOffset" : 12345.0,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "retentionOnly" : true,
    "position" : 12345,
    "unique" : true,
    "alias" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "pinterest" : "...",
  "externalBio" : "...",
  "brandLogo" : "...",
  "banner" : {
    "name" : "...",
    "image" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "awards" : [ {
    "name" : "...",
    "description" : "...",
    "dateAwarded" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "name" : "...",
    "description" : "...",
    "dateAwarded" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "testimonials" : [ {
    "content" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "state" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "content" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "state" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "freeFieldTitle" : "...",
  "freeFieldBody" : "...",
  "city" : "...",
  "extension" : "...",
  "specialties" : [ {
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "active" : true,
  "pendingApproval" : true,
  "affiliate" : true,
  "instagram" : "...",
  "presidentsClub" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}
                
              

GET /employee/getAdvisorScheduleByUserId/{id}

gets the schedule that is used in the employee directory.

Request Parameters
name type description constraints
id query the user id long
Response Body
media type data type description
application/json array of AdvisorSchedule (JSON)
application/xml list of advisorSchedule (XML)

Example

Request
GET /employee/getAdvisorScheduleByUserId/{id}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "startDay" : 12345,
  "endDay" : 12345,
  "startHour" : 12345,
  "startMinute" : 12345,
  "endHour" : 12345,
  "endMinute" : 12345,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
} ]
                
              

GET /employee/getAdvisorVisitedById/{id}

Gets Visited of an advisor

Request Parameters
name type description constraints
id query the User id long
Response Body
media type data type description
application/json array of AdvisorDestination (JSON)
application/xml list of advisorDestination (XML)

Example

Request
GET /employee/getAdvisorVisitedById/{id}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "name" : "...",
  "value" : "...",
  "passportOnline" : "...",
  "latitude" : 12345.0,
  "longitude" : 12345.0,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
} ]
                
              

GET /employee/getEmployeeProfileById/{id}

get a users employee profile by profile id.

Request Parameters
name type description constraints
id path long
Response Body
media type data type description
application/json EmployeeDirectoryProfile (JSON)
application/xml employeeDirectoryProfile (XML)

Example

Request
GET /employee/getEmployeeProfileById/{id}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "title" : "...",
  "imageName" : "...",
  "phone" : "...",
  "bio" : "...",
  "user" : {
    "answer" : "...",
    "emailed" : true,
    "newUser" : true,
    "temporaryPassword" : "...",
    "question" : "...",
    "obeUserName" : "...",
    "obePassword" : "...",
    "obeSyncId" : "...",
    "created" : 12345,
    "emailedWhen" : 12345,
    "travelgpaLogin" : "...",
    "groups" : [ {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "active" : true,
    "prefix" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "middleName" : "...",
    "suffix" : "...",
    "email" : "...",
    "tripitAuthorized" : true,
    "supportTitle" : "...",
    "automatedNotifications" : true,
    "enableHotelAttachment" : true,
    "atHomeNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "inTravelNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "cellPhoneNumber" : "...",
    "defaultClient" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "defaultPlannerGroup" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "showWelcomeDialog" : true,
    "siteTour" : true,
    "unusedTicketEmail" : true,
    "surveyEmail" : true,
    "wt0EmailEnabled" : true,
    "wt0EmailDaily" : true,
    "wt0EmailDay" : 12345,
    "wt0EmailHour" : 12345,
    "marketingSubscribed" : true,
    "responsive" : true,
    "businessPhoneNumber" : "...",
    "homePhoneNumber" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "startedInIndustry" : 12345,
  "startedInCompany" : 12345,
  "interestsText" : "...",
  "hometown" : "...",
  "specialization" : {
    "name" : "...",
    "code" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "department" : {
    "name" : "...",
    "code" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "designations" : [ {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "schedules" : [ {
    "startDay" : 12345,
    "endDay" : 12345,
    "startHour" : 12345,
    "startMinute" : 12345,
    "endHour" : 12345,
    "endMinute" : 12345,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "startDay" : 12345,
    "endDay" : 12345,
    "startHour" : 12345,
    "startMinute" : 12345,
    "endHour" : 12345,
    "endMinute" : 12345,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "timezone" : {
    "name" : "...",
    "offset" : 12345.0,
    "daylightSavingsOffset" : 12345.0,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}
                
              

GET /employee/getEmployeeProfileForUser/{userId}

Get the employee directory profile for a user.

Request Parameters
name type description constraints
userId path long
Response Body
media type data type description
application/json EmployeeDirectoryProfile (JSON)
application/xml employeeDirectoryProfile (XML)

Example

Request
GET /employee/getEmployeeProfileForUser/{userId}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "title" : "...",
  "imageName" : "...",
  "phone" : "...",
  "bio" : "...",
  "user" : {
    "answer" : "...",
    "emailed" : true,
    "newUser" : true,
    "temporaryPassword" : "...",
    "question" : "...",
    "obeUserName" : "...",
    "obePassword" : "...",
    "obeSyncId" : "...",
    "created" : 12345,
    "emailedWhen" : 12345,
    "travelgpaLogin" : "...",
    "groups" : [ {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "active" : true,
    "prefix" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "middleName" : "...",
    "suffix" : "...",
    "email" : "...",
    "tripitAuthorized" : true,
    "supportTitle" : "...",
    "automatedNotifications" : true,
    "enableHotelAttachment" : true,
    "atHomeNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "inTravelNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "cellPhoneNumber" : "...",
    "defaultClient" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "defaultPlannerGroup" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "showWelcomeDialog" : true,
    "siteTour" : true,
    "unusedTicketEmail" : true,
    "surveyEmail" : true,
    "wt0EmailEnabled" : true,
    "wt0EmailDaily" : true,
    "wt0EmailDay" : 12345,
    "wt0EmailHour" : 12345,
    "marketingSubscribed" : true,
    "responsive" : true,
    "businessPhoneNumber" : "...",
    "homePhoneNumber" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "startedInIndustry" : 12345,
  "startedInCompany" : 12345,
  "interestsText" : "...",
  "hometown" : "...",
  "specialization" : {
    "name" : "...",
    "code" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "department" : {
    "name" : "...",
    "code" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "designations" : [ {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "schedules" : [ {
    "startDay" : 12345,
    "endDay" : 12345,
    "startHour" : 12345,
    "startMinute" : 12345,
    "endHour" : 12345,
    "endMinute" : 12345,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "startDay" : 12345,
    "endDay" : 12345,
    "startHour" : 12345,
    "startMinute" : 12345,
    "endHour" : 12345,
    "endMinute" : 12345,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "timezone" : {
    "name" : "...",
    "offset" : 12345.0,
    "daylightSavingsOffset" : 12345.0,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}
                
              

POST /employee/updateAdvisorTestimonials/{testimonials}

Override the advisor's current list of testimonials with the ones passed in.

Request Parameters
name type description constraints multivalued
id query advisor id long no
testimonials query   yes
Response Body
media type data type description
application/json array of AdvisorTestimonial (JSON)
application/xml list of advisorTestimonial (XML)

Example

Request
POST /employee/updateAdvisorTestimonials/{testimonials}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
[ {
  "content" : "...",
  "firstName" : "...",
  "lastName" : "...",
  "state" : "...",
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
} ]
                
              

POST /employee/updateEmployeeProfile/{profile}

A lightweight updater used strictly by the employee profile piece to make updating less overhead intensive.

Request Parameters
name type description
profile path the employee profile to be updated.
Response Body
media type data type description
application/json EmployeeDirectoryProfile (JSON) the updated employee profile.
application/xml employeeDirectoryProfile (XML)

Example

Request
POST /employee/updateEmployeeProfile/{profile}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "title" : "...",
  "imageName" : "...",
  "phone" : "...",
  "bio" : "...",
  "user" : {
    "answer" : "...",
    "emailed" : true,
    "newUser" : true,
    "temporaryPassword" : "...",
    "question" : "...",
    "obeUserName" : "...",
    "obePassword" : "...",
    "obeSyncId" : "...",
    "created" : 12345,
    "emailedWhen" : 12345,
    "travelgpaLogin" : "...",
    "groups" : [ {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "active" : true,
    "prefix" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "middleName" : "...",
    "suffix" : "...",
    "email" : "...",
    "tripitAuthorized" : true,
    "supportTitle" : "...",
    "automatedNotifications" : true,
    "enableHotelAttachment" : true,
    "atHomeNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "inTravelNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "cellPhoneNumber" : "...",
    "defaultClient" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "defaultPlannerGroup" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "showWelcomeDialog" : true,
    "siteTour" : true,
    "unusedTicketEmail" : true,
    "surveyEmail" : true,
    "wt0EmailEnabled" : true,
    "wt0EmailDaily" : true,
    "wt0EmailDay" : 12345,
    "wt0EmailHour" : 12345,
    "marketingSubscribed" : true,
    "responsive" : true,
    "businessPhoneNumber" : "...",
    "homePhoneNumber" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "startedInIndustry" : 12345,
  "startedInCompany" : 12345,
  "interestsText" : "...",
  "hometown" : "...",
  "specialization" : {
    "name" : "...",
    "code" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "department" : {
    "name" : "...",
    "code" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "designations" : [ {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "schedules" : [ {
    "startDay" : 12345,
    "endDay" : 12345,
    "startHour" : 12345,
    "startMinute" : 12345,
    "endHour" : 12345,
    "endMinute" : 12345,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "startDay" : 12345,
    "endDay" : 12345,
    "startHour" : 12345,
    "startMinute" : 12345,
    "endHour" : 12345,
    "endMinute" : 12345,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "timezone" : {
    "name" : "...",
    "offset" : 12345.0,
    "daylightSavingsOffset" : 12345.0,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}
                
              

GET /employee/getEmployeeInfoForUser/{userid}/{clientid}

Request Parameters
name type description constraints
clientid path long
userid path long
Response Body
media type data type description
application/json EmployeeInfo (JSON)
application/xml employeeInfo (XML)

Example

Request
GET /employee/getEmployeeInfoForUser/{userid}/{clientid}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "user" : {
    "answer" : "...",
    "emailed" : true,
    "newUser" : true,
    "temporaryPassword" : "...",
    "question" : "...",
    "obeUserName" : "...",
    "obePassword" : "...",
    "obeSyncId" : "...",
    "created" : 12345,
    "emailedWhen" : 12345,
    "travelgpaLogin" : "...",
    "groups" : [ {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "active" : true,
    "prefix" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "middleName" : "...",
    "suffix" : "...",
    "email" : "...",
    "tripitAuthorized" : true,
    "supportTitle" : "...",
    "automatedNotifications" : true,
    "enableHotelAttachment" : true,
    "atHomeNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "inTravelNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "cellPhoneNumber" : "...",
    "defaultClient" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "defaultPlannerGroup" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "showWelcomeDialog" : true,
    "siteTour" : true,
    "unusedTicketEmail" : true,
    "surveyEmail" : true,
    "wt0EmailEnabled" : true,
    "wt0EmailDaily" : true,
    "wt0EmailDay" : 12345,
    "wt0EmailHour" : 12345,
    "marketingSubscribed" : true,
    "responsive" : true,
    "businessPhoneNumber" : "...",
    "homePhoneNumber" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "agentCode" : "...",
  "office" : {
    "pcc" : "...",
    "name" : "...",
    "address1" : "...",
    "address2" : "...",
    "address3" : "...",
    "city" : "...",
    "state" : "...",
    "zip" : "...",
    "parentCompany" : {
      "name" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "active" : "...",
    "branch" : "...",
    "clientPrefix" : "...",
    "profileSettings" : {
      "profileNameFormat" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "afterHoursNumber" : "...",
    "collectVoidLogs" : true,
    "gds" : {
      "code" : "...",
      "name" : "...",
      "enabled" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "arcNumber" : "...",
    "logo" : "...",
    "logoLink" : "...",
    "afterHoursInternationalNumber" : "...",
    "tollFreeNumber" : "...",
    "phoneNumber" : "...",
    "onlineOffice" : {
      "name" : "...",
      "hours" : "...",
      "phone" : "...",
      "tollFree" : "...",
      "email" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "showTmcAppLinks" : true,
    "vipTollFree" : "...",
    "vipAfterHours" : "...",
    "cityCode" : {
      "code" : "...",
      "countryCode" : "...",
      "latitude" : 12345.0,
      "longitude" : 12345.0,
      "name" : "...",
      "stateOrCountry" : "...",
      "airportName" : "...",
      "region" : { },
      "timeZone" : { },
      "retentionOnly" : true,
      "position" : 12345,
      "unique" : true,
      "alias" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "tmcHeadQuarters" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "workEmail" : "...",
  "active" : "...",
  "type" : "...",
  "emailList" : "...",
  "category" : "...",
  "directLine" : "...",
  "hours" : "...",
  "onlineAgent" : true,
  "recheckEmails" : true,
  "serviceFeesPct" : 12345.0,
  "otherServiceFeesPct" : 12345.0,
  "internationalAirCommissionPct" : 12345.0,
  "miscCommissionPct" : 12345.0,
  "airCommissionPct" : 12345.0,
  "hotelCommissionPct" : 12345.0,
  "carCommissionPct" : 12345.0,
  "employeeType" : {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "ticketingAgent" : true,
  "supportAgent" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}
                
              

POST /employee/updateAdvisorSchedules/{id}/{schedules}

This method has been deprecated.

Updates an advisors schedule list

Request Parameters
name type description constraints multivalued
id path the advisor id long no
schedules path schedules to be changed   yes
Response Body
media type data type description
application/json array of AdvisorSchedule (JSON)
application/xml list of advisorSchedule (XML)

Example

Request
POST /employee/updateAdvisorSchedules/{id}/{schedules}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
[ {
  "startDay" : 12345,
  "endDay" : 12345,
  "startHour" : 12345,
  "startMinute" : 12345,
  "endHour" : 12345,
  "endMinute" : 12345,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
} ]
                
              

GET /employee/getEmployeeInfoFromAgentSine/{pcc}/{branch}/{agentsine}/{gdsid}

A function we can use to get the EmployeeInfo from the PCC and agent sine.

Request Parameters
name type description constraints
agentSine path The agent sine the employee books as.  
branch path The branch that the agent books as.  
gdsid path The GDS that the agent is working in. long
pcc path The pcc the employee should be in.  
Response Body
media type data type description
application/json EmployeeInfo (JSON) The EmployeeInfo from the pcc and agent code.
application/xml employeeInfo (XML)

Example

Request
GET /employee/getEmployeeInfoFromAgentSine/{pcc}/{branch}/{agentsine}/{gdsid}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "user" : {
    "answer" : "...",
    "emailed" : true,
    "newUser" : true,
    "temporaryPassword" : "...",
    "question" : "...",
    "obeUserName" : "...",
    "obePassword" : "...",
    "obeSyncId" : "...",
    "created" : 12345,
    "emailedWhen" : 12345,
    "travelgpaLogin" : "...",
    "groups" : [ {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "name" : "...",
      "permissions" : [ { }, { } ],
      "description" : "...",
      "role" : { },
      "type" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "active" : true,
    "prefix" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "middleName" : "...",
    "suffix" : "...",
    "email" : "...",
    "tripitAuthorized" : true,
    "supportTitle" : "...",
    "automatedNotifications" : true,
    "enableHotelAttachment" : true,
    "atHomeNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "inTravelNotificationMethod" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "cellPhoneNumber" : "...",
    "defaultClient" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "defaultPlannerGroup" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "showWelcomeDialog" : true,
    "siteTour" : true,
    "unusedTicketEmail" : true,
    "surveyEmail" : true,
    "wt0EmailEnabled" : true,
    "wt0EmailDaily" : true,
    "wt0EmailDay" : 12345,
    "wt0EmailHour" : 12345,
    "marketingSubscribed" : true,
    "responsive" : true,
    "businessPhoneNumber" : "...",
    "homePhoneNumber" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "agentCode" : "...",
  "office" : {
    "pcc" : "...",
    "name" : "...",
    "address1" : "...",
    "address2" : "...",
    "address3" : "...",
    "city" : "...",
    "state" : "...",
    "zip" : "...",
    "parentCompany" : {
      "name" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "active" : "...",
    "branch" : "...",
    "clientPrefix" : "...",
    "profileSettings" : {
      "profileNameFormat" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "afterHoursNumber" : "...",
    "collectVoidLogs" : true,
    "gds" : {
      "code" : "...",
      "name" : "...",
      "enabled" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "arcNumber" : "...",
    "logo" : "...",
    "logoLink" : "...",
    "afterHoursInternationalNumber" : "...",
    "tollFreeNumber" : "...",
    "phoneNumber" : "...",
    "onlineOffice" : {
      "name" : "...",
      "hours" : "...",
      "phone" : "...",
      "tollFree" : "...",
      "email" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "showTmcAppLinks" : true,
    "vipTollFree" : "...",
    "vipAfterHours" : "...",
    "cityCode" : {
      "code" : "...",
      "countryCode" : "...",
      "latitude" : 12345.0,
      "longitude" : 12345.0,
      "name" : "...",
      "stateOrCountry" : "...",
      "airportName" : "...",
      "region" : { },
      "timeZone" : { },
      "retentionOnly" : true,
      "position" : 12345,
      "unique" : true,
      "alias" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "tmcHeadQuarters" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "workEmail" : "...",
  "active" : "...",
  "type" : "...",
  "emailList" : "...",
  "category" : "...",
  "directLine" : "...",
  "hours" : "...",
  "onlineAgent" : true,
  "recheckEmails" : true,
  "serviceFeesPct" : 12345.0,
  "otherServiceFeesPct" : 12345.0,
  "internationalAirCommissionPct" : 12345.0,
  "miscCommissionPct" : 12345.0,
  "airCommissionPct" : 12345.0,
  "hotelCommissionPct" : 12345.0,
  "carCommissionPct" : 12345.0,
  "employeeType" : {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "ticketingAgent" : true,
  "supportAgent" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}