openapi: 3.2.0 info: version: V1 title: Orion Connect Portfolio/Bond Ratings API x-swagger-net-version: 8.4.12.001 servers: - url: https://api.orionadvisor.com/api tags: - name: Portfolio/BondRatings paths: /v1/Portfolio/BondRatings: get: tags: - Portfolio/BondRatings summary: Gets a list of bond ratings that the logged in user has access to operationId: BondRatings_Get parameters: - name: source in: query description: 'Optional. Default: null. When provided only ratings with the provided source are returned. Ex: "S&P" or "Moody"' required: false schema: type: string responses: '200': description: OK content: text/plain: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BondRatingDto' xml: name: BondRatingDto wrapped: true type: array application/json: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BondRatingDto' xml: name: BondRatingDto wrapped: true type: array text/json: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BondRatingDto' xml: name: BondRatingDto wrapped: true type: array application/xml: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BondRatingDto' xml: name: BondRatingDto wrapped: true type: array text/xml: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BondRatingDto' xml: name: BondRatingDto wrapped: true type: array multipart/form-data: schema: items: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BondRatingDto' xml: name: BondRatingDto wrapped: true type: array security: - Authorization: [] post: tags: - Portfolio/BondRatings summary: Used to create a new bond rating. operationId: BondRatings_Create 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.BondRatingDto' application/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BondRatingDto' text/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BondRatingDto' application/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BondRatingDto' text/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BondRatingDto' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BondRatingDto' multipart/form-data: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BondRatingDto' required: true /v1/Portfolio/BondRatings/{key}: get: tags: - Portfolio/BondRatings summary: Gets the bond rating that has the provided key. operationId: BondRatings_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: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BondRatingDto' application/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BondRatingDto' text/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BondRatingDto' application/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BondRatingDto' text/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BondRatingDto' multipart/form-data: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BondRatingDto' security: - Authorization: [] put: tags: - Portfolio/BondRatings summary: Used to update an existing bond rating. operationId: BondRatings_Update 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.BondRatingDto' application/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BondRatingDto' text/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BondRatingDto' application/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BondRatingDto' text/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BondRatingDto' multipart/form-data: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BondRatingDto' security: - Authorization: [] requestBody: content: text/plain: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BondRatingDto' application/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BondRatingDto' text/json: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BondRatingDto' application/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BondRatingDto' text/xml: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BondRatingDto' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BondRatingDto' multipart/form-data: schema: $ref: '#/components/schemas/OAS.WebApi.DTO.Portfolio.BondRatingDto' required: true delete: tags: - Portfolio/BondRatings summary: Used to delete an existing bond rating. operationId: BondRatings_Delete 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: [] /v1/Portfolio/BondRatings/Simple: get: tags: - Portfolio/BondRatings summary: Gets a simple list of bond ratings that the logged in user has access to operationId: BondRatings_GetSimple parameters: - name: source in: query description: 'Optional. Default: null. When provided only ratings with the provided source are returned. Ex: "S&P" or "Moody"' required: false schema: type: string 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: [] components: schemas: OAS.WebApi.DTO.Portfolio.BondRatingDto: properties: id: type: integer format: int32 code: type: string ratingNumber: type: integer format: int32 description: type: string source: type: string xml: name: BondRatingDto type: object OAS.DataModel.SimpleEntity: properties: id: type: integer format: int32 name: type: string xml: name: SimpleEntity type: object securitySchemes: Authorization: type: apiKey description: 'JWT Authorization header using the Session scheme. Example: "Authorization: Session {token}"' name: Authorization in: header