Institution Contact Info

openapi: 3.0.0 info: version: '0.0' title: Institution Contact Info tags: - name: Institution Contact servers: - url: 'https://banno.com' paths: "/a/institution-contact-info/api/v0/institutions/{institutionId}/contact-info": get: tags: - Institution Contact description: | Returns the basic information for an institution. Requires the "View" permission for People parameters: - $ref: '#/components/parameters/institutionIdParam' responses: "200": description: OK content: application/json: schema: $ref: "#/components/schemas/contactInfoResponse" put: tags: - Institution Contact description: | Updates the contact information for an institution. Requires the "Manage everything – users, messages & settings" permission for People parameters: - $ref: '#/components/parameters/institutionIdParam' requestBody: content: application/json: schema: $ref: "#/components/schemas/updateContact" description: Institution information to update. responses: "200": description: OK patch: tags: - Institution Contact description: | Updates the contact information for an institution. Requires the "Manage everything – users, messages & settings" permission for People parameters: - $ref: '#/components/parameters/institutionIdParam' requestBody: content: application/json: schema: $ref: "#/components/schemas/updateContact" description: Institution information to update. All fields are optional, and only provided fields will be updated. responses: "200": description: OK components: securitySchemes: clientCredentials: type: oauth2 description: OAuth2 using the client credentials flow flows: clientCredentials: tokenUrl: https://banno.com/a/oidc-provider/api/v0/token scopes: {} parameters: institutionIdParam: in: path name: institutionId required: true schema: $ref: '#/components/schemas/institutionId' schemas: contactInfoResponse: type: object properties: details: $ref: "#/components/schemas/contactInfo" contactInfo: type: object required: - supportEmail properties: supportEmail: type: string phone: type: string privacyPolicyUrl: type: string contactHtml: type: string contactEmail: type: string updateContact: type: object properties: phone: type: string supportEmail: type: string contactEmail: type: string contactHtml: type: string privacyPolicyUrl: type: string institutionId: type: string format: uuid description: institution id