POST v1/TravelLeaders/GetFeaturedAgent

Request Information

URI Parameters

None.

Body Parameters

FeaturedAgentRQ
NameDescriptionTypeAdditional information
AgencyId

string

None.

ShowDestinationRows

integer

None.

ShowSpecialtyRows

integer

None.

ReturnRows

integer

None.

Vuserid

string

None.

PccCode

string

None.

UserId

integer

None.

AccountID

string

None.

UserName

string

None.

ApplicationDomain

ApplicationDomain

None.

guid

string

None.

Request Formats

application/json, text/json

Sample:
{
  "AgencyId": "sample string 1",
  "ShowDestinationRows": 2,
  "ShowSpecialtyRows": 3,
  "ReturnRows": 4,
  "Vuserid": "sample string 5",
  "PccCode": "sample string 6",
  "UserId": 7,
  "AccountID": "sample string 8",
  "UserName": "sample string 9",
  "ApplicationDomain": 0,
  "guid": "sample string 10"
}

application/xml, text/xml

Sample:
<FeaturedAgentRQ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GT.AzrTravelApi.Model.TravelLeaders">
  <AccountID xmlns="http://schemas.datacontract.org/2004/07/GT.AzrTravelApi.Model">sample string 8</AccountID>
  <ApplicationDomain xmlns="http://schemas.datacontract.org/2004/07/GT.AzrTravelApi.Model">GTL</ApplicationDomain>
  <PccCode xmlns="http://schemas.datacontract.org/2004/07/GT.AzrTravelApi.Model">sample string 6</PccCode>
  <UserId xmlns="http://schemas.datacontract.org/2004/07/GT.AzrTravelApi.Model">7</UserId>
  <UserName xmlns="http://schemas.datacontract.org/2004/07/GT.AzrTravelApi.Model">sample string 9</UserName>
  <Vuserid xmlns="http://schemas.datacontract.org/2004/07/GT.AzrTravelApi.Model">sample string 5</Vuserid>
  <guid xmlns="http://schemas.datacontract.org/2004/07/GT.AzrTravelApi.Model">sample string 10</guid>
  <AgencyId>sample string 1</AgencyId>
  <ReturnRows>4</ReturnRows>
  <ShowDestinationRows>2</ShowDestinationRows>
  <ShowSpecialtyRows>3</ShowSpecialtyRows>
</FeaturedAgentRQ>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

FeaturedAgentResponse
NameDescriptionTypeAdditional information
FeaturedAgents

Collection of AgentFeaturedByAgency

None.

IsSuccess

boolean

None.

Message

string

None.

guid

string

None.

PNR

string

None.

Response Formats

application/json, text/json

