ProfileSearch

ProfileSearch returns data for client, supplier, advisor and other profiles.

User needs at least select permission for whichever type of profile being searched for. Results may be filtered if client or advisor permission includes OnlySelf (based on user’s linked advisors) or if client permission or advisor permission includes OnlyBranch (based on user’s branch).

See: AdvisorProfile, ClientProfile, OtherProfile, SupplierProfile

Permission Areas: AdvisorProfile, ClientProfile, OtherProfile, SupplierProfile

Column	Type	Size	Table	Description
`recNo`	`long`		`profile`
`tagRecNo`	`long`		`profile`
`tagName`	`string`	64	`profile`
`tagValue`	`string`	1024	`profile`
`tags`	`string`		`profile`
`summaryCount`	`int`		`profile`
`createDateTime`	`DateTimeOffset`		`profile`
`lastModifiedDateTime`	`DateTimeOffset`		`profile`
`name`	`string`	256	`profile`
`uniqueId`	`string`	64	`profile`
`profileType`	`short`		`profile`	Client = 1, Supplier = 2, Advisor = 3, Other = 4
`clientType`	`short`		`clientProfile`	Personal = 1, Corporate = 2
`supplierType`	`short`		`supplierProfile`	BillingAndServiceProvider = 1, BillingProvider = 2, ServiceProvider = 3
`primaryPersonRecNo`	`long`		`profile`
`primaryPersonName`	`string`	256	`profile`
`primaryPersonFirstName`	`string`	64	`profile`
`primaryPersonLastName`	`string`	64	`profile`
`primaryPersonEmail`	`string`	256	`profile`
`primaryPersonPhone`	`string`	256	`profile`
`clientAnniversaryDay`	`short`		`clientProfile`
`clientAnniversaryMonth`	`short`		`clientProfile`
`clientAnniversaryYear`	`short`		`clientProfile`
`clientAnniversaryNote`	`string`	256	`clientProfile`
`clientAdvisorProfileRecNo`	`long`		`clientProfile`
`clientAdvisorName`	`string`	256	`clientProfile`
`clientBranchRecNo`	`long`		`clientProfile`
`clientBranchName`	`string`	64	`clientProfile`
`remarks`	`string`	256	`profile`
`activeStatus`	`short`		`profile`	Inactive = 0, Active = 1, Pending = 2
`primaryEmail`	`string`	256	`profile`
`primaryEmailPermitMarketing`	`bool`		`profile`
`primaryPhone`	`string`	256	`profile`
`primaryPhonePermitMarketing`	`bool`		`profile`
`preferredSupplier`	`bool`		`supplierProfile`
`supplierTravelCategoryFlags`	`int`		`supplierProfile`	Air = 1, Hotel = 2, Car = 4, Cruise = 8, Tour = 16, Rail = 32, Transfer = 64, Insurance = 128, ServiceFee = 256, Excursion = 512
`street1`	`string`	128	`address`
`street2`	`string`	128	`address`
`city`	`string`	64	`address`
`stateProvince`	`string`	8	`address`
`zipPostalCode`	`string`	16	`address`
`country`	`string`	4	`address`
`mailingStreet1`	`string`	128	`address`
`mailingStreet2`	`string`	128	`address`
`mailingCity`	`string`	64	`address`
`mailingStateProvince`	`string`	8	`address`
`mailingZipPostalCode`	`string`	16	`address`
`mailingCountry`	`string`	4	`address`
`addressPermitMarketing`	`bool`		`address`
`supplierVendorId`	`string`	10	`supplierProfile`
`supplierCommissionRate`	`short`		`supplierProfile`	Percentage values have an implied 2 digits after the decimal point. A value of 25% is represented as 2500
`clientInformalSalutation`	`string`	128	`clientProfile`
`clientFormalSalutation`	`string`	128	`clientProfile`
`firstId`	`string`	32	`profile`
`profileCommType`	`short`		`communication`	Phone = 1, Email = 2, SocialMedia = 3, Web = 4
`profileCommValue`	`string`	256	`communication`
`profileCommIsBillingContact`	`bool`		`communication`	ProfileSearch.profileCommIsBillingContact is deprecated, use profileCommContactOption instead.
`profileCommContactOption`	`short`		`communication`	Billing = 1, CustomerService = 2
`actionRecNo`	`long`		`clientProfileActionItem`
`actionItemTriggerIndex`	`short`		`clientProfileActionItem`	FixedDate = 1, CreateDate = 2, AnniversaryDate = 3
`actionItemDate`	`Date`		`clientProfileActionItem`
`actionItemTriggerFixedDate`	`Date`		`clientProfileActionItem`
`actionItemDescription`	`string`		`clientProfileActionItem`
`actionItemCompleted`	`DateTime`		`clientProfileActionItem`
`actionItemAssignedToAppUserRecNo`	`long`		`clientProfileActionItem`
`actionItemAssignedToAppUserId`	`string`	64	`clientProfileActionItem`
`imageCount`	`short`		`profile`
`supplierAirlineNo`	`short`		`supplierProfile`

