openapi: 3.2.0 info: title: Kelowna Production TSS - Divisions API version: v1 tags: - name: TSS - Divisions paths: /TSS/Divisions: get: tags: - TSS - Divisions summary: Gets a list of the divisions responses: '200': description: OK content: text/plain: schema: type: array items: $ref: '#/components/schemas/Division' application/json: schema: type: array items: $ref: '#/components/schemas/Division' text/json: schema: type: array items: $ref: '#/components/schemas/Division' security: - OrcaAuth: - applicationId - roles - {} - {} operationId: getTSSDivisions x-operation-id-source: derived /TSS/Divisions/{id}: get: tags: - TSS - Divisions summary: Gets the details of a division parameters: - name: id in: path description: The ID of the division to get required: true schema: type: integer format: int32 responses: '200': description: OK content: text/plain: schema: $ref: '#/components/schemas/Division' application/json: schema: $ref: '#/components/schemas/Division' text/json: schema: $ref: '#/components/schemas/Division' security: - OrcaAuth: - applicationId - roles - {} - {} operationId: getTSSDivisionsById x-operation-id-source: derived /TSS/Divisions/Names: get: tags: - TSS - Divisions summary: Returns division names and ids, mostly used for dropdowns description: Used by both Orca and myCC parameters: - name: clientsOnly in: query description: Whether the divisions have ever been clients of CarbonCure schema: type: boolean - name: skipMasonry in: query description: Whether to ignore divisions with only masonry plants schema: type: boolean responses: '200': description: OK content: text/plain: schema: type: array items: $ref: '#/components/schemas/DivisionNameAndUnits' application/json: schema: type: array items: $ref: '#/components/schemas/DivisionNameAndUnits' text/json: schema: type: array items: $ref: '#/components/schemas/DivisionNameAndUnits' security: - OrcaAuth: - applicationId - roles - {} - {} operationId: getTSSDivisionsNames x-operation-id-source: derived /TSS/Divisions/Overview: get: tags: - TSS - Divisions summary: Returns an overview of customers (divisions) for TSS description: 'Still requires: list of alarms/alerts' responses: '200': description: OK content: text/plain: schema: type: array items: $ref: '#/components/schemas/DivisionOverviewArgs' application/json: schema: type: array items: $ref: '#/components/schemas/DivisionOverviewArgs' text/json: schema: type: array items: $ref: '#/components/schemas/DivisionOverviewArgs' security: - OrcaAuth: - applicationId - roles - {} - {} operationId: getTSSDivisionsOverview x-operation-id-source: derived /TSS/Divisions/Commissioning/{id}: put: tags: - TSS - Divisions summary: Marks a division's InCommissioning property as false parameters: - name: id in: path description: ID of division to update. required: true schema: type: integer format: int32 responses: '200': description: OK security: - OrcaAuth: - applicationId - roles - {} - {} operationId: putTSSDivisionsCommissioningById x-operation-id-source: derived /TSS/Divisions/Commissioning/{id}/{inCommissioning}: put: tags: - TSS - Divisions summary: Used to toggle a division's InCommissioning property for development parameters: - name: id in: path description: ID of division to update. required: true schema: type: integer format: int32 - name: inCommissioning in: path description: Whether division is currently in commissioning stage. required: true schema: type: boolean responses: '200': description: OK security: - OrcaAuth: - applicationId - roles - {} - {} operationId: putTSSDivisionsCommissioningByIdByInCommissioning x-operation-id-source: derived /Customers/Management/Divisions/{id}: get: tags: - TSS - Divisions summary: Gets the details of a division parameters: - name: id in: path description: The ID of the division to get required: true schema: type: integer format: int32 responses: '200': description: OK content: text/plain: schema: $ref: '#/components/schemas/Division' application/json: schema: $ref: '#/components/schemas/Division' text/json: schema: $ref: '#/components/schemas/Division' deprecated: true security: - OrcaAuth: - applicationId - roles - {} - {} operationId: getCustomersManagementDivisionsById x-operation-id-source: derived components: schemas: Division: required: - name type: object properties: divisionId: type: integer format: int32 name: minLength: 1 type: string corporationId: type: integer format: int32 sfAccountId: type: - string - 'null' sfCustomerSuccessId: type: - string - 'null' creationTimestamp: type: string format: date-time isImperial: type: boolean isRequiredStrengthRisky: type: boolean inCommissioning: type: boolean efTCO2EqPerTClinker: type: - number - 'null' format: double clinkerToCementRatio: type: - number - 'null' format: double stage: type: - string - 'null' churnRiskReason: type: - string - 'null' operationallyChurnedDate: type: - string - 'null' format: date tier: type: - string - 'null' arContactEmail: type: - string - 'null' tssRepId: type: - integer - 'null' format: int32 tssRep: $ref: '#/components/schemas/StaffUser' tpmRepId: type: - integer - 'null' format: int32 tpmRep: $ref: '#/components/schemas/StaffUser' amRepId: type: - integer - 'null' format: int32 amRep: $ref: '#/components/schemas/StaffUser' hardwareRepId: type: - integer - 'null' format: int32 hardwareRep: $ref: '#/components/schemas/StaffUser' website: type: - string - 'null' customerSuccessName: type: - string - 'null' additionalProperties: false Language: enum: - English - Spanish - NL - FR - DE - IT - ES - ES_MX - PT - PT_BR - JP - ZH_TW - ZH_CN - KO - ID - EN_GB - EN_US - EN_CA - TL - TH type: string User: required: - email - firstName - lastName - naiveFullName type: object properties: userId: type: integer format: int32 email: minLength: 1 type: string firstName: minLength: 1 type: string lastName: minLength: 1 type: string naiveFullName: minLength: 1 type: string externalUserId: type: - string - 'null' wasInviteSent: type: boolean readOnly: true jobTitle: type: - string - 'null' jobField: type: - array - 'null' items: type: string phone: type: - string - 'null' language: $ref: '#/components/schemas/Language' numericFormat: type: - string - 'null' myCCNotificationSubscriptionsId: type: integer format: int32 myCCNotificationSubscriptions: $ref: '#/components/schemas/MyCCNotificationSubscriptions' allowsCookies: type: - boolean - 'null' readOnly: true allowsFunctionalCookies: type: - boolean - 'null' allowsAnalyticsCookies: type: - boolean - 'null' enviroContactName: type: - string - 'null' enviroContactPhone: type: - string - 'null' enviroContactEmail: type: - string - 'null' enviroContactWebsite: type: - string - 'null' settingsChangedTimestamp: type: - string - 'null' format: date-time policiesAcceptedTimestamp: type: - string - 'null' format: date-time lastActivityTimestamp: type: - string - 'null' format: date-time additionalProperties: false MyCCNotificationSubscriptions: type: object properties: myCCNotificationSubscriptionsId: type: integer format: int32 user: $ref: '#/components/schemas/User' sendGridContactId: type: - string - 'null' hasNewFeatureSub: type: boolean hasPositionSub: type: boolean hasTestingSub: type: boolean hasActionItemsSub: type: boolean hasPlantUpdatesSub: type: boolean hasCreditUpdatesSub: type: boolean hasNewOnboardingTaskSub: type: boolean hasOngoingTasksSub: type: boolean subscriptionsChangedTimestamp: type: - string - 'null' format: date-time additionalProperties: false DivisionOverviewArgs: type: object properties: divisionId: type: integer format: int32 tssRep: type: - string - 'null' divisionName: type: - string - 'null' numMixDesigns: type: integer format: int32 numControlDesigns: type: integer format: int32 numCO2Designs: type: integer format: int32 mostRecentInstall: type: - string - 'null' format: date-time avgVolumePerPlantLastMonthM3: type: number format: double priority: type: integer format: int32 inCommissioning: type: boolean designsOver15Samples: type: integer format: int32 additionalProperties: false DivisionNameAndUnits: type: object properties: divisionId: type: integer format: int32 name: type: - string - 'null' corporationId: type: integer format: int32 corporationName: type: - string - 'null' isImperial: type: boolean additionalProperties: false StaffUser: required: - email - firstName - lastName - naiveFullName type: object properties: userId: type: integer format: int32 email: minLength: 1 type: string firstName: minLength: 1 type: string lastName: minLength: 1 type: string naiveFullName: minLength: 1 type: string externalUserId: type: - string - 'null' wasInviteSent: type: boolean readOnly: true jobTitle: type: - string - 'null' jobField: type: - array - 'null' items: type: string phone: type: - string - 'null' language: $ref: '#/components/schemas/Language' numericFormat: type: - string - 'null' myCCNotificationSubscriptionsId: type: integer format: int32 myCCNotificationSubscriptions: $ref: '#/components/schemas/MyCCNotificationSubscriptions' allowsCookies: type: - boolean - 'null' readOnly: true allowsFunctionalCookies: type: - boolean - 'null' allowsAnalyticsCookies: type: - boolean - 'null' enviroContactName: type: - string - 'null' enviroContactPhone: type: - string - 'null' enviroContactEmail: type: - string - 'null' enviroContactWebsite: type: - string - 'null' settingsChangedTimestamp: type: - string - 'null' format: date-time policiesAcceptedTimestamp: type: - string - 'null' format: date-time lastActivityTimestamp: type: - string - 'null' format: date-time photoUrl: type: - string - 'null' iconId: type: - integer - 'null' format: int32 repType: type: - array - 'null' items: type: string alarmNotificationsEnabled: type: boolean rwAlarmNotificationsEnabled: type: boolean rwEmailNotificationEnabled: type: boolean hmisWatching: type: - array - 'null' items: type: integer format: int32 additionalProperties: false securitySchemes: OrcaAuth: type: oauth2 flows: authorizationCode: authorizationUrl: https://auth.carboncure.com/oauth2/authorize tokenUrl: https://auth.carboncure.com/oauth2/token scopes: {} MyCCAuth: type: oauth2 flows: authorizationCode: authorizationUrl: https://auth.carboncure.com/oauth2/authorize tokenUrl: https://auth.carboncure.com/oauth2/token scopes: {} M2MAuth: type: oauth2 flows: authorizationCode: authorizationUrl: https://auth.carboncure.com/oauth2/authorize tokenUrl: https://auth.carboncure.com/oauth2/token scopes: {}