openapi: 3.2.0 info: version: V1 title: Orion Connect Settings/Web Options API x-swagger-net-version: 8.4.12.001 servers: - url: https://api.orionadvisor.com/api tags: - name: Settings/WebOptions paths: /v1/Settings/WebOptions: get: tags: - Settings/WebOptions summary: Gets a list of web options that the logged in user has access to. operationId: WebOptions_Get parameters: - name: optionType in: query description: "Optional. Default null. If provided will limit the web options that are returned to just those with the provided option type. Available options are:\n StyleSheet, SiteHeader, WebsiteText, ChartColor, PageDefaults, MobileSetting, EProfileTemplate, MIG_IPS, UMAManager, PBWorksMapping, and Reporting." required: false schema: type: string enum: - StyleSheet - SiteHeader - WebsiteText - ChartColor - PageDefaults - MobileSetting - EProfileTemplate - MIG_IPS - UMAManager - PBWorksMapping - Reporting - Trading - Credentials - name: entity in: query description: Optional. Default null. If provided will limit the web options that are returned to just those with the provided entity. required: false schema: type: string enum: - Undefined - Payee - BrokerDealer - Wholesaler - Representative - Client - Registration - Account - Asset - Product - Transaction - Distribution - FundFamily - Personal - PayoutSchedule - FeeSchedule - Platform - RIA - Custodian - Journal - SWP - Other - NASD - CashFunding - Bill - BillInstance - BillMasterPayout - Model - NewAccountClient - NewAccountReg - DownloadExclusion - Price - UserDefinedFields - NewAcctUserDef - ManagersMessage - IndexEntry - PerformanceFee - PerformancePayout - NewAccountAsset - Owner - Administrator - OutsideClient - SubAdvisor - ModelRange - FaxCover - Fax - OneTimeDistribution - WebLogin - Plan401k - BillAccountItem - ThirdPartyAdministrator - CrmContact - Participant - PlanSponsor - CRMEmailList - ThirdParty - WorkflowItem - WorkflowAction - ServiceAccount - EntityOption - HouseholdMember - DownloadSymbol - IndexBlend - NABenefit - AggregateModel - CompositeRange - RepAccountManager - ScriptsScrubs - ServiceAccountBrokerDealer - BusinessLine - Blob - AssetClass - ServiceAccountLite - NewAcctUserDefDtl - Branch - AssetLevelStrategy - Report - DataQueries - PriceUnUsed - ModelItem - AssetCategory - RiskCategory - PlatformRange - Dividend - RegistrationType - CustodianCommon - RepState - QpeDashboard - ReportBatch - ModelGroup - ShareClass - DownloadFile - User - DynamicGrouping - ProductType - ProductSubType - InvestmentObjective - PortfolioGroup - OrionRealizedLot - OrionUnrealizedLot - CustodianRealizedLot - CustodianUnrealizedLot - AssetCategoryParent - TaxType - AuditRequest - AuditRequestLetter - ManagedUnmanaged - AuditRowAttachment - InformPolicy - InformAnswerAttachment - UserDetail - BillPayMethod - ModelInclusion - CommunityModel - EclipseModel - Global - ClientCategory - Taxability - Qualified - TaxID - BondState - ProductTaxability - TargetAllocation - RIATable - ProductRegion - ProductPropertyType - ProductManagerAip - MoodyRating - SPRating - BondMaturityYear - InterestRate - RegistrationTaxType - MaturityPeriod - NewHousehold - BillPayoutDashboardPayment - OptionLevel - MarginAgreement - PrimeBrokerage - InformHistoricalDocument - SleeveStrategyAggregate - MorningstarSector - BillEntity - SleeveStrategy - MorningstarGeography - GenericProspect - BillEntityType - AdditionalRep - BillPayoutReport - ProductSubHolding - DownloadSource - ModelVsActual - ProductVintageYear - EclipsePortfolio - Country - Currency - SecurityClassification1 - SecurityClassification2 - SecurityClassification3 - SecurityClassification4 - SecurityClassification5 - SecurityClassification6 - SecurityClassification7 - SecurityClassification8 - SecurityClassification9 - SecurityClassification10 - SecurityClassification11 - SecurityClassification12 - SecurityClassification13 - SecurityClassification14 - SecurityClassification15 - SecurityClassification16 - SecurityClassification17 - SecurityClassification18 - SecurityClassification19 - SecurityClassification20 - SecurityClassification21 - SecurityClassification22 - SecurityClassification23 - SecurityClassification24 - SecurityClassification25 - DownloadRecord - CustomGrouping - Cotenant - AllocatedUnrealizedCostBasis - AllocatedRealizedCostBasis - name: fieldName in: query description: Optional. Default null. If provided will limit the web options that are returned to just those with the provided field name. required: false schema: type: string responses: '200': description: OK content: text/plain: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' xml: name: WebOptionDto wrapped: true type: array application/json: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' xml: name: WebOptionDto wrapped: true type: array text/json: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' xml: name: WebOptionDto wrapped: true type: array application/xml: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' xml: name: WebOptionDto wrapped: true type: array text/xml: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' xml: name: WebOptionDto wrapped: true type: array multipart/form-data: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' xml: name: WebOptionDto wrapped: true type: array security: - Authorization: [] put: tags: - Settings/WebOptions summary: Used to update existing web options. operationId: WebOptions_UpdateWebOption responses: '200': description: OK content: text/plain: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' application/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' text/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' application/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' text/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' multipart/form-data: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' security: - Authorization: [] requestBody: content: text/plain: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' application/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' text/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' application/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' text/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' multipart/form-data: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' description: The collection of web options being updated. required: true post: tags: - Settings/WebOptions summary: Used to update existing web options. operationId: WebOptions_CreateWebOption responses: '200': description: OK content: text/plain: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' application/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' text/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' application/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' text/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' multipart/form-data: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' security: - Authorization: [] requestBody: content: text/plain: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' application/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' text/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' application/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' text/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' multipart/form-data: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' description: The collection of web options being updated. required: true /v1/Settings/WebOptions/{optionname}: get: tags: - Settings/WebOptions summary: Gets the web option that has the provided name. operationId: WebOptions_GetByOptionName parameters: - name: optionname in: path description: Name of the option to return. required: true schema: type: string - name: defaultValue in: query description: Optional. Default null. If provided will be used to fill in the value property of the object if one does not already exist. required: false schema: type: string responses: '200': description: OK content: text/plain: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' application/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' text/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' application/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' text/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' multipart/form-data: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.WebOptionDto' security: - Authorization: [] delete: tags: - Settings/WebOptions operationId: WebOptions_Delete parameters: - name: optionname in: path required: true schema: type: string responses: '204': description: No Content security: - Authorization: [] summary: Web options delete x-summary-source: derived components: schemas: OAS.WebApi.DTO.Settings.WebOptionDto: properties: id: type: integer format: int32 optionType: type: string enum: - StyleSheet - SiteHeader - WebsiteText - ChartColor - PageDefaults - MobileSetting - EProfileTemplate - MIG_IPS - UMAManager - PBWorksMapping - Reporting - Trading - Credentials fieldName: type: string fieldValue: type: string entityId: type: integer format: int32 entity: type: string enum: - Undefined - Payee - BrokerDealer - Wholesaler - Representative - Client - Registration - Account - Asset - Product - Transaction - Distribution - FundFamily - Personal - PayoutSchedule - FeeSchedule - Platform - RIA - Custodian - Journal - SWP - Other - NASD - CashFunding - Bill - BillInstance - BillMasterPayout - Model - NewAccountClient - NewAccountReg - DownloadExclusion - Price - UserDefinedFields - NewAcctUserDef - ManagersMessage - IndexEntry - PerformanceFee - PerformancePayout - NewAccountAsset - Owner - Administrator - OutsideClient - SubAdvisor - ModelRange - FaxCover - Fax - OneTimeDistribution - WebLogin - Plan401k - BillAccountItem - ThirdPartyAdministrator - CrmContact - Participant - PlanSponsor - CRMEmailList - ThirdParty - WorkflowItem - WorkflowAction - ServiceAccount - EntityOption - HouseholdMember - DownloadSymbol - IndexBlend - NABenefit - AggregateModel - CompositeRange - RepAccountManager - ScriptsScrubs - ServiceAccountBrokerDealer - BusinessLine - Blob - AssetClass - ServiceAccountLite - NewAcctUserDefDtl - Branch - AssetLevelStrategy - Report - DataQueries - PriceUnUsed - ModelItem - AssetCategory - RiskCategory - PlatformRange - Dividend - RegistrationType - CustodianCommon - RepState - QpeDashboard - ReportBatch - ModelGroup - ShareClass - DownloadFile - User - DynamicGrouping - ProductType - ProductSubType - InvestmentObjective - PortfolioGroup - OrionRealizedLot - OrionUnrealizedLot - CustodianRealizedLot - CustodianUnrealizedLot - AssetCategoryParent - TaxType - AuditRequest - AuditRequestLetter - ManagedUnmanaged - AuditRowAttachment - InformPolicy - InformAnswerAttachment - UserDetail - BillPayMethod - ModelInclusion - CommunityModel - EclipseModel - Global - ClientCategory - Taxability - Qualified - TaxID - BondState - ProductTaxability - TargetAllocation - RIATable - ProductRegion - ProductPropertyType - ProductManagerAip - MoodyRating - SPRating - BondMaturityYear - InterestRate - RegistrationTaxType - MaturityPeriod - NewHousehold - BillPayoutDashboardPayment - OptionLevel - MarginAgreement - PrimeBrokerage - InformHistoricalDocument - SleeveStrategyAggregate - MorningstarSector - BillEntity - SleeveStrategy - MorningstarGeography - GenericProspect - BillEntityType - AdditionalRep - BillPayoutReport - ProductSubHolding - DownloadSource - ModelVsActual - ProductVintageYear - EclipsePortfolio - Country - Currency - SecurityClassification1 - SecurityClassification2 - SecurityClassification3 - SecurityClassification4 - SecurityClassification5 - SecurityClassification6 - SecurityClassification7 - SecurityClassification8 - SecurityClassification9 - SecurityClassification10 - SecurityClassification11 - SecurityClassification12 - SecurityClassification13 - SecurityClassification14 - SecurityClassification15 - SecurityClassification16 - SecurityClassification17 - SecurityClassification18 - SecurityClassification19 - SecurityClassification20 - SecurityClassification21 - SecurityClassification22 - SecurityClassification23 - SecurityClassification24 - SecurityClassification25 - DownloadRecord - CustomGrouping - Cotenant - AllocatedUnrealizedCostBasis - AllocatedRealizedCostBasis xml: name: WebOptionDto type: object securitySchemes: Authorization: type: apiKey description: 'JWT Authorization header using the Session scheme. Example: "Authorization: Session {token}"' name: Authorization in: header