{ "info": { "title": "neh-api", "version": "3.0" }, "servers": [ { "url": "https://etaqfzu51f.execute-api.us-west-2.amazonaws.com/{basePath}", "variables": { "basePath": { "default": "uat" } } } ], "openapi": "3.0.1", "components": { "securitySchemes": { "OAuth2": { "flows": { "clientCredentials": { "tokenUrl": "{tokenUrl}", "scopes": { } } }, "type": "oauth2" } }, "schemas": { "VisitAttendeeInviteStatus": { "type": "object", "properties": { "InviteStatusID": { "type": "integer", "format": "int32" }, "StatusName": { "type": "string" } }, "additionalProperties": false }, "VisitDayExtended": { "type": "object", "properties": { "VisitDayID": { "type": "integer", "format": "int32" }, "DayStart": { "type": "string", "format": "date-time" }, "DayEnd": { "type": "string", "format": "date-time" }, "DateLastUpdated": { "type": "string", "format": "date-time" }, "UpdatedByUserID": { "type": "integer", "format": "int32" }, "VisitID": { "type": "integer", "format": "int32" }, "StartRoomID": { "type": "integer", "format": "int32" }, "Rooms": { "type": "array", "items": { "$ref": "#/components/schemas/VisitRoomExtended" } } }, "additionalProperties": false }, "ReadVisitParamsErrorsBadRequestErrorResponse": { "oneOf": [ { "type": "object", "properties": { "message": { "type": "string", "description": "Simple error message" } }, "required": [ "message" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "errors": { "$ref": "#/components/schemas/ReadVisitParamsErrors" }, "traceId": { "type": "string" } }, "additionalProperties": false } ] }, "ItineraryItemField": { "type": "object", "properties": { "ItineraryItemID": { "type": "integer", "format": "int32" }, "FieldID": { "type": "integer", "format": "int32" }, "DisplayText": { "type": "string" }, "DisplayOrder": { "type": "integer", "format": "int32" }, "HideFromAM": { "type": "boolean" }, "HideFieldOnRpt": { "type": "boolean" }, "QuestionTypeID": { "type": "integer", "format": "int32" }, "Usage": { "$ref": "#/components/schemas/UsageEnum" }, "IsAttendeeField": { "type": "boolean" }, "fieldValue": { "type": "string" } }, "additionalProperties": false }, "CustomerOption": { "type": "object", "properties": { "ID": { "type": "integer", "format": "int32", "nullable": true }, "Description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SiteCustomFieldDto": { "type": "object", "properties": { "FieldName": { "type": "string", "nullable": true }, "FieldLabel": { "type": "string", "nullable": true }, "FieldValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "VisitCustomerSalesChannel": { "type": "object", "properties": { "ID": { "type": "integer", "format": "int32" }, "Description": { "type": "string" } }, "additionalProperties": false }, "InternalServerErrorResponse": { "oneOf": [ { "type": "object", "properties": { "message": { "type": "string", "description": "Simple error message" } }, "required": [ "message" ], "additionalProperties": false }, { "type": "object", "properties": { "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" } }, "additionalProperties": false } ] }, "UpdateCustomerParams": { "type": "object", "properties": { "Name": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "CRMCustomerID": { "type": "string", "nullable": true }, "AccountID": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "Website": { "type": "string", "nullable": true }, "IsActive": { "type": "boolean", "nullable": true }, "Division": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "Address1": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "Address2": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "City": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "Zip": { "maxLength": 15, "minLength": 0, "type": "string", "nullable": true }, "CountryCode": { "maxLength": 2, "minLength": 0, "type": "string", "nullable": true }, "StateProvince": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "IndustryID": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "CustomerStatusID": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "CustomerOption1ID": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "CustomerOption2ID": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "CustomerOption3ID": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "SalesChannelLevel1ID": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "SalesChannelLevel2ID": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "CustomerOption4IDs": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "OpportunityUpdateManyResponse": { "type": "object", "properties": { "Opportunity": { "type": "array", "items": { "$ref": "#/components/schemas/OpportunityPrePostFlat" } }, "AvailableCategories": { "type": "array", "items": { "$ref": "#/components/schemas/OpportunityCategory" } }, "AvailableStages": { "type": "array", "items": { "$ref": "#/components/schemas/OpportunityStageInfo" } }, "AvailableSegments": { "type": "array", "items": { "$ref": "#/components/schemas/OpportunitySegment" }, "nullable": true }, "AvailablePriorities": { "type": "array", "items": { "$ref": "#/components/schemas/OpportunityPriority" }, "nullable": true }, "ValidationMessage": { "type": "string" } }, "additionalProperties": false }, "ObjectNotFoundResponse": { "type": "object", "properties": { "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Country": { "type": "object", "properties": { "CountryCode": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "VisitSpeakerExtended": { "type": "object", "properties": { "VisitID": { "type": "integer", "format": "int32" }, "VisitAgendaItemID": { "type": "integer", "format": "int32" }, "VisitSpeakerID": { "type": "integer", "format": "int32" }, "SpeakerID": { "type": "integer", "format": "int32" }, "NameOverride": { "type": "string" }, "TitleOverride": { "type": "string" }, "EmailOverride": { "type": "string" }, "ExcludeFromEval": { "type": "boolean" }, "HideFromAgenda": { "type": "boolean" }, "InviteStatusID": { "type": "integer", "format": "int32" }, "IsActive": { "type": "boolean" }, "Memo": { "type": "string" }, "SpeakerClassificationID": { "type": "integer", "format": "int32" }, "SpeakerDepartmentID": { "type": "integer", "format": "int32" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "Prefix": { "type": "string" }, "Suffix": { "type": "string" }, "JobTitle": { "type": "string" }, "Email": { "type": "string" }, "Phone1": { "type": "string" }, "Phone2": { "type": "string" }, "Address": { "type": "string" }, "City": { "type": "string" }, "Zip": { "type": "string" }, "StateProvince": { "type": "string" }, "Country": { "type": "string" }, "CountryCode": { "type": "string" }, "SpeakerClassification": { "$ref": "#/components/schemas/VisitSpeakerClassification" }, "SpeakerDepartment": { "$ref": "#/components/schemas/VisitSpeakerDepartment" }, "InviteStatus": { "$ref": "#/components/schemas/VisitSpeakerInviteStatus" } }, "additionalProperties": false }, "AgendaTopicExtended": { "type": "object", "properties": { "LanguageID": { "type": "integer", "format": "int32" }, "TopicCategoryID": { "type": "integer", "format": "int32" }, "TopicID": { "type": "integer", "format": "int32" }, "TopicName": { "type": "string" }, "TopicNotes": { "type": "string" }, "TopicAbstract": { "type": "string" }, "IsActive": { "type": "boolean" }, "DisplayOrder": { "type": "integer", "format": "int32" }, "DurationMinutes": { "type": "integer", "format": "int32" }, "AllowAM": { "type": "boolean" }, "IsRefSiteEquipment": { "type": "boolean" }, "ShowAdditionalNotes": { "type": "boolean" }, "AdditionalNotes": { "type": "string" }, "HideFromAgenda": { "type": "boolean" }, "ExcludeFromEval": { "type": "boolean" }, "TopicCategory": { "$ref": "#/components/schemas/TopicCategory" } }, "additionalProperties": false }, "VisitSurveyPacket": { "type": "object", "properties": { "ReturnCode": { "type": "integer", "format": "int32" }, "ReturnMessage": { "type": "string" }, "Name": { "type": "string" }, "IntroText": { "type": "string" }, "ClosingText": { "type": "string" }, "TitleText": { "type": "string" }, "CustomCompletedText": { "type": "string" }, "Image": { "type": "string" }, "SurveyID": { "type": "string" }, "VisitSurveyID": { "type": "string" }, "Token": { "type": "string" }, "VisitID": { "type": "string" }, "LanguageID": { "type": "integer", "format": "int32" }, "VisitAttendeeID": { "type": "string" }, "Sections": { "type": "array", "items": { "$ref": "#/components/schemas/VisitSurveySection" } } }, "additionalProperties": false }, "CreateOpportunityCRMVisitDto": { "type": "object", "properties": { "OpportunityName": { "type": "string" }, "OpportunityNumber": { "type": "string" }, "OpportunityCurrentStage": { "type": "string" }, "OpportunityRevenuePotential": { "type": "number", "format": "double" }, "OpportunitySalesRevenue": { "type": "number", "format": "double" }, "OpportunityExpectedBookingDate": { "type": "string", "format": "date-time" }, "OpportunityCategory": { "type": "string" }, "OppNote": { "type": "string" }, "OpportunitySegment": { "type": "string" }, "OpportunityPriority": { "type": "string" } }, "additionalProperties": false }, "VisitItinerary": { "type": "object", "properties": { "VisitID": { "type": "integer", "format": "int32" }, "SectionLabels": { "type": "object", "additionalProperties": { "type": "string" } }, "ItineraryItems": { "type": "array", "items": { "$ref": "#/components/schemas/ItineraryItem" } }, "AttendeeList": { "type": "array", "items": { "$ref": "#/components/schemas/ItineraryAttendee" } }, "ProviderList": { "type": "array", "items": { "$ref": "#/components/schemas/ItineraryProvider" } }, "SectionsToShow": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "additionalProperties": false }, "VisitIndustry": { "type": "object", "properties": { "Name": { "type": "string" }, "IndustryID": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AttendeeFunction": { "type": "object", "properties": { "AttendeeFunctionID": { "type": "integer", "format": "int32" }, "Title": { "type": "string" } }, "additionalProperties": false }, "StringPrePost": { "type": "object", "properties": { "Pre": { "type": "string" }, "Post": { "type": "string" } }, "additionalProperties": false }, "SalesChannelLevel1": { "type": "object", "properties": { "ID": { "type": "integer", "format": "int32" }, "IsActive": { "type": "boolean" }, "Name": { "type": "string" }, "DisplayOrder": { "type": "integer", "format": "int32" }, "SalesChannelLevel2s": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelLevel2" } } }, "additionalProperties": false }, "OpportunityStage": { "type": "object", "properties": { "ID": { "type": "integer", "format": "int32" }, "Name": { "type": "string", "nullable": true }, "IsActive": { "type": "boolean" }, "DisplayOrder": { "type": "integer", "format": "int32" }, "MemoField": { "type": "string", "nullable": true }, "ClosedStatus": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Meal": { "type": "object", "properties": { "MealID": { "type": "integer", "format": "int32" }, "MealName": { "type": "string" }, "MealNotes": { "type": "string" }, "IsActive": { "type": "boolean" }, "DisplayOrder": { "type": "integer", "format": "int32" }, "DurationMinutes": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "VisitOwner": { "type": "object", "properties": { "VisitID": { "type": "integer", "format": "int32" }, "UserID": { "type": "integer", "format": "int32" }, "UserName": { "type": "string" }, "PersonID": { "type": "integer", "format": "int32" }, "Prefix": { "type": "string" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "Suffix": { "type": "string" }, "JobTitle": { "type": "string" }, "Email": { "type": "string" }, "Phone1": { "type": "string" }, "Phone2": { "type": "string" }, "AddedByUserID": { "type": "integer", "format": "int32" }, "InviteStatusID": { "type": "integer", "format": "int32" }, "InviteStatus": { "type": "string" } }, "additionalProperties": false }, "VisitCustomerStatus": { "type": "object", "properties": { "CustomerStatusID": { "type": "integer", "format": "int32" }, "StatusName": { "type": "string" } }, "additionalProperties": false }, "VisitCoordinatorRole": { "type": "object", "properties": { "RoleID": { "type": "integer", "format": "int32" }, "Title": { "type": "string" }, "IsActive": { "type": "boolean" }, "DisplayOrder": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "OpportunityUpdateRequest": { "type": "object", "properties": { "OpportunityName": { "type": "string" }, "OpportunityID": { "type": "string" }, "CategoryName": { "type": "string" }, "StageName": { "type": "string" }, "SegmentName": { "type": "string" }, "PriorityName": { "type": "string" }, "AcctPotential": { "type": "number", "format": "double" }, "SalesRevenue": { "type": "number", "format": "double" }, "PendingCloseDate": { "type": "string" } }, "additionalProperties": false }, "AgendaClassification": { "type": "object", "properties": { "AgendaClassificationID": { "type": "integer", "format": "int32" }, "Title": { "type": "string" } }, "additionalProperties": false }, "OpportunityUpdateInvalidResponse": { "oneOf": [ { "type": "object", "properties": { "message": { "type": "string", "description": "Simple error message" } }, "required": [ "message" ], "additionalProperties": false }, { "type": "object", "required": [ "title", "status" ], "additionalProperties": false, "properties": { "title": { "type": "string", "example": "One or more validation errors occurred." }, "status": { "type": "integer", "format": "int32", "example": 400 }, "responseData": { "type": "object", "properties": { "validationMessage": { "type": "string" }, "availableCategories": { "type": "array", "items": { "$ref": "#/components/schemas/OpportunityCategory" } }, "availableStages": { "type": "array", "items": { "$ref": "#/components/schemas/OpportunityStageInfo" } } }, "additionalProperties": false } } } ] }, "Customer": { "type": "object", "properties": { "ID": { "type": "integer", "format": "int32" }, "Name": { "type": "string" }, "CRMCustomerID": { "type": "string", "nullable": true }, "AccountID": { "type": "string", "nullable": true }, "Website": { "type": "string", "nullable": true }, "IsActive": { "type": "boolean" }, "IndustryID": { "type": "integer", "format": "int32", "nullable": true }, "CustomerStatusID": { "type": "integer", "format": "int32", "nullable": true }, "Division": { "type": "string", "nullable": true }, "Address1": { "type": "string", "nullable": true }, "Address2": { "type": "string", "nullable": true }, "City": { "type": "string", "nullable": true }, "Zip": { "type": "string", "nullable": true }, "CountryCode": { "type": "string", "nullable": true }, "DateLastUpdated": { "type": "string", "format": "date-time" }, "UpdatedByUserID": { "type": "integer", "format": "int32" }, "StateProvince": { "type": "string", "nullable": true }, "CustomerOption1ID": { "type": "integer", "format": "int32", "nullable": true }, "CustomerOption2ID": { "type": "integer", "format": "int32", "nullable": true }, "CustomerOption3ID": { "type": "integer", "format": "int32", "nullable": true }, "SalesChannelLevel1ID": { "type": "integer", "format": "int32", "nullable": true }, "SalesChannelLevel2ID": { "type": "integer", "format": "int32", "nullable": true }, "Country": { "$ref": "#/components/schemas/Country", "nullable": true }, "CustomerStatus": { "$ref": "#/components/schemas/CustomerStatus", "nullable": true }, "Industry": { "$ref": "#/components/schemas/Industry", "nullable": true }, "SalesChannelLevel1": { "$ref": "#/components/schemas/CustomerSalesChannel", "nullable": true }, "SalesChannelLevel2": { "$ref": "#/components/schemas/CustomerSalesChannel", "nullable": true }, "CustomerOption1": { "$ref": "#/components/schemas/CustomerOption", "nullable": true }, "CustomerOption2": { "$ref": "#/components/schemas/CustomerOption", "nullable": true }, "CustomerOption3": { "$ref": "#/components/schemas/CustomerOption", "nullable": true }, "CustomerOption4": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerOption" }, "nullable": true }, "CustomerLogoUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PersonSearchCriteria": { "type": "object", "properties": { "Emails": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "ArrayOfPersonPacket": { "type": "array", "items": { "$ref": "#/components/schemas/PersonPacket" } }, "ProviderTypes": { "type": "string", "enum": [ "airline", "airport", "entertainment", "ground", "hotel", "custom", "restaurant" ] }, "ItineraryItem": { "type": "object", "properties": { "VisitItineraryID": { "type": "integer", "format": "int32" }, "SectionID": { "type": "integer", "format": "int32" }, "SectionName": { "type": "string" }, "ItemFields": { "type": "array", "items": { "$ref": "#/components/schemas/ItineraryItemField" } }, "Participants": { "type": "array", "items": { "$ref": "#/components/schemas/ItineraryAttendee" } }, "ItemDate": { "type": "string", "format": "date-time" }, "ProviderName": { "type": "string" }, "ProviderID": { "type": "integer", "format": "int32" }, "StartTime": { "type": "string", "format": "date-time" }, "GetStartTime": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "StringSchema": { "type": "string" }, "TopicCategory": { "type": "object", "properties": { "TopicCategoryID": { "type": "integer", "format": "int32" }, "TopicCategoryName": { "type": "string" }, "TopicCategoryNotes": { "type": "string" }, "IsActive": { "type": "boolean" }, "DisplayOrder": { "type": "integer", "format": "int32" }, "IsProductModality": { "type": "boolean" }, "AllowAM": { "type": "boolean" } }, "additionalProperties": false }, "ArrayOfLookupItem": { "type": "array", "items": { "$ref": "#/components/schemas/LookupItem" } }, "Int32NullablePrePost": { "type": "object", "properties": { "Pre": { "type": "integer", "format": "int32" }, "Post": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BadRequestErrorResponse": { "type": "object", "oneOf": [ { "type": "object", "properties": { "message": { "type": "string", "description": "Simple error message" } }, "required": [ "message" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "format": "uri", "example": "https://tools.ietf.org/html/rfc9110#section-15.5.1" }, "title": { "type": "string", "example": "One or more validation errors occurred." }, "status": { "type": "integer", "format": "int32", "example": 400 }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "traceId": { "type": "string" } }, "required": [ "type", "title", "status", "errors", "traceId" ], "additionalProperties": false } ] }, "SalesChannel": { "type": "object", "properties": { "VisitSalesChannelID": { "type": "integer", "format": "int32" }, "VisitID": { "type": "integer", "format": "int32" }, "IsPrimary": { "type": "boolean" }, "DateLastUpdated": { "type": "string", "format": "date-time" }, "UpdatedByUserID": { "type": "integer", "format": "int32" }, "UserSalesChannel1ID": { "type": "integer", "format": "int32" }, "UserSalesChannel2ID": { "type": "integer", "format": "int32" }, "UserSalesChannel1": { "$ref": "#/components/schemas/UserSalesChannel" }, "UserSalesChannel2": { "$ref": "#/components/schemas/UserSalesChannel" } }, "additionalProperties": false }, "QuestionType": { "type": "object", "properties": { "QuestionTypeID": { "type": "integer", "format": "int32" }, "TypeName": { "type": "string" } }, "additionalProperties": false }, "PaginatedResponseMetadataLinks": { "type": "object", "properties": { "Self": { "type": "string", "format": "uri" }, "Previous": { "type": "string", "format": "uri" }, "Next": { "type": "string", "format": "uri" }, "First": { "type": "string", "format": "uri" }, "Last": { "type": "string", "format": "uri" } }, "additionalProperties": false }, "VisitSurveyQuestionGroup": { "type": "object", "properties": { "ID": { "type": "integer", "format": "int32" }, "GroupByQuestion": { "type": "boolean" }, "GroupByAgenda": { "type": "boolean" }, "GroupBySpeaker": { "type": "boolean" }, "VisitHasAgendaItems": { "type": "boolean" }, "InfoText": { "type": "string" }, "DisplayOrder": { "type": "string" }, "Questions": { "type": "array", "items": { "$ref": "#/components/schemas/VisitSurveyQuestion" } } }, "additionalProperties": false }, "UpdateCustomerParamsErrorsBadRequestErrorResponse": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32" }, "errors": { "$ref": "#/components/schemas/UpdateCustomerParamsErrors" }, "traceId": { "type": "string", "nullable": true } }, "additionalProperties": false }, { "type": "object", "properties": { "title": { "type": "string", "example": "Validation failed" }, "status": { "type": "integer", "example": 400 }, "responseData": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32" }, "errors": { "$ref": "#/components/schemas/UpdateCustomerParamsErrors" }, "traceId": { "type": "string", "nullable": true } }, "additionalProperties": false } }, "additionalProperties": false } ] }, "VisitFull": { "type": "object", "properties": { "VisitID": { "type": "integer", "format": "int32" }, "VisitName": { "type": "string" }, "VisitStatusID": { "type": "integer", "format": "int32" }, "EngagementTypeID": { "type": "integer", "format": "int32" }, "SiteID": { "type": "integer", "format": "int32" }, "VisitTypeID": { "type": "integer", "format": "int32" }, "EstimatedNumberOfAttendees": { "type": "integer", "format": "int32" }, "TimezoneIndex": { "type": "string" }, "TimezoneString": { "type": "string" }, "VisitStart": { "type": "string", "format": "date-time" }, "VisitEnd": { "type": "string", "format": "date-time" }, "VisitRequestDate": { "type": "string", "format": "date-time" }, "VisitModifiedDate": { "type": "string", "format": "date-time" }, "IsConfidential": { "type": "boolean" }, "IsBusinessAttireRequired": { "type": "boolean" }, "WebinarLink": { "type": "string" }, "WebinarInstructions": { "type": "string" }, "WebinarLinkIsLocation": { "type": "boolean" }, "CRMInstanceID": { "type": "integer", "format": "int32" }, "IncompleteExpirationNotificationSentDate": { "type": "string", "format": "date-time" }, "OffsiteLocation": { "type": "string" }, "VisitPIN": { "type": "string" }, "RequesterID": { "type": "integer", "format": "int32" }, "SourceOfRequest": { "type": "string" }, "Site": { "$ref": "#/components/schemas/VisitSite" }, "Status": { "$ref": "#/components/schemas/VisitStatus" }, "VisitType": { "$ref": "#/components/schemas/VisitType" }, "EngagementType": { "$ref": "#/components/schemas/EngagementType" }, "Requester": { "$ref": "#/components/schemas/Person" }, "Coordinator": { "$ref": "#/components/schemas/VisitCoordinatorExtended" }, "Coordinators": { "type": "array", "items": { "$ref": "#/components/schemas/VisitCoordinatorExtended" } }, "Owners": { "type": "array", "items": { "$ref": "#/components/schemas/VisitOwner" } }, "VisitDays": { "type": "array", "items": { "$ref": "#/components/schemas/VisitDayExtended" } }, "Customers": { "type": "array", "items": { "$ref": "#/components/schemas/VisitCustomerExtended" } }, "Attendees": { "type": "array", "items": { "$ref": "#/components/schemas/VisitAttendee" } }, "ReasonsForVisit": { "type": "array", "items": { "$ref": "#/components/schemas/VisitQuestionExtended" } }, "ExtraInfo": { "type": "array", "items": { "$ref": "#/components/schemas/VisitQuestionExtended" } }, "Logistics": { "type": "array", "items": { "$ref": "#/components/schemas/VisitQuestionExtended" } }, "SalesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } }, "Documents": { "type": "array", "items": { "$ref": "#/components/schemas/VisitDocumentExtended" } } }, "additionalProperties": false }, "PersonPacket": { "type": "object", "properties": { "KeyEmail": { "type": "string" }, "PersonalData": { "$ref": "#/components/schemas/PersonalData" }, "ReturnCode": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CustomerStatus": { "type": "object", "properties": { "CustomerStatusID": { "type": "integer", "format": "int32", "nullable": true }, "StatusName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PersonPartialUpdateRequest": { "type": "object", "properties": { "FirstName": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "LastName": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "NameOnID": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "Prefix": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "Suffix": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "Gender": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "JobTitle": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "DateOfBirth": { "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "nullable": true }, "Phone1": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "Phone2": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "Address": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "City": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "StateProvince": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "PostalCode": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "Country": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "CompanyName": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "CorporateID": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "HomeSiteID": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "UserRole": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "Biography": { "type": "string", "nullable": true }, "IsActive": { "type": "string", "nullable": true }, "IsUser": { "type": "string", "nullable": true }, "IsSpeaker": { "type": "string", "nullable": true }, "ContactType": { "type": "string", "nullable": true }, "BusinessGroup": { "type": "string", "nullable": true }, "BusinessUnit": { "type": "string", "nullable": true }, "Level1BusinessGroup": { "type": "string", "nullable": true }, "Level2BusinessUnit": { "type": "string", "nullable": true } }, "additionalProperties": false }, "VisitSurveyQuestion": { "type": "object", "properties": { "QuestionType": { "type": "integer", "format": "int32" }, "ID": { "type": "integer", "format": "int32" }, "QuestionID": { "type": "integer", "format": "int32" }, "VisitID": { "type": "integer", "format": "int32" }, "VisitAgendaID": { "type": "string" }, "AgendaItemName": { "type": "string" }, "VisitSpeakerID": { "type": "string" }, "SpeakerName": { "type": "string" }, "QuestionText": { "type": "string" }, "DisplayOrder": { "type": "string" }, "VisitAgenaItemTime": { "type": "string", "format": "date-time" }, "DateLastUpdated": { "type": "string", "format": "date-time" }, "ResponseInt": { "type": "string" }, "ResponseString": { "type": "string" }, "AvailableResponses": { "type": "array", "items": { "$ref": "#/components/schemas/LookupItem" } }, "SelectedResponses": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "AgendaItemNameWithSpeaker": { "type": "string" }, "RatingMin": { "type": "integer", "format": "int32" }, "RatingMax": { "type": "integer", "format": "int32" }, "RatingIncr": { "type": "integer", "format": "int32" }, "RatingMinTxt": { "type": "string" }, "RatingMaxTxt": { "type": "string" }, "PickListMax": { "type": "integer", "format": "int32" }, "IncludeNA": { "type": "boolean" }, "TextforNA": { "type": "string" } }, "additionalProperties": false }, "Person": { "type": "object", "properties": { "UserID": { "type": "integer", "format": "int32" }, "PersonID": { "type": "integer", "format": "int32" }, "Email": { "type": "string" }, "FirstName": { "type": "string" }, "JobTitle": { "type": "string" }, "LastName": { "type": "string" }, "Phone1": { "type": "string" }, "Phone2": { "type": "string" }, "Prefix": { "type": "string" }, "Suffix": { "type": "string" } }, "additionalProperties": false }, "VisitCustomerOption": { "type": "object", "properties": { "Title": { "type": "string" }, "OptionID": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "OpportunityStageInfo": { "type": "object", "properties": { "StageID": { "type": "integer", "format": "int32" }, "StageName": { "type": "string" } }, "additionalProperties": false }, "ItineraryAttendee": { "type": "object", "properties": { "VisitItineraryItemID": { "type": "integer", "format": "int32" }, "AttendeeID": { "type": "integer", "format": "int32" }, "CustomerID": { "type": "integer", "format": "int32" }, "CompanyName": { "type": "string" }, "FName": { "type": "string" }, "LName": { "type": "string" }, "isInternal": { "type": "boolean" }, "AttendeeSpecificFields": { "type": "array", "items": { "$ref": "#/components/schemas/ItineraryItemField" } }, "isLeadContact": { "type": "boolean" }, "Phone": { "type": "string" }, "DisplayOrder": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "VisitDocumentExtended": { "type": "object", "properties": { "ID": { "type": "integer", "format": "int32" }, "VisitID": { "type": "integer", "format": "int32" }, "DocumentID": { "type": "integer", "format": "int32" }, "Name": { "type": "string" }, "DateLastUpdated": { "type": "string", "format": "date-time" }, "UpdatedByUserID": { "type": "integer", "format": "int32" }, "DownloadPath": { "type": "string" }, "DownloadUrl": { "type": "string" } }, "additionalProperties": false }, "LookupItem": { "type": "object", "properties": { "ID": { "type": "integer", "format": "int32" }, "DisplayText": { "type": "string" }, "IsActive": { "type": "boolean" }, "DisplayOrder": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "OpportunityCreateRequest": { "type": "object", "properties": { "visitID": { "type": "integer", "format": "int32" }, "CustomerId": { "type": "integer", "format": "int32" }, "OpportunityName": { "type": "string" }, "OpportunityID": { "type": "string" }, "CategoryName": { "type": "string" }, "SegmentName": { "type": "string" }, "PriorityName": { "type": "string" }, "StageName": { "type": "string" }, "AcctPotential": { "type": "number", "format": "double" }, "SalesRevenue": { "type": "number", "format": "double" }, "PendingCloseDate": { "type": "string" }, "OpportunityType": { "$ref": "#/components/schemas/OpportunityType" } }, "additionalProperties": false }, "OpportunityCreateInvalidResponse": { "oneOf": [ { "type": "object", "properties": { "message": { "type": "string", "description": "Simple error message" } }, "required": [ "message" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "format": "uri", "example": "https://tools.ietf.org/html/rfc9110#section-15.5.1" }, "title": { "type": "string", "example": "One or more validation errors occurred." }, "status": { "type": "integer", "format": "int32", "example": 400 }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "traceId": { "type": "string" } }, "required": [ "type", "title", "status", "errors", "traceId" ], "additionalProperties": false }, { "type": "object", "required": [ "title", "status" ], "additionalProperties": false, "properties": { "title": { "type": "string", "example": "One or more validation errors occurred." }, "status": { "type": "integer", "format": "int32", "example": 400 }, "responseData": { "type": "object", "properties": { "validationMessage": { "type": "string" }, "availableCategories": { "type": "array", "items": { "$ref": "#/components/schemas/OpportunityCategory" } }, "availableStages": { "type": "array", "items": { "$ref": "#/components/schemas/OpportunityStageInfo" } } }, "additionalProperties": false } } } ] }, "VisitResponseChoice": { "type": "object", "properties": { "ID": { "type": "integer", "format": "int32" }, "VisitID": { "type": "integer", "format": "int32" }, "QuestionID": { "type": "integer", "format": "int32" }, "CustomerID": { "type": "integer", "format": "int32" }, "QuestionResponseID": { "type": "integer", "format": "int32" }, "DisplayText": { "type": "string" }, "DisplayTextID": { "type": "integer", "format": "int32" }, "NotesText": { "type": "string" }, "NotesTextID": { "type": "integer", "format": "int32" }, "isSelectedByVisit": { "type": "boolean" }, "DisplayOrder": { "type": "integer", "format": "int32" }, "DateLastUpdated": { "type": "string", "format": "date-time" }, "UpdatedByUserID": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "VisitAttendee": { "type": "object", "properties": { "VisitAttendeeID": { "type": "integer", "format": "int32" }, "AttendeeRoleID": { "type": "integer", "format": "int32" }, "SurveyURL": { "type": "string" }, "IsInternalAttendee": { "type": "boolean" }, "VisitID": { "type": "integer", "format": "int32" }, "PersonID": { "type": "integer", "format": "int32" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "Prefix": { "type": "string" }, "Suffix": { "type": "string" }, "GenderID": { "type": "integer", "format": "int32" }, "Email": { "type": "string" }, "JobTitle": { "type": "string" }, "Phone": { "type": "string" }, "DisplayOrder": { "type": "integer", "format": "int32" }, "CompanyNameOverride": { "type": "string" }, "SendSurvey": { "type": "boolean" }, "SurveyWasSent": { "type": "boolean" }, "SurveyReceived": { "type": "boolean" }, "Attendee_Flagged": { "type": "boolean" }, "Notes": { "type": "string" }, "AttendeeFunctionID": { "type": "integer", "format": "int32" }, "InternalFlag": { "type": "boolean" }, "IsItineraryLeadContact": { "type": "boolean" }, "InviteStatusID": { "type": "integer", "format": "int32" }, "IsKeyContact": { "type": "boolean" }, "CustomerID": { "type": "integer", "format": "int32" }, "Country": { "type": "string" }, "CountryCode": { "type": "string" }, "CountryPhoneCode": { "type": "string" }, "NameOnDriverLicense": { "type": "string" }, "InviteStatus": { "$ref": "#/components/schemas/VisitAttendeeInviteStatus" }, "Gender": { "$ref": "#/components/schemas/Gender" }, "Role": { "$ref": "#/components/schemas/VisitAttendeeRole" }, "Function": { "$ref": "#/components/schemas/AttendeeFunction" } }, "additionalProperties": false }, "CustomerLogo": { "type": "object", "properties": { "CustomerID": { "type": "integer", "format": "int32" }, "Name": { "type": "string" }, "AccountID": { "type": "string" }, "FileType": { "type": "string" }, "S3Path": { "type": "string" }, "Logo": { "type": "string" }, "LogoUrl": { "type": "string" }, "LogoPreviewUrl": { "type": "string" }, "UpdatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "VisitRoomExtended": { "type": "object", "properties": { "VisitID": { "type": "integer", "format": "int32" }, "VisitDayID": { "type": "integer", "format": "int32" }, "VisitRoomID": { "type": "integer", "format": "int32" }, "RoomID": { "type": "integer", "format": "int32" }, "RoomName": { "type": "string" }, "RoomStart": { "type": "string", "format": "date-time" }, "RoomEnd": { "type": "string", "format": "date-time" }, "StartDate": { "type": "string", "format": "date-time" }, "StartMin": { "type": "integer", "format": "int32" }, "EndMin": { "type": "integer", "format": "int32" }, "Occupancy": { "type": "integer", "format": "int32" }, "DisplayOrder": { "type": "integer", "format": "int32" }, "RoomStartBufferMins": { "type": "integer", "format": "int32" }, "RoomEndBufferMins": { "type": "integer", "format": "int32" }, "AgendaItems": { "type": "array", "items": { "$ref": "#/components/schemas/AgendaItemExtended" } } }, "additionalProperties": false }, "VisitSpeakerDepartment": { "type": "object", "properties": { "VisitSpeakerDepartmentID": { "type": "integer", "format": "int32" }, "Title": { "type": "string" } }, "additionalProperties": false }, "VisitSurveyQuestionResponse": { "type": "object", "properties": { "ReturnCode": { "type": "integer", "format": "int32", "nullable": true }, "ReturnMessage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserSalesChannel": { "type": "object", "properties": { "ID": { "type": "integer", "format": "int32" }, "Descriptoin": { "type": "string" }, "DisplayOrder": { "type": "integer", "format": "int32" }, "IsActive": { "type": "boolean" } }, "additionalProperties": false }, "ArrayOfCustomerLogo": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerLogo" } }, "VisitSurveyQuestionRequest": { "type": "object", "properties": { "ResponseInt": { "type": "string", "nullable": true }, "ResponseString": { "type": "string", "nullable": true }, "SelectedResponses": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "VisitExtended": { "type": "object", "properties": { "VisitID": { "type": "integer", "format": "int32" }, "VisitName": { "type": "string" }, "VisitStatusID": { "type": "integer", "format": "int32" }, "EngagementTypeID": { "type": "integer", "format": "int32" }, "SiteID": { "type": "integer", "format": "int32" }, "VisitTypeID": { "type": "integer", "format": "int32" }, "EstimatedNumberOfAttendees": { "type": "integer", "format": "int32" }, "TimezoneIndex": { "type": "string" }, "TimezoneString": { "type": "string" }, "VisitStart": { "type": "string", "format": "date-time" }, "VisitEnd": { "type": "string", "format": "date-time" }, "VisitRequestDate": { "type": "string", "format": "date-time" }, "VisitModifiedDate": { "type": "string", "format": "date-time" }, "IsConfidential": { "type": "boolean" }, "IsBusinessAttireRequired": { "type": "boolean" }, "WebinarLink": { "type": "string" }, "WebinarInstructions": { "type": "string" }, "WebinarLinkIsLocation": { "type": "boolean" }, "CRMInstanceID": { "type": "integer", "format": "int32" }, "IncompleteExpirationNotificationSentDate": { "type": "string", "format": "date-time" }, "OffsiteLocation": { "type": "string" }, "VisitPIN": { "type": "string" }, "RequesterID": { "type": "integer", "format": "int32" }, "SourceOfRequest": { "type": "string" }, "Site": { "$ref": "#/components/schemas/VisitSite" }, "Status": { "$ref": "#/components/schemas/VisitStatus" }, "VisitType": { "$ref": "#/components/schemas/VisitType" }, "EngagementType": { "$ref": "#/components/schemas/EngagementType" } }, "additionalProperties": false }, "EngagementType": { "type": "object", "properties": { "EngagementTypeID": { "type": "integer", "format": "int32" }, "EngagementTypeName": { "type": "string" }, "IsActive": { "type": "boolean" }, "DisplayOrder": { "type": "integer", "format": "int32" }, "Notes": { "type": "string" } }, "additionalProperties": false }, "Topic": { "type": "object", "properties": { "TopicID": { "type": "integer", "format": "int32" }, "TopicName": { "type": "string" }, "IsActive": { "type": "boolean" }, "CategoryID": { "type": "integer", "format": "int32" }, "CategoryName": { "type": "string" }, "IsActiveCategory": { "type": "boolean" }, "DisplayOrder": { "type": "integer", "format": "int32" }, "DurationMinutes": { "type": "integer", "format": "int32" }, "ExcludeFromEval": { "type": "boolean" }, "HideFromAgenda": { "type": "boolean" }, "ShowAdditionalNotes": { "type": "boolean" }, "Notes": { "type": "string" }, "AdditionalNotes": { "type": "string" }, "TopicAbstract": { "type": "string" } }, "additionalProperties": false }, "OpportunitySegment": { "type": "object", "properties": { "SegmentID": { "type": "integer", "format": "int32", "nullable": true }, "SegmentName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "VisitSurveySection": { "type": "object", "properties": { "SectionText": { "type": "string" }, "DisplayOrder": { "type": "string" }, "QuestionGroups": { "type": "array", "items": { "$ref": "#/components/schemas/VisitSurveyQuestionGroup" } } }, "additionalProperties": false }, "ArrayOfIndustry": { "type": "array", "items": { "$ref": "#/components/schemas/Industry" } }, "OpportunityType": { "type": "string", "enum": [ "Pre", "Post" ] }, "SalesChannelLevel2": { "type": "object", "properties": { "ID": { "type": "integer", "format": "int32" }, "IsActive": { "type": "boolean" }, "Name": { "type": "string" }, "DisplayOrder": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ReadVisitParamsErrors": { "type": "object", "properties": { "visitID": { "type": "array", "items": { "type": "string" } }, "LanguageId": { "type": "array", "items": { "type": "string" } }, "IncludeSite": { "type": "array", "items": { "type": "string" } }, "IncludeEngagementType": { "type": "array", "items": { "type": "string" } }, "IncludeVisitStatus": { "type": "array", "items": { "type": "string" } }, "IncludeVisitType": { "type": "array", "items": { "type": "string" } }, "IncludeCoordinators": { "type": "array", "items": { "type": "string" } }, "IncludeCoordinatorRoles": { "type": "array", "items": { "type": "string" } }, "IncludeRequester": { "type": "array", "items": { "type": "string" } }, "IncludeOwners": { "type": "array", "items": { "type": "string" } }, "IncludeSalesChannels": { "type": "array", "items": { "type": "string" } }, "IncludeVisitDays": { "type": "array", "items": { "type": "string" } }, "IncludeVisitRooms": { "type": "array", "items": { "type": "string" } }, "IcludeAgendaItems": { "type": "array", "items": { "type": "string" } }, "IncludeTopics": { "type": "array", "items": { "type": "string" } }, "IncludeMeals": { "type": "array", "items": { "type": "string" } }, "IncludeTopicCategories": { "type": "array", "items": { "type": "string" } }, "IncludeSpeakers": { "type": "array", "items": { "type": "string" } }, "IncludeAttendees": { "type": "array", "items": { "type": "string" } }, "IncludeCustomers": { "type": "array", "items": { "type": "string" } }, "IncludeOpportunities": { "type": "array", "items": { "type": "string" } }, "IncludeCustomerQuestions": { "type": "array", "items": { "type": "string" } }, "IncludeReasons": { "type": "array", "items": { "type": "string" } }, "IncludeLogistics": { "type": "array", "items": { "type": "string" } }, "IncludeExtraInfo": { "type": "array", "items": { "type": "string" } }, "IncludeDocuments": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "OpportunityPrePostVisitCustomer": { "type": "object", "properties": { "PreID": { "type": "integer", "format": "int32" }, "PostID": { "type": "integer", "format": "int32" }, "VisitID": { "type": "integer", "format": "int32" }, "CustomerID": { "type": "integer", "format": "int32" }, "Name": { "$ref": "#/components/schemas/StringPrePost" }, "OpportunityID": { "$ref": "#/components/schemas/StringPrePost" }, "Stage": { "$ref": "#/components/schemas/OpportunityPrePost" }, "Category": { "$ref": "#/components/schemas/OpportunityPrePost" }, "Competitor": { "$ref": "#/components/schemas/OpportunityPrePost" }, "AcctPotential": { "$ref": "#/components/schemas/DecimalNullablePrePost" }, "SalesRevenue": { "$ref": "#/components/schemas/DecimalNullablePrePost" }, "PendingCloseDate": { "$ref": "#/components/schemas/StringPrePost" }, "FollowUpSentDate": { "type": "string" } }, "additionalProperties": false }, "Industry": { "type": "object", "properties": { "ID": { "type": "integer", "format": "int32" }, "Name": { "type": "string", "nullable": true }, "IsActive": { "type": "boolean" }, "DisplayOrder": { "type": "integer", "format": "int32" }, "Memo": { "type": "string", "nullable": true }, "BackgroundColor": { "type": "string", "nullable": true }, "ForegroundColor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "VisitStatus": { "type": "object", "properties": { "StatusID": { "type": "integer", "format": "int32" }, "IsActive": { "type": "boolean" }, "Name": { "type": "string" } }, "additionalProperties": false }, "CreateCRMVisitDto": { "type": "object", "properties": { "RequesterID": { "type": "string" }, "RequesterFederationID": { "type": "string" }, "RequesterFirstName": { "type": "string" }, "RequesterLastName": { "type": "string" }, "RequesterEmailAddress": { "type": "string", "format": "email" }, "OpportunityOwnerID": { "type": "string" }, "OpportunityOwnerFirstName": { "type": "string" }, "OpportunityOwnerLastName": { "type": "string" }, "OpportunityOwnerFederationID": { "type": "string" }, "OpportunityOwnerEmailAddress": { "type": "string", "format": "email" }, "Opportunities": { "type": "array", "items": { "$ref": "#/components/schemas/CreateOpportunityCRMVisitDto" } }, "Attendees": { "type": "array", "items": { "$ref": "#/components/schemas/CreateAttendeeCRMVisitDto" } }, "AccountSalesChannelLevel1": { "type": "string" }, "AccountSalesChannelLevel2": { "type": "string" }, "AccountID": { "type": "string" }, "AccountName": { "type": "string" }, "AccountAddressLine1": { "type": "string" }, "AccountAddressLine2": { "type": "string" }, "AccountCity": { "type": "string" }, "AccountState": { "type": "string" }, "AccountProvince": { "type": "string" }, "AccountPostalCode": { "type": "string" }, "AccountCountry": { "type": "string" }, "AccountIndustry": { "type": "string" }, "AccountContactName": { "type": "string" }, "AccountContactTitle": { "type": "string" }, "AccountContactPhone": { "type": "string" }, "AccountContactEmail": { "type": "string", "format": "email" }, "AccountWebsiteURL": { "type": "string" }, "OpportunityPartnerName": { "type": "string" }, "OpportunityPartnerProgramLevel": { "type": "string" }, "OpportunityPartnerContactName": { "type": "string" }, "OpportunityPartnerContactPhone": { "type": "string" }, "OpportunityPartnerContactEmail": { "type": "string", "format": "email" }, "OrgID": { "type": "string" }, "AccountNote1": { "type": "string" }, "AccountNote2": { "type": "string" }, "AccountNote3": { "type": "string" }, "AccountNote4": { "type": "string" }, "AccountIdent": { "type": "string" }, "AccountStatus": { "type": "string" }, "AccountPicklist1": { "type": "string" }, "AccountPicklist2": { "type": "string" }, "AccountPicklist3": { "type": "string" }, "AccountTextField": { "type": "string" }, "NDA": { "type": "string" }, "ParentAccountName": { "type": "string" }, "ParentAccountID": { "type": "string" }, "OrganizationID": { "type": "string" }, "PartnerID": { "type": "string" }, "AnnualRevenue": { "type": "number", "format": "double", "nullable": true } }, "required": [ "RequesterID", "RequesterFirstName", "RequesterLastName", "RequesterEmailAddress", "AccountID", "AccountName", "OrgID" ], "additionalProperties": false }, "VisitQuestionExtended": { "type": "object", "properties": { "QuestionID": { "type": "integer", "format": "int32" }, "QuestionTypeID": { "type": "integer", "format": "int32" }, "SiteID": { "type": "integer", "format": "int32" }, "TypeVisitID": { "type": "integer", "format": "int32" }, "DisplayOrder": { "type": "integer", "format": "int32" }, "IsActive": { "type": "boolean" }, "IsRequired": { "type": "boolean" }, "QuestionContextID": { "type": "integer", "format": "int32" }, "QuestionText": { "type": "string" }, "QuestionAbbrText": { "type": "string" }, "QuestionType": { "$ref": "#/components/schemas/QuestionType" }, "ResponseChoice": { "$ref": "#/components/schemas/VisitResponseChoice" }, "ResponseMultiChoice": { "type": "array", "items": { "$ref": "#/components/schemas/VisitResponseChoice" } }, "QuestionReply": { "$ref": "#/components/schemas/VisitQuestionReply" } }, "additionalProperties": false }, "OpportunityPriority": { "type": "object", "properties": { "PriorityID": { "type": "integer", "format": "int32", "nullable": true }, "PriorityName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PersonalData": { "type": "object", "properties": { "ID": { "type": "integer", "format": "int32" }, "ContactTypeID": { "type": "integer", "format": "int32" }, "BusinessGroup": { "type": "string" }, "BusinessUnit": { "type": "string" }, "Level1BusinessGroup": { "type": "string" }, "Level2BusinessUnit": { "type": "string" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "NameOnID": { "type": "string" }, "Prefix": { "type": "string" }, "Suffix": { "type": "string" }, "Gender": { "type": "string" }, "Email": { "type": "string" }, "JobTitle": { "type": "string" }, "DateOfBirth": { "type": "string" }, "Phone1": { "type": "string" }, "Phone2": { "type": "string" }, "Address": { "type": "string" }, "City": { "type": "string" }, "StateProvince": { "type": "string" }, "PostalCode": { "type": "string" }, "Country": { "type": "string" }, "CompanyName": { "type": "string" }, "CorporateID": { "type": "string" }, "HomeSiteID": { "type": "string" }, "UserRole": { "type": "string" }, "Biography": { "type": "string" }, "ProfilePicture": { "type": "string" }, "ProfilePictureUrl": { "type": "string" }, "ProfilePicturePreviewUrl": { "type": "string" }, "IsActive": { "type": "string" }, "IsUser": { "type": "string" }, "IsSpeaker": { "type": "string" }, "IsExternal": { "type": "string" } }, "additionalProperties": false }, "DecimalNullablePrePost": { "type": "object", "properties": { "Pre": { "type": "number", "format": "double" }, "Post": { "type": "number", "format": "double" } }, "additionalProperties": false }, "OpportunityPrePostFlat": { "type": "object", "properties": { "ID": { "type": "integer", "format": "int32" }, "VisitID": { "type": "integer", "format": "int32" }, "CustomerID": { "type": "integer", "format": "int32" }, "OpportunityName": { "type": "string" }, "OpportunityID": { "type": "string" }, "OpportunityCategoryID": { "type": "integer", "format": "int32" }, "OpportunityStageID": { "type": "integer", "format": "int32" }, "OpportunityCompetitorID": { "type": "integer", "format": "int32" }, "OpportunitySegmentID": { "type": "integer", "format": "int32" }, "OpportunityPriorityID": { "type": "integer", "format": "int32" }, "AcctPotential": { "type": "number", "format": "double" }, "SalesRevenue": { "type": "number", "format": "double" }, "PendingCloseDate": { "type": "string" }, "Type": { "$ref": "#/components/schemas/OpportunityType" }, "VisitCustomerOpportunityID": { "type": "integer", "format": "int32" }, "FollowUpSentDate": { "type": "string" } }, "additionalProperties": false }, "VisitAttendeeRole": { "type": "object", "properties": { "AttendeeRoleID": { "type": "integer", "format": "int32" }, "Title": { "type": "string" } }, "additionalProperties": false }, "VisitSite": { "type": "object", "properties": { "SiteID": { "type": "integer", "format": "int32" }, "SiteName": { "type": "string" }, "ContactInfo": { "type": "string" }, "MaxVisitsPerDay": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "DateLastUpdated": { "type": "string", "format": "date-time" }, "DateFormat": { "type": "string" }, "TimeFormat": { "type": "integer", "format": "int32" }, "MinimumVisitLength": { "type": "number", "format": "double" }, "MaximumVisitLength": { "type": "number", "format": "double" }, "SiteAddress": { "type": "string" }, "ProgramName": { "type": "string" }, "SiteCity": { "type": "string" }, "SiteStateProvince": { "type": "string" }, "SiteCountry": { "type": "string" }, "SitePostalCode": { "type": "string" }, "SiteRegionID": { "type": "integer", "format": "int32" }, "SiteType": { "type": "string" }, "TourSite": { "type": "integer", "format": "int32" }, "Description": { "type": "string" }, "BusinessUnitID": { "type": "integer", "format": "int32" }, "SiteNameAbbr": { "type": "string" }, "AllowWeekendVisits": { "type": "boolean" }, "AllowAMFullTopicsPage": { "type": "boolean" }, "ContractExpireDate": { "type": "string", "format": "date-time" }, "MinVisitStart": { "type": "string" }, "MaxVisitEnd": { "type": "string" }, "TimeZoneIndex": { "type": "string" }, "TimeZoneName": { "type": "string" }, "CustomerPortal_SiteName": { "type": "string" }, "Notes": { "type": "string" }, "RegionName": { "type": "string" } }, "additionalProperties": false }, "VisitExtendedPaginatedResponse": { "type": "object", "properties": { "Records": { "type": "array", "items": { "$ref": "#/components/schemas/VisitExtended" } }, "Metadata": { "$ref": "#/components/schemas/PaginatedResponseMetadata" } }, "additionalProperties": false }, "VisitSpeakerClassification": { "type": "object", "properties": { "VisitSpeakerClassificationID": { "type": "integer", "format": "int32" }, "Title": { "type": "string" } }, "additionalProperties": false }, "OpportunityUpdateManyRequest": { "type": "object", "properties": { "SearchCriteria": { "$ref": "#/components/schemas/OpportunitySearchCriteria" }, "UpdateRequest": { "$ref": "#/components/schemas/OpportunityUpdateRequest" } }, "additionalProperties": false }, "ArrayOfSalesChannelLevel1": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelLevel1" } }, "VisitCustomerOpportunity": { "type": "object", "properties": { "VisitID": { "type": "integer", "format": "int32" }, "VisitCustomerOpportunityID": { "type": "integer", "format": "int32" }, "CustomerID": { "type": "integer", "format": "int32" }, "CustomerName": { "type": "string" }, "OpportunityName": { "type": "string" }, "OpportunityID": { "type": "string" }, "OpportunityCategoryID": { "type": "integer", "format": "int32" }, "OpportunityStageID": { "type": "integer", "format": "int32" }, "OpportunityCompetitorID": { "type": "integer", "format": "int32" }, "AcctPotential": { "type": "number", "format": "double" }, "SalesRevenue": { "type": "number", "format": "double" }, "PendingCloseDate": { "type": "string", "format": "date-time" }, "OpportunityCategory": { "$ref": "#/components/schemas/OpportunityCategory" }, "OpportunityCompetitor": { "$ref": "#/components/schemas/OpportunityCompetitor" }, "OpportunityStage": { "$ref": "#/components/schemas/OpportunityStageInfo" } }, "additionalProperties": false }, "UsageEnum": { "type": "string", "enum": [ "Removed", "Optional", "BERequired", "ClientRequired" ] }, "VisitCustomerExtended": { "type": "object", "properties": { "VisitID": { "type": "integer", "format": "int32" }, "CustomerID": { "type": "integer", "format": "int32" }, "CustomerName": { "type": "string" }, "AccountID": { "type": "string" }, "CustomerStatusID": { "type": "integer", "format": "int32" }, "Division": { "type": "string" }, "Address1": { "type": "string" }, "Address2": { "type": "string" }, "City": { "type": "string" }, "StateProvince": { "type": "string" }, "Zip": { "type": "string" }, "Country": { "type": "string" }, "CountryCode": { "type": "string" }, "CRMID": { "type": "string" }, "IndustryID": { "type": "integer", "format": "int32" }, "CustomerOption1ID": { "type": "integer", "format": "int32" }, "CustomerOption2ID": { "type": "integer", "format": "int32" }, "CustomerOption3ID": { "type": "integer", "format": "int32" }, "SalesChannelLevel1ID": { "type": "integer", "format": "int32" }, "SalesChannelLevel2ID": { "type": "integer", "format": "int32" }, "SignedNDA": { "type": "boolean" }, "Website": { "type": "string" }, "CustomerStatus": { "$ref": "#/components/schemas/VisitCustomerStatus" }, "Industry": { "$ref": "#/components/schemas/VisitIndustry" }, "SalesChannelLevel1": { "$ref": "#/components/schemas/VisitCustomerSalesChannel" }, "SalesChannelLevel2": { "$ref": "#/components/schemas/VisitCustomerSalesChannel" }, "Option1": { "$ref": "#/components/schemas/VisitCustomerOption" }, "Option2": { "$ref": "#/components/schemas/VisitCustomerOption" }, "Option3": { "$ref": "#/components/schemas/VisitCustomerOption" }, "Opportunities": { "type": "array", "items": { "$ref": "#/components/schemas/VisitCustomerOpportunity" } }, "OpportunitiesPrePost": { "type": "array", "items": { "$ref": "#/components/schemas/OpportunityPrePostVisitCustomer" } }, "Questions": { "type": "array", "items": { "$ref": "#/components/schemas/VisitQuestionExtended" } } }, "additionalProperties": false }, "AgendaItemExtended": { "type": "object", "properties": { "VisitID": { "type": "integer", "format": "int32" }, "VisitAgendaItemID": { "type": "integer", "format": "int32" }, "VisitRoomID": { "type": "integer", "format": "int32" }, "RoomNameOverride": { "type": "string" }, "RoomName": { "type": "string" }, "AgendaItemStart": { "type": "string", "format": "date-time" }, "AgendaItemEnd": { "type": "string", "format": "date-time" }, "StartDate": { "type": "string", "format": "date-time" }, "StartMin": { "type": "integer", "format": "int32" }, "EndMin": { "type": "integer", "format": "int32" }, "AgendaClassificationID": { "type": "integer", "format": "int32" }, "AgendaClassification": { "$ref": "#/components/schemas/AgendaClassification" }, "IncludeOnRpt": { "type": "boolean" }, "ExcludeFromEval": { "type": "boolean" }, "HideFromAgenda": { "type": "boolean" }, "AgendaDisplayOverride": { "type": "string" }, "AbstractOverride": { "type": "string" }, "Notes": { "type": "string" }, "TopicID": { "type": "integer", "format": "int32" }, "MealID": { "type": "integer", "format": "int32" }, "Topic": { "$ref": "#/components/schemas/AgendaTopicExtended" }, "Meal": { "$ref": "#/components/schemas/Meal" }, "Speakers": { "type": "array", "items": { "$ref": "#/components/schemas/VisitSpeakerExtended" } } }, "additionalProperties": false }, "Site": { "type": "object", "properties": { "ContactInfo": { "type": "string", "nullable": true }, "MaxVisitsPerDay": { "type": "integer", "format": "int32", "nullable": true }, "DateFormat": { "type": "string", "nullable": true }, "MinimumVisitLength": { "type": "number", "format": "double" }, "MaximumVisitLength": { "type": "number", "format": "double" }, "COORD_ConfirmationEmails": { "type": "boolean" }, "COORD_RescheduleEmails": { "type": "boolean" }, "HOST_ConfirmationEmails": { "type": "boolean" }, "HOST_RescheduleEMails": { "type": "boolean" }, "COORD_SpeakerResponseCC": { "type": "integer", "format": "int32" }, "SiteAddress": { "type": "string", "nullable": true }, "ProgramName": { "type": "string", "nullable": true }, "City": { "type": "string", "nullable": true }, "StateProvince": { "type": "string", "nullable": true }, "Country": { "type": "string", "nullable": true }, "COORD_CCReminder": { "type": "integer", "format": "int32", "nullable": true }, "NotifyCoord_EachAppResponse": { "type": "integer", "format": "int32" }, "PostalCode": { "type": "string", "nullable": true }, "Host_SpeakerResponseCC": { "type": "integer", "format": "int32" }, "EncryptCCNumber": { "type": "integer", "format": "int32" }, "SiteRegionID": { "type": "integer", "format": "int32", "nullable": true }, "SiteType": { "type": "string", "nullable": true }, "AllowAnonSurveys": { "type": "boolean" }, "SalesTracking_LastUpdated_Auto": { "type": "string", "format": "date-time" }, "TourSite": { "type": "integer", "format": "int32" }, "Description": { "type": "string", "nullable": true }, "BusinessUnitID": { "type": "integer", "format": "int32", "nullable": true }, "AMCanAccessSite": { "type": "boolean" }, "LobbyMonitorRefreshSeconds": { "type": "integer", "format": "int32", "nullable": true }, "LobbyMonitorMaxVisitsPerPg": { "type": "integer", "format": "int32", "nullable": true }, "LogisticsNotificationEmailAddress": { "type": "string", "nullable": true }, "SiteName_Abbr": { "type": "string", "nullable": true }, "AllowWeekendVisits": { "type": "boolean" }, "AllowAMFullTopicsPage": { "type": "boolean" }, "AgendaTemplateID": { "type": "integer", "format": "int32", "nullable": true }, "PromptForAgendaTemplate": { "type": "boolean" }, "ContractExpireDate": { "type": "string", "format": "date-time", "nullable": true }, "MinVisitStart": { "type": "string", "nullable": true }, "MaxVisitEnd": { "type": "string", "nullable": true }, "UseWeekendsByDefault": { "type": "boolean" }, "DefVisitStart": { "type": "string", "nullable": true }, "DisplayOrder": { "type": "integer", "format": "int32" }, "SiteNotes": { "type": "integer", "format": "int32" }, "TimeZoneIndex": { "type": "string", "nullable": true }, "COORD_AcknowledgementEmails": { "type": "boolean" }, "HOST_AcknowledgementEmails": { "type": "boolean" }, "LanguageID": { "type": "integer", "format": "int32" }, "AllowAMAddOwners": { "type": "boolean" }, "COORD_SendInviteAtConfirmation": { "type": "boolean" }, "HOST_SendInviteAtConfirmation": { "type": "boolean" }, "OWNER_SendInviteAtConfirmation": { "type": "boolean" }, "OWNER_RescheduleEmails": { "type": "boolean" }, "OWNER_AcknowledgementEmails": { "type": "boolean" }, "OWNER_ConfirmationEmails": { "type": "boolean" }, "OWNER_StatusChangeEMails": { "type": "boolean" }, "OWNER_ApprovalResponsesCC": { "type": "boolean" }, "OWNER_CancellationReminderEmails": { "type": "boolean" }, "NameTentTemplateID": { "type": "integer", "format": "int32" }, "PromptForNameTentTemplate": { "type": "boolean" }, "ItineraryTemplateID": { "type": "integer", "format": "int32", "nullable": true }, "BadgeTemplateID": { "type": "integer", "format": "int32", "nullable": true }, "CustomerPortal_SiteName": { "type": "string", "nullable": true }, "FollowUpOnOpps": { "type": "boolean" }, "FollowUpWaitDays": { "type": "integer", "format": "int32", "nullable": true }, "AllowAMCopyVisits": { "type": "boolean" }, "ReplyToEmailAddresses": { "type": "string", "nullable": true }, "PictureS3Path": { "type": "string", "nullable": true }, "FollowUpOnNoOpps": { "type": "boolean" }, "UsesNexusPortal": { "type": "boolean" }, "InviteRoomsOnConfirm": { "type": "boolean" }, "SiteCustomFields": { "type": "array", "items": { "$ref": "#/components/schemas/SiteCustomFieldDto" }, "nullable": true } }, "additionalProperties": false }, "Room": { "type": "object", "properties": { "SiteID": { "type": "integer", "format": "int32" }, "RoomID": { "type": "integer", "format": "int32" }, "Occupancy": { "type": "integer", "format": "int32" }, "IsActive": { "type": "boolean" }, "RoomName": { "type": "string", "nullable": true }, "IsConflictCheck": { "type": "boolean" }, "StartBufferMins": { "type": "integer", "format": "int32" }, "EndBufferMins": { "type": "integer", "format": "int32" }, "EmailAddress": { "type": "string", "nullable": true } }, "additionalProperties": false }, "VisitType": { "type": "object", "properties": { "VisitTypeID": { "type": "integer", "format": "int32" }, "VisitTypeName": { "type": "string" }, "DisplayOrder": { "type": "integer", "format": "int32" }, "SchedulingUse": { "type": "integer", "format": "int32" }, "IsRoomRequired": { "type": "boolean" }, "IncludeInExecRpts": { "type": "boolean" }, "CountsTowardMax": { "type": "boolean" }, "IsTopicRequired": { "type": "boolean" }, "AllowMultiDay": { "type": "boolean" }, "AMCanPickVisitStartEnd": { "type": "boolean" }, "AllowAMTimeChangePage": { "type": "boolean" }, "DurationText": { "type": "string" }, "NumMinutes": { "type": "integer", "format": "int32" }, "Notes": { "type": "string" }, "AddCustomerOptCode": { "type": "integer", "format": "int32" }, "AddCustomerCRMOptCode": { "type": "integer", "format": "int32" }, "AddCustAttendeeOptCode": { "type": "integer", "format": "int32" }, "AddCustAttendeeCRMOptCode": { "type": "integer", "format": "int32" }, "AddOpportunityOptCode": { "type": "integer", "format": "int32" }, "AddOpportunityCRMOptCode": { "type": "integer", "format": "int32" }, "AltDate1Code": { "type": "integer", "format": "int32" }, "AltDate2Code": { "type": "integer", "format": "int32" }, "AddInternalAttendeeOptCode": { "type": "integer", "format": "int32" }, "VisitStartTimeInterval": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Gender": { "type": "object", "properties": { "GenderID": { "type": "integer", "format": "int32" }, "Title": { "type": "string" } }, "additionalProperties": false }, "PersonalDataPaginatedResponse": { "type": "object", "properties": { "Records": { "type": "array", "items": { "$ref": "#/components/schemas/PersonalData" } }, "Metadata": { "$ref": "#/components/schemas/PaginatedResponseMetadata" } }, "additionalProperties": false }, "CreateAttendeeCRMVisitDto": { "type": "object", "properties": { "CRMContactID": { "type": "string" }, "AttendeePrefix": { "type": "string" }, "AttendeeFName": { "type": "string" }, "AttendeeLName": { "type": "string" }, "AttendeeTitle": { "type": "string" }, "AttendeeRole": { "type": "string" }, "AttendeePhone": { "type": "string" }, "AttendeeEmail": { "type": "string", "format": "email" }, "AttendeeGender": { "type": "string" }, "AttendeeFunction": { "type": "string" }, "CRMAccountID": { "type": "string" }, "AttendeeContactType": { "type": "string" }, "AttendeeBusinessGroup": { "type": "string" }, "AttendeeBusinessUnit": { "type": "string" }, "AttendeeLevel1BusinessGroup": { "type": "string" }, "AttendeeLevel2BusinessUnit": { "type": "string" } }, "required": [ "CRMContactID", "AttendeeFName", "AttendeeLName", "AttendeeEmail" ], "additionalProperties": false }, "ItineraryProvider": { "type": "object", "properties": { "ID": { "type": "integer", "format": "int32" }, "ProviderType": { "$ref": "#/components/schemas/ProviderTypes" }, "Name": { "type": "string" }, "Phone": { "type": "string" }, "Website": { "type": "string" }, "Address": { "type": "string" }, "Description": { "type": "string" }, "IsActive": { "type": "boolean" }, "SiteID": { "type": "integer", "format": "int32" }, "DisplayOrder": { "type": "integer", "format": "int32" }, "City": { "type": "string" }, "StateProvince": { "type": "string" }, "Country": { "type": "string" }, "HiddenFromAM": { "type": "boolean" } }, "additionalProperties": false }, "OpportunitySearchCriteria": { "type": "object", "properties": { "OpportunityIds": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "VisitCoordinatorExtended": { "type": "object", "properties": { "VisitCoordinatorID": { "type": "integer", "format": "int32" }, "VisitID": { "type": "integer", "format": "int32" }, "UserID": { "type": "integer", "format": "int32" }, "UserName": { "type": "string" }, "PersonID": { "type": "integer", "format": "int32" }, "Prefix": { "type": "string" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "Suffix": { "type": "string" }, "JobTitle": { "type": "string" }, "Email": { "type": "string" }, "Phone1": { "type": "string" }, "Phone2": { "type": "string" }, "CoordinatorVisitRoleID": { "type": "integer", "format": "int32" }, "CoordinatorVisitRoleText": { "type": "string" }, "UpdatedByUserID": { "type": "integer", "format": "int32" }, "InviteStatusID": { "type": "integer", "format": "int32" }, "InviteStatus": { "type": "string" }, "VisitWorkload": { "type": "integer", "format": "int32" }, "Assignments": { "type": "integer", "format": "int32" }, "TotalWorkload": { "type": "integer", "format": "int32" }, "Role": { "$ref": "#/components/schemas/VisitCoordinatorRole" } }, "additionalProperties": false }, "UpdateCustomerParamsErrors": { "type": "object", "properties": { "Name": { "type": "array", "items": { "type": "string" }, "nullable": true }, "CRMCustomerID": { "type": "array", "items": { "type": "string" }, "nullable": true }, "AccountID": { "type": "array", "items": { "type": "string" }, "nullable": true }, "Website": { "type": "array", "items": { "type": "string" }, "nullable": true }, "IsActive": { "type": "boolean", "nullable": true }, "Division": { "type": "array", "items": { "type": "string" }, "nullable": true }, "Address1": { "type": "array", "items": { "type": "string" }, "nullable": true }, "Address2": { "type": "array", "items": { "type": "string" }, "nullable": true }, "City": { "type": "array", "items": { "type": "string" }, "nullable": true }, "Zip": { "type": "array", "items": { "type": "string" }, "nullable": true }, "CountryCode": { "type": "array", "items": { "type": "string" }, "nullable": true }, "StateProvince": { "type": "array", "items": { "type": "string" }, "nullable": true }, "IndustryID": { "type": "array", "items": { "type": "string" }, "nullable": true }, "CustomerStatusID": { "type": "array", "items": { "type": "string" }, "nullable": true }, "CustomerOption1ID": { "type": "array", "items": { "type": "string" }, "nullable": true }, "CustomerOption2ID": { "type": "array", "items": { "type": "string" }, "nullable": true }, "CustomerOption3ID": { "type": "array", "items": { "type": "string" }, "nullable": true }, "SalesChannelLevel1ID": { "type": "array", "items": { "type": "string" }, "nullable": true }, "SalesChannelLevel2ID": { "type": "array", "items": { "type": "string" }, "nullable": true }, "CustomerOption4IDs": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "AttendeeRole": { "type": "object", "properties": { "RoleID": { "type": "integer", "format": "int32" }, "Name": { "type": "string", "nullable": true }, "IsActive": { "type": "boolean" }, "DisplayOrder": { "type": "integer", "format": "int32" }, "CustomerOrInternal": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OpportunityPrePost": { "type": "object", "properties": { "ID": { "$ref": "#/components/schemas/Int32NullablePrePost" }, "Name": { "$ref": "#/components/schemas/StringPrePost" } }, "additionalProperties": false }, "ForbiddenResponse": { "type": "object", "required": [ "type", "title", "status", "detail", "instance", "traceId" ], "properties": { "type": { "type": "string", "format": "uri", "example": "https://tools.ietf.org/html/rfc9110#section-15.5.4", "description": "A URI reference that identifies the problem type." }, "title": { "type": "string", "example": "Forbidden", "description": "A short, human-readable summary of the problem." }, "status": { "type": "integer", "example": 403, "description": "The HTTP status code generated by the origin server." }, "detail": { "type": "string", "example": "The room can not be deleted due to its usage", "description": "A human-readable explanation specific to this occurrence of the problem." }, "instance": { "type": "string", "example": "/api/v3/rooms/4", "description": "A URI reference that identifies the specific occurrence of the problem." }, "traceId": { "type": "string", "example": "00-7c1f0e4f5a7d8c9f...", "description": "A unique identifier for tracing this request (e.g., for logging/correlation)." } } }, "CreateCRMVisitResults": { "type": "object", "properties": { "Code": { "type": "integer", "format": "int32", "description": "ID of created request" }, "VisitHash": { "type": "string" } }, "additionalProperties": false }, "VisitQuestionReply": { "type": "object", "properties": { "ID": { "type": "integer", "format": "int32" }, "VisitID": { "type": "integer", "format": "int32" }, "QuestionID": { "type": "integer", "format": "int32" }, "CustomerID": { "type": "integer", "format": "int32" }, "Answer": { "type": "string" }, "DateLastUpdated": { "type": "string", "format": "date-time" }, "UpdatedByUserID": { "type": "integer", "format": "int32" }, "ItemValueNumeric": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ArrayOfOpportunityPrePostFlat": { "type": "array", "items": { "$ref": "#/components/schemas/OpportunityPrePostFlat" } }, "PaginatedResponseMetadata": { "type": "object", "properties": { "Limit": { "type": "integer", "format": "int32" }, "Offset": { "type": "integer", "format": "int32" }, "Total": { "type": "integer", "format": "int32" }, "Links": { "$ref": "#/components/schemas/PaginatedResponseMetadataLinks" } }, "additionalProperties": false }, "VisitSpeakerInviteStatus": { "type": "object", "properties": { "VisitSpeakerInviteStatusID": { "type": "integer", "format": "int32" }, "StatusName": { "type": "string" } }, "additionalProperties": false }, "OpportunityCompetitor": { "type": "object", "properties": { "CompetitorID": { "type": "integer", "format": "int32" }, "CompetitorName": { "type": "string" } }, "additionalProperties": false }, "OpportunityCategory": { "type": "object", "properties": { "CategoryID": { "type": "integer", "format": "int32" }, "CategoryName": { "type": "string" } }, "additionalProperties": false }, "ArrayOfCountry": { "type": "array", "items": { "$ref": "#/components/schemas/Country" } }, "CustomerSalesChannel": { "type": "object", "properties": { "ID": { "type": "integer", "format": "int32", "nullable": true }, "Description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ArrayOfTopic": { "type": "array", "items": { "$ref": "#/components/schemas/Topic" } }, "UnauthorizedResponse": { "type": "object", "properties": { "message": { "type": "string", "example": "Unauthorized" } }, "required": [ "message" ], "additionalProperties": false } } }, "paths": { "/api/v3/rooms/{roomId}": { "get": { "tags": [ "Rooms" ], "operationId": "readRoom", "summary": "Read room by id", "parameters": [ { "name": "roomId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The ID of the room to retrieve" }, { "name": "languageId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } } ], "responses": { "200": { "description": "Successfully retrieved", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Room" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectNotFoundResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } } }, "delete": { "tags": [ "Rooms" ], "summary": "Delete room by ID", "operationId": "deleteRoom", "parameters": [ { "name": "roomId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } } ], "responses": { "204": { "description": "No Content", "content": { } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } } } }, "/api/v3/opportunity-stages": { "get": { "tags": [ "Opportunities", "Stages" ], "operationId": "readOpportunityStages", "summary": "Read opportunity stages", "parameters": [ { "name": "includeInactive", "in": "query", "required": true, "schema": { "type": "boolean", "default": false } }, { "name": "languageId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpportunityStage" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } } } }, "/api/v3/accounts/{accountId}": { "get": { "tags": [ "Accounts" ], "operationId": "readAccount", "summary": "Read account by id", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The ID of the account to retrieve" }, { "name": "languageId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "description": "Optional. Defaults to 1 (English). Set to a specific language ID to override. Note: If duplicate parameters are provided, the last value will be used." }, { "name": "Authorization", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } } ], "responses": { "200": { "description": "Successfully retrieved", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Customer" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Customer" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BadRequestErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectNotFoundResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } } }, "patch": { "tags": [ "Accounts" ], "summary": "Partially update account by ID", "operationId": "updateAccount", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "languageId", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerParams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerParams" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerParamsErrorsBadRequestErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringSchema" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } } } }, "/api/v3/sites/{siteId}": { "get": { "tags": [ "Sites" ], "operationId": "readSite", "summary": "Read site by id", "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The ID of the site to retrieve" }, { "name": "languageId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Site" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectNotFoundResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } } } }, "/api/v3/coordinator-roles": { "get": { "tags": [ "CoordinatorRoles" ], "operationId": "readCoordinatorRoles", "summary": "Read coordinator roles", "parameters": [ { "name": "includeInactive", "in": "query", "required": true, "schema": { "type": "boolean", "default": false } }, { "name": "languageId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LookupItem" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } } } }, "/api/v3/accounts/statuses": { "get": { "tags": [ "Accounts", "Statuses" ], "operationId": "readAccountStatuses", "summary": "Get all account statuses defined in the system", "description": "Retrieves a list of all account statuses (formerly customer statuses) available in the system. These statuses are used to categorize and manage account states.", "parameters": [ { "name": "includeInactive", "in": "query", "required": true, "schema": { "type": "boolean", "default": false }, "description": "Optional. Defaults to false. Set to true to include inactive account statuses in the response." }, { "name": "languageId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32", "default": 1 }, "description": "Optional. Defaults to 1 (English). Set to a specific language ID to override. Note: If duplicate parameters are provided, the last value will be used." }, { "name": "Authorization", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArrayOfLookupItem" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } } } }, "/api/v3/user-sales-channels": { "get": { "tags": [ "UserSalesChannels" ], "summary": "Returns the list of sales channels available to the authenticated user.", "operationId": "readBusinessUnits", "parameters": [ { "name": "includeInactive", "in": "query", "required": true, "schema": { "type": "boolean" }, "description": "Required. Set to true to include inactive user sales channels, false to only return active user sales channels. Note: If duplicate parameters are provided, the last value will be used." }, { "name": "languageId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "description": "Optional. Defaults to 1 (English). Set to a specific language ID to override. Note: If duplicate parameters are provided, the last value will be used." }, { "name": "Authorization", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArrayOfSalesChannelLevel1" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } } } }, "/api/v3/countries": { "get": { "tags": [ "Countries" ], "operationId": "readCountries", "summary": "Read countries list", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArrayOfCountry" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } } } }, "/api/v3/visits/{visitId}/itinerary": { "get": { "tags": [ "Visits", "Itinerary" ], "summary": "Retrieves the itinerary details for a specific visit", "operationId": "readVisitItinerary", "parameters": [ { "name": "visitId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "languageId", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectNotFoundResponse" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisitItinerary" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } } } }, "/api/v3/visits/{visitId}/customer-logos": { "get": { "tags": [ "Visits", "CustomerLogos" ], "operationId": "readVisitCustomersLogos", "summary": "Read visit customers logos", "parameters": [ { "name": "visitId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" }, "description": "Required. Visit ID to retrieve customer logos for" }, { "name": "Authorization", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" }, "description": "OAuth 2.0 Bearer Token. Example: \u0027Bearer {token}\u0027" } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArrayOfCustomerLogo" } } } } } } }, "/api/v3/persons": { "get": { "tags": [ "Persons" ], "summary": "Retrieve a paginated list of persons, optionally filtered by active status.", "operationId": "readPersons", "parameters": [ { "name": "isActive", "in": "query", "schema": { "type": "boolean" } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadVisitParamsErrorsBadRequestErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonalDataPaginatedResponse" } } } } } } }, "/api/v3/rooms": { "put": { "operationId": "createOrUpdateRoom", "summary": "Create or update room", "parameters": [ { "name": "languageId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Room" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Room" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Room" } } } } } } }, "/api/v3/opportunity-priorities": { "get": { "tags": [ "Opportunities", "Priorities" ], "operationId": "readOpportunityPriorities", "summary": "Read opportunity priorities", "parameters": [ { "name": "includeInactive", "in": "query", "required": true, "schema": { "type": "boolean", "default": false } }, { "name": "languageId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LookupItem" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } } } }, "/api/v3/visits/{visitId}/attendees/{visitAttendeeId}/survey": { "get": { "tags": [ "Visits", "Survey" ], "operationId": "readVisitAttendeeSurvey", "summary": "Retrieves survey data for a specific visit attendee", "parameters": [ { "name": "surveyTypeId", "required": true, "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "languageId", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "visitAttendeeId", "required": true, "in": "path", "schema": { "type": "integer", "format": "int32" } }, { "name": "visitId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisitSurveyPacket" } } } } } } }, "/api/v3/persons/{personId}": { "get": { "tags": [ "Persons" ], "operationId": "readPersonById", "summary": "Read person by id", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } }, { "name": "personId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectNotFoundResponse" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonalData" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } } }, "patch": { "tags": [ "Persons" ], "operationId": "UpdatePersonById", "summary": "Partially update person by ID", "parameters": [ { "name": "personId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonPartialUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PersonPartialUpdateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonalData" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectNotFoundResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } } } }, "/api/v3/accounts/options": { "get": { "tags": [ "Accounts", "Options" ], "summary": "Get account option lookup items by type.", "operationId": "readAccountOptions", "parameters": [ { "name": "optionType", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema", "enum": [ "1", "2", "3", "4" ] }, "description": "Required. Account option type: 1 for CustomerOption1, 2 for CustomerOption2, 3 for CustomerOption3, 4 for CustomerOption4. Note: If duplicate parameters are provided, the last value will be used. Invalid values (e.g. anything other than 1-4) will return 400 Bad Request." }, { "name": "includeInactive", "in": "query", "required": true, "schema": { "type": "boolean" }, "description": "Required. Set to true to include inactive Account Options, false to only return active account options. Note: If duplicate parameters are provided, the last value will be used." }, { "name": "languageId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "description": "Optional. Defaults to 1 (English). Set to a specific language ID to override. Note: If duplicate parameters are provided, the last value will be used." }, { "name": "Authorization", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArrayOfLookupItem" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } } } }, "/api/v3/persons/search": { "post": { "tags": [ "Persons" ], "operationId": "searchPersons", "summary": "Find persons matching the provided search criteria", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonSearchCriteria" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PersonSearchCriteria" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PersonSearchCriteria" } } }, "required": true }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringSchema" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArrayOfPersonPacket" } } } } } } }, "/api/v3/visit-types": { "get": { "tags": [ "VisitTypes" ], "summary": "Retrieves available visit types", "operationId": "readVisitTypes", "parameters": [ { "name": "languageId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "description": "Optional. Defaults to 1 (English). Set to a specific language ID to override. Note: If duplicate parameters are provided, the last value will be used." }, { "name": "Authorization", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArrayOfLookupItem" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } } } }, "/api/v3/opportunity-categories": { "get": { "tags": [ "Opportunities", "Categories" ], "operationId": "readOpportunityCategories", "summary": "Read opportunity categories", "parameters": [ { "name": "includeInactive", "in": "query", "required": true, "schema": { "type": "boolean" } }, { "name": "languageId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LookupItem" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } } } }, "/api/v3/visits/{visitId}": { "get": { "tags": [ "Visits" ], "operationId": "readVisit", "summary": "Retrieves detailed information for a specific visit including optional related data such as attendees, documents, logistics, and agenda items", "parameters": [ { "name": "includeVisitType", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeRequester", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeAttendees", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeReasons", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeCustomerQuestions", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeOwners", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeSalesChannels", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeSpeakers", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeOpportunities", "in": "query", "schema": { "type": "boolean" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } }, { "name": "includeExtraInfo", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeCoordinatorRoles", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeVisitDays", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeLogistics", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeDocuments", "in": "query", "schema": { "type": "boolean" } }, { "name": "visitId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "includeVisitRooms", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeVisitStatus", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeTopics", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeCustomers", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeCoordinators", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeEngagementType", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeAgendaItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "languageId", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "includeMeals", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeSite", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeTopicCategories", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectNotFoundResponse" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisitFull" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadVisitParamsErrorsBadRequestErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "500": { "description": "500 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } } } }, "/api/v3/opportunity-segments": { "get": { "tags": [ "Opportunities", "Segments" ], "operationId": "readOpportunitySegments", "summary": "Read opportunity segments", "parameters": [ { "name": "includeInactive", "in": "query", "required": true, "schema": { "type": "boolean", "default": false } }, { "name": "languageId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LookupItem" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } } } }, "/api/v3/visits/request": { "post": { "tags": [ "Visits", "Request" ], "operationId": "createVisitRequest", "summary": "Submit a new customer visit request from the CRM system", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCRMVisitDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateCRMVisitDto" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCRMVisitResults" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } } } }, "/api/v3/topics": { "get": { "tags": [ "Topics" ], "summary": "Read topic list", "operationId": "readTopics", "parameters": [ { "name": "includeInactive", "in": "query", "required": true, "schema": { "type": "boolean" }, "description": "Required. Set to true to include inactive Topics, false to only return active topics. Note: If duplicate parameters are provided, the last value will be used." }, { "name": "languageId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "description": "Optional. Defaults to 1 (English). Set to a specific language ID to override. Note: If duplicate parameters are provided, the last value will be used." }, { "name": "Authorization", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArrayOfTopic" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } } } }, "/api/v3/visits": { "get": { "tags": [ "Visits" ], "summary": "Retrieves paginated visit records with optional filtering by date range, status, type, site, and includes related data such as visit types, statuses, sites, and engagement information", "operationId": "readVisits", "parameters": [ { "name": "includeVisitType", "in": "query", "schema": { "type": "boolean" } }, { "name": "startsAt", "in": "query", "description": "Start time filter (ISO 8601 format, e.g. 2024-01-01T00:00:00.000Z)", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "statusIds", "in": "query", "description": "Comma-separated list of site IDs", "style": "form", "required": false, "explode": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "includeVisitStatus", "in": "query", "schema": { "type": "boolean" } }, { "name": "endsAt", "in": "query", "description": "End time filter (ISO 8601 format, e.g. 2024-01-01T00:00:00.000Z)", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "orderBy", "in": "query", "description": "Field to order by", "required": false, "schema": { "type": "string", "enum": [ "VisitStart", "VisitName", "VisitModifiedDate" ] } }, { "name": "includeEngagementType", "in": "query", "schema": { "type": "boolean" } }, { "name": "updatedAfter", "in": "query", "description": "Return visits updated after this timestamp (ISO 8601 format, e.g. 2024-01-01T00:00:00.000Z)", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "languageId", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } }, { "name": "siteIds", "in": "query", "description": "Comma-separated list of site IDs", "style": "form", "required": false, "explode": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "order", "in": "query", "description": "Sorting order: ASC or DESC", "required": false, "schema": { "type": "string", "enum": [ "ASC", "DESC" ] } }, { "name": "includeSite", "in": "query", "schema": { "type": "boolean" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "typeIds", "in": "query", "description": "Comma-separated list of site IDs", "style": "form", "required": false, "explode": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisitExtendedPaginatedResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadVisitParamsErrorsBadRequestErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } } } }, "/api/v3/sites": { "get": { "tags": [ "Sites" ], "summary": "Read sites list", "operationId": "readSites", "parameters": [ { "name": "includeInactive", "in": "query", "required": true, "schema": { "type": "boolean" }, "description": "Required. Set to true to include inactive Sites, false to only return active sites. Note: If duplicate parameters are provided, the last value will be used." }, { "name": "languageId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "description": "Optional. Defaults to 1 (English). Set to a specific language ID to override. Note: If duplicate parameters are provided, the last value will be used." }, { "name": "Authorization", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArrayOfLookupItem" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } } } }, "/api/v3/opportunities/{opportunityId}": { "get": { "tags": [ "Opportunities" ], "operationId": "readOpportunityById", "summary": "Read opportunity by id", "parameters": [ { "name": "opportunityType", "in": "query", "schema": { "$ref": "#/components/schemas/StringSchema" } }, { "name": "languageId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "description": "Optional. Defaults to 1 (English). Set to a specific language ID to override. Note: If duplicate parameters are provided, the last value will be used." }, { "name": "Authorization", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } }, { "name": "opportunityId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } } ], "responses": { "404": { "description": "Fot Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectNotFoundResponse" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArrayOfOpportunityPrePostFlat" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } } }, "patch": { "tags": [ "Opportunities" ], "operationId": "updateOpportunityById", "summary": "Update opportunity by id", "parameters": [ { "name": "opportunityType", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } }, { "name": "languageId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "description": "Optional. Defaults to 1 (English). Set to a specific language ID to override. Note: If duplicate parameters are provided, the last value will be used." }, { "name": "Authorization", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } }, { "name": "opportunityId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OpportunityUpdateRequest" } } }, "required": true }, "responses": { "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectNotFoundResponse" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityPrePostFlat" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityUpdateInvalidResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } } } }, "/api/v3/opportunities": { "post": { "tags": [ "Opportunities" ], "operationId": "createOpportunity", "summary": "Create opportunity", "parameters": [ { "name": "languageId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "description": "Optional. Defaults to 1 (English). Set to a specific language ID to override. Note: If duplicate parameters are provided, the last value will be used." }, { "name": "Authorization", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OpportunityCreateRequest" } } }, "required": true }, "responses": { "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectNotFoundResponse" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityPrePostFlat" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityCreateInvalidResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "500": { "description": "500 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } } }, "patch": { "tags": [ "Opportunities" ], "operationId": "updateOpportunitiesByOpportunityId", "summary": "Update opportunities by Opportunity IDs", "parameters": [ { "name": "languageId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "description": "Optional. Defaults to 1 (English). Set to a specific language ID to override. Note: If duplicate parameters are provided, the last value will be used." }, { "name": "Authorization", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityUpdateManyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OpportunityUpdateManyRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityUpdateManyResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectNotFoundResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } } } }, "/api/v3/surveys/{surveyId}/responses/{responseId}": { "patch": { "tags": [ "Surveys", "Responses" ], "operationId": "updateSurveyResponse", "summary": "Update Survey Response", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } }, { "name": "surveyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The ID of the survey" }, { "name": "responseId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The ID of the response" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisitSurveyQuestionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/VisitSurveyQuestionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisitSurveyQuestionResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } } } }, "/api/v3/accounts/sales-channels": { "get": { "tags": [ "Accounts", "SalesChannels" ], "summary": "Returns the list of sales channels for the authenticated account.", "operationId": "readAccountSalesChannels", "parameters": [ { "name": "includeInactive", "in": "query", "required": true, "schema": { "type": "boolean" }, "description": "Required. Set to true to include inactive Account Sales Channels, false to only return active account sales channels. Note: If duplicate parameters are provided, the last value will be used." }, { "name": "languageId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "description": "Optional. Defaults to 1 (English). Set to a specific language ID to override. Note: If duplicate parameters are provided, the last value will be used." }, { "name": "Authorization", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArrayOfSalesChannelLevel1" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } } } }, "/api/v3/engagement-types": { "get": { "tags": [ "EngagementTypes" ], "operationId": "readEngagementTypes", "summary": "Read engagement types list", "parameters": [ { "name": "includeInactive", "in": "query", "required": false, "schema": { "type": "boolean", "default": false }, "description": "Optional. Defaults to false. Set to true to include inactive Engagement Types, false to only return active engagement types. Note: If duplicate parameters are provided, the last value will be used." }, { "name": "languageId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "description": "Optional. Defaults to 1 (English). Set to a specific language ID to override. Note: If duplicate parameters are provided, the last value will be used." }, { "name": "Authorization", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArrayOfLookupItem" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } } } }, "/api/v3/industries": { "get": { "tags": [ "Industries" ], "operationId": "readIndustries", "summary": "Read industries list", "parameters": [ { "name": "includeInactive", "in": "query", "required": true, "schema": { "type": "boolean" }, "description": "Required. Set to true to include inactive Industries, false to only return active industries. Note: If duplicate parameters are provided, the last value will be used." }, { "name": "languageId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "description": "Optional. Defaults to 1 (English). Set to a specific language ID to override. Note: If duplicate parameters are provided, the last value will be used." }, { "name": "Authorization", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } } ], "responses": { "200": { "description": "200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArrayOfIndustry" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } } } }, "/api/v3/attendee-roles": { "get": { "tags": [ "AttendeeRoles" ], "operationId": "readAttendeeRoles", "summary": "Read attendee roles", "parameters": [ { "name": "includeInactive", "in": "query", "required": true, "schema": { "type": "boolean", "default": false } }, { "name": "languageId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/StringSchema" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AttendeeRole" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } } } } }, "security": [ { "OAuth2": [ ] } ] }