Parameter	Type	Linked Column	Description
`recNo [inherited]`	`NumSearchParam`	`recNo`
`startingRow [inherited]`	`long`
`rowCount [inherited]`	`long`
`topRows [inherited]`	`long`
`distinct [inherited]`	`bool`
`createDateTimeFrom [inherited]`	`DateTimeUTCSearchParam`
`createDateTimeTo [inherited]`	`DateTimeUTCSearchParam`
`modifiedDateTimeFrom [inherited]`	`DateTimeUTCSearchParam`
`modifiedDateTimeTo [inherited]`	`DateTimeUTCSearchParam`
`includeCols [inherited]`	`string[]`
`includeColsExtended [inherited]`	`includeColsExtended[]`
`baseUrl [inherited]`	`string`
`reportFormat [inherited]`	`bool`
`reportName [inherited]`	`string`
`tags [inherited]`	`TagsSearchParams[]`
`profileType`	[`short<short>`]	`profileType`	Client = 1, Supplier = 2, Advisor = 3, Other = 4
`profileName`	`StringSearchParam`	`name`
`profileUniqueId`	`string`	`uniqueId`
`commType`	[`short<short>`]	`profileCommType`	Phone = 1, Email = 2, SocialMedia = 3, Web = 4
`commValue`	`StringSearchParam`	`profileCommValue`
`commValueCountryDomain`	`string`
`commValueCityArea`	`string`
`commValueUserSpecific`	`StringSearchParam`
`clientAnniversaryMonth`	`NumSearchParam`	`clientAnniversaryMonth`
`clientAnniversaryMonthFrom`	`long`
`clientAnniversaryMonthTo`	`long`
`clientAnniversaryDayFrom`	`long`
`clientAnniversaryDayTo`	`long`
`clientAdvisorProfileRecNo`	`NumSearchParam`	`clientAdvisorProfileRecNo`
`clientType`	[`short<short>`]	`clientType`	Personal = 1, Corporate = 2
`supplierType`	`EnumSearchParam<SupplierType>`	`supplierType`	BillingAndServiceProvider = 1, BillingProvider = 2, ServiceProvider = 3
`activeStatus`	[`short<short>`]	`activeStatus`	Inactive = 0, Active = 1, Pending = 2
`clientBranchRecNo`	`NumSearchParam`	`clientBranchRecNo`
`personRecNo`	`NumSearchParam`
`personFirstName`	`StringSearchParam`
`personLastName`	`StringSearchParam`
`preferredSupplier`	`bool`	`preferredSupplier`
`street1`	`StringSearchParam`	`street1`
`city`	`StringSearchParam`	`city`
`stateProvince`	`StringSearchParam`	`stateProvince`
`zipPostalCode`	`StringSearchParam`	`zipPostalCode`
`country`	`StringSearchParam`	`country`
`marketing`	`MarketingSearchParam[]`
`id`	`StringSearchParam`
`emailPermitMarketing`	`bool`
`phonePermitMarketing`	`bool`
`addressPermitMarketing`	`bool`	`addressPermitMarketing`
`supplierVendorId`	`StringSearchParam`	`supplierVendorId`
`supplierTravelCategoryFlags`	[`int<int>`]	`supplierTravelCategoryFlags`	Air = 1, Hotel = 2, Car = 4, Cruise = 8, Tour = 16, Rail = 32, Transfer = 64, Insurance = 128, ServiceFee = 256, Excursion = 512
`profileCommunicationBillingContact`	`bool`	`profileCommIsBillingContact`
`clientActionItemCompleted`	`bool`	`actionItemCompleted`
`clientActionItemDateFrom`	`DateSearchParam`	`actionItemDate`
`clientActionItemDateTo`	`DateSearchParam`	`actionItemDate`
`clientActionItemAssignedToAppUserRecNo`	`NumSearchParam`	`actionItemAssignedToAppUserRecNo`
`supplierAirlineNo`	`NumSearchParam`	`supplierAirlineNo`
`clientTripSearchParams`	`TripSearchParams`
`supplierTripSearchParams`	`TripSearchParams`
`clientActivitySearchParams`	`ActivitySearchParams`

Status code	Description
200	Ok
401	Unauthorized
403	Forbidden

Example request: a profile search that returns the profile recNo and name for active client profiles whose name starts with “Able”

POST https://api-dev.trestechnologies.com/profileSearch
Content-Type: application/json
Authorization: Bearer <session-token>
{
  "profileType": 1,
  "activeStatus": true,
  "profileName": {
    "value": [
      "Able"
    ],
    "compareCondition": 5
  },
  "includeCols": [
    "recNo",
    "name"
  ]
}

Example response

Content-Type: application/json
Status: 200 Ok
[
  {
    "recNo": 1519190,
    "name": "Able Family"
  },
  {
    "recNo": 1518989,
    "name": "Able/Ken"
  },
  {
    "recNo": 2089967,
    "name": "Abler/Hale Nicole"
  },
  {
    "recNo": 1517502,
    "name": "Abler/Ken"
  }
]