lib/swagger/members-vernonkeenan.yaml

3101 lines
88 KiB
YAML
Raw Normal View History

2023-03-28 17:47:34 +00:00
swagger: "2.0"
info:
version: 0.3.0
title: "members"
description: "Membership Microservice"
termsOfService: "https://salesforcedevops.net/terms/"
contact:
2023-04-30 02:07:31 +00:00
email: "vern@salesforcedevops.net"
2023-03-28 17:47:34 +00:00
license:
name: "Proprietary - Copyright (c) 2018-2023 by Vernon Keenan"
securityDefinitions:
ApiKeyAuth:
type: "apiKey"
in: "header"
name: "X-API-Key"
schemes:
- "http"
basePath: "/v1"
host: "members.vernonkeenan.com:8080"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
AttendeeRequest:
description: An array of new Attendee records
in: body
name: attendeeRequest
required: true
schema:
$ref: "#/definitions/AttendeeRequest"
CertificateRequest:
description: An array of new Certificate records
in: body
name: certificateRequest
required: true
schema:
$ref: "#/definitions/CertificateRequest"
CourseLessonRequest:
description: An array of new CourseLesson records
in: body
name: courselessonRequest
required: true
schema:
$ref: "#/definitions/CourseLessonRequest"
2023-04-07 18:00:15 +00:00
clusterIdQuery:
description: Record Id of a Cluster
in: query
name: clusterId
required: false
type: string
ClusterRequest:
description: An array of Cluster records
in: body
name: ClusterRequest
required: true
schema:
$ref: "#/definitions/ClusterRequest"
CourseRequest:
description: An array of new Course records
in: body
name: courseRequest
required: true
schema:
$ref: "#/definitions/CourseRequest"
2023-03-28 17:47:34 +00:00
CourseSectionRequest:
description: An array of new CourseSection records
in: body
name: coursesectionRequest
required: true
schema:
$ref: "#/definitions/CourseSectionRequest"
2023-04-17 22:11:43 +00:00
OutgoingEmailMessageRequest:
description: An array of new Outgoing Email Message records
in: body
name: OutgoingEmailMessageRequest
required: true
schema:
$ref: "#/definitions/OutgoingEmailMessageRequest"
2023-03-28 17:47:34 +00:00
EnrollmentRequest:
description: An array of new Enrollment records
in: body
name: enrollmentRequest
required: true
schema:
$ref: "#/definitions/EnrollmentRequest"
2023-04-07 18:00:15 +00:00
EventRequest:
description: An array of new Event records
2023-03-28 17:47:34 +00:00
in: body
2023-04-07 18:00:15 +00:00
name: eventRequest
2023-03-28 17:47:34 +00:00
required: true
schema:
2023-04-07 18:00:15 +00:00
$ref: "#/definitions/EventRequest"
2023-04-30 17:56:32 +00:00
EventCategoryRequest:
description: An array of new Event records
in: body
name: eventCategoryRequest
required: true
schema:
$ref: "#/definitions/EventCategoryRequest"
2023-03-28 17:47:34 +00:00
FavoriteRequest:
description: An array of new Favorite records
in: body
name: favoriteRequest
required: true
schema:
$ref: "#/definitions/FavoriteRequest"
InvoiceRequest:
description: An array of new Invoice records
in: body
name: invoiceRequest
required: true
schema:
$ref: "#/definitions/InvoiceRequest"
IssuedCertificateRequest:
description: An array of new IssuedCertificate records
in: body
2023-05-13 16:46:48 +00:00
name: issuedCertificateRequest
2023-03-28 17:47:34 +00:00
required: true
schema:
$ref: "#/definitions/IssuedCertificateRequest"
LessonProgressRequest:
description: An array of new LessonProgress records
in: body
name: lessonprogressRequest
required: true
schema:
$ref: "#/definitions/LessonProgressRequest"
OrderRequest:
description: An array of new Order records
in: body
name: orderRequest
required: true
schema:
$ref: "#/definitions/OrderRequest"
PaymentMethodRequest:
description: An array of new PaymentMethod records
in: body
2023-05-13 16:46:48 +00:00
name: paymentMethodRequest
2023-03-28 17:47:34 +00:00
required: true
schema:
$ref: "#/definitions/PaymentMethodRequest"
ResearchProjectCompanyRequest:
description: An array of new ResearchProjectCompany records
in: body
2023-05-13 16:46:48 +00:00
name: researchProjectCompanyRequest
2023-03-28 17:47:34 +00:00
required: true
schema:
$ref: "#/definitions/ResearchProjectCompanyRequest"
2023-05-13 16:46:48 +00:00
researchProjectProductRequest:
description: An array of new ResearchProjectProduct records
in: body
name: researchProjectProductRequest
required: true
schema:
$ref: "#/definitions/ResearchProjectProductRequest"
2023-04-07 18:00:15 +00:00
ResearchProjectRequest:
description: An array of new ResearchProject records
in: body
2023-05-13 16:46:48 +00:00
name: researchProjectRequest
2023-04-07 18:00:15 +00:00
required: true
schema:
$ref: "#/definitions/ResearchProjectRequest"
2023-03-28 17:47:34 +00:00
ResearchProjectTopicRequest:
description: An array of new ResearchProjectTopic records
in: body
2023-05-13 16:46:48 +00:00
name: researchProjectTopicRequest
2023-03-28 17:47:34 +00:00
required: true
schema:
$ref: "#/definitions/ResearchProjectTopicRequest"
2023-04-07 18:00:15 +00:00
templateIdQuery:
description: Template ID
in: query
name: templateId
type: string
TemplateRequest:
description: An array of Template records
in: body
name: TemplateRequest
required: true
schema:
$ref: "#/definitions/TemplateRequest"
2023-04-30 02:07:31 +00:00
EmailMessageRequest:
description: An array of Email Message records
in: body
name: EmailMessageRequest
required: true
schema:
$ref: "#/definitions/EmailMessageRequest"
2023-04-07 18:00:15 +00:00
tenantIdQuery:
description: Record Id of a Tenant
in: query
name: tenantId
required: false
type: string
tenantRequest:
description: An array of Tenant records
in: body
name: TenantRequest
required: true
schema:
$ref: "#/definitions/TenantRequest"
2023-03-28 17:47:34 +00:00
TicketRequest:
description: An array of new Ticket records
in: body
name: ticketRequest
required: true
schema:
$ref: "#/definitions/TicketRequest"
TransactionRequest:
description: An array of new Transaction records
in: body
name: transactionRequest
required: true
schema:
$ref: "#/definitions/TransactionRequest"
2023-04-07 18:00:15 +00:00
UserRequest:
description: An array of User records
in: body
name: UserRequest
required: true
schema:
$ref: "#/definitions/UserRequest"
2023-04-11 14:59:35 +00:00
WebhookClerkRequest:
description: An array of new WebhookClerk records
in: body
name: webhookclerkRequest
required: true
schema:
$ref: "#/definitions/WebhookClerkRequest"
2023-04-07 18:00:15 +00:00
activeQuery:
description: Retrieve active records only?
in: query
name: active
required: false
type: boolean
auth0UserIdQuery:
description: External Auth0 User ID
in: query
name: auth0UserId
required: false
type: string
2023-04-11 14:59:35 +00:00
userIdQuery:
description: Internal User ID
in: query
name: userId
required: false
type: string
2023-05-14 21:32:28 +00:00
userIdQueryRequired:
description: Internal User ID
in: query
name: userId
required: true
type: string
2023-04-11 14:59:35 +00:00
contactIdQuery:
description: Internal Contact ID (links to Account)
in: query
name: contactId
required: false
type: string
2023-04-07 18:00:15 +00:00
databaseIdQuery:
description: Record Id of a Database
in: query
name: databaseId
type: string
required: true
databaseRequest:
description: An array of Database records
in: body
name: DatabaseRequest
required: true
schema:
$ref: "#/definitions/DatabaseRequest"
2023-04-17 22:11:43 +00:00
emailMessageIdQuery:
description: Email Message ID
in: query
name: emailMessageId
type: string
2023-04-07 18:00:15 +00:00
emailQuery:
description: Email address
in: query
name: email
required: false
type: string
idQuery:
description: Unique Record ID
in: query
name: id
required: false
type: string
objectTypeQuery:
description: Object Type Name
in: query
name: objectType
type: string
isMasterQuery:
description: Is Master Template?
in: query
name: isMaster
type: boolean
limitQuery:
description: How many objects to return at one time
format: int64
in: query
name: limit
required: false
type: integer
offsetQuery:
description: How many objects to skip?
format: int64
in: query
name: offset
required: false
type: integer
2023-03-28 17:47:34 +00:00
responses:
2023-04-07 18:00:15 +00:00
AccessForbidden:
description: Access forbidden, account lacks access
headers:
Access-Control-Allow-Origin:
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-07 18:00:15 +00:00
schema:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/error.yaml#/Error"
2023-03-28 17:47:34 +00:00
AttendeeResponse:
description: Attendee Response Object
schema:
$ref: "#/definitions/AttendeeResponse"
CertificateResponse:
description: Certificate Response Object
schema:
$ref: "#/definitions/CertificateResponse"
2023-04-07 18:00:15 +00:00
ClusterResponse:
description: Response with Cluster objects
2023-03-28 17:47:34 +00:00
schema:
2023-04-07 18:00:15 +00:00
$ref: "#/definitions/ClusterResponse"
2023-03-28 17:47:34 +00:00
CourseLessonResponse:
description: CourseLesson Response Object
schema:
$ref: "#/definitions/CourseLessonResponse"
2023-04-07 18:00:15 +00:00
CourseResponse:
description: Course Response Object
schema:
$ref: "#/definitions/CourseResponse"
2023-03-28 17:47:34 +00:00
CourseSectionResponse:
description: CourseSection Response Object
schema:
$ref: "#/definitions/CourseSectionResponse"
2023-04-07 18:00:15 +00:00
DatabaseResponse:
description: Response with Database objects
schema:
$ref: "#/definitions/DatabaseResponse"
2023-04-17 22:11:43 +00:00
EmailMessagesResponse:
description: "Array of Email Messages"
schema:
$ref: "#/definitions/EmailMessagesResponse"
2023-04-30 02:07:31 +00:00
OutgoingEmailMessagesResponse:
description: "Array of Outgoing Email Messages"
schema:
$ref: "#/definitions/OutgoingEmailMessagesResponse"
2023-03-28 17:47:34 +00:00
EnrollmentResponse:
description: Enrollment Response Object
schema:
$ref: "#/definitions/EnrollmentResponse"
2023-04-07 18:00:15 +00:00
EventResponse:
description: Event Response Object
2023-03-28 17:47:34 +00:00
schema:
2023-04-07 18:00:15 +00:00
$ref: "#/definitions/EventResponse"
2023-04-30 17:56:32 +00:00
EventCategoryResponse:
description: Event Response Object
schema:
$ref: "#/definitions/EventCategoryResponse"
2023-03-28 17:47:34 +00:00
FavoriteResponse:
description: Favorite Response Object
schema:
$ref: "#/definitions/FavoriteResponse"
InvoiceResponse:
description: Invoice Response Object
schema:
$ref: "#/definitions/InvoiceResponse"
IssuedCertificateResponse:
description: IssuedCertificate Response Object
schema:
$ref: "#/definitions/IssuedCertificateResponse"
LessonProgressResponse:
description: LessonProgress Response Object
schema:
$ref: "#/definitions/LessonProgressResponse"
2023-04-07 18:00:15 +00:00
NotFound:
description: Resource was not found
schema:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/error.yaml#/Error"
2023-03-28 17:47:34 +00:00
OrderResponse:
description: Order Response Object
schema:
$ref: "#/definitions/OrderResponse"
PaymentMethodResponse:
description: PaymentMethod Response Object
schema:
$ref: "#/definitions/PaymentMethodResponse"
2023-04-07 18:00:15 +00:00
ResearchProjectCompanyResponse:
description: ResearchProjectCompany Response Object
2023-03-28 17:47:34 +00:00
schema:
2023-04-07 18:00:15 +00:00
$ref: "#/definitions/ResearchProjectCompanyResponse"
2023-05-13 16:46:48 +00:00
ResearchProjectProductResponse:
description: ResearchProjectProduct Response Object
schema:
$ref: "#/definitions/ResearchProjectProductResponse"
2023-04-07 18:00:15 +00:00
ResearchProjectResponse:
description: ResearchProject Response Object
2023-03-28 17:47:34 +00:00
schema:
2023-04-07 18:00:15 +00:00
$ref: "#/definitions/ResearchProjectResponse"
2023-03-28 17:47:34 +00:00
ResearchProjectTopicResponse:
description: ResearchProjectTopic Response Object
schema:
$ref: "#/definitions/ResearchProjectTopicResponse"
2023-04-07 18:00:15 +00:00
ServerError:
description: Server Internal Error
schema:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/error.yaml#/Error"
2023-04-07 18:00:15 +00:00
TenantResponse:
description: Response with Tenant objects
schema:
$ref: "#/definitions/TenantResponse"
TemplateResponse:
description: Response with Template objects
schema:
$ref: "#/definitions/TemplateResponse"
2023-03-28 17:47:34 +00:00
TicketResponse:
description: Ticket Response Object
schema:
$ref: "#/definitions/TicketResponse"
TransactionResponse:
description: Transaction Response Object
schema:
$ref: "#/definitions/TransactionResponse"
2023-04-07 18:00:15 +00:00
Unauthorized:
description: Access Unauthorized, invalid API-KEY was used
schema:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/error.yaml#/Error"
2023-04-07 18:00:15 +00:00
UnprocessableEntity:
description: Unprocessable Entity, likely a bad parameter
schema:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/error.yaml#/Error"
2023-04-07 18:00:15 +00:00
UserResponse:
description: Response with User objects
schema:
$ref: "#/definitions/UserResponse"
2023-04-11 14:59:35 +00:00
WebhookClerkResponse:
description: WebhookClerk Response Object
schema:
$ref: "#/definitions/WebhookClerkResponse"
2023-03-28 17:47:34 +00:00
paths:
/attendees:
get:
2023-05-13 16:46:48 +00:00
description: Return a list of Attendee records from the datastore
2023-03-28 17:47:34 +00:00
operationId: getAttendees
parameters:
- $ref: "#/parameters/idQuery"
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
responses:
"200":
2023-05-13 16:46:48 +00:00
$ref: "#/responses/AttendeeResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Get a list Attendees
2023-04-07 18:00:15 +00:00
tags:
- Attendees
2023-03-28 17:47:34 +00:00
post:
2023-05-13 16:46:48 +00:00
description: Create Attendees
operationId: postAttendees
2023-03-28 17:47:34 +00:00
parameters:
- $ref: "#/parameters/AttendeeRequest"
responses:
2023-05-13 16:46:48 +00:00
"200":
$ref: "#/responses/AttendeeResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Create new Attendees
2023-04-07 18:00:15 +00:00
tags:
- Attendees
2023-03-28 17:47:34 +00:00
put:
2023-05-13 16:46:48 +00:00
description: Update Attendee
operationId: putAttendees
2023-03-28 17:47:34 +00:00
parameters:
2023-05-13 16:46:48 +00:00
- $ref: "#/parameters/AttendeeRequest"
2023-03-28 17:47:34 +00:00
responses:
"200":
2023-05-13 16:46:48 +00:00
$ref: "#/responses/AttendeeResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
2023-04-30 02:07:31 +00:00
security:
- ApiKeyAuth: []
2023-05-13 16:46:48 +00:00
summary: Update Attendee
2023-04-07 18:00:15 +00:00
tags:
2023-05-13 16:46:48 +00:00
- Attendees
/certificates:
2023-03-28 17:47:34 +00:00
get:
2023-05-13 16:46:48 +00:00
description: Return a list of Certificate records from the datastore
2023-04-07 18:00:15 +00:00
operationId: getCertificates
2023-03-28 17:47:34 +00:00
parameters:
- $ref: "#/parameters/idQuery"
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
responses:
"200":
2023-05-13 16:46:48 +00:00
$ref: "#/responses/CertificateResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Get a list Certificates
2023-04-07 18:00:15 +00:00
tags:
- Certificates
2023-03-28 17:47:34 +00:00
post:
2023-05-13 16:46:48 +00:00
description: Create Certificates
operationId: postCertificates
2023-03-28 17:47:34 +00:00
parameters:
- $ref: "#/parameters/CertificateRequest"
responses:
2023-05-13 16:46:48 +00:00
"200":
$ref: "#/responses/CertificateResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Create new Certificates
2023-04-07 18:00:15 +00:00
tags:
- Certificates
2023-03-28 17:47:34 +00:00
put:
2023-05-13 16:46:48 +00:00
description: Update Certificate
operationId: putCertificates
2023-03-28 17:47:34 +00:00
parameters:
2023-05-13 16:46:48 +00:00
- $ref: "#/parameters/CertificateRequest"
2023-03-28 17:47:34 +00:00
responses:
"200":
2023-05-13 16:46:48 +00:00
$ref: "#/responses/CertificateResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Update Certificate
2023-04-07 18:00:15 +00:00
tags:
- Certificates
/clusters:
2023-03-28 17:47:34 +00:00
get:
2023-04-07 18:00:15 +00:00
description: Return a list of Cluster records from the datastore
operationId: getClusters
2023-03-28 17:47:34 +00:00
parameters:
2023-04-07 18:00:15 +00:00
- $ref: "#/parameters/clusterIdQuery"
2023-03-28 17:47:34 +00:00
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
responses:
"200":
2023-04-07 18:00:15 +00:00
$ref: "#/responses/ClusterResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Get a list Clusters
tags:
- Clusters
2023-03-28 17:47:34 +00:00
post:
2023-05-13 16:46:48 +00:00
description: Create Clusters
2023-04-07 18:00:15 +00:00
operationId: postClusters
2023-03-28 17:47:34 +00:00
parameters:
2023-04-07 18:00:15 +00:00
- $ref: "#/parameters/ClusterRequest"
2023-03-28 17:47:34 +00:00
responses:
2023-04-07 18:00:15 +00:00
"200":
$ref: "#/responses/ClusterResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Create new Clusters
tags:
- Clusters
2023-03-28 17:47:34 +00:00
put:
2023-05-13 16:46:48 +00:00
description: Update Cluster
2023-04-07 18:00:15 +00:00
operationId: putClusters
2023-03-28 17:47:34 +00:00
parameters:
2023-04-07 18:00:15 +00:00
- $ref: "#/parameters/ClusterRequest"
2023-03-28 17:47:34 +00:00
responses:
"200":
2023-04-07 18:00:15 +00:00
$ref: "#/responses/ClusterResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Update Clustera
tags:
- Clusters
/courselessons:
2023-03-28 17:47:34 +00:00
get:
2023-04-07 18:00:15 +00:00
operationId: getCourseLessons
2023-04-30 02:07:31 +00:00
security:
- ApiKeyAuth: []
2023-03-28 17:47:34 +00:00
parameters:
- $ref: "#/parameters/idQuery"
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
responses:
"200":
2023-04-30 02:07:31 +00:00
$ref: "#/responses/CourseLessonResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
2023-04-07 18:00:15 +00:00
summary: Get a list of CourseLessons
tags:
2023-04-30 02:07:31 +00:00
- Courses
2023-03-28 17:47:34 +00:00
post:
2023-04-30 02:07:31 +00:00
operationId: postCourseLessons
security:
- ApiKeyAuth: []
2023-03-28 17:47:34 +00:00
parameters:
- $ref: "#/parameters/CourseLessonRequest"
responses:
2023-04-30 02:07:31 +00:00
"200":
$ref: "#/responses/CourseLessonResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
2023-04-07 18:00:15 +00:00
summary: Create a new CourseLesson
tags:
2023-04-30 02:07:31 +00:00
- Courses
2023-03-28 17:47:34 +00:00
put:
2023-04-30 02:07:31 +00:00
security:
- ApiKeyAuth: []
operationId: updateCourseLessons
2023-03-28 17:47:34 +00:00
parameters:
2023-04-30 02:07:31 +00:00
- $ref: "#/parameters/CourseLessonRequest"
2023-03-28 17:47:34 +00:00
responses:
"200":
2023-04-30 02:07:31 +00:00
$ref: "#/responses/CourseLessonResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
2023-04-07 18:00:15 +00:00
summary: Update an existing CourseLesson
tags:
- Courses
2023-04-30 02:07:31 +00:00
/courses:
2023-03-28 17:47:34 +00:00
get:
2023-04-30 02:07:31 +00:00
security:
- ApiKeyAuth: []
2023-04-07 18:00:15 +00:00
operationId: getCourses
2023-03-28 17:47:34 +00:00
parameters:
- $ref: "#/parameters/idQuery"
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
responses:
"200":
2023-04-30 02:07:31 +00:00
$ref: "#/responses/CourseResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
2023-04-07 18:00:15 +00:00
summary: Get a list of Courses
tags:
- Courses
2023-03-28 17:47:34 +00:00
post:
2023-04-30 02:07:31 +00:00
security:
- ApiKeyAuth: []
operationId: postCourses
2023-03-28 17:47:34 +00:00
parameters:
2023-04-07 18:00:15 +00:00
- $ref: "#/parameters/CourseRequest"
2023-03-28 17:47:34 +00:00
responses:
2023-04-30 02:07:31 +00:00
"200":
$ref: "#/responses/CourseResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
2023-04-07 18:00:15 +00:00
summary: Create a new Course
tags:
- Courses
2023-03-28 17:47:34 +00:00
put:
2023-04-30 02:07:31 +00:00
security:
- ApiKeyAuth: []
operationId: updateCourses
2023-03-28 17:47:34 +00:00
parameters:
2023-04-30 02:07:31 +00:00
- $ref: "#/parameters/CourseRequest"
2023-03-28 17:47:34 +00:00
responses:
"200":
2023-04-30 02:07:31 +00:00
$ref: "#/responses/CourseResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
2023-04-07 18:00:15 +00:00
summary: Update an existing Course
tags:
- Courses
/coursesections:
2023-03-28 17:47:34 +00:00
get:
2023-04-30 02:07:31 +00:00
security:
- ApiKeyAuth: []
2023-04-07 18:00:15 +00:00
operationId: getCourseSections
2023-03-28 17:47:34 +00:00
parameters:
- $ref: "#/parameters/idQuery"
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
responses:
"200":
2023-04-30 02:07:31 +00:00
$ref: "#/responses/CourseSectionResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
2023-04-07 18:00:15 +00:00
summary: Get a list of CourseSections
tags:
2023-04-30 02:07:31 +00:00
- Courses
2023-03-28 17:47:34 +00:00
post:
2023-04-30 02:07:31 +00:00
security:
- ApiKeyAuth: []
operationId: postCourseSections
2023-03-28 17:47:34 +00:00
parameters:
2023-04-07 18:00:15 +00:00
- $ref: "#/parameters/CourseSectionRequest"
2023-03-28 17:47:34 +00:00
responses:
2023-04-30 02:07:31 +00:00
"200":
$ref: "#/responses/CourseSectionResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
2023-04-07 18:00:15 +00:00
summary: Create a new CourseSection
tags:
2023-04-30 02:07:31 +00:00
- Courses
2023-03-28 17:47:34 +00:00
put:
2023-04-30 02:07:31 +00:00
security:
- ApiKeyAuth: []
operationId: updateCourseSections
2023-03-28 17:47:34 +00:00
parameters:
2023-04-30 02:07:31 +00:00
- $ref: "#/parameters/CourseSectionRequest"
2023-03-28 17:47:34 +00:00
responses:
"200":
2023-04-30 02:07:31 +00:00
$ref: "#/responses/CourseSectionResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
2023-04-07 18:00:15 +00:00
summary: Update an existing CourseSection
tags:
2023-04-30 02:07:31 +00:00
- Courses
2023-04-07 18:00:15 +00:00
/databases:
get:
description: Return a list of Database records from the datastore
operationId: getDatabases
parameters:
- $ref: "#/parameters/databaseIdQuery"
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
responses:
"200":
$ref: "#/responses/DatabaseResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Get a list Databases
tags:
- Databases
post:
2023-05-13 16:46:48 +00:00
description: Create Databases
2023-04-07 18:00:15 +00:00
operationId: postDatabases
parameters:
- $ref: "#/parameters/databaseRequest"
responses:
"200":
$ref: "#/responses/DatabaseResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Create new Databases
tags:
- Databases
put:
2023-05-13 16:46:48 +00:00
description: Update Database
2023-04-07 18:00:15 +00:00
operationId: putDatabases
parameters:
- $ref: "#/parameters/databaseRequest"
responses:
"200":
$ref: "#/responses/DatabaseResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Update Databases
tags:
- Databases
2023-04-30 02:07:31 +00:00
/emailmessages:
2023-04-17 22:11:43 +00:00
get:
security:
- ApiKeyAuth: []
summary: "Get email messages from data store"
operationId: getEmailMessages
description: "Retrieves email messages from workflow storage"
parameters:
- $ref: "#/parameters/emailMessageIdQuery"
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
tags:
- Emails
responses:
"200":
$ref: "#/responses/EmailMessagesResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
post:
security:
- ApiKeyAuth: []
summary: Add new email messages to the outgoing queue
2023-04-30 02:07:31 +00:00
operationId: postEmailMessages
2023-04-17 22:11:43 +00:00
description: Insert new email messages into workflow storage
parameters:
2023-04-30 02:07:31 +00:00
- $ref: "#/parameters/EmailMessageRequest"
2023-04-17 22:11:43 +00:00
responses:
"200":
$ref: "#/responses/EmailMessagesResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
tags:
- Emails
2023-04-30 02:07:31 +00:00
/outgoingemailmessages:
2023-03-28 17:47:34 +00:00
get:
2023-04-30 02:07:31 +00:00
security:
- ApiKeyAuth: []
summary: "Get email messages from data store"
operationId: getOutgoingEmailMessages
description: "Retrieves email messages from workflow storage"
2023-03-28 17:47:34 +00:00
parameters:
2023-04-30 02:07:31 +00:00
- $ref: "#/parameters/emailMessageIdQuery"
2023-03-28 17:47:34 +00:00
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
2023-04-07 18:00:15 +00:00
tags:
2023-04-30 02:07:31 +00:00
- Emails
2023-03-28 17:47:34 +00:00
responses:
"200":
2023-04-30 02:07:31 +00:00
$ref: "#/responses/OutgoingEmailMessagesResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
2023-03-28 17:47:34 +00:00
post:
2023-04-30 02:07:31 +00:00
security:
- ApiKeyAuth: []
summary: Add new email messages to the outgoing queue
operationId: postOutgoingEmailMessages
description: Insert new email messages into workflow storage
2023-03-28 17:47:34 +00:00
parameters:
2023-04-30 02:07:31 +00:00
- $ref: "#/parameters/OutgoingEmailMessageRequest"
2023-03-28 17:47:34 +00:00
responses:
"200":
2023-04-30 02:07:31 +00:00
$ref: "#/responses/OutgoingEmailMessagesResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
2023-04-07 18:00:15 +00:00
tags:
2023-04-30 02:07:31 +00:00
- Emails
/enrollments:
2023-03-28 17:47:34 +00:00
get:
2023-05-13 16:46:48 +00:00
description: Return a list of Enrollment records from the datastore
2023-04-30 02:07:31 +00:00
operationId: getEnrollments
2023-03-28 17:47:34 +00:00
parameters:
- $ref: "#/parameters/idQuery"
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
responses:
"200":
2023-04-30 02:07:31 +00:00
$ref: "#/responses/EnrollmentResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
2023-05-13 16:46:48 +00:00
security:
- ApiKeyAuth: []
summary: Get a list Enrollments
2023-04-07 18:00:15 +00:00
tags:
2023-04-30 02:07:31 +00:00
- Enrollments
2023-03-28 17:47:34 +00:00
post:
2023-05-13 16:46:48 +00:00
description: Create Enrollments
operationId: postEnrollments
2023-03-28 17:47:34 +00:00
parameters:
2023-04-30 02:07:31 +00:00
- $ref: "#/parameters/EnrollmentRequest"
2023-03-28 17:47:34 +00:00
responses:
2023-05-13 16:46:48 +00:00
"200":
$ref: "#/responses/EnrollmentResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Create new Enrollments
2023-04-07 18:00:15 +00:00
tags:
2023-04-30 02:07:31 +00:00
- Enrollments
2023-03-28 17:47:34 +00:00
put:
2023-05-13 16:46:48 +00:00
description: Update Enrollment
operationId: putEnrollments
2023-03-28 17:47:34 +00:00
parameters:
2023-05-13 16:46:48 +00:00
- $ref: "#/parameters/EnrollmentRequest"
2023-03-28 17:47:34 +00:00
responses:
"200":
2023-05-13 16:46:48 +00:00
$ref: "#/responses/EnrollmentResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Update Enrollment
2023-04-07 18:00:15 +00:00
tags:
2023-04-30 02:07:31 +00:00
- Enrollments
2023-04-30 17:56:32 +00:00
/eventcategories:
2023-03-28 17:47:34 +00:00
get:
2023-04-30 02:07:31 +00:00
security:
- ApiKeyAuth: []
2023-04-30 17:56:32 +00:00
operationId: getEventCategories
2023-03-28 17:47:34 +00:00
parameters:
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
2023-04-07 18:00:15 +00:00
- $ref: "#/parameters/idQuery"
2023-03-28 17:47:34 +00:00
responses:
"200":
2023-04-30 17:56:32 +00:00
$ref: "#/responses/EventCategoryResponse"
2023-04-30 02:07:31 +00:00
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
2023-04-30 17:56:32 +00:00
summary: Get a list of Eventcategories
2023-04-07 18:00:15 +00:00
tags:
- Events
2023-03-28 17:47:34 +00:00
post:
2023-04-30 02:07:31 +00:00
security:
- ApiKeyAuth: []
2023-04-30 17:56:32 +00:00
operationId: postEventCategories
2023-03-28 17:47:34 +00:00
parameters:
2023-04-30 17:56:32 +00:00
- $ref: "#/parameters/EventCategoryRequest"
2023-03-28 17:47:34 +00:00
responses:
2023-04-30 02:07:31 +00:00
"200":
2023-04-30 17:56:32 +00:00
$ref: "#/responses/EventCategoryResponse"
2023-04-30 02:07:31 +00:00
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
2023-04-30 17:56:32 +00:00
summary: Create a new EventCategory
2023-04-07 18:00:15 +00:00
tags:
- Events
2023-04-30 17:56:32 +00:00
/events:
get:
2023-04-30 02:07:31 +00:00
security:
- ApiKeyAuth: []
2023-04-30 17:56:32 +00:00
operationId: getEvents
2023-03-28 17:47:34 +00:00
parameters:
2023-04-30 17:56:32 +00:00
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
2023-03-28 17:47:34 +00:00
- $ref: "#/parameters/idQuery"
responses:
"200":
2023-04-30 02:07:31 +00:00
$ref: "#/responses/EventResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
2023-04-30 17:56:32 +00:00
summary: Get a list of Events
tags:
- Events
post:
security:
- ApiKeyAuth: []
operationId: postEvents
parameters:
- $ref: "#/parameters/EventRequest"
responses:
"200":
$ref: "#/responses/EventResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
summary: Create a new Event
2023-04-07 18:00:15 +00:00
tags:
- Events
/favorites:
2023-03-28 17:47:34 +00:00
get:
2023-05-13 16:46:48 +00:00
description: Return a list of Favorite records from the datastore
2023-04-07 18:00:15 +00:00
operationId: getFavorites
2023-03-28 17:47:34 +00:00
parameters:
- $ref: "#/parameters/idQuery"
2023-05-14 21:32:28 +00:00
- $ref: "#/parameters/userIdQueryRequired"
2023-03-28 17:47:34 +00:00
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
responses:
"200":
2023-05-13 16:46:48 +00:00
$ref: "#/responses/FavoriteResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Get a list Favorites
2023-04-07 18:00:15 +00:00
tags:
- Favorites
2023-03-28 17:47:34 +00:00
post:
2023-05-13 16:46:48 +00:00
description: Create Favorites
operationId: postFavorites
2023-03-28 17:47:34 +00:00
parameters:
2023-04-07 18:00:15 +00:00
- $ref: "#/parameters/FavoriteRequest"
2023-03-28 17:47:34 +00:00
responses:
2023-05-13 16:46:48 +00:00
"200":
$ref: "#/responses/FavoriteResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Create new Favorites
2023-04-07 18:00:15 +00:00
tags:
- Favorites
2023-03-28 17:47:34 +00:00
put:
2023-05-13 16:46:48 +00:00
description: Update Favorite
operationId: putFavorites
2023-03-28 17:47:34 +00:00
parameters:
2023-05-13 16:46:48 +00:00
- $ref: "#/parameters/FavoriteRequest"
2023-03-28 17:47:34 +00:00
responses:
"200":
2023-05-13 16:46:48 +00:00
$ref: "#/responses/FavoriteResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
2023-04-30 02:07:31 +00:00
security:
- ApiKeyAuth: []
2023-05-13 16:46:48 +00:00
summary: Update Favorite
2023-04-07 18:00:15 +00:00
tags:
2023-05-13 16:46:48 +00:00
- Favorites
/invoices:
2023-03-28 17:47:34 +00:00
get:
2023-05-13 16:46:48 +00:00
description: Return a list of Invoice records from the datastore
2023-04-07 18:00:15 +00:00
operationId: getInvoices
2023-03-28 17:47:34 +00:00
parameters:
2023-04-07 18:00:15 +00:00
- $ref: "#/parameters/idQuery"
2023-03-28 17:47:34 +00:00
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
responses:
"200":
2023-05-13 16:46:48 +00:00
$ref: "#/responses/InvoiceResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Get a list Invoices
2023-04-07 18:00:15 +00:00
tags:
- Invoices
2023-03-28 17:47:34 +00:00
post:
2023-05-13 16:46:48 +00:00
description: Create Invoices
operationId: postInvoices
2023-03-28 17:47:34 +00:00
parameters:
2023-04-07 18:00:15 +00:00
- $ref: "#/parameters/InvoiceRequest"
2023-03-28 17:47:34 +00:00
responses:
2023-05-13 16:46:48 +00:00
"200":
$ref: "#/responses/InvoiceResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
2023-04-30 02:07:31 +00:00
security:
- ApiKeyAuth: []
2023-05-13 16:46:48 +00:00
summary: Create new Invoices
2023-04-07 18:00:15 +00:00
tags:
- Invoices
2023-05-13 16:46:48 +00:00
put:
description: Update Invoice
operationId: putInvoices
2023-03-28 17:47:34 +00:00
parameters:
2023-05-13 16:46:48 +00:00
- $ref: "#/parameters/InvoiceRequest"
2023-03-28 17:47:34 +00:00
responses:
2023-05-13 16:46:48 +00:00
"200":
$ref: "#/responses/InvoiceResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
2023-04-30 02:07:31 +00:00
security:
- ApiKeyAuth: []
2023-05-13 16:46:48 +00:00
summary: Update Invoice
tags:
- Invoices
/issuedcertificates:
get:
description: Return a list of IssuedCertificate records from the datastore
2023-04-07 18:00:15 +00:00
operationId: getIssuedCertificates
2023-03-28 17:47:34 +00:00
parameters:
2023-05-13 16:46:48 +00:00
- $ref: "#/parameters/idQuery"
2023-03-28 17:47:34 +00:00
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
responses:
"200":
2023-05-13 16:46:48 +00:00
$ref: "#/responses/IssuedCertificateResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Get a list IssuedCertificates
2023-04-07 18:00:15 +00:00
tags:
- IssuedCertificates
2023-03-28 17:47:34 +00:00
post:
2023-05-13 16:46:48 +00:00
description: Create IssuedCertificates
operationId: postIssuedCertificates
2023-03-28 17:47:34 +00:00
parameters:
2023-04-07 18:00:15 +00:00
- $ref: "#/parameters/IssuedCertificateRequest"
2023-03-28 17:47:34 +00:00
responses:
2023-05-13 16:46:48 +00:00
"200":
$ref: "#/responses/IssuedCertificateResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Create new IssuedCertificates
2023-04-07 18:00:15 +00:00
tags:
- IssuedCertificates
2023-03-28 17:47:34 +00:00
put:
2023-05-13 16:46:48 +00:00
description: Update IssuedCertificate
operationId: putIssuedCertificates
2023-03-28 17:47:34 +00:00
parameters:
2023-05-13 16:46:48 +00:00
- $ref: "#/parameters/IssuedCertificateRequest"
2023-03-28 17:47:34 +00:00
responses:
"200":
2023-05-13 16:46:48 +00:00
$ref: "#/responses/IssuedCertificateResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
2023-04-30 02:07:31 +00:00
security:
- ApiKeyAuth: []
2023-05-13 16:46:48 +00:00
summary: Update IssuedCertificate
2023-04-07 18:00:15 +00:00
tags:
2023-05-13 16:46:48 +00:00
- IssuedCertificates
/lessonprogress:
2023-03-28 17:47:34 +00:00
get:
2023-05-13 16:46:48 +00:00
description: Return a list of LessonProgress records from the datastore
operationId: getLessonProgresses
2023-03-28 17:47:34 +00:00
parameters:
2023-05-13 16:46:48 +00:00
- $ref: "#/parameters/idQuery"
2023-03-28 17:47:34 +00:00
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
responses:
"200":
2023-05-13 16:46:48 +00:00
$ref: "#/responses/LessonProgressResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Get a list LessonProgresses
2023-04-07 18:00:15 +00:00
tags:
- LessonProgress
2023-03-28 17:47:34 +00:00
post:
2023-05-13 16:46:48 +00:00
description: Create LessonProgresses
operationId: postLessonProgresses
2023-03-28 17:47:34 +00:00
parameters:
2023-04-07 18:00:15 +00:00
- $ref: "#/parameters/LessonProgressRequest"
2023-03-28 17:47:34 +00:00
responses:
2023-05-13 16:46:48 +00:00
"200":
$ref: "#/responses/LessonProgressResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Create new LessonProgresses
2023-04-07 18:00:15 +00:00
tags:
- LessonProgress
2023-03-28 17:47:34 +00:00
put:
2023-05-13 16:46:48 +00:00
description: Update LessonProgress
operationId: putLessonProgresses
2023-03-28 17:47:34 +00:00
parameters:
2023-05-13 16:46:48 +00:00
- $ref: "#/parameters/LessonProgressRequest"
2023-03-28 17:47:34 +00:00
responses:
"200":
2023-05-13 16:46:48 +00:00
$ref: "#/responses/LessonProgressResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
2023-04-30 02:07:31 +00:00
security:
- ApiKeyAuth: []
2023-05-13 16:46:48 +00:00
summary: Update LessonProgress
2023-04-07 18:00:15 +00:00
tags:
2023-05-13 16:46:48 +00:00
- LessonProgress
/orders:
2023-03-28 17:47:34 +00:00
get:
2023-05-13 16:46:48 +00:00
description: Return a list of Order records from the datastore
2023-04-07 18:00:15 +00:00
operationId: getOrders
2023-03-28 17:47:34 +00:00
parameters:
2023-05-13 16:46:48 +00:00
- $ref: "#/parameters/idQuery"
2023-03-28 17:47:34 +00:00
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
responses:
"200":
2023-05-13 16:46:48 +00:00
$ref: "#/responses/OrderResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Get a list Orders
2023-04-07 18:00:15 +00:00
tags:
- Orders
2023-03-28 17:47:34 +00:00
post:
2023-05-13 16:46:48 +00:00
description: Create Orders
operationId: postOrders
2023-03-28 17:47:34 +00:00
parameters:
2023-04-07 18:00:15 +00:00
- $ref: "#/parameters/OrderRequest"
2023-03-28 17:47:34 +00:00
responses:
2023-05-13 16:46:48 +00:00
"200":
$ref: "#/responses/OrderResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Create new Orders
2023-04-07 18:00:15 +00:00
tags:
- Orders
2023-03-28 17:47:34 +00:00
put:
2023-05-13 16:46:48 +00:00
description: Update Order
operationId: putOrders
2023-03-28 17:47:34 +00:00
parameters:
2023-05-13 16:46:48 +00:00
- $ref: "#/parameters/OrderRequest"
2023-03-28 17:47:34 +00:00
responses:
"200":
2023-05-13 16:46:48 +00:00
$ref: "#/responses/OrderResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
2023-04-30 02:07:31 +00:00
security:
- ApiKeyAuth: []
2023-05-13 16:46:48 +00:00
summary: Update Order
2023-04-07 18:00:15 +00:00
tags:
2023-05-13 16:46:48 +00:00
- Orders
/paymentmethods:
2023-03-28 17:47:34 +00:00
get:
2023-05-13 16:46:48 +00:00
description: Return a list of PaymentMethod records from the datastore
2023-04-07 18:00:15 +00:00
operationId: getPaymentMethods
2023-03-28 17:47:34 +00:00
parameters:
2023-05-13 16:46:48 +00:00
- $ref: "#/parameters/idQuery"
2023-03-28 17:47:34 +00:00
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
responses:
"200":
2023-05-13 16:46:48 +00:00
$ref: "#/responses/PaymentMethodResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Get a list PaymentMethods
2023-04-07 18:00:15 +00:00
tags:
- PaymentMethods
2023-03-28 17:47:34 +00:00
post:
2023-05-13 16:46:48 +00:00
description: Create PaymentMethods
operationId: postPaymentMethods
2023-03-28 17:47:34 +00:00
parameters:
2023-04-07 18:00:15 +00:00
- $ref: "#/parameters/PaymentMethodRequest"
2023-03-28 17:47:34 +00:00
responses:
2023-05-13 16:46:48 +00:00
"200":
$ref: "#/responses/PaymentMethodResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Create new PaymentMethods
2023-04-07 18:00:15 +00:00
tags:
- PaymentMethods
2023-03-28 17:47:34 +00:00
put:
2023-05-13 16:46:48 +00:00
description: Update PaymentMethod
operationId: putPaymentMethods
2023-03-28 17:47:34 +00:00
parameters:
2023-05-13 16:46:48 +00:00
- $ref: "#/parameters/PaymentMethodRequest"
2023-03-28 17:47:34 +00:00
responses:
"200":
2023-05-13 16:46:48 +00:00
$ref: "#/responses/PaymentMethodResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
2023-04-30 02:07:31 +00:00
security:
- ApiKeyAuth: []
2023-05-13 16:46:48 +00:00
summary: Update PaymentMethod
2023-04-07 18:00:15 +00:00
tags:
2023-05-13 16:46:48 +00:00
- PaymentMethods
/researchprojectcompanies:
2023-03-28 17:47:34 +00:00
get:
2023-05-13 16:46:48 +00:00
description: Return a list of ResearchProjectCompany records from the datastore
2023-04-07 18:00:15 +00:00
operationId: getResearchProjectCompanies
2023-03-28 17:47:34 +00:00
parameters:
2023-05-13 16:46:48 +00:00
- $ref: "#/parameters/idQuery"
2023-03-28 17:47:34 +00:00
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
responses:
"200":
2023-05-13 16:46:48 +00:00
$ref: "#/responses/ResearchProjectCompanyResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
2023-04-07 18:00:15 +00:00
summary: Get a list of ResearchProjectCompanies
tags:
2023-05-13 16:46:48 +00:00
- ResearchProjects
2023-03-28 17:47:34 +00:00
post:
2023-05-13 16:46:48 +00:00
description: Create ResearchProjectCompanies in the system
operationId: postResearchProjectCompanies
2023-03-28 17:47:34 +00:00
parameters:
- $ref: "#/parameters/ResearchProjectCompanyRequest"
responses:
2023-05-13 16:46:48 +00:00
"200":
$ref: "#/responses/ResearchProjectCompanyResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
2023-04-30 02:07:31 +00:00
- ApiKeyAuth: []
2023-05-13 16:46:48 +00:00
summary: Create new ResearchProjectCompanies
tags:
- ResearchProjects
put:
description: Update ResearchProjectCompany in the system
operationId: putResearchProjectCompanies
2023-03-28 17:47:34 +00:00
parameters:
2023-05-13 16:46:48 +00:00
- $ref: "#/parameters/ResearchProjectCompanyRequest"
2023-03-28 17:47:34 +00:00
responses:
"200":
2023-05-13 16:46:48 +00:00
$ref: "#/responses/ResearchProjectCompanyResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
2023-04-30 02:07:31 +00:00
security:
- ApiKeyAuth: []
2023-05-13 16:46:48 +00:00
summary: Update ResearchProjectCompanies
2023-04-07 18:00:15 +00:00
tags:
- ResearchProjects
2023-05-13 16:46:48 +00:00
/researchprojectproducts:
2023-03-28 17:47:34 +00:00
get:
2023-05-13 16:46:48 +00:00
description: Return a list of ResearchProjectProduct records from the datastore
operationId: getResearchProjectProducts
2023-03-28 17:47:34 +00:00
parameters:
2023-05-13 16:46:48 +00:00
- $ref: "#/parameters/idQuery"
2023-03-28 17:47:34 +00:00
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
responses:
"200":
2023-05-13 16:46:48 +00:00
$ref: "#/responses/ResearchProjectProductResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Get a list of ResearchProjectProducts
2023-04-07 18:00:15 +00:00
tags:
- ResearchProjects
2023-03-28 17:47:34 +00:00
post:
2023-05-13 16:46:48 +00:00
description: Create ResearchProjectProducts in the system
operationId: postResearchProjectProducts
2023-03-28 17:47:34 +00:00
parameters:
2023-05-13 16:46:48 +00:00
- $ref: "#/parameters/researchProjectProductRequest"
2023-03-28 17:47:34 +00:00
responses:
2023-05-13 16:46:48 +00:00
"200":
$ref: "#/responses/ResearchProjectProductResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Create new ResearchProjectProducts
2023-04-07 18:00:15 +00:00
tags:
- ResearchProjects
2023-03-28 17:47:34 +00:00
put:
2023-05-13 16:46:48 +00:00
description: Update ResearchProjectProduct in the system
operationId: putResearchProjectProducts
parameters:
- $ref: "#/parameters/researchProjectProductRequest"
responses:
"200":
$ref: "#/responses/ResearchProjectProductResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
2023-04-30 02:07:31 +00:00
security:
- ApiKeyAuth: []
2023-05-13 16:46:48 +00:00
summary: Update ResearchProjectProducts
tags:
- ResearchProjects
/researchprojects:
get:
description: Return a list of ResearchProject records from the datastore
operationId: getResearchProjects
2023-03-28 17:47:34 +00:00
parameters:
- $ref: "#/parameters/idQuery"
2023-05-13 16:46:48 +00:00
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
2023-03-28 17:47:34 +00:00
responses:
"200":
2023-05-13 16:46:48 +00:00
$ref: "#/responses/ResearchProjectResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Get a list of ResearchProjects
2023-04-07 18:00:15 +00:00
tags:
- ResearchProjects
2023-05-13 16:46:48 +00:00
post:
description: Create ResearchProjects in the system
operationId: postResearchProjects
parameters:
- $ref: "#/parameters/ResearchProjectRequest"
responses:
"200":
$ref: "#/responses/ResearchProjectResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
2023-04-30 02:07:31 +00:00
security:
- ApiKeyAuth: []
2023-05-13 16:46:48 +00:00
summary: Create new ResearchProjects
tags:
- ResearchProjects
put:
description: Update ResearchProject in the system
operationId: putResearchProjects
2023-03-28 17:47:34 +00:00
parameters:
2023-05-13 16:46:48 +00:00
- $ref: "#/parameters/ResearchProjectRequest"
2023-03-28 17:47:34 +00:00
responses:
2023-05-13 16:46:48 +00:00
"200":
$ref: "#/responses/ResearchProjectResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
2023-04-30 02:07:31 +00:00
security:
- ApiKeyAuth: []
2023-05-13 16:46:48 +00:00
summary: Update ResearchProjects
tags:
- ResearchProjects
/researchprojecttopics:
get:
description: Return a list of ResearchProjectTopic records from the datastore
2023-04-07 18:00:15 +00:00
operationId: getResearchProjectTopics
parameters:
2023-05-13 16:46:48 +00:00
- $ref: "#/parameters/idQuery"
2023-04-07 18:00:15 +00:00
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
responses:
"200":
2023-05-13 16:46:48 +00:00
$ref: "#/responses/ResearchProjectTopicResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
2023-04-07 18:00:15 +00:00
summary: Get a list of ResearchProjectTopics
tags:
2023-05-13 16:46:48 +00:00
- ResearchProjects
2023-04-07 18:00:15 +00:00
post:
2023-05-13 16:46:48 +00:00
description: Create ResearchProjectTopics in the system
operationId: postResearchProjectTopics
2023-04-07 18:00:15 +00:00
parameters:
- $ref: "#/parameters/ResearchProjectTopicRequest"
responses:
2023-05-13 16:46:48 +00:00
"200":
$ref: "#/responses/ResearchProjectTopicResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
2023-04-30 02:07:31 +00:00
security:
- ApiKeyAuth: []
2023-05-13 16:46:48 +00:00
summary: Create new ResearchProjectTopics
tags:
- ResearchProjects
put:
description: Update ResearchProjectTopic in the system
operationId: putResearchProjectTopics
2023-04-07 18:00:15 +00:00
parameters:
2023-05-13 16:46:48 +00:00
- $ref: "#/parameters/ResearchProjectTopicRequest"
2023-04-07 18:00:15 +00:00
responses:
"200":
2023-05-13 16:46:48 +00:00
$ref: "#/responses/ResearchProjectTopicResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Update ResearchProjectTopics
2023-04-07 18:00:15 +00:00
tags:
2023-05-13 16:46:48 +00:00
- ResearchProjects
2023-04-07 18:00:15 +00:00
/tenants:
get:
description: Return a list of Tenant records from the datastore
operationId: getTenants
parameters:
- $ref: "#/parameters/tenantIdQuery"
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
responses:
"200":
$ref: "#/responses/TenantResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Get a list Tenants
tags:
- Tenants
post:
2023-05-13 16:46:48 +00:00
description: Create Tenants
2023-04-07 18:00:15 +00:00
operationId: postTenants
parameters:
- $ref: "#/parameters/tenantRequest"
responses:
"200":
$ref: "#/responses/TenantResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Create new Tenants
tags:
- Tenants
put:
2023-05-13 16:46:48 +00:00
description: Update Tenant
2023-04-07 18:00:15 +00:00
operationId: putTenants
parameters:
- $ref: "#/parameters/tenantRequest"
responses:
"200":
$ref: "#/responses/TenantResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Update Tenants
tags:
- Tenants
/templates:
get:
description: Return a list of Templates from the datastore
operationId: getTemplates
2023-03-28 17:47:34 +00:00
parameters:
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
2023-04-07 18:00:15 +00:00
- $ref: "#/parameters/activeQuery"
- $ref: "#/parameters/templateIdQuery"
- $ref: "#/parameters/isMasterQuery"
- $ref: "#/parameters/objectTypeQuery"
responses:
"200":
$ref: "#/responses/TemplateResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Get a list Templates
tags:
- Templates
post:
description: Create new Templates
operationId: postTemplates
parameters:
- $ref: "#/parameters/TemplateRequest"
responses:
"200":
$ref: "#/responses/TemplateResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Create new Templates
tags:
- Templates
/tickets:
get:
2023-05-13 16:46:48 +00:00
description: Return a list of Ticket records from the datastore
2023-03-28 17:47:34 +00:00
operationId: getTickets
2023-04-07 18:00:15 +00:00
parameters:
2023-05-13 16:46:48 +00:00
- $ref: "#/parameters/idQuery"
2023-04-07 18:00:15 +00:00
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
2023-03-28 17:47:34 +00:00
responses:
"200":
2023-05-13 16:46:48 +00:00
$ref: "#/responses/TicketResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Get a list Tickets
2023-04-07 18:00:15 +00:00
tags:
- Tickets
2023-03-28 17:47:34 +00:00
post:
2023-05-13 16:46:48 +00:00
description: Create Tickets
operationId: postTickets
2023-03-28 17:47:34 +00:00
parameters:
- $ref: "#/parameters/TicketRequest"
responses:
2023-05-13 16:46:48 +00:00
"200":
$ref: "#/responses/TicketResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Create new Tickets
2023-04-07 18:00:15 +00:00
tags:
- Tickets
2023-03-28 17:47:34 +00:00
put:
2023-05-13 16:46:48 +00:00
description: Update Ticket
operationId: putTickets
2023-03-28 17:47:34 +00:00
parameters:
2023-05-13 16:46:48 +00:00
- $ref: "#/parameters/TicketRequest"
2023-03-28 17:47:34 +00:00
responses:
"200":
2023-05-13 16:46:48 +00:00
$ref: "#/responses/TicketResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
2023-04-30 02:07:31 +00:00
security:
- ApiKeyAuth: []
2023-05-13 16:46:48 +00:00
summary: Update Ticket
2023-04-07 18:00:15 +00:00
tags:
2023-05-13 16:46:48 +00:00
- Tickets
/transactions:
2023-03-28 17:47:34 +00:00
get:
2023-05-13 16:46:48 +00:00
description: Return a list of Transaction records from the datastore
2023-04-07 18:00:15 +00:00
operationId: getTransactions
2023-03-28 17:47:34 +00:00
parameters:
2023-05-13 16:46:48 +00:00
- $ref: "#/parameters/idQuery"
2023-03-28 17:47:34 +00:00
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
responses:
"200":
2023-05-13 16:46:48 +00:00
$ref: "#/responses/TransactionResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
2023-04-30 02:07:31 +00:00
security:
- ApiKeyAuth: []
2023-05-13 16:46:48 +00:00
summary: Get a list of Transactions
tags:
- Transactions
post:
description: Create Transactions
operationId: postTransactions
2023-03-28 17:47:34 +00:00
parameters:
- $ref: "#/parameters/TransactionRequest"
responses:
2023-05-13 16:46:48 +00:00
"200":
$ref: "#/responses/TransactionResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Create new Transactions
2023-04-07 18:00:15 +00:00
tags:
- Transactions
2023-03-28 17:47:34 +00:00
put:
2023-05-13 16:46:48 +00:00
description: Update Transaction
operationId: putTransactions
2023-03-28 17:47:34 +00:00
parameters:
2023-05-13 16:46:48 +00:00
- $ref: "#/parameters/TransactionRequest"
2023-03-28 17:47:34 +00:00
responses:
"200":
2023-05-13 16:46:48 +00:00
$ref: "#/responses/TransactionResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Update Transaction
2023-04-07 18:00:15 +00:00
tags:
- Transactions
2023-04-11 14:59:35 +00:00
/users/onboard:
post:
description: Async onboard new users
operationId: postUsersOnboard
parameters:
- $ref: "#/parameters/UserRequest"
responses:
"200":
$ref: "#/responses/UserResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Async onboard new users
tags:
- Users
/webhooks/clerk:
post:
description: Clerk webhook
operationId: postWebhooksClerk
parameters:
- $ref: "#/parameters/WebhookClerkRequest"
responses:
"201":
$ref: "#/responses/WebhookClerkResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
summary: Clerk webhook
tags:
- Webhooks
2023-04-07 18:00:15 +00:00
/users:
get:
description: Return a list of User records from the datastore
operationId: getUsers
2023-03-28 17:47:34 +00:00
parameters:
2023-04-07 18:00:15 +00:00
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
- $ref: "#/parameters/emailQuery"
- $ref: "#/parameters/auth0UserIdQuery"
2023-04-11 14:59:35 +00:00
- $ref: "#/parameters/userIdQuery"
- $ref: "#/parameters/contactIdQuery"
2023-03-28 17:47:34 +00:00
responses:
2023-04-07 18:00:15 +00:00
"200":
$ref: "#/responses/UserResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Get a list Users
tags:
- Users
post:
description: Create new Users
operationId: postUsers
parameters:
- $ref: "#/parameters/UserRequest"
responses:
"200":
$ref: "#/responses/UserResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Create new Users
tags:
- Users
put:
description: Update existing users
operationId: putUsers
parameters:
- $ref: "#/parameters/UserRequest"
responses:
"200":
$ref: "#/responses/UserResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Update existing users
tags:
- Users
2023-03-28 17:47:34 +00:00
definitions:
2023-04-07 18:00:15 +00:00
AttendeeRequest:
2023-03-28 17:47:34 +00:00
description: An array of Attendee objects
properties:
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/attendee.yaml#/Attendee"
2023-04-07 18:00:15 +00:00
type: array
2023-03-28 17:47:34 +00:00
type: object
2023-04-07 18:00:15 +00:00
AttendeeResponse:
2023-03-28 17:47:34 +00:00
description: An array of Attendee objects
properties:
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/attendee.yaml#/Attendee"
2023-04-07 18:00:15 +00:00
type: array
2023-03-28 17:47:34 +00:00
type: object
2023-04-07 18:00:15 +00:00
CertificateRequest:
2023-03-28 17:47:34 +00:00
description: An array of Certificate objects
properties:
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/certificate.yaml#/Certificate"
2023-04-07 18:00:15 +00:00
type: array
2023-03-28 17:47:34 +00:00
type: object
2023-04-07 18:00:15 +00:00
CertificateResponse:
2023-03-28 17:47:34 +00:00
description: An array of Certificate objects
properties:
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/certificate.yaml#/Certificate"
2023-04-07 18:00:15 +00:00
type: array
2023-03-28 17:47:34 +00:00
type: object
2023-04-30 02:07:31 +00:00
ClusterRequest:
properties:
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/cluster.yaml#/Cluster"
2023-04-30 02:07:31 +00:00
type: array
type: object
ClusterResponse:
description: An array of cluster objects
properties:
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/cluster.yaml#/Cluster"
2023-04-30 02:07:31 +00:00
type: array
Meta:
$ref: "#/definitions/ResponseMeta"
type: object
2023-04-07 18:00:15 +00:00
CourseLessonRequest:
2023-03-28 17:47:34 +00:00
description: An array of CourseLesson objects
properties:
Data:
items:
2023-04-30 02:07:31 +00:00
$ref: "../../lib/swagger/defs/course-lesson.yaml#/CourseLesson"
2023-04-07 18:00:15 +00:00
type: array
2023-03-28 17:47:34 +00:00
type: object
2023-04-07 18:00:15 +00:00
CourseLessonResponse:
2023-03-28 17:47:34 +00:00
description: An array of CourseLesson objects
properties:
Data:
items:
2023-04-30 02:07:31 +00:00
$ref: "../../lib/swagger/defs/course-lesson.yaml#/CourseLesson"
2023-04-07 18:00:15 +00:00
type: array
2023-04-30 02:07:31 +00:00
Meta:
$ref: "#/definitions/ResponseMeta"
2023-03-28 17:47:34 +00:00
type: object
2023-04-07 18:00:15 +00:00
CourseRequest:
description: An array of Course objects
properties:
Data:
items:
2023-04-30 02:07:31 +00:00
$ref: "../../lib/swagger/defs/course.yaml#/Course"
2023-04-07 18:00:15 +00:00
type: array
type: object
CourseResponse:
description: An array of Course objects
properties:
2023-04-30 02:07:31 +00:00
Meta:
$ref: "#/definitions/ResponseMeta"
2023-04-07 18:00:15 +00:00
Data:
items:
2023-04-30 02:07:31 +00:00
$ref: "../../lib/swagger/defs/course.yaml#/Course"
2023-04-07 18:00:15 +00:00
type: array
type: object
CourseSectionRequest:
2023-03-28 17:47:34 +00:00
description: An array of CourseSection objects
properties:
Data:
items:
2023-04-30 02:07:31 +00:00
$ref: "../../lib/swagger/defs/course-section.yaml#/CourseSection"
2023-04-07 18:00:15 +00:00
type: array
2023-03-28 17:47:34 +00:00
type: object
2023-04-07 18:00:15 +00:00
CourseSectionResponse:
2023-03-28 17:47:34 +00:00
description: An array of CourseSection objects
properties:
2023-04-30 02:07:31 +00:00
Meta:
$ref: "#/definitions/ResponseMeta"
2023-03-28 17:47:34 +00:00
Data:
items:
2023-04-30 02:07:31 +00:00
$ref: "../../lib/swagger/defs/course-section.yaml#/CourseSection"
2023-04-07 18:00:15 +00:00
type: array
2023-03-28 17:47:34 +00:00
type: object
2023-04-07 18:00:15 +00:00
DatabaseRequest:
description: An array of Database objects
properties:
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/database.yaml#/Database"
2023-04-07 18:00:15 +00:00
type: array
type: object
DatabaseResponse:
description: An array of Database objects
properties:
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/database.yaml#/Database"
2023-04-07 18:00:15 +00:00
type: array
Meta:
$ref: "#/definitions/ResponseMeta"
type: object
2023-04-17 22:11:43 +00:00
EmailMessageRequest:
description: An array Taxnexus Send Email Message objects
properties:
data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/email-message.yaml#/EmailMessage"
2023-04-17 22:11:43 +00:00
type: array
meta:
$ref: "#/definitions/RequestMeta"
type: object
EmailMessagesResponse:
description: An array Taxnexus user objects
properties:
data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/email-message.yaml#/EmailMessage"
2023-04-17 22:11:43 +00:00
type: array
meta:
$ref: "#/definitions/ResponseMeta"
type: object
2023-04-07 18:00:15 +00:00
EnrollmentRequest:
2023-03-28 17:47:34 +00:00
description: An array of Enrollment objects
properties:
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/enrollment.yaml#/Enrollment"
2023-04-07 18:00:15 +00:00
type: array
2023-03-28 17:47:34 +00:00
type: object
2023-04-07 18:00:15 +00:00
EnrollmentResponse:
2023-03-28 17:47:34 +00:00
description: An array of Enrollment objects
properties:
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/enrollment.yaml#/Enrollment"
2023-04-07 18:00:15 +00:00
type: array
2023-03-28 17:47:34 +00:00
type: object
2023-04-07 18:00:15 +00:00
EventRequest:
description: An array of Event objects
2023-03-28 17:47:34 +00:00
properties:
Data:
items:
2023-04-30 02:07:31 +00:00
$ref: "../../lib/swagger/defs/event.yaml#/Event"
2023-04-07 18:00:15 +00:00
type: array
2023-03-28 17:47:34 +00:00
type: object
2023-04-07 18:00:15 +00:00
EventResponse:
description: An array of Event objects
2023-03-28 17:47:34 +00:00
properties:
2023-04-30 02:07:31 +00:00
Meta:
$ref: "#/definitions/ResponseMeta"
2023-03-28 17:47:34 +00:00
Data:
items:
2023-04-30 02:07:31 +00:00
$ref: "../../lib/swagger/defs/event.yaml#/Event"
2023-04-07 18:00:15 +00:00
type: array
2023-03-28 17:47:34 +00:00
type: object
2023-04-30 17:56:32 +00:00
EventCategoryRequest:
description: An array of EventCategory objects
properties:
Data:
items:
$ref: "../../lib/swagger/defs/event-category.yaml#/EventCategory"
type: array
type: object
EventCategoryResponse:
description: An array of EventCategory objects
properties:
Meta:
$ref: "#/definitions/ResponseMeta"
Data:
items:
$ref: "../../lib/swagger/defs/event-category.yaml#/EventCategory"
type: array
type: object
2023-04-07 18:00:15 +00:00
FavoriteRequest:
2023-03-28 17:47:34 +00:00
description: An array of Favorite objects
properties:
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/favorite.yaml#/Favorite"
2023-04-07 18:00:15 +00:00
type: array
2023-03-28 17:47:34 +00:00
type: object
2023-04-07 18:00:15 +00:00
FavoriteResponse:
2023-03-28 17:47:34 +00:00
description: An array of Favorite objects
properties:
2023-04-30 02:07:31 +00:00
Meta:
$ref: "#/definitions/ResponseMeta"
2023-03-28 17:47:34 +00:00
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/favorite.yaml#/Favorite"
2023-04-07 18:00:15 +00:00
type: array
2023-03-28 17:47:34 +00:00
type: object
2023-05-13 16:46:48 +00:00
InvoiceRequest:
description: An array of Invoice objects
2023-03-28 17:47:34 +00:00
properties:
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/invoice.yaml#/Invoice"
2023-04-07 18:00:15 +00:00
type: array
2023-03-28 17:47:34 +00:00
type: object
2023-04-07 18:00:15 +00:00
InvoiceResponse:
2023-03-28 17:47:34 +00:00
description: An array of Invoice objects
properties:
2023-04-30 02:07:31 +00:00
Meta:
$ref: "#/definitions/ResponseMeta"
2023-03-28 17:47:34 +00:00
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/invoice.yaml#/Invoice"
2023-04-07 18:00:15 +00:00
type: array
2023-03-28 17:47:34 +00:00
type: object
2023-04-07 18:00:15 +00:00
IssuedCertificateRequest:
2023-03-28 17:47:34 +00:00
description: An array of IssuedCertificate objects
properties:
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/issued-certificate.yaml#/IssuedCertificate"
2023-04-07 18:00:15 +00:00
type: array
2023-03-28 17:47:34 +00:00
type: object
2023-04-07 18:00:15 +00:00
IssuedCertificateResponse:
2023-03-28 17:47:34 +00:00
description: An array of IssuedCertificate objects
properties:
2023-04-30 02:07:31 +00:00
Meta:
$ref: "#/definitions/ResponseMeta"
2023-03-28 17:47:34 +00:00
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/issued-certificate.yaml#/IssuedCertificate"
2023-04-07 18:00:15 +00:00
type: array
2023-03-28 17:47:34 +00:00
type: object
2023-04-07 18:00:15 +00:00
LessonProgressRequest:
2023-03-28 17:47:34 +00:00
description: An array of LessonProgress objects
properties:
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/lesson-progress.yaml#/LessonProgress"
2023-04-07 18:00:15 +00:00
type: array
2023-03-28 17:47:34 +00:00
type: object
2023-04-07 18:00:15 +00:00
LessonProgressResponse:
2023-03-28 17:47:34 +00:00
description: An array of LessonProgress objects
properties:
2023-04-30 02:07:31 +00:00
Meta:
$ref: "#/definitions/ResponseMeta"
2023-03-28 17:47:34 +00:00
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/lesson-progress.yaml#/LessonProgress"
2023-04-17 22:11:43 +00:00
type: array
type: object
OutgoingEmailMessageRequest:
2023-04-30 02:07:31 +00:00
description: An array Taxnexus New Email Message objects
properties:
data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/outgoing-email-message.yaml#/OutgoingEmailMessage"
2023-04-30 02:07:31 +00:00
type: array
type: object
OutgoingEmailMessagesResponse:
2023-04-17 22:11:43 +00:00
description: An array Taxnexus New Email Message objects
properties:
data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/outgoing-email-message.yaml#/OutgoingEmailMessage"
2023-04-17 22:11:43 +00:00
type: array
meta:
2023-04-30 02:07:31 +00:00
$ref: "#/definitions/ResponseMeta"
2023-04-17 22:11:43 +00:00
type: object
2023-04-07 18:00:15 +00:00
OrderRequest:
2023-03-28 17:47:34 +00:00
description: An array of Order objects
properties:
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/order.yaml#/Order"
2023-04-07 18:00:15 +00:00
type: array
2023-03-28 17:47:34 +00:00
type: object
2023-04-07 18:00:15 +00:00
OrderResponse:
2023-03-28 17:47:34 +00:00
description: An array of Order objects
properties:
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/order.yaml#/Order"
2023-04-07 18:00:15 +00:00
type: array
2023-03-28 17:47:34 +00:00
type: object
2023-04-07 18:00:15 +00:00
Pagination:
properties:
Limit:
format: int64
type: integer
POffset:
format: int64
type: integer
PageSize:
format: int64
type: integer
SetSize:
format: int64
type: integer
type: object
PaymentMethodRequest:
2023-03-28 17:47:34 +00:00
description: An array of PaymentMethod objects
properties:
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/payment-method.yaml#/PaymentMethod"
2023-04-07 18:00:15 +00:00
type: array
2023-03-28 17:47:34 +00:00
type: object
2023-04-07 18:00:15 +00:00
PaymentMethodResponse:
2023-03-28 17:47:34 +00:00
description: An array of PaymentMethod objects
properties:
2023-04-30 02:07:31 +00:00
Meta:
$ref: "#/definitions/ResponseMeta"
2023-03-28 17:47:34 +00:00
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/payment-method.yaml#/PaymentMethod"
2023-04-07 18:00:15 +00:00
type: array
2023-03-28 17:47:34 +00:00
type: object
2023-04-07 18:00:15 +00:00
RequestMeta:
2023-03-28 17:47:34 +00:00
properties:
2023-04-07 18:00:15 +00:00
TaxnexusAccount:
description: Account Number of the Reseller or OEM
2023-03-28 17:47:34 +00:00
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-07 18:00:15 +00:00
required:
- TaxnexusAccount
type: object
ResearchProjectCompanyRequest:
2023-03-28 17:47:34 +00:00
description: An array of ResearchProjectCompany objects
properties:
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/research-project-company.yaml#/ResearchProjectCompany"
2023-04-07 18:00:15 +00:00
type: array
2023-03-28 17:47:34 +00:00
type: object
2023-04-07 18:00:15 +00:00
ResearchProjectCompanyResponse:
2023-03-28 17:47:34 +00:00
description: An array of ResearchProjectCompany objects
properties:
2023-04-30 02:07:31 +00:00
Meta:
$ref: "#/definitions/ResponseMeta"
2023-03-28 17:47:34 +00:00
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/research-project-company.yaml#/ResearchProjectCompany"
2023-04-07 18:00:15 +00:00
type: array
2023-03-28 17:47:34 +00:00
type: object
2023-04-07 18:00:15 +00:00
ResearchProjectRequest:
description: An array of ResearchProject objects
properties:
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/research-project.yaml#/ResearchProject"
2023-04-07 18:00:15 +00:00
type: array
type: object
ResearchProjectResponse:
description: An array of ResearchProject objects
properties:
2023-04-30 02:07:31 +00:00
Meta:
$ref: "#/definitions/ResponseMeta"
2023-04-07 18:00:15 +00:00
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/research-project.yaml#/ResearchProject"
2023-04-07 18:00:15 +00:00
type: array
type: object
2023-05-13 16:46:48 +00:00
ResearchProjectProductRequest:
description: An array of ResearchProjectProduct objects
2023-03-28 17:47:34 +00:00
properties:
2023-05-13 16:46:48 +00:00
Data:
items:
$ref: "../../lib/swagger/defs/research-project-product.yaml#/ResearchProjectProduct"
type: array
type: object
ResearchProjectProductResponse:
description: An array of ResearchProjectProduct objects
properties:
Meta:
$ref: "#/definitions/ResponseMeta"
Data:
items:
$ref: "../../lib/swagger/defs/research-project-product.yaml#/ResearchProjectProduct"
type: array
2023-03-28 17:47:34 +00:00
type: object
2023-04-07 18:00:15 +00:00
ResearchProjectTopicRequest:
2023-03-28 17:47:34 +00:00
description: An array of ResearchProjectTopic objects
properties:
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/research-project-topic.yaml#/ResearchProjectTopic"
2023-04-07 18:00:15 +00:00
type: array
2023-03-28 17:47:34 +00:00
type: object
2023-04-07 18:00:15 +00:00
ResearchProjectTopicResponse:
2023-03-28 17:47:34 +00:00
description: An array of ResearchProjectTopic objects
properties:
2023-04-30 02:07:31 +00:00
Meta:
$ref: "#/definitions/ResponseMeta"
2023-03-28 17:47:34 +00:00
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/research-project-topic.yaml#/ResearchProjectTopic"
2023-04-07 18:00:15 +00:00
type: array
type: object
ResponseMeta:
properties:
Contact:
description: Microservice Contact Info
type: string
Copyright:
description: Copyright Info
type: string
License:
description: License Information and Restrictions
type: string
OperationID:
description: Operation ID
type: string
Pagination:
$ref: "#/definitions/Pagination"
RequestIP:
description: Request IP Address
type: string
RequestType:
description: Request Type
type: string
RequestURL:
description: Request URL
type: string
ServerInfo:
description: Data Server Info
type: string
ServerResponseTime:
description: Data Server Response Time (ms)
type: string
ServerTimestamp:
description: Backend Server Timestamp
type: string
TaxnexusAccount:
description: Account Number used for recording transactions
type: string
type: object
2023-05-13 16:46:48 +00:00
RoleRequest:
description: An array of Role objects
2023-04-07 18:00:15 +00:00
properties:
Date:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/role.yaml#/Role"
2023-04-07 18:00:15 +00:00
type: array
type: object
RoleResponse:
description: An array of Role objects
properties:
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/role.yaml#/Role"
2023-04-07 18:00:15 +00:00
type: array
Meta:
$ref: "#/definitions/ResponseMeta"
type: object
TemplateRequest:
description: An array of Templates
2023-03-28 17:47:34 +00:00
properties:
2023-04-07 18:00:15 +00:00
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/template.yaml#/Template"
2023-04-07 18:00:15 +00:00
type: array
type: object
TemplateResponse:
description: An array of Templates
properties:
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/template.yaml#/Template"
2023-04-07 18:00:15 +00:00
type: array
Meta:
$ref: "#/definitions/ResponseMeta"
type: object
TenantRequest:
description: An array of Tenant objects
properties:
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/tenant.yaml#/Tenant"
2023-04-07 18:00:15 +00:00
type: array
type: object
TenantResponse:
description: An array of Tenant objects
properties:
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/tenant.yaml#/Tenant"
2023-04-07 18:00:15 +00:00
type: array
Meta:
$ref: "#/definitions/ResponseMeta"
type: object
TicketRequest:
2023-03-28 17:47:34 +00:00
description: An array of Ticket objects
properties:
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/ticket.yaml#/Ticket"
2023-04-07 18:00:15 +00:00
type: array
2023-03-28 17:47:34 +00:00
type: object
2023-04-07 18:00:15 +00:00
TicketResponse:
2023-03-28 17:47:34 +00:00
description: An array of Ticket objects
properties:
2023-04-30 02:07:31 +00:00
Meta:
$ref: "#/definitions/ResponseMeta"
2023-03-28 17:47:34 +00:00
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/ticket.yaml#/Ticket"
2023-04-07 18:00:15 +00:00
type: array
2023-03-28 17:47:34 +00:00
type: object
2023-04-07 18:00:15 +00:00
TransactionRequest:
2023-03-28 17:47:34 +00:00
description: An array of Transaction objects
properties:
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/transaction.yaml#/Transaction"
2023-04-07 18:00:15 +00:00
type: array
2023-03-28 17:47:34 +00:00
type: object
2023-04-07 18:00:15 +00:00
TransactionResponse:
2023-03-28 17:47:34 +00:00
description: An array of Transaction objects
properties:
2023-04-30 02:07:31 +00:00
Meta:
$ref: "#/definitions/ResponseMeta"
2023-03-28 17:47:34 +00:00
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/transaction.yaml#/Transaction"
2023-04-07 18:00:15 +00:00
type: array
type: object
UserRequest:
properties:
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/user.yaml#/User"
2023-04-07 18:00:15 +00:00
type: array
type: object
UserResponse:
description: An array of Print-Ready ingest Objects
properties:
Data:
items:
2023-05-13 16:46:48 +00:00
$ref: "../../lib/swagger/defs/user.yaml#/User"
2023-04-07 18:00:15 +00:00
type: array
Meta:
$ref: "#/definitions/ResponseMeta"
type: object
2023-04-11 14:59:35 +00:00
WebhookClerkRequest:
description: Clerk webhook object
properties:
object:
type: string
type:
description: Clerk Name
type: string
data:
type: object
type: object
ClerkUser:
description: Clerk user object
type: object
properties:
external_id:
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-11 14:59:35 +00:00
description: |-
The ID of the user as used in your external systems or your previous authentication solution.
Must be unique across your instance.
first_name:
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-11 14:59:35 +00:00
description: The first name to assign to the user
last_name:
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-11 14:59:35 +00:00
description: The last name to assign to the user
email_address:
type: array
items:
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-11 14:59:35 +00:00
description: |-
Email addresses to add to the user.
Must be unique across your instance.
The first email address will be set as the user's primary email address.
phone_number:
type: array
items:
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-11 14:59:35 +00:00
description: |-
Phone numbers to add to the user.
Must be unique across your instance.
The first phone number will be set as the user's primary phone number.
web3_wallet:
type: array
items:
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-11 14:59:35 +00:00
description: |-
Web3 wallets to add to the user.
Must be unique across your instance.
The first wallet will be set as the user's primary wallet.
username:
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-11 14:59:35 +00:00
description: |-
The username to give to the user.
It must be unique across your instance.
password:
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-11 14:59:35 +00:00
description: |-
The plaintext password to give the user.
Must be at least 8 characters long, and can not be in any list of hacked passwords.
password_digest:
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-11 14:59:35 +00:00
description: |-
In case you already have the password digests and not the passwords, you can use them for the newly created user via this property.
The digests should be generated with one of the supported algorithms.
The hashing algorithm can be specified using the `password_hasher` property.
password_hasher:
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-11 14:59:35 +00:00
description: |-
The hashing algorithm that was used to generate the password digest.
The algorithms we support at the moment are [bcrypt](https://en.wikipedia.org/wiki/Bcrypt), md5, pbkdf2_sha256, [pbkdf2_sha256_django](https://docs.djangoproject.com/en/4.0/topics/auth/passwords/), [scrypt_firebase](https://firebaseopensource.com/projects/firebase/scrypt/) and 2 [argon2](https://argon2.online/) variants, argon2i and argon2id.
Each of the above expects the incoming digest to be of a particular format.
More specifically:
**bcrypt:** The digest should be of the following form:
`$<algorithm version>$<cost>$<salt & hash>`
**md5:** The digest should follow the regular form e.g.:
`5f4dcc3b5aa765d61d8327deb882cf99`
**pbkdf2_sha256:** This is the PBKDF2 algorithm using the SHA256 hashing function. The format should be as follows:
`pbkdf2_sha256$<iterations>$<salt>$<hash>`
Note: Both the salt and the hash are expected to be base64-encoded.
**pbkdf2_sha256_django:** This is the Django-specific variant of PBKDF2 and the digest should have the following format (as exported from Django):
`pbkdf2_sha256$<iterations>$<salt>$<hash>`
Note: The salt is expected to be un-encoded, the hash is expected base64-encoded.
**pbkdf2_sha1:** This is similar to pkbdf2_sha256_django, but with two differences:
1. uses sha1 instead of sha256
2. accepts the hash as a hex-encoded string
The format is the following:
`pbkdf2_sha1$<iterations>$<salt>$<hash-as-hex-string>`
**scrypt_firebase:** The Firebase-specific variant of scrypt.
The value is expected to have 6 segments separated by the $ character and include the following information:
_hash:_ The actual Base64 hash. This can be retrieved when exporting the user from Firebase.
_salt:_ The salt used to generate the above hash. Again, this is given when exporting the user.
_signer key:_ The base64 encoded signer key.
_salt separator:_ The base64 encoded salt separator.
_rounds:_ The number of rounds the algorithm needs to run.
_memory cost:_ The cost of the algorithm run
The first 2 (hash and salt) are per user and can be retrieved when exporting the user from Firebase.
The other 4 values (signer key, salt separator, rounds and memory cost) are project-wide settings and can be retrieved from the project's password hash parameters.
Once you have all these, you can combine it in the following format and send this as the digest in order for Clerk to accept it:
`<hash>$<salt>$<signer key>$<salt separator>$<rounds>$<memory cost>`
**argon2i:** Algorithms in the argon2 family generate digests that encode the following information:
_version (v):_ The argon version, version 19 is assumed
_memory (m):_ The memory used by the algorithm (in kibibytes)
_iterations (t):_ The number of iterations to perform
_parallelism (p):_ The number of threads to use
Parts are demarcated by the `$` character, with the first part identifying the algorithm variant.
The middle part is a comma-separated list of the encoding options (memory, iterations, parallelism).
The final part is the actual digest.
`$argon2i$v=19$m=4096,t=3,p=1$4t6CL3P7YiHBtwESXawI8Hm20zJj4cs7/4/G3c187e0$m7RQFczcKr5bIR0IIxbpO2P0tyrLjf3eUW3M3QSwnLc`
**argon2id:** See the previous algorithm for an explanation of the formatting.
For the argon2id case, the value of the algorithm in the first part of the digest is `argon2id`:
`$argon2id$v=19$m=64,t=4,p=8$Z2liZXJyaXNo$iGXEpMBTDYQ8G/71tF0qGjxRHEmR3gpGULcE93zUJVU`
If you need support for any particular hashing algorithm, [please let us know](https://clerk.com/support).
enum:
- bcrypt
- md5
- pbkdf2_sha256
- pbkdf2_sha256_django
- pbkdf2_sha1
- scrypt_firebase
- argon2i
- argon2id
skip_password_checks:
type: boolean
description: |-
When set to `true` all password checks are skipped.
It is recommended to use this method only when migrating plaintext passwords to Clerk.
Upon migration the user base should be prompted to pick stronger password.
skip_password_requirement:
type: boolean
description: |-
When set to `true`, `password` is not required anymore when creating the user and can be omitted.
This is useful when you are trying to create a user that doesn't have a password, in an instance that is using passwords.
Please note that you cannot use this flag if password is the only way for a user to sign into your instance.
totp_secret:
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-11 14:59:35 +00:00
description: |-
In case TOTP is configured on the instance, you can provide the secret to enable it on the newly created user without the need to reset it.
Please note that currently the supported options are:
* Period: 30 seconds
* Code length: 6 digits
* Algorithm: SHA1
backup_codes:
type: array
items:
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-11 14:59:35 +00:00
description: |-
If Backup Codes are configured on the instance, you can provide them to enable it on the newly created user without the need to reset them.
You must provide the backup codes in plain format or the corresponding bcrypt digest.
public_metadata:
type: object
description: Metadata saved on the user, that is visible to both
your Frontend and Backend APIs
private_metadata:
type: object
description: Metadata saved on the user, that is only visible to
your Backend API
unsafe_metadata:
type: object
description: |-
Metadata saved on the user, that can be updated from both the Frontend and Backend APIs.
Note: Since this data can be modified from the frontend, it is not guaranteed to be safe.
created_at:
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-11 14:59:35 +00:00
description: A custom date/time denoting _when_ the user signed
up to the application, specified in RFC3339 format (e.g. `2012-10-20T07:15:20.902Z`).
WebhookClerkResponse:
description: Clerk webhook object
properties:
object:
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-11 14:59:35 +00:00
type:
description: Clerk Name
type: string
2023-04-15 14:27:18 +00:00
x-nullable: true
2023-04-11 14:59:35 +00:00
data:
type: object
type: object