Sample:
{
  "FeaturedAgents": [
    {
      "agentIdField": 1,
      "firstNameField": "sample string 2",
      "lastNameField": "sample string 3",
      "agentPhotoFileNameField": "sample string 4",
      "websiteDisplayTitleField": "sample string 5",
      "cityField": "sample string 6",
      "stateField": "sample string 7",
      "agencyIdField": 8,
      "agentFullBioField": "sample string 9",
      "approverEmailField": "sample string 10",
      "iCAgentField": true,
      "hostAgencyField": "sample string 12",
      "hostAgencyPhoneField": "sample string 13",
      "scoreMatchField": 14,
      "customerContactCountField": 15,
      "talkativeCompanyField": "sample string 16",
      "talkativeQueueField": "sample string 17",
      "yearsActiveField": "sample string 18",
      "agentInterestsField": [
        {
          "interestNameField": "sample string 1",
          "interestIdField": 2
        },
        {
          "interestNameField": "sample string 1",
          "interestIdField": 2
        }
      ],
      "agentConnectionsField": [
        {
          "contactValueField": "sample string 1",
          "contactMethodField": "sample string 2",
          "contactIconField": "sample string 3"
        },
        {
          "contactValueField": "sample string 1",
          "contactMethodField": "sample string 2",
          "contactIconField": "sample string 3"
        }
      ],
      "agentDestinationsField": [
        {
          "locationTypeField": "sample string 1",
          "regionField": "sample string 2",
          "subRegionField": "sample string 3",
          "areaField": "sample string 4",
          "localeField": "sample string 5",
          "locationIdField": 6,
          "errorMsgField": "sample string 7"
        },
        {
          "locationTypeField": "sample string 1",
          "regionField": "sample string 2",
          "subRegionField": "sample string 3",
          "areaField": "sample string 4",
          "localeField": "sample string 5",
          "locationIdField": 6,
          "errorMsgField": "sample string 7"
        }
      ],
      "agentSpecialtyGroupsField": [
        {
          "specialtyGroupField": "sample string 1"
        },
        {
          "specialtyGroupField": "sample string 1"
        }
      ],
      "agentRatingField": {
        "totalReviewsField": 1,
        "ratingField": 2.1,
        "recommendedField": 3,
        "errorMsgField": "sample string 4"
      },
      "errorMsgField": "sample string 19"
    },
    {
      "agentIdField": 1,
      "firstNameField": "sample string 2",
      "lastNameField": "sample string 3",
      "agentPhotoFileNameField": "sample string 4",
      "websiteDisplayTitleField": "sample string 5",
      "cityField": "sample string 6",
      "stateField": "sample string 7",
      "agencyIdField": 8,
      "agentFullBioField": "sample string 9",
      "approverEmailField": "sample string 10",
      "iCAgentField": true,
      "hostAgencyField": "sample string 12",
      "hostAgencyPhoneField": "sample string 13",
      "scoreMatchField": 14,
      "customerContactCountField": 15,
      "talkativeCompanyField": "sample string 16",
      "talkativeQueueField": "sample string 17",
      "yearsActiveField": "sample string 18",
      "agentInterestsField": [
        {
          "interestNameField": "sample string 1",
          "interestIdField": 2
        },
        {
          "interestNameField": "sample string 1",
          "interestIdField": 2
        }
      ],
      "agentConnectionsField": [
        {
          "contactValueField": "sample string 1",
          "contactMethodField": "sample string 2",
          "contactIconField": "sample string 3"
        },
        {
          "contactValueField": "sample string 1",
          "contactMethodField": "sample string 2",
          "contactIconField": "sample string 3"
        }
      ],
      "agentDestinationsField": [
        {
          "locationTypeField": "sample string 1",
          "regionField": "sample string 2",
          "subRegionField": "sample string 3",
          "areaField": "sample string 4",
          "localeField": "sample string 5",
          "locationIdField": 6,
          "errorMsgField": "sample string 7"
        },
        {
          "locationTypeField": "sample string 1",
          "regionField": "sample string 2",
          "subRegionField": "sample string 3",
          "areaField": "sample string 4",
          "localeField": "sample string 5",
          "locationIdField": 6,
          "errorMsgField": "sample string 7"
        }
      ],
      "agentSpecialtyGroupsField": [
        {
          "specialtyGroupField": "sample string 1"
        },
        {
          "specialtyGroupField": "sample string 1"
        }
      ],
      "agentRatingField": {
        "totalReviewsField": 1,
        "ratingField": 2.1,
        "recommendedField": 3,
        "errorMsgField": "sample string 4"
      },
      "errorMsgField": "sample string 19"
    }
  ],
  "IsSuccess": true,
  "Message": "sample string 2",
  "guid": "sample string 3",
  "PNR": "sample string 4"
}

application/xml, text/xml

Sample:
<FeaturedAgentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GT.AzrTravelApi.Business.TravelLeadersModel">
  <IsSuccess xmlns="http://schemas.datacontract.org/2004/07/GT.AzrTravelApi.Model">true</IsSuccess>
  <Message xmlns="http://schemas.datacontract.org/2004/07/GT.AzrTravelApi.Model">sample string 2</Message>
  <PNR xmlns="http://schemas.datacontract.org/2004/07/GT.AzrTravelApi.Model">sample string 4</PNR>
  <guid xmlns="http://schemas.datacontract.org/2004/07/GT.AzrTravelApi.Model">sample string 3</guid>
  <FeaturedAgents xmlns:d2p1="http://schemas.datacontract.org/2004/07/GT.AzrTravelApi.Business.AgentService">
    <d2p1:AgentFeaturedByAgency>
      <d2p1:agencyIdField>8</d2p1:agencyIdField>
      <d2p1:agentConnectionsField>
        <d2p1:AgentConnection>
          <d2p1:contactIconField>sample string 3</d2p1:contactIconField>
          <d2p1:contactMethodField>sample string 2</d2p1:contactMethodField>
          <d2p1:contactValueField>sample string 1</d2p1:contactValueField>
        </d2p1:AgentConnection>
        <d2p1:AgentConnection>
          <d2p1:contactIconField>sample string 3</d2p1:contactIconField>
          <d2p1:contactMethodField>sample string 2</d2p1:contactMethodField>
          <d2p1:contactValueField>sample string 1</d2p1:contactValueField>
        </d2p1:AgentConnection>
      </d2p1:agentConnectionsField>
      <d2p1:agentDestinationsField>
        <d2p1:AgentDestination>
          <d2p1:areaField>sample string 4</d2p1:areaField>
          <d2p1:errorMsgField>sample string 7</d2p1:errorMsgField>
          <d2p1:localeField>sample string 5</d2p1:localeField>
          <d2p1:locationIdField>6</d2p1:locationIdField>
          <d2p1:locationTypeField>sample string 1</d2p1:locationTypeField>
          <d2p1:regionField>sample string 2</d2p1:regionField>
          <d2p1:subRegionField>sample string 3</d2p1:subRegionField>
        </d2p1:AgentDestination>
        <d2p1:AgentDestination>
          <d2p1:areaField>sample string 4</d2p1:areaField>
          <d2p1:errorMsgField>sample string 7</d2p1:errorMsgField>
          <d2p1:localeField>sample string 5</d2p1:localeField>
          <d2p1:locationIdField>6</d2p1:locationIdField>
          <d2p1:locationTypeField>sample string 1</d2p1:locationTypeField>
          <d2p1:regionField>sample string 2</d2p1:regionField>
          <d2p1:subRegionField>sample string 3</d2p1:subRegionField>
        </d2p1:AgentDestination>
      </d2p1:agentDestinationsField>
      <d2p1:agentFullBioField>sample string 9</d2p1:agentFullBioField>
      <d2p1:agentIdField>1</d2p1:agentIdField>
      <d2p1:agentInterestsField>
        <d2p1:AgentInterest>
          <d2p1:interestIdField>2</d2p1:interestIdField>
          <d2p1:interestNameField>sample string 1</d2p1:interestNameField>
        </d2p1:AgentInterest>
        <d2p1:AgentInterest>
          <d2p1:interestIdField>2</d2p1:interestIdField>
          <d2p1:interestNameField>sample string 1</d2p1:interestNameField>
        </d2p1:AgentInterest>
      </d2p1:agentInterestsField>
      <d2p1:agentPhotoFileNameField>sample string 4</d2p1:agentPhotoFileNameField>
      <d2p1:agentRatingField>
        <d2p1:errorMsgField>sample string 4</d2p1:errorMsgField>
        <d2p1:ratingField>2.1</d2p1:ratingField>
        <d2p1:recommendedField>3</d2p1:recommendedField>
        <d2p1:totalReviewsField>1</d2p1:totalReviewsField>
      </d2p1:agentRatingField>
      <d2p1:agentSpecialtyGroupsField>
        <d2p1:AgentSpecialtyGroup>
          <d2p1:specialtyGroupField>sample string 1</d2p1:specialtyGroupField>
        </d2p1:AgentSpecialtyGroup>
        <d2p1:AgentSpecialtyGroup>
          <d2p1:specialtyGroupField>sample string 1</d2p1:specialtyGroupField>
        </d2p1:AgentSpecialtyGroup>
      </d2p1:agentSpecialtyGroupsField>
      <d2p1:approverEmailField>sample string 10</d2p1:approverEmailField>
      <d2p1:cityField>sample string 6</d2p1:cityField>
      <d2p1:customerContactCountField>15</d2p1:customerContactCountField>
      <d2p1:errorMsgField>sample string 19</d2p1:errorMsgField>
      <d2p1:firstNameField>sample string 2</d2p1:firstNameField>
      <d2p1:hostAgencyField>sample string 12</d2p1:hostAgencyField>
      <d2p1:hostAgencyPhoneField>sample string 13</d2p1:hostAgencyPhoneField>
      <d2p1:iCAgentField>true</d2p1:iCAgentField>
      <d2p1:lastNameField>sample string 3</d2p1:lastNameField>
      <d2p1:scoreMatchField>14</d2p1:scoreMatchField>
      <d2p1:stateField>sample string 7</d2p1:stateField>
      <d2p1:talkativeCompanyField>sample string 16</d2p1:talkativeCompanyField>
      <d2p1:talkativeQueueField>sample string 17</d2p1:talkativeQueueField>
      <d2p1:websiteDisplayTitleField>sample string 5</d2p1:websiteDisplayTitleField>
      <d2p1:yearsActiveField>sample string 18</d2p1:yearsActiveField>
    </d2p1:AgentFeaturedByAgency>
    <d2p1:AgentFeaturedByAgency>
      <d2p1:agencyIdField>8</d2p1:agencyIdField>
      <d2p1:agentConnectionsField>
        <d2p1:AgentConnection>
          <d2p1:contactIconField>sample string 3</d2p1:contactIconField>
          <d2p1:contactMethodField>sample string 2</d2p1:contactMethodField>
          <d2p1:contactValueField>sample string 1</d2p1:contactValueField>
        </d2p1:AgentConnection>
        <d2p1:AgentConnection>
          <d2p1:contactIconField>sample string 3</d2p1:contactIconField>
          <d2p1:contactMethodField>sample string 2</d2p1:contactMethodField>
          <d2p1:contactValueField>sample string 1</d2p1:contactValueField>
        </d2p1:AgentConnection>
      </d2p1:agentConnectionsField>
      <d2p1:agentDestinationsField>
        <d2p1:AgentDestination>
          <d2p1:areaField>sample string 4</d2p1:areaField>
          <d2p1:errorMsgField>sample string 7</d2p1:errorMsgField>
          <d2p1:localeField>sample string 5</d2p1:localeField>
          <d2p1:locationIdField>6</d2p1:locationIdField>
          <d2p1:locationTypeField>sample string 1</d2p1:locationTypeField>
          <d2p1:regionField>sample string 2</d2p1:regionField>
          <d2p1:subRegionField>sample string 3</d2p1:subRegionField>
        </d2p1:AgentDestination>
        <d2p1:AgentDestination>
          <d2p1:areaField>sample string 4</d2p1:areaField>
          <d2p1:errorMsgField>sample string 7</d2p1:errorMsgField>
          <d2p1:localeField>sample string 5</d2p1:localeField>
          <d2p1:locationIdField>6</d2p1:locationIdField>
          <d2p1:locationTypeField>sample string 1</d2p1:locationTypeField>
          <d2p1:regionField>sample string 2</d2p1:regionField>
          <d2p1:subRegionField>sample string 3</d2p1:subRegionField>
        </d2p1:AgentDestination>
      </d2p1:agentDestinationsField>
      <d2p1:agentFullBioField>sample string 9</d2p1:agentFullBioField>
      <d2p1:agentIdField>1</d2p1:agentIdField>
      <d2p1:agentInterestsField>
        <d2p1:AgentInterest>
          <d2p1:interestIdField>2</d2p1:interestIdField>
          <d2p1:interestNameField>sample string 1</d2p1:interestNameField>
        </d2p1:AgentInterest>
        <d2p1:AgentInterest>
          <d2p1:interestIdField>2</d2p1:interestIdField>
          <d2p1:interestNameField>sample string 1</d2p1:interestNameField>
        </d2p1:AgentInterest>
      </d2p1:agentInterestsField>
      <d2p1:agentPhotoFileNameField>sample string 4</d2p1:agentPhotoFileNameField>
      <d2p1:agentRatingField>
        <d2p1:errorMsgField>sample string 4</d2p1:errorMsgField>
        <d2p1:ratingField>2.1</d2p1:ratingField>
        <d2p1:recommendedField>3</d2p1:recommendedField>
        <d2p1:totalReviewsField>1</d2p1:totalReviewsField>
      </d2p1:agentRatingField>
      <d2p1:agentSpecialtyGroupsField>
        <d2p1:AgentSpecialtyGroup>
          <d2p1:specialtyGroupField>sample string 1</d2p1:specialtyGroupField>
        </d2p1:AgentSpecialtyGroup>
        <d2p1:AgentSpecialtyGroup>
          <d2p1:specialtyGroupField>sample string 1</d2p1:specialtyGroupField>
        </d2p1:AgentSpecialtyGroup>
      </d2p1:agentSpecialtyGroupsField>
      <d2p1:approverEmailField>sample string 10</d2p1:approverEmailField>
      <d2p1:cityField>sample string 6</d2p1:cityField>
      <d2p1:customerContactCountField>15</d2p1:customerContactCountField>
      <d2p1:errorMsgField>sample string 19</d2p1:errorMsgField>
      <d2p1:firstNameField>sample string 2</d2p1:firstNameField>
      <d2p1:hostAgencyField>sample string 12</d2p1:hostAgencyField>
      <d2p1:hostAgencyPhoneField>sample string 13</d2p1:hostAgencyPhoneField>
      <d2p1:iCAgentField>true</d2p1:iCAgentField>
      <d2p1:lastNameField>sample string 3</d2p1:lastNameField>
      <d2p1:scoreMatchField>14</d2p1:scoreMatchField>
      <d2p1:stateField>sample string 7</d2p1:stateField>
      <d2p1:talkativeCompanyField>sample string 16</d2p1:talkativeCompanyField>
      <d2p1:talkativeQueueField>sample string 17</d2p1:talkativeQueueField>
      <d2p1:websiteDisplayTitleField>sample string 5</d2p1:websiteDisplayTitleField>
      <d2p1:yearsActiveField>sample string 18</d2p1:yearsActiveField>
    </d2p1:AgentFeaturedByAgency>
  </FeaturedAgents>
</FeaturedAgentResponse>