openapi: 3.2.0 info: version: V1 title: Orion Connect Portfolio/Representatives API x-swagger-net-version: 8.4.12.001 servers: - url: https://api.orionadvisor.com/api tags: - name: Portfolio/Representatives paths: /v1/Portfolio/Representatives: get: tags: - Portfolio/Representatives summary: Gets a list of representatives that the logged in user has access to. operationId: Representatives_Get parameters: - name: isUsed in: query description: Optional. When provided will only return representatives that have are used (true) or are not used (false). required: false schema: type: boolean - name: brokerDealerId in: query description: Optional. When provided will only return representatives are tied to the provided BrokerDealerId (3). required: false schema: type: integer format: int32 - name: riaId in: query description: Optional. When provided will only return representatives are tied to the provided RiaId (5). required: false schema: type: integer format: int32 responses: '200': description: OK content: text/plain: schema: type: object application/json: schema: type: object text/json: schema: type: object multipart/form-data: schema: type: object security: - Authorization: [] /v1/Portfolio/Representatives/{key}: get: tags: - Portfolio/Representatives summary: Gets the representative that has the provided key. operationId: Representatives_GetEntityByKey parameters: - name: key in: path description: Key of the desired return object. required: true schema: type: integer format: int32 responses: '200': description: OK content: text/plain: schema: type: object application/json: schema: type: object text/json: schema: type: object multipart/form-data: schema: type: object security: - Authorization: [] /v1/Portfolio/Representatives/{key}/Accounts: get: tags: - Portfolio/Representatives summary: Gets a list of accounts that fall below the representative with the specified… operationId: Representatives_GetAccountsAsync parameters: - name: cancellationToken in: header required: true - name: key in: path description: Key of the desired return object. required: true schema: type: integer format: int32 - name: isActive in: query required: false schema: type: boolean responses: '200': description: OK content: text/plain: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.AccountDto' xml: name: AccountDto wrapped: true type: array application/json: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.AccountDto' xml: name: AccountDto wrapped: true type: array text/json: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.AccountDto' xml: name: AccountDto wrapped: true type: array application/xml: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.AccountDto' xml: name: AccountDto wrapped: true type: array text/xml: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.AccountDto' xml: name: AccountDto wrapped: true type: array multipart/form-data: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.AccountDto' xml: name: AccountDto wrapped: true type: array security: - Authorization: [] /v1/Portfolio/Representatives/{key}/Accounts/Value: get: tags: - Portfolio/Representatives summary: Gets a simple list of accounts (including aum for today) that fall below the… operationId: Representatives_GetAccountsValue parameters: - name: key in: path description: Key of the desired return object. required: true schema: type: integer format: int32 - name: hasValue in: query description: Optional. When provided will only return accounts that have value (true) or don't have value (false). required: false schema: type: boolean responses: '200': description: OK content: text/plain: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue' xml: name: SimpleAccountWithValue wrapped: true type: array application/json: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue' xml: name: SimpleAccountWithValue wrapped: true type: array text/json: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue' xml: name: SimpleAccountWithValue wrapped: true type: array application/xml: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue' xml: name: SimpleAccountWithValue wrapped: true type: array text/xml: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue' xml: name: SimpleAccountWithValue wrapped: true type: array multipart/form-data: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue' xml: name: SimpleAccountWithValue wrapped: true type: array security: - Authorization: [] /v1/Portfolio/Representatives/{key}/Accounts/Value/{asOfDate}: get: tags: - Portfolio/Representatives summary: Gets a simple list of accounts (including aum for the end of the date… operationId: Representatives_GetAccountsValueAsOfDate parameters: - name: key in: path description: Key of the desired return object. required: true schema: type: integer format: int32 - name: asOfDate in: path description: The aum returned is as of the end of this date. required: true schema: type: string format: date-time - name: hasValue in: query description: Optional. When provided will only return accounts that have value (true) or don't have value (false). required: false schema: type: boolean responses: '200': description: OK content: text/plain: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue' xml: name: SimpleAccountWithValue wrapped: true type: array application/json: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue' xml: name: SimpleAccountWithValue wrapped: true type: array text/json: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue' xml: name: SimpleAccountWithValue wrapped: true type: array application/xml: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue' xml: name: SimpleAccountWithValue wrapped: true type: array text/xml: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue' xml: name: SimpleAccountWithValue wrapped: true type: array multipart/form-data: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue' xml: name: SimpleAccountWithValue wrapped: true type: array security: - Authorization: [] /v1/Portfolio/Representatives/{key}/Clients/Simple/Search: get: tags: - Portfolio/Representatives summary: Gets a simple list of clients that the logged in user has access to where the… operationId: Representatives_GetSimpleClientSearch parameters: - name: key in: path description: representative Id. Filters the list of clients by this rep id. required: true schema: type: integer format: int32 - name: search in: query description: Partial client name to search for. required: true schema: type: string - name: top in: query description: 'Optional. Default: null. The maximum number of products to return. If null returns all.' required: false schema: type: integer format: int32 - name: skip in: query description: 'Optional. Default: 0. Defines number of items to skip.' required: false schema: type: integer format: int32 default: 0 responses: '200': description: OK content: text/plain: schema: items: $ref: '#/components/schemas/OAS.DataModel.Portfolio.SimpleClient' xml: name: SimpleClient wrapped: true type: array application/json: schema: items: $ref: '#/components/schemas/OAS.DataModel.Portfolio.SimpleClient' xml: name: SimpleClient wrapped: true type: array text/json: schema: items: $ref: '#/components/schemas/OAS.DataModel.Portfolio.SimpleClient' xml: name: SimpleClient wrapped: true type: array application/xml: schema: items: $ref: '#/components/schemas/OAS.DataModel.Portfolio.SimpleClient' xml: name: SimpleClient wrapped: true type: array text/xml: schema: items: $ref: '#/components/schemas/OAS.DataModel.Portfolio.SimpleClient' xml: name: SimpleClient wrapped: true type: array multipart/form-data: schema: items: $ref: '#/components/schemas/OAS.DataModel.Portfolio.SimpleClient' xml: name: SimpleClient wrapped: true type: array security: - Authorization: [] /v1/Portfolio/Representatives/{key}/Documents: get: tags: - Portfolio/Representatives operationId: Representatives_GetBlobs parameters: - name: key in: path required: true schema: type: integer format: int32 - name: fileType in: query required: false style: form explode: true schema: type: array items: type: string enum: - QuarterlyStatements - CrmDocuments - Payable responses: '200': description: OK content: text/plain: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BlobBaseDto' xml: name: BlobBaseDto wrapped: true type: array application/json: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BlobBaseDto' xml: name: BlobBaseDto wrapped: true type: array text/json: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BlobBaseDto' xml: name: BlobBaseDto wrapped: true type: array application/xml: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BlobBaseDto' xml: name: BlobBaseDto wrapped: true type: array text/xml: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BlobBaseDto' xml: name: BlobBaseDto wrapped: true type: array multipart/form-data: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BlobBaseDto' xml: name: BlobBaseDto wrapped: true type: array security: - Authorization: [] summary: Representatives get blobs x-summary-source: derived post: tags: - Portfolio/Representatives operationId: Representatives_CreateBlobAsync parameters: - name: key in: path required: true schema: type: integer format: int32 responses: '200': description: OK content: text/plain: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BlobBaseDto' application/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BlobBaseDto' text/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BlobBaseDto' application/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BlobBaseDto' text/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BlobBaseDto' multipart/form-data: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BlobBaseDto' security: - Authorization: [] requestBody: content: text/plain: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeFileDto' application/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeFileDto' text/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeFileDto' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeFileDto' multipart/form-data: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeFileDto' required: true summary: Representatives create blob async x-summary-source: derived /v1/Portfolio/Representatives/{key}/Documents/{fileId}: get: tags: - Portfolio/Representatives summary: Gets a file for the client with the specified key and the file with the… operationId: Representatives_GetBlobDto parameters: - name: key in: path description: Key of the desired return object. required: true schema: type: integer format: int32 - name: fileId in: path description: Key of the file to be returned. required: true schema: type: integer format: int32 responses: '200': description: OK content: text/plain: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BlobBaseDto' application/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BlobBaseDto' text/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BlobBaseDto' application/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BlobBaseDto' text/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BlobBaseDto' multipart/form-data: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BlobBaseDto' security: - Authorization: [] put: tags: - Portfolio/Representatives operationId: Representatives_UpdateBlobAsync parameters: - name: key in: path required: true schema: type: integer format: int32 - name: fileId in: path required: true schema: type: integer format: int32 responses: '200': description: OK content: text/plain: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BlobBaseDto' application/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BlobBaseDto' text/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BlobBaseDto' application/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BlobBaseDto' text/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BlobBaseDto' multipart/form-data: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BlobBaseDto' security: - Authorization: [] requestBody: content: text/plain: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeFileDto' application/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeFileDto' text/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeFileDto' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeFileDto' multipart/form-data: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeFileDto' required: true summary: Representatives update blob async x-summary-source: derived delete: tags: - Portfolio/Representatives operationId: Representatives_DeleteBlob parameters: - name: key in: path required: true schema: type: integer format: int32 - name: fileId in: path required: true schema: type: integer format: int32 responses: '204': description: No Content security: - Authorization: [] summary: Representatives delete blob x-summary-source: derived /v1/Portfolio/Representatives/{key}/Documents/{fileId}/Download: get: tags: - Portfolio/Representatives summary: Gets the raw data of the specific file with the blobId provided which is… operationId: Representatives_GetBlobFile parameters: - name: key in: path description: Key of the desired return object. required: true schema: type: integer format: int32 - name: fileId in: path description: Key of the file to be downloaded. required: true schema: type: integer format: int32 responses: '200': description: OK content: text/plain: schema: type: object application/json: schema: type: object text/json: schema: type: object multipart/form-data: schema: type: object security: - Authorization: [] /v1/Portfolio/Representatives/{key}/MakeDefault: put: tags: - Portfolio/Representatives summary: Sets the rep as the default operationId: Representatives_ActionMakeDefault parameters: - name: key in: path description: The rep to mark as default. required: true schema: type: integer format: int32 responses: '200': description: OK content: text/plain: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeDto' application/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeDto' text/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeDto' application/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeDto' text/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeDto' multipart/form-data: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeDto' security: - Authorization: [] /v1/Portfolio/Representatives/{key}/ReportImage: get: tags: - Portfolio/Representatives summary: Gets the representative's report image if one exists. operationId: Representatives_GetRepImageById parameters: - name: key in: path description: Key of the desired return object. required: true schema: type: integer format: int32 responses: '200': description: OK content: text/plain: schema: type: object application/json: schema: type: object text/json: schema: type: object multipart/form-data: schema: type: object security: - Authorization: [] /v1/Portfolio/Representatives/{key}/Simple: get: tags: - Portfolio/Representatives summary: Gets the simple representative that has the provided key. operationId: Representatives_GetSimpleByKey parameters: - name: key in: path description: Key of the desired return object. required: true schema: type: integer format: int32 responses: '200': description: OK content: text/plain: schema: $ref: '#/components/schemas/OAS.DataModel.Portfolio.SimpleRepresentative' application/json: schema: $ref: '#/components/schemas/OAS.DataModel.Portfolio.SimpleRepresentative' text/json: schema: $ref: '#/components/schemas/OAS.DataModel.Portfolio.SimpleRepresentative' application/xml: schema: $ref: '#/components/schemas/OAS.DataModel.Portfolio.SimpleRepresentative' text/xml: schema: $ref: '#/components/schemas/OAS.DataModel.Portfolio.SimpleRepresentative' multipart/form-data: schema: $ref: '#/components/schemas/OAS.DataModel.Portfolio.SimpleRepresentative' security: - Authorization: [] /v1/Portfolio/Representatives/{key}/SSNTaxId: put: tags: - Portfolio/Representatives summary: Retrieve or update SSN for representative description: If updateInfo.SSN is null => we will just retrieve SSN otherwise we will attempt to update SSN with data in updateInfo.SSN operationId: Representatives_UpdateSSNTaxId parameters: - name: key in: path required: true schema: type: integer format: int32 responses: '200': description: OK content: text/plain: schema: type: object application/json: schema: type: object text/json: schema: type: object multipart/form-data: schema: type: object security: - Authorization: [] requestBody: content: text/plain: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.UpdateSsnDto' application/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.UpdateSsnDto' text/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.UpdateSsnDto' application/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.UpdateSsnDto' text/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.UpdateSsnDto' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.UpdateSsnDto' multipart/form-data: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.UpdateSsnDto' required: true /v1/Portfolio/Representatives/{key}/Subadvisors: get: tags: - Portfolio/Representatives operationId: Representatives_GetApprovedSubadvisorsForRep parameters: - name: key in: path required: true schema: type: integer format: int32 responses: '200': description: OK content: text/plain: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array application/json: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array text/json: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array application/xml: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array text/xml: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array multipart/form-data: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array security: - Authorization: [] summary: Representatives get approved subadvisors for rep x-summary-source: derived /v1/Portfolio/Representatives/{key}/UserDefinedFields: get: tags: - Portfolio/Representatives operationId: Representatives_GetUserDefinedFields parameters: - name: key in: path required: true schema: type: integer format: int32 - name: entities in: query required: false style: form explode: true schema: type: array items: type: string enum: - BrokerDealers - Wholesalers - Representatives - Clients - Registrations - Accounts - Assets - Transactions - Products - FundFamilies - ModelRanges - PortfolioGroups responses: '200': description: OK content: text/plain: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.EntityOptionDto' xml: name: EntityOptionDto wrapped: true type: array application/json: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.EntityOptionDto' xml: name: EntityOptionDto wrapped: true type: array text/json: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.EntityOptionDto' xml: name: EntityOptionDto wrapped: true type: array application/xml: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.EntityOptionDto' xml: name: EntityOptionDto wrapped: true type: array text/xml: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.EntityOptionDto' xml: name: EntityOptionDto wrapped: true type: array multipart/form-data: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.EntityOptionDto' xml: name: EntityOptionDto wrapped: true type: array security: - Authorization: [] summary: Representatives get user defined fields x-summary-source: derived /v1/Portfolio/Representatives/Action/Delete: post: tags: - Portfolio/Representatives operationId: Representatives_ActionDeleteAsync parameters: - name: cancellationToken in: header required: true responses: '200': description: OK content: text/plain: schema: items: type: integer format: int32 type: array application/json: schema: items: type: integer format: int32 type: array text/json: schema: items: type: integer format: int32 type: array application/xml: schema: items: type: integer format: int32 type: array text/xml: schema: items: type: integer format: int32 type: array multipart/form-data: schema: items: type: integer format: int32 type: array security: - Authorization: [] requestBody: content: text/plain: schema: items: type: integer format: int32 type: array application/json: schema: items: type: integer format: int32 type: array text/json: schema: items: type: integer format: int32 type: array application/xml: schema: items: type: integer format: int32 type: array text/xml: schema: items: type: integer format: int32 type: array application/x-www-form-urlencoded: schema: items: type: integer format: int32 type: array multipart/form-data: schema: items: type: integer format: int32 type: array required: true summary: Representatives action delete async x-summary-source: derived /v1/Portfolio/Representatives/Action/RecalculateAUMData: put: tags: - Portfolio/Representatives summary: Endpoint to recalculate AUM data for a representative operationId: Representatives_RecalculateAUMData responses: '200': description: OK content: text/plain: schema: type: object application/json: schema: type: object text/json: schema: type: object multipart/form-data: schema: type: object security: - Authorization: [] /v1/Portfolio/Representatives/Action/ValidateChangeHistory/{repId}: post: tags: - Portfolio/Representatives operationId: Representatives_ValidateChangeHistoryAsync parameters: - name: repId in: path required: true schema: type: integer format: int32 - name: ct in: header required: true responses: '200': description: OK content: text/plain: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepBrokerDealerDto' xml: name: RepBrokerDealerDto wrapped: true type: array application/json: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepBrokerDealerDto' xml: name: RepBrokerDealerDto wrapped: true type: array text/json: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepBrokerDealerDto' xml: name: RepBrokerDealerDto wrapped: true type: array application/xml: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepBrokerDealerDto' xml: name: RepBrokerDealerDto wrapped: true type: array text/xml: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepBrokerDealerDto' xml: name: RepBrokerDealerDto wrapped: true type: array multipart/form-data: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepBrokerDealerDto' xml: name: RepBrokerDealerDto wrapped: true type: array security: - Authorization: [] requestBody: content: text/plain: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepBrokerDealerDto' xml: name: RepBrokerDealerDto wrapped: true type: array application/json: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepBrokerDealerDto' xml: name: RepBrokerDealerDto wrapped: true type: array text/json: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepBrokerDealerDto' xml: name: RepBrokerDealerDto wrapped: true type: array application/xml: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepBrokerDealerDto' xml: name: RepBrokerDealerDto wrapped: true type: array text/xml: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepBrokerDealerDto' xml: name: RepBrokerDealerDto wrapped: true type: array application/x-www-form-urlencoded: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepBrokerDealerDto' xml: name: RepBrokerDealerDto wrapped: true type: array multipart/form-data: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepBrokerDealerDto' xml: name: RepBrokerDealerDto wrapped: true type: array required: true summary: Representatives validate change history async x-summary-source: derived /v1/Portfolio/Representatives/Client/{key}: get: tags: - Portfolio/Representatives summary: Gets a simple list of representatives that matches the client key operationId: Representatives_GetSimpleRepByClientId parameters: - name: key in: path description: Key of client of the desired return objects. required: true schema: type: integer format: int32 responses: '200': description: OK content: text/plain: schema: type: object application/json: schema: type: object text/json: schema: type: object multipart/form-data: schema: type: object security: - Authorization: [] /v1/Portfolio/Representatives/GetDefault: get: tags: - Portfolio/Representatives summary: Gets the default rep operationId: Representatives_GetDefault responses: '200': description: OK content: text/plain: schema: type: object application/json: schema: type: object text/json: schema: type: object multipart/form-data: schema: type: object security: - Authorization: [] /v1/Portfolio/Representatives/Reptitles: get: tags: - Portfolio/Representatives operationId: Representatives_GetRepTitles responses: '200': description: OK content: text/plain: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array application/json: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array text/json: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array application/xml: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array text/xml: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array multipart/form-data: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array security: - Authorization: [] summary: Representatives get rep titles x-summary-source: derived put: tags: - Portfolio/Representatives operationId: Representatives_UpdateRepTitles responses: '200': description: OK content: text/plain: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array application/json: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array text/json: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array application/xml: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array text/xml: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array multipart/form-data: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array security: - Authorization: [] requestBody: content: text/plain: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array application/json: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array text/json: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array application/xml: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array text/xml: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array application/x-www-form-urlencoded: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array multipart/form-data: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array required: true summary: Representatives update rep titles x-summary-source: derived /v1/Portfolio/Representatives/Simple: get: tags: - Portfolio/Representatives summary: Gets a simple list of representatives that the logged in user has access to operationId: Representatives_GetSimple parameters: - name: isUsed in: query description: Optional. When provided will only return representatives that have are used (true) or are not used (false). required: false schema: type: boolean responses: '200': description: OK content: text/plain: schema: type: object application/json: schema: type: object text/json: schema: type: object multipart/form-data: schema: type: object security: - Authorization: [] /v1/Portfolio/Representatives/Simple/List: post: tags: - Portfolio/Representatives summary: Gets a simple list of representatives that match one of the keys in the… operationId: Representatives_GetSimpleListById responses: '200': description: OK content: text/plain: schema: type: object application/json: schema: type: object text/json: schema: type: object multipart/form-data: schema: type: object security: - Authorization: [] requestBody: content: text/plain: schema: items: type: integer format: int32 type: array application/json: schema: items: type: integer format: int32 type: array text/json: schema: items: type: integer format: int32 type: array application/xml: schema: items: type: integer format: int32 type: array text/xml: schema: items: type: integer format: int32 type: array application/x-www-form-urlencoded: schema: items: type: integer format: int32 type: array multipart/form-data: schema: items: type: integer format: int32 type: array description: List of keys of the desired return objects. required: true /v1/Portfolio/Representatives/Simple/List/Id: post: tags: - Portfolio/Representatives summary: Gets a simple list of representatives that match one of the keys in the… operationId: Representatives_PostV1PortfolioRepresentativesSimpleListId responses: '200': description: OK content: text/plain: schema: type: object application/json: schema: type: object text/json: schema: type: object multipart/form-data: schema: type: object security: - Authorization: [] requestBody: content: text/plain: schema: items: type: integer format: int32 type: array application/json: schema: items: type: integer format: int32 type: array text/json: schema: items: type: integer format: int32 type: array application/xml: schema: items: type: integer format: int32 type: array text/xml: schema: items: type: integer format: int32 type: array application/x-www-form-urlencoded: schema: items: type: integer format: int32 type: array multipart/form-data: schema: items: type: integer format: int32 type: array description: List of keys of the desired return objects. required: true /v1/Portfolio/Representatives/Simple/Search: get: tags: - Portfolio/Representatives summary: Gets a simple list of representatives that the logged in user has access to… operationId: Representatives_GetSimpleRepresentativeSearch parameters: - name: search in: query description: Partial representative name to search for. required: true schema: type: string - name: hasEmail in: query required: false schema: type: boolean - name: isUsed in: query required: false schema: type: boolean - name: isActive in: query required: false schema: type: boolean responses: '200': description: OK content: text/plain: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array application/json: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array text/json: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array application/xml: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array text/xml: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array multipart/form-data: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array security: - Authorization: [] /v1/Portfolio/Representatives/Simple/Search/{search}: get: tags: - Portfolio/Representatives summary: Gets a simple list of representatives that the logged in user has access to… operationId: Representatives_GetV1PortfolioRepresentativesSimpleSearchBySearch parameters: - name: search in: path description: Partial representative name to search for. required: true schema: type: string - name: hasEmail in: query required: false schema: type: boolean - name: isUsed in: query required: false schema: type: boolean - name: isActive in: query required: false schema: type: boolean responses: '200': description: OK content: text/plain: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array application/json: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array text/json: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array application/xml: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array text/xml: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array multipart/form-data: schema: items: $ref: '#/components/schemas/OAS.DataModel.SimpleEntity' xml: name: SimpleEntity wrapped: true type: array security: - Authorization: [] /v1/Portfolio/Representatives/Value: get: tags: - Portfolio/Representatives summary: Gets a simple list of representatives (including aum for today) that the logged… operationId: Representatives_GetValue responses: '200': description: OK content: text/plain: schema: type: object application/json: schema: type: object text/json: schema: type: object multipart/form-data: schema: type: object security: - Authorization: [] /v1/Portfolio/Representatives/Value/{asOfDate}: get: tags: - Portfolio/Representatives summary: Gets a simple list of representatives (including aum for the end of the date… operationId: Representatives_GetValueAsOfDate parameters: - name: asOfDate in: path description: The aum returned is as of the end of this date. required: true schema: type: string format: date-time responses: '200': description: OK content: text/plain: schema: type: object application/json: schema: type: object text/json: schema: type: object multipart/form-data: schema: type: object security: - Authorization: [] /v1/Portfolio/Representatives/Verbose: get: tags: - Portfolio/Representatives operationId: Representatives_GetVerbose parameters: - name: isActive in: query required: false schema: type: boolean - name: expand in: query required: false style: form explode: true schema: type: array items: type: string enum: - None - Portfolio - BillRepresentativePlatforms - ReportImage - Notes - Documents - UserDefinedFields - EntityOptions - RepresentativeChanges - RepBrokerDealers - All responses: '200': description: OK content: text/plain: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' xml: name: RepresentativeVerboseDto wrapped: true type: array application/json: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' xml: name: RepresentativeVerboseDto wrapped: true type: array text/json: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' xml: name: RepresentativeVerboseDto wrapped: true type: array application/xml: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' xml: name: RepresentativeVerboseDto wrapped: true type: array text/xml: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' xml: name: RepresentativeVerboseDto wrapped: true type: array multipart/form-data: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' xml: name: RepresentativeVerboseDto wrapped: true type: array security: - Authorization: [] summary: Representatives get verbose x-summary-source: derived put: tags: - Portfolio/Representatives operationId: Representatives_UpdateVerboseRepresentativesAsync parameters: - name: ct in: header required: true responses: '200': description: OK content: text/plain: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' xml: name: RepresentativeVerboseDto wrapped: true type: array application/json: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' xml: name: RepresentativeVerboseDto wrapped: true type: array text/json: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' xml: name: RepresentativeVerboseDto wrapped: true type: array application/xml: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' xml: name: RepresentativeVerboseDto wrapped: true type: array text/xml: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' xml: name: RepresentativeVerboseDto wrapped: true type: array multipart/form-data: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' xml: name: RepresentativeVerboseDto wrapped: true type: array security: - Authorization: [] requestBody: content: text/plain: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' xml: name: RepresentativeVerboseDto wrapped: true type: array application/json: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' xml: name: RepresentativeVerboseDto wrapped: true type: array text/json: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' xml: name: RepresentativeVerboseDto wrapped: true type: array application/xml: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' xml: name: RepresentativeVerboseDto wrapped: true type: array text/xml: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' xml: name: RepresentativeVerboseDto wrapped: true type: array application/x-www-form-urlencoded: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' xml: name: RepresentativeVerboseDto wrapped: true type: array multipart/form-data: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' xml: name: RepresentativeVerboseDto wrapped: true type: array required: true summary: Representatives update verbose representatives async x-summary-source: derived post: tags: - Portfolio/Representatives summary: Create new representative operationId: Representatives_CreateVerboseRepresentativeAsync parameters: - name: ct in: header required: true responses: '200': description: OK content: text/plain: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' application/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' text/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' application/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' text/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' multipart/form-data: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' security: - Authorization: [] requestBody: content: text/plain: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' application/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' text/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' application/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' text/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' multipart/form-data: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' required: true /v1/Portfolio/Representatives/Verbose/{key}: get: tags: - Portfolio/Representatives operationId: Representatives_GetVerboseByKeyAsync parameters: - name: key in: path required: true schema: type: integer format: int32 - name: ct in: header required: true - name: expand in: query required: false style: form explode: true schema: type: array items: type: string enum: - None - Portfolio - BillRepresentativePlatforms - ReportImage - Notes - Documents - UserDefinedFields - EntityOptions - RepresentativeChanges - RepBrokerDealers - All responses: '200': description: OK content: text/plain: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' application/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' text/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' application/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' text/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' multipart/form-data: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' security: - Authorization: [] summary: Representatives get verbose by key async x-summary-source: derived put: tags: - Portfolio/Representatives operationId: Representatives_UpdateVerboseRepresentativeAsync parameters: - name: key in: path required: true schema: type: integer format: int32 - name: ct in: header required: true responses: '200': description: OK content: text/plain: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' application/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' text/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' application/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' text/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' multipart/form-data: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' security: - Authorization: [] requestBody: content: text/plain: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' application/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' text/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' application/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' text/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' multipart/form-data: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' required: true summary: Representatives update verbose representative async x-summary-source: derived /v1/Portfolio/Representatives/Verbose/List: post: tags: - Portfolio/Representatives operationId: Representatives_GetVerboseListById parameters: - name: expand in: query required: false style: form explode: true schema: type: array items: type: string enum: - None - Portfolio - BillRepresentativePlatforms - ReportImage - Notes - Documents - UserDefinedFields - EntityOptions - RepresentativeChanges - RepBrokerDealers - All responses: '200': description: OK content: text/plain: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' xml: name: RepresentativeVerboseDto wrapped: true type: array application/json: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' xml: name: RepresentativeVerboseDto wrapped: true type: array text/json: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' xml: name: RepresentativeVerboseDto wrapped: true type: array application/xml: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' xml: name: RepresentativeVerboseDto wrapped: true type: array text/xml: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' xml: name: RepresentativeVerboseDto wrapped: true type: array multipart/form-data: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' xml: name: RepresentativeVerboseDto wrapped: true type: array security: - Authorization: [] requestBody: content: text/plain: schema: items: type: integer format: int32 type: array application/json: schema: items: type: integer format: int32 type: array text/json: schema: items: type: integer format: int32 type: array application/x-www-form-urlencoded: schema: items: type: integer format: int32 type: array multipart/form-data: schema: items: type: integer format: int32 type: array required: true summary: Representatives get verbose list by id x-summary-source: derived /v1/Portfolio/Representatives/Verbose/List/Id: post: tags: - Portfolio/Representatives operationId: Representatives_PostV1PortfolioRepresentativesVerboseListId parameters: - name: expand in: query required: false style: form explode: true schema: type: array items: type: string enum: - None - Portfolio - BillRepresentativePlatforms - ReportImage - Notes - Documents - UserDefinedFields - EntityOptions - RepresentativeChanges - RepBrokerDealers - All responses: '200': description: OK content: text/plain: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' xml: name: RepresentativeVerboseDto wrapped: true type: array application/json: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' xml: name: RepresentativeVerboseDto wrapped: true type: array text/json: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' xml: name: RepresentativeVerboseDto wrapped: true type: array application/xml: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' xml: name: RepresentativeVerboseDto wrapped: true type: array text/xml: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' xml: name: RepresentativeVerboseDto wrapped: true type: array multipart/form-data: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' xml: name: RepresentativeVerboseDto wrapped: true type: array security: - Authorization: [] requestBody: content: text/plain: schema: items: type: integer format: int32 type: array application/json: schema: items: type: integer format: int32 type: array text/json: schema: items: type: integer format: int32 type: array application/x-www-form-urlencoded: schema: items: type: integer format: int32 type: array multipart/form-data: schema: items: type: integer format: int32 type: array required: true summary: Representatives post V1 portfolio representatives verbose list id x-summary-source: derived /v1/Portfolio/Representatives/Verbose/New: get: tags: - Portfolio/Representatives operationId: Representatives_GetNewVerbose parameters: - name: expand in: query required: false style: form explode: true schema: type: array items: type: string enum: - None - Portfolio - BillRepresentativePlatforms - ReportImage - Notes - Documents - UserDefinedFields - EntityOptions - RepresentativeChanges - RepBrokerDealers - All responses: '200': description: OK content: text/plain: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' application/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' text/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' application/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' text/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' multipart/form-data: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto' security: - Authorization: [] summary: Representatives get new verbose x-summary-source: derived components: schemas: MultipartDataMediaFormatter.Infrastructure.HttpFile: properties: fileName: type: string mediaType: type: string data: $ref: '#/components/schemas/System.Net.Http.StreamContent' xml: name: HttpFile type: object System.Collections.Generic.KeyValuePairOfSystem.StringAndSystem.Collections.Generic.IEnumerableOfSystem.String: properties: key: readOnly: true type: string value: items: type: string readOnly: true type: array xml: name: KeyValuePair`2 type: object OAS.WebApi.DTO.Portfolio.AccountDto: properties: isActive: type: boolean custodian: type: string custodianCode: type: string managementStyle: type: string currentValue: type: number format: double fundFamily: type: string accountStartValue: type: number format: double createdDate: type: string format: date-time isManaged: type: boolean isSweepAccount: type: boolean isSleeveAccount: type: boolean sleeveType: type: string enum: - Normal sleeve - Custodial account - Contribution sleeve - Distribution sleeve - Unmanaged sleeve isAdvReportable: type: boolean is13FReportable: type: boolean isAuaReportable: type: boolean advCustodyTypeId: type: integer format: int32 custodialRepCode: type: string brokerDealer: type: string importKey: type: string outsideId: type: string secondaryAccountNumber: type: string managementStyleId: type: integer format: int32 fundFamilyId: type: integer format: int32 accountHistoryId: type: integer format: int32 registrationId: type: integer format: int32 clientId: type: integer format: int32 custodianId: type: integer format: int32 shareClass: type: string shareClassId: type: integer format: int32 subAdvisorId: type: integer format: int32 provider: type: string plan: type: integer format: int32 planName: type: string modelGroupNumber: type: string isOriginalSMCAccount: type: boolean isTradingBlocked: type: boolean tradingInstructions: type: string downloadSource: type: string businessLine: type: string createdBy: type: string accountStartDate: type: string format: date-time editedBy: type: string editedDate: type: string format: date-time accountStatusId: type: integer format: int32 accountStatus: type: string accountStatusDescription: type: string feeScheduleId: type: integer format: int32 feeSchedule: type: string masterPayoutScheduleId: type: integer format: int32 masterPayoutSchedule: type: string billFrequency: type: string enum: - Undefined - Monthly - Quarterly - Triannual - Semiannually - Annually - AtMaturity representative: type: string representativeNumber: type: string representativeId: type: integer format: int32 household: type: string cancelDate: type: string format: date-time riskBudget: type: integer format: int32 modelAggId: type: integer format: int32 billPayMethod: type: string acceptsList: type: boolean billStartDate: type: string format: date-time missingInfoFromView: type: string sweepAssetId: type: integer format: int32 includeInAggregate: type: boolean isDiscretionary: type: boolean cashBalance: type: number format: double sleeveStrategy: type: string isQualified: type: boolean riskScore: type: number format: double isWrapManaged: type: boolean isWrapSponsored: type: boolean lastName: type: string nickname: type: string isPositionOnlyRecon: type: boolean eclipseFirmId: type: integer format: int32 isUnfunded: type: boolean isBundled: type: boolean isExcludedFromFirmAssets: type: boolean annuityIncomeValue: type: number format: double currentRiskScore: type: integer format: int32 targetRiskScore: type: integer format: int32 riskScoreAsOfDate: type: string format: date-time riskScoreProvider: description: The source of {OAS.WebApi.DTO.Portfolio.AccountDto.TargetRiskScore}{OAS.WebApi.DTO.Portfolio.AccountDto.CurrentRiskScore} and {OAS.WebApi.DTO.Portfolio.AccountDto.RiskScoreAsOfDate} type: string riskTol: type: integer format: int32 tieredFeePriority: type: integer format: int32 additionalColumns: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Interface.AdditionalColumnDefinition' xml: name: AdditionalColumnDefinition wrapped: true type: array isOps: type: boolean lastPositionDate: type: string format: date-time inBalance: type: boolean lastReconciledEffectiveDate: type: string format: date-time clientGlobalId: example: 00000000-0000-0000-0000-000000000000 type: string format: uuid registrationGlobalId: example: 00000000-0000-0000-0000-000000000000 type: string format: uuid id: type: integer format: int32 name: type: string number: type: string modelName: type: string subAdvisor: type: string accountType: type: string isDataSharingEntity: type: boolean xml: name: AccountDto type: object OAS.WebApi.DTO.Settings.EntityOptionDto: properties: userDefineDataId: type: integer format: int32 value: type: string childParameter: type: string 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 entityId: type: integer format: int32 entityName: type: string userDefineDefinitionId: type: integer format: int32 name: type: string category: type: string type: type: string enum: - MultiLineEditor - DropDownEditor - DropDownList - CheckBox - Currency - Date - DateTime - Integer - String - Double - Time - Long - CustomObject - Email maxLength: type: integer format: int32 code: type: string sequence: type: integer format: int32 options: type: object input: type: string securityCode: type: string canEdit: type: boolean xml: name: EntityOptionDto type: object OAS.WebApi.DTO.Portfolio.RepStateDto: properties: id: type: integer format: int32 stateId: type: integer format: int32 stateName: type: string xml: name: RepStateDto type: object OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue: properties: value: type: number format: double number: type: string managementStyle: type: string isActive: type: boolean clientId: type: integer format: int32 custodian: type: string registrationId: type: integer format: int32 id: type: integer format: int32 name: type: string xml: name: SimpleAccountWithValue type: object System.Net.Http.StreamContent: properties: headers: items: $ref: '#/components/schemas/System.Collections.Generic.KeyValuePairOfSystem.StringAndSystem.Collections.Generic.IEnumerableOfSystem.String' readOnly: true xml: name: KeyValuePair`2 wrapped: true type: array xml: name: StreamContent type: object OAS.DataModel.SimpleEntity: properties: id: type: integer format: int32 name: type: string xml: name: SimpleEntity type: object OAS.WebApi.DTO.Interface.AdditionalColumnDefinition: properties: key: type: string value: type: string xml: name: AdditionalColumnDefinition type: object OAS.WebApi.DTO.Portfolio.UpdateSsnDto: properties: ssn: type: string reason: type: string xml: name: UpdateSsnDto type: object OAS.WebApi.DTO.Portfolio.RepNasdDto: properties: nasdId: type: integer format: int32 representativeId: type: integer format: int32 number: type: string xml: name: RepNasdDto type: object OAS.WebApi.DTO.Portfolio.RepOnHoldDto: properties: id: type: integer format: int32 entityEnum: type: integer format: int32 holdDate: type: string format: date-time holdStatus: type: string xml: name: RepOnHoldDto type: object OAS.WebApi.DTO.Billing.BillRepresentativePlatformDto: properties: id: type: integer format: int32 billFeeScheduleId: type: integer format: int32 platformId: type: integer format: int32 billMasterPayoutScheduleId: type: integer format: int32 xml: name: BillRepresentativePlatformDto type: object OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto: properties: id: type: integer format: int32 name: type: string portfolio: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativePortfolioDto' notes: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.NoteDto' xml: name: NoteDto wrapped: true type: array documents: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.DocumentDto' xml: name: DocumentDto wrapped: true type: array billRepresentativePlatforms: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Billing.BillRepresentativePlatformDto' xml: name: BillRepresentativePlatformDto wrapped: true type: array repBrokerDealers: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepBrokerDealerDto' xml: name: RepBrokerDealerDto wrapped: true type: array reportImage: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepresentativeReportImageDto' userDefinedFields: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.EntityOptionDto' xml: name: EntityOptionDto wrapped: true type: array entityOptions: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Settings.EntityOptionDto' xml: name: EntityOptionDto wrapped: true type: array xml: name: RepresentativeVerboseDto type: object OAS.DataModel.Portfolio.SimpleRepresentative: properties: isActive: type: boolean number: type: string id: type: integer format: int32 name: type: string xml: name: SimpleRepresentative type: object OAS.DataModel.Portfolio.SimpleClient: properties: firstName: type: string lastName: type: string entityName: type: string isActive: type: boolean repCode: type: string id: type: integer format: int32 name: type: string xml: name: SimpleClient type: object OAS.WebApi.DTO.Portfolio.RepresentativePortfolioDto: properties: brokerDealerId: type: integer format: int32 wholesalerId: type: integer format: int32 payeeId: type: integer format: int32 payoutOverride: type: number format: double riaId: type: integer format: int32 wholesaler401KId: type: integer format: int32 planAdministratorId: type: integer format: int32 custodianId: type: integer format: int32 createdDate: type: string format: date-time copyToRep: type: boolean isRIA: type: boolean riaName: type: string royalTCode: type: string hasADV: type: boolean hasU4: type: boolean isActive: type: boolean isDstDwnld: type: boolean branchID: type: string oldRep_ID: type: integer format: int32 number: type: string impDate: type: string format: date-time createdBy: type: string editedDate: type: string format: date-time firstTransactionDate: type: string format: date-time editedBy: type: string startDate: type: string format: date-time repStatus: type: string enum: - ActiveNoIssues - HoldForCompliance - ActiveNoNewClients - InActive - Pending - Limited - Prospect - Rejected firmName: type: string actgLedgerNum: type: string isDefault: type: boolean importKey: example: 00000000-0000-0000-0000-000000000000 type: string format: uuid raAmount: type: number format: double raDate: type: string format: date-time isRAActive: type: boolean repRestrict: type: string custodianPortalId: type: string name: type: string salutation: type: string address1: type: string address2: type: string address3: type: string zip: type: string homePhone: type: string homePhoneExt: type: string fax: type: string faxExt: type: string pager: type: string pagerExt: type: string mobilePhone: type: string businessPhone: type: string businessPhoneExt: type: string otherPhone: type: string otherPhoneExt: type: string reportName: type: string company: type: string jobTitle: type: string ssN_TaxID: type: string gender: type: string dob: type: string format: date-time webAddress: type: string lastName: type: string firstName: type: string prefix: type: string suffix: type: string id: type: integer format: int32 city: type: string state: type: string email: type: string repNasds: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepNasdDto' xml: name: RepNasdDto wrapped: true type: array repOnHolds: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepOnHoldDto' xml: name: RepOnHoldDto wrapped: true type: array repStates: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.RepStateDto' xml: name: RepStateDto wrapped: true type: array payoutDashNotCompliance: type: boolean repCRDNumber: type: string xml: name: RepresentativePortfolioDto type: object OAS.WebApi.DTO.Portfolio.RepBrokerDealerDto: properties: id: type: integer format: int32 representativeId: type: integer format: int32 startDate: type: string format: date-time endDate: type: string format: date-time brokerDealerId: type: integer format: int32 isActive: type: boolean createdDate: type: string format: date-time createdBy: type: string editedDate: type: string format: date-time editedBy: type: string isSystemGenerated: type: boolean isValid: type: boolean validationMessage: type: string xml: name: RepBrokerDealerDto type: object OAS.WebApi.DTO.Portfolio.RepresentativeDto: properties: id: type: integer format: int32 repNo: type: string fullName: type: string firstName: type: string lastName: type: string addressLine1: type: string addressLine2: type: string city: type: string state: type: string zip: type: string phoneNumber: type: string email: type: string company: type: string mobilePhoneNumber: type: string faxNumber: type: string brokerDealer: type: string businessPhoneNumber: type: string households: type: integer format: int32 value: type: number format: double isActive: type: boolean accountingLedgerNo: type: string branch: type: string copyToRep: type: boolean createdBy: type: string createdDate: type: string format: date-time default: type: boolean destinationDownload: type: boolean editedBy: type: string editedDate: type: string format: date-time firmName: type: string hasADV: type: boolean hasU4: type: boolean importKey: example: 00000000-0000-0000-0000-000000000000 type: string format: uuid payee: type: integer format: int32 planAdministrator: type: integer format: int32 raActive: type: boolean raAmount: type: number format: double raDate: type: string format: date-time repRestriction: type: string riaId: type: integer format: int32 riaName: type: string royalTCode: type: string startDate: type: string format: date-time status: type: string enum: - ActiveNoIssues - HoldForCompliance - ActiveNoNewClients - InActive - Pending - Limited - Prospect - Rejected wholeSaler: type: string custodianId: type: integer format: int32 brokerDealerId: type: integer format: int32 custodianPortalId: type: string repCRDNumber: type: string globalId: example: 00000000-0000-0000-0000-000000000000 type: string format: uuid xml: name: RepresentativeDto type: object OAS.WebApi.DTO.Portfolio.DocumentDto: properties: id: type: integer format: int32 description: type: string category: type: string editedBy: type: string editedDate: type: string format: date-time systemGenerated: type: boolean xml: name: DocumentDto type: object OAS.WebApi.DTO.Portfolio.BlobBaseDto: properties: createdDate: type: string format: date-time id: type: integer format: int32 openWith: type: string fileName: type: string blobDesc: type: string blobText: type: string category: type: string isZip: type: boolean xml: name: BlobBaseDto type: object OAS.WebApi.DTO.Portfolio.NoteDto: properties: id: type: integer format: int32 text: type: string editedBy: type: string editedDate: type: string format: date-time category: type: string isWebVisible: type: boolean isSystemGenerated: type: boolean xml: name: NoteDto type: object OAS.WebApi.DTO.Portfolio.RepresentativeFileDto: properties: file: $ref: '#/components/schemas/MultipartDataMediaFormatter.Infrastructure.HttpFile' openWith: type: string blobDesc: type: string category: type: string blobType: type: string enum: - QuarterlyStatements - CrmDocuments - Payable xml: name: RepresentativeFileDto type: object OAS.WebApi.DTO.Portfolio.RepresentativeReportImageDto: properties: representativeId: type: integer format: int32 image: type: string format: byte height: type: number format: double width: type: number format: double barColor: type: string maxLength: 50 minLength: 0 xml: name: RepresentativeReportImageDto type: object securitySchemes: Authorization: type: apiKey description: 'JWT Authorization header using the Session scheme. Example: "Authorization: Session {token}"' name: Authorization in: header