All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| CreateQuestionBankQuestion | Post /api/v1/questions | QuestionBank@store |
| DeleteQuestionBankQuestion | Delete /api/v1/questions/{id} | QuestionBank@destroy |
| DownloadQuestionBankQuestionFile | Get /api/v1/questions/{id}/files/{fileId} | QuestionBank@destroyFile |
| EditQuestionBankQuestion | Patch /api/v1/questions/{id} | QuestionBank@update |
| FetchArchivedQuestionBankQuestions | Get /api/v1/questions/archived | QuestionBank@indexArchived |
| FetchCustomQuestionBankQuestions | Get /api/v1/questions/custom | QuestionBank@indexCustom |
| FetchQuestionBankQuestion | Get /api/v1/questions/{id} | QuestionBank@show |
| FetchQuestionBankQuestionVersion | Get /api/v1/questions/version/{id} | QuestionBank@showVersion |
| FetchQuestionBankQuestions | Get /api/v1/questions | QuestionBank@index |
| FetchStandardQuestionBankQuestions | Get /api/v1/questions/standard | QuestionBank@indexStandard |
| FetchTeamQuestionBankQuestionsBySection | Get /api/v1/teams/{teamId}/questions/section/{sectionId} | TeamQuestionBank@indexBySection |
| UpdateQuestionBankQuestion | Put /api/v1/questions/{id} | QuestionBank@update |
| UpdateQuestionBankQuestionStatus | Patch /api/v1/questions/{id}/{status} | QuestionBank@updateStatus |
CreateDarIntegration201Response CreateQuestionBankQuestion(ctx).CreateQuestionBankQuestionRequest(createQuestionBankQuestionRequest).Execute()
QuestionBank@store
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/HDRUK/gateway-api-go-sdk"
)
func main() {
createQuestionBankQuestionRequest := *openapiclient.NewCreateQuestionBankQuestionRequest(int32(1), false, true, "Question guidance", "Question title", []map[string]interface{}{map[string]interface{}(123)}, "RadioGroup", []map[string]interface{}{map[string]interface{}(123)}, []openapiclient.CreateQuestionBankQuestionRequestOptionsInner{*openapiclient.NewCreateQuestionBankQuestionRequestOptionsInner()}) // CreateQuestionBankQuestionRequest | QuestionBank definition
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.QuestionBankAPI.CreateQuestionBankQuestion(context.Background()).CreateQuestionBankQuestionRequest(createQuestionBankQuestionRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `QuestionBankAPI.CreateQuestionBankQuestion``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateQuestionBankQuestion`: CreateDarIntegration201Response
fmt.Fprintf(os.Stdout, "Response from `QuestionBankAPI.CreateQuestionBankQuestion`: %v\n", resp)
}Other parameters are passed through a pointer to a apiCreateQuestionBankQuestionRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| createQuestionBankQuestionRequest | CreateQuestionBankQuestionRequest | QuestionBank definition |
CreateDarIntegration201Response
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteApplications200Response DeleteQuestionBankQuestion(ctx, id).Execute()
QuestionBank@destroy
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/HDRUK/gateway-api-go-sdk"
)
func main() {
id := int32(1) // int32 | question bank question id
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.QuestionBankAPI.DeleteQuestionBankQuestion(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `QuestionBankAPI.DeleteQuestionBankQuestion``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DeleteQuestionBankQuestion`: DeleteApplications200Response
fmt.Fprintf(os.Stdout, "Response from `QuestionBankAPI.DeleteQuestionBankQuestion`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int32 | question bank question id |
Other parameters are passed through a pointer to a apiDeleteQuestionBankQuestionRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteApplications200Response DownloadQuestionBankQuestionFile(ctx, id, fileId).Execute()
QuestionBank@destroyFile
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/HDRUK/gateway-api-go-sdk"
)
func main() {
id := int32(1) // int32 | question bank question id
fileId := int32(1) // int32 | file uuid
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.QuestionBankAPI.DownloadQuestionBankQuestionFile(context.Background(), id, fileId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `QuestionBankAPI.DownloadQuestionBankQuestionFile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DownloadQuestionBankQuestionFile`: DeleteApplications200Response
fmt.Fprintf(os.Stdout, "Response from `QuestionBankAPI.DownloadQuestionBankQuestionFile`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int32 | question bank question id | |
| fileId | int32 | file uuid |
Other parameters are passed through a pointer to a apiDownloadQuestionBankQuestionFileRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateQuestionBankQuestion200Response EditQuestionBankQuestion(ctx, id).EditQuestionBankQuestionRequest(editQuestionBankQuestionRequest).Execute()
QuestionBank@update
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/HDRUK/gateway-api-go-sdk"
)
func main() {
id := int32(1) // int32 | question bank question id
editQuestionBankQuestionRequest := *openapiclient.NewEditQuestionBankQuestionRequest() // EditQuestionBankQuestionRequest | QuestionBank definition
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.QuestionBankAPI.EditQuestionBankQuestion(context.Background(), id).EditQuestionBankQuestionRequest(editQuestionBankQuestionRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `QuestionBankAPI.EditQuestionBankQuestion``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `EditQuestionBankQuestion`: UpdateQuestionBankQuestion200Response
fmt.Fprintf(os.Stdout, "Response from `QuestionBankAPI.EditQuestionBankQuestion`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int32 | question bank question id |
Other parameters are passed through a pointer to a apiEditQuestionBankQuestionRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
editQuestionBankQuestionRequest | EditQuestionBankQuestionRequest | QuestionBank definition |
UpdateQuestionBankQuestion200Response
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FetchQuestionBankQuestions200Response FetchArchivedQuestionBankQuestions(ctx).SectionId(sectionId).IsChild(isChild).PerPage(perPage).Page(page).Execute()
QuestionBank@indexArchived
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/HDRUK/gateway-api-go-sdk"
)
func main() {
sectionId := int32(1) // int32 | section id (optional)
isChild := int32(1) // int32 | filter on is_child field (optional)
perPage := int32(1) // int32 | per page (optional)
page := int32(1) // int32 | page (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.QuestionBankAPI.FetchArchivedQuestionBankQuestions(context.Background()).SectionId(sectionId).IsChild(isChild).PerPage(perPage).Page(page).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `QuestionBankAPI.FetchArchivedQuestionBankQuestions``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `FetchArchivedQuestionBankQuestions`: FetchQuestionBankQuestions200Response
fmt.Fprintf(os.Stdout, "Response from `QuestionBankAPI.FetchArchivedQuestionBankQuestions`: %v\n", resp)
}Other parameters are passed through a pointer to a apiFetchArchivedQuestionBankQuestionsRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| sectionId | int32 | section id | |
| isChild | int32 | filter on is_child field | |
| perPage | int32 | per page | |
| page | int32 | page |
FetchQuestionBankQuestions200Response
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FetchCustomQuestionBankQuestions200Response FetchCustomQuestionBankQuestions(ctx).SectionId(sectionId).IsChild(isChild).PerPage(perPage).Page(page).Execute()
QuestionBank@indexCustom
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/HDRUK/gateway-api-go-sdk"
)
func main() {
sectionId := int32(1) // int32 | section id (optional)
isChild := int32(1) // int32 | filter on is_child field (optional)
perPage := int32(1) // int32 | per page (optional)
page := int32(1) // int32 | page (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.QuestionBankAPI.FetchCustomQuestionBankQuestions(context.Background()).SectionId(sectionId).IsChild(isChild).PerPage(perPage).Page(page).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `QuestionBankAPI.FetchCustomQuestionBankQuestions``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `FetchCustomQuestionBankQuestions`: FetchCustomQuestionBankQuestions200Response
fmt.Fprintf(os.Stdout, "Response from `QuestionBankAPI.FetchCustomQuestionBankQuestions`: %v\n", resp)
}Other parameters are passed through a pointer to a apiFetchCustomQuestionBankQuestionsRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| sectionId | int32 | section id | |
| isChild | int32 | filter on is_child field | |
| perPage | int32 | per page | |
| page | int32 | page |
FetchCustomQuestionBankQuestions200Response
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FetchQuestionBankQuestion200Response FetchQuestionBankQuestion(ctx, id).Execute()
QuestionBank@show
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/HDRUK/gateway-api-go-sdk"
)
func main() {
id := int32(1) // int32 | question bank question id
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.QuestionBankAPI.FetchQuestionBankQuestion(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `QuestionBankAPI.FetchQuestionBankQuestion``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `FetchQuestionBankQuestion`: FetchQuestionBankQuestion200Response
fmt.Fprintf(os.Stdout, "Response from `QuestionBankAPI.FetchQuestionBankQuestion`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int32 | question bank question id |
Other parameters are passed through a pointer to a apiFetchQuestionBankQuestionRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
FetchQuestionBankQuestion200Response
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FetchQuestionBankQuestionVersion200Response FetchQuestionBankQuestionVersion(ctx, id).Execute()
QuestionBank@showVersion
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/HDRUK/gateway-api-go-sdk"
)
func main() {
id := int32(1) // int32 | question bank question version id
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.QuestionBankAPI.FetchQuestionBankQuestionVersion(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `QuestionBankAPI.FetchQuestionBankQuestionVersion``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `FetchQuestionBankQuestionVersion`: FetchQuestionBankQuestionVersion200Response
fmt.Fprintf(os.Stdout, "Response from `QuestionBankAPI.FetchQuestionBankQuestionVersion`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int32 | question bank question version id |
Other parameters are passed through a pointer to a apiFetchQuestionBankQuestionVersionRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
FetchQuestionBankQuestionVersion200Response
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FetchQuestionBankQuestions200Response FetchQuestionBankQuestions(ctx).SectionId(sectionId).IsChild(isChild).PerPage(perPage).Page(page).Execute()
QuestionBank@index
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/HDRUK/gateway-api-go-sdk"
)
func main() {
sectionId := int32(1) // int32 | section id (optional)
isChild := int32(1) // int32 | filter on is_child field (optional)
perPage := int32(1) // int32 | per page (optional)
page := int32(1) // int32 | page (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.QuestionBankAPI.FetchQuestionBankQuestions(context.Background()).SectionId(sectionId).IsChild(isChild).PerPage(perPage).Page(page).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `QuestionBankAPI.FetchQuestionBankQuestions``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `FetchQuestionBankQuestions`: FetchQuestionBankQuestions200Response
fmt.Fprintf(os.Stdout, "Response from `QuestionBankAPI.FetchQuestionBankQuestions`: %v\n", resp)
}Other parameters are passed through a pointer to a apiFetchQuestionBankQuestionsRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| sectionId | int32 | section id | |
| isChild | int32 | filter on is_child field | |
| perPage | int32 | per page | |
| page | int32 | page |
FetchQuestionBankQuestions200Response
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FetchStandardQuestionBankQuestions200Response FetchStandardQuestionBankQuestions(ctx).SectionId(sectionId).IsChild(isChild).PerPage(perPage).Page(page).Execute()
QuestionBank@indexStandard
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/HDRUK/gateway-api-go-sdk"
)
func main() {
sectionId := int32(1) // int32 | section id (optional)
isChild := int32(1) // int32 | filter on is_child field (optional)
perPage := int32(1) // int32 | per page (optional)
page := int32(1) // int32 | page (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.QuestionBankAPI.FetchStandardQuestionBankQuestions(context.Background()).SectionId(sectionId).IsChild(isChild).PerPage(perPage).Page(page).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `QuestionBankAPI.FetchStandardQuestionBankQuestions``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `FetchStandardQuestionBankQuestions`: FetchStandardQuestionBankQuestions200Response
fmt.Fprintf(os.Stdout, "Response from `QuestionBankAPI.FetchStandardQuestionBankQuestions`: %v\n", resp)
}Other parameters are passed through a pointer to a apiFetchStandardQuestionBankQuestionsRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| sectionId | int32 | section id | |
| isChild | int32 | filter on is_child field | |
| perPage | int32 | per page | |
| page | int32 | page |
FetchStandardQuestionBankQuestions200Response
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FetchTeamQuestionBankQuestionsBySection200Response FetchTeamQuestionBankQuestionsBySection(ctx, teamId, sectionId).IsChild(isChild).Execute()
TeamQuestionBank@indexBySection
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/HDRUK/gateway-api-go-sdk"
)
func main() {
teamId := int32(1) // int32 | Team ID
sectionId := int32(1) // int32 | section id
isChild := int32(1) // int32 | filter on is_child field (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.QuestionBankAPI.FetchTeamQuestionBankQuestionsBySection(context.Background(), teamId, sectionId).IsChild(isChild).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `QuestionBankAPI.FetchTeamQuestionBankQuestionsBySection``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `FetchTeamQuestionBankQuestionsBySection`: FetchTeamQuestionBankQuestionsBySection200Response
fmt.Fprintf(os.Stdout, "Response from `QuestionBankAPI.FetchTeamQuestionBankQuestionsBySection`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| teamId | int32 | Team ID | |
| sectionId | int32 | section id |
Other parameters are passed through a pointer to a apiFetchTeamQuestionBankQuestionsBySectionRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
isChild | int32 | filter on is_child field |
FetchTeamQuestionBankQuestionsBySection200Response
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateQuestionBankQuestion200Response UpdateQuestionBankQuestion(ctx, id).UpdateQuestionBankQuestionRequest(updateQuestionBankQuestionRequest).Execute()
QuestionBank@update
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/HDRUK/gateway-api-go-sdk"
)
func main() {
id := int32(1) // int32 | question bank question id
updateQuestionBankQuestionRequest := *openapiclient.NewUpdateQuestionBankQuestionRequest(int32(1), false, true, "Question guidance", "Question title", []map[string]interface{}{map[string]interface{}(123)}) // UpdateQuestionBankQuestionRequest | QuestionBank definition
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.QuestionBankAPI.UpdateQuestionBankQuestion(context.Background(), id).UpdateQuestionBankQuestionRequest(updateQuestionBankQuestionRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `QuestionBankAPI.UpdateQuestionBankQuestion``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `UpdateQuestionBankQuestion`: UpdateQuestionBankQuestion200Response
fmt.Fprintf(os.Stdout, "Response from `QuestionBankAPI.UpdateQuestionBankQuestion`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int32 | question bank question id |
Other parameters are passed through a pointer to a apiUpdateQuestionBankQuestionRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
updateQuestionBankQuestionRequest | UpdateQuestionBankQuestionRequest | QuestionBank definition |
UpdateQuestionBankQuestion200Response
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateQuestionBankQuestionStatus200Response UpdateQuestionBankQuestionStatus(ctx, id, status).Execute()
QuestionBank@updateStatus
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/HDRUK/gateway-api-go-sdk"
)
func main() {
id := int32(1) // int32 | question bank question id
status := "lock" // string | lock or unlock
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.QuestionBankAPI.UpdateQuestionBankQuestionStatus(context.Background(), id, status).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `QuestionBankAPI.UpdateQuestionBankQuestionStatus``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `UpdateQuestionBankQuestionStatus`: UpdateQuestionBankQuestionStatus200Response
fmt.Fprintf(os.Stdout, "Response from `QuestionBankAPI.UpdateQuestionBankQuestionStatus`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int32 | question bank question id | |
| status | string | lock or unlock |
Other parameters are passed through a pointer to a apiUpdateQuestionBankQuestionStatusRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
UpdateQuestionBankQuestionStatus200Response
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]