Voxco Codebooks API
The Codebooks API from Voxco — 5 operation(s) for codebooks.
OpenAPI Specification
openapi: 3.0.4
info:
title: Ascribe Coder AICoder Codebooks API
description: <br/> To import this API to Postman, copy the URL from the top of this page.<br/> Open Postman, and select Import.<br/> In the dialog select 'Import From Link'.<br/> Paste the URL and click Import.<br/><br/> To use this API interactively from this page, open the POST Sessions operation below.<br/> Click the Example Value in the Parameters section to move it to the request.<br/> Modify the request with your credentials, then click "Try it out!"<br/> Copy the value of the bearerToken returned in the response to the api_key text box at the top of this page.<br/> You can now interact with the other resources on this page.<br/> You can save the bearer token for future use without needing to POST to the Sessions resource again.
contact:
email: support@goascribe.com
version: v2
servers:
- url: https://api.goascribe.us/coder/v2
description: US Servers
- url: https://api.goascribe.eu/coder/v2
description: EU Servers
- url: https://api-ca.goascribe.com/coder/v2
description: CA Servers
security:
- Bearer: []
tags:
- name: Codebooks
paths:
/Codebooks/{codebookKey}:
get:
tags:
- Codebooks
summary: Get a Codebook by its key
description: "Each Question has exactly one Codebook, which may be shared across multiple Questions.\r\n\r\nA Codebook is tree-structured, where the leaf nodes are Codes and non-leaf nodes are Nets. Only Codes may be used to code a Response.\r\n\r\n\r\nThis resource can return the Codes in the Codebook as a flattened list containing only the Codes, or as a tree with the full structure of the Codebook.\r\n"
parameters:
- name: codebookKey
in: path
description: The Codebook key, which must be an integer value.
required: true
schema:
type: integer
format: int32
- name: tree
in: query
description: "Optional query parameter.\r\n\r\n If true, return a tree-structured representation of the Codebook.\r\n \r\n When tree=false (the default) only the Codes are returned (no Nets) as a single list."
schema:
type: boolean
default: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetCodebookResponse'
example:
codebookKey: 1234567
codebook:
- key: 1
description: Code1
inputId: '10'
outputId: '10'
regexPattern: null
color: '#FF0000'
children: null
- key: 2
description: Net1
inputId: '20'
outputId: '20'
regexPattern: null
color: null
children:
- key: 3
description: Code2
inputId: '30'
outputId: '30'
regexPattern: null
color: '#FF0000'
children: null
- key: 4
description: Code3
inputId: '40'
outputId: '40'
regexPattern: null
color: '#0000FF'
children: null
errorMessage: null
/Codebooks/Question/{questionKey}:
get:
tags:
- Codebooks
summary: Get the Codebook for a Question
description: "Each Question has exactly one Codebook, which may be shared across multiple Questions.\r\n\r\nA Codebook is tree-structured, where the leaf nodes are Codes and non-leaf nodes are Nets. Only Codes may be used to code a Response.\r\n\r\n\r\nThis resource can return the Codes in the Codebook as a flattened list containing only the Codes, or as a tree with the full structure of the Codebook.\r\n"
parameters:
- name: questionKey
in: path
description: The Question key, which must be an integer value.
required: true
schema:
type: integer
format: int32
- name: tree
in: query
description: "Optional query parameter.\r\n\r\n If true, return a tree-structured representation of the Codebook.\r\n \r\n When tree=false (the default) only the Codes are returned (no Nets) as a single list."
schema:
type: boolean
default: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetQuestionCodebookResponse'
example:
codebookKey: 1234567
codebook:
- key: 1
description: Code1
inputId: '10'
outputId: '10'
regexPattern: null
color: '#FF0000'
children: null
- key: 2
description: Net1
inputId: '20'
outputId: '20'
regexPattern: null
color: null
children:
- key: 3
description: Code2
inputId: '30'
outputId: '30'
regexPattern: null
color: '#FF0000'
children: null
- key: 4
description: Code3
inputId: '40'
outputId: '40'
regexPattern: null
color: '#0000FF'
children: null
errorMessage: null
/Codebooks/{questionKey}:
post:
tags:
- Codebooks
summary: Create a new Codebook for a Question
description: "This operation replaces any existing Codebook for the specified Question with the new Codebook.\r\n\r\nThis operation is permitted only if there are no coded responses in the Question."
parameters:
- name: questionKey
in: path
description: The key of the Question.
required: true
schema:
type: integer
format: int32
requestBody:
description: The codes and nets in the new Codebook.
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCodebookForQuestionRequest'
example:
codes:
- description: Likes
inputId: null
outputId: '1000'
regexPattern: null
color: '#00FF00'
children:
- description: Color
inputId: null
outputId: '1001'
regexPattern: null
color: null
children: null
- description: Taste
inputId: null
outputId: '1002'
regexPattern: null
color: null
children: null
- description: Dislikes
inputId: null
outputId: '2000'
regexPattern: null
color: '#FF0000'
children:
- description: Color
inputId: null
outputId: '2001'
regexPattern: null
color: null
children: null
- description: Taste
inputId: null
outputId: '2002'
regexPattern: null
color: null
children: null
text/json:
schema:
$ref: '#/components/schemas/CreateCodebookForQuestionRequest'
example:
codes:
- description: Likes
inputId: null
outputId: '1000'
regexPattern: null
color: '#00FF00'
children:
- description: Color
inputId: null
outputId: '1001'
regexPattern: null
color: null
children: null
- description: Taste
inputId: null
outputId: '1002'
regexPattern: null
color: null
children: null
- description: Dislikes
inputId: null
outputId: '2000'
regexPattern: null
color: '#FF0000'
children:
- description: Color
inputId: null
outputId: '2001'
regexPattern: null
color: null
children: null
- description: Taste
inputId: null
outputId: '2002'
regexPattern: null
color: null
children: null
application/*+json:
schema:
$ref: '#/components/schemas/CreateCodebookForQuestionRequest'
example:
codes:
- description: Likes
inputId: null
outputId: '1000'
regexPattern: null
color: '#00FF00'
children:
- description: Color
inputId: null
outputId: '1001'
regexPattern: null
color: null
children: null
- description: Taste
inputId: null
outputId: '1002'
regexPattern: null
color: null
children: null
- description: Dislikes
inputId: null
outputId: '2000'
regexPattern: null
color: '#FF0000'
children:
- description: Color
inputId: null
outputId: '2001'
regexPattern: null
color: null
children: null
- description: Taste
inputId: null
outputId: '2002'
regexPattern: null
color: null
children: null
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCodebookForQuestionResponse'
example:
codebookKey: 1234567
codebook:
- key: 1
description: Code1
inputId: '10'
outputId: '10'
regexPattern: null
color: '#FF0000'
children: null
- key: 2
description: Net1
inputId: '20'
outputId: '20'
regexPattern: null
color: null
children:
- key: 3
description: Code2
inputId: '30'
outputId: '30'
regexPattern: null
color: '#FF0000'
children: null
- key: 4
description: Code3
inputId: '40'
outputId: '40'
regexPattern: null
color: '#0000FF'
children: null
errorMessage: null
/Codebooks/{codebookKey}/Codes:
post:
tags:
- Codebooks
summary: Add codes to a codebook
description: This operation adds the given codes to the specified codebook.
parameters:
- name: codebookKey
in: path
description: The key of the Codebook.
required: true
schema:
type: integer
format: int32
requestBody:
description: The codes and nets in the new Codebook.
content:
application/json:
schema:
$ref: '#/components/schemas/AddCodesIntoCodebookRequest'
example:
codes:
- description: Likes
inputId: null
outputId: '1000'
regexPattern: null
color: '#00FF00'
children:
- description: Color
inputId: null
outputId: '1001'
regexPattern: null
color: null
children: null
- description: Taste
inputId: null
outputId: '1002'
regexPattern: null
color: null
children: null
- description: Dislikes
inputId: null
outputId: '2000'
regexPattern: null
color: '#FF0000'
children:
- description: Color
inputId: null
outputId: '2001'
regexPattern: null
color: null
children: null
- description: Taste
inputId: null
outputId: '2002'
regexPattern: null
color: null
children: null
overwrite: false
text/json:
schema:
$ref: '#/components/schemas/AddCodesIntoCodebookRequest'
example:
codes:
- description: Likes
inputId: null
outputId: '1000'
regexPattern: null
color: '#00FF00'
children:
- description: Color
inputId: null
outputId: '1001'
regexPattern: null
color: null
children: null
- description: Taste
inputId: null
outputId: '1002'
regexPattern: null
color: null
children: null
- description: Dislikes
inputId: null
outputId: '2000'
regexPattern: null
color: '#FF0000'
children:
- description: Color
inputId: null
outputId: '2001'
regexPattern: null
color: null
children: null
- description: Taste
inputId: null
outputId: '2002'
regexPattern: null
color: null
children: null
overwrite: false
application/*+json:
schema:
$ref: '#/components/schemas/AddCodesIntoCodebookRequest'
example:
codes:
- description: Likes
inputId: null
outputId: '1000'
regexPattern: null
color: '#00FF00'
children:
- description: Color
inputId: null
outputId: '1001'
regexPattern: null
color: null
children: null
- description: Taste
inputId: null
outputId: '1002'
regexPattern: null
color: null
children: null
- description: Dislikes
inputId: null
outputId: '2000'
regexPattern: null
color: '#FF0000'
children:
- description: Color
inputId: null
outputId: '2001'
regexPattern: null
color: null
children: null
- description: Taste
inputId: null
outputId: '2002'
regexPattern: null
color: null
children: null
overwrite: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AddCodesIntoCodebookResponse'
example:
codebookKey: 1234567
codebook:
- key: 1
description: Code1
inputId: '10'
outputId: '10'
regexPattern: null
color: '#FF0000'
children: null
- key: 2
description: Net1
inputId: '20'
outputId: '20'
regexPattern: null
color: null
children:
- key: 3
description: Code2
inputId: '30'
outputId: '30'
regexPattern: null
color: '#FF0000'
children: null
- key: 4
description: Code3
inputId: '40'
outputId: '40'
regexPattern: null
color: '#0000FF'
children: null
errorMessage: null
put:
tags:
- Codebooks
summary: Updates codes in a specified codebook
description: This operation updates the given codes in a specified codebook.
parameters:
- name: codebookKey
in: path
description: The key of the Codebook.
required: true
schema:
type: integer
format: int32
requestBody:
description: The codes/nets in the new Codebook.
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateCodesInCodebookRequest'
example:
codes:
- key: 1234567
description: New Description for the code with key 1234567
inputId: '101'
outputId: '101'
regexPattern: null
color: '#00FF00'
- key: 1234568
description: New Description for the code with key 1234568
inputId: '102'
outputId: '102'
regexPattern: null
color: '#FF0000'
- key: 1234569
description: New Description for the code with key 1234569
inputId: '103'
outputId: '103'
regexPattern: \bnothing\b
color: '#00CCCC'
overwrite: true
text/json:
schema:
$ref: '#/components/schemas/UpdateCodesInCodebookRequest'
example:
codes:
- key: 1234567
description: New Description for the code with key 1234567
inputId: '101'
outputId: '101'
regexPattern: null
color: '#00FF00'
- key: 1234568
description: New Description for the code with key 1234568
inputId: '102'
outputId: '102'
regexPattern: null
color: '#FF0000'
- key: 1234569
description: New Description for the code with key 1234569
inputId: '103'
outputId: '103'
regexPattern: \bnothing\b
color: '#00CCCC'
overwrite: true
application/*+json:
schema:
$ref: '#/components/schemas/UpdateCodesInCodebookRequest'
example:
codes:
- key: 1234567
description: New Description for the code with key 1234567
inputId: '101'
outputId: '101'
regexPattern: null
color: '#00FF00'
- key: 1234568
description: New Description for the code with key 1234568
inputId: '102'
outputId: '102'
regexPattern: null
color: '#FF0000'
- key: 1234569
description: New Description for the code with key 1234569
inputId: '103'
outputId: '103'
regexPattern: \bnothing\b
color: '#00CCCC'
overwrite: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateCodesInCodebookResponse'
example:
failedCodes:
- key: '1234569'
errorMessage: Some error happens during updating of code with key '1234569'.
codebookKey: 0
codebook:
- key: 1234567
description: New Description for the code with key 1234567
inputId: '101'
outputId: '101'
regexPattern: null
color: '#00FF00'
children: null
- key: 1234568
description: New Description for the code with key 1234568
inputId: '102'
outputId: '102'
regexPattern: null
color: '#FF0000'
children: null
- key: 1234569
description: New Description for the code with key 1234569
inputId: '103'
outputId: '103'
regexPattern: \bnothing\b
color: '#00CCCC'
children: null
errorMessage: null
delete:
tags:
- Codebooks
summary: Deletes codes from the specified codebook.
parameters:
- name: codebookKey
in: path
description: Key of the codebook
required: true
schema:
type: integer
format: int32
requestBody:
description: Request that contains information about codes to delete
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteCodebookCodesRequest'
example:
codeKeys:
- 21000
- 21001
- 22100
- 21003
uncodeResponses: false
text/json:
schema:
$ref: '#/components/schemas/DeleteCodebookCodesRequest'
example:
codeKeys:
- 21000
- 21001
- 22100
- 21003
uncodeResponses: false
application/*+json:
schema:
$ref: '#/components/schemas/DeleteCodebookCodesRequest'
example:
codeKeys:
- 21000
- 21001
- 22100
- 21003
uncodeResponses: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteCodebookCodesResponse'
example:
codeKeysDeleted:
- 21000
- 21001
- 21003
codeKeysNotDeleted:
- 22100
codesRemovedFromResponses: []
errorMessage: null
/Codebooks/Codes/Batch:
post:
tags:
- Codebooks
summary: Add codes into target codebooks
description: This operation adds the given codes to the corresponding codebooks.
requestBody:
description: Information about the codes and nets and target codebooks.
content:
application/json:
schema:
$ref: '#/components/schemas/AddCodesIntoCodebooksBatchRequest'
example:
codebooksAndTheirCodes:
- codebookKey: 1234567
codes:
- description: Likes
inputId: null
outputId: '1000'
regexPattern: null
color: '#00FF00'
children:
- description: Color
inputId: null
outputId: '1001'
regexPattern: null
color: null
children: null
- description: Taste
inputId: null
outputId: '1002'
regexPattern: null
color: null
children: null
- description: Dislikes
inputId: null
outputId: '1003'
regexPattern: null
color: '#FF0000'
children:
- description: Color
inputId: null
outputId: '1004'
regexPattern: null
color: null
children: null
- description: Taste
inputId: null
outputId: '1005'
regexPattern: null
color: null
children: null
- codebookKey: 2345678
codes:
- description: Likes
inputId: null
outputId: '1006'
regexPattern: null
color: '#00FF00'
children:
- description: Color
inputId: null
outputId: '1007'
regexPattern: null
color: null
children: null
- description: Taste
inputId: null
outputId: '1008'
regexPattern: null
color: null
children: null
- description: Dislikes
inputId: null
outputId: '1009'
regexPattern: null
color: '#FF0000'
children:
- description: Color
inputId: null
outputId: '1010'
regexPattern: null
color: null
children: null
- description: Taste
inputId: null
outputId: '1011'
regexPattern: null
color: null
children: null
overwrite: false
text/json:
schema:
$ref: '#/components/schemas/AddCodesIntoCodebooksBatchRequest'
example:
codebooksAndTheirCodes:
- codebookKey: 1234567
codes:
- description: Likes
inputId: null
outputId: '1000'
regexPattern: null
color: '#00FF00'
children:
- description: Color
inputId: null
outputId: '1001'
regexPattern: null
color: null
children: null
- description: Taste
inputId: null
outputId: '1002'
regexPattern: null
color: null
children: null
- description: Dislikes
inputId: null
outputId: '1003'
regexPattern: null
color: '#FF0000'
children:
- description: Color
inputId: null
outputId: '1004'
regexPattern: null
color: null
children: null
- description: Taste
inputId: null
outputId: '1005'
regexPattern: null
color: null
children: null
- codebookKey: 2345678
codes:
- description: Likes
inputId: null
outputId: '1006'
regexPattern: null
color: '#00FF00'
children:
- description: Color
inputId: null
outputId: '1007'
regexPattern: null
color: null
children: null
- description: Taste
inputId: null
outputId: '1008'
regexPattern: null
color: null
children: null
- description: Dislikes
inputId: null
outputId: '1009'
regexPattern: null
color: '#FF0000'
children:
- description: Color
inputId: null
outputId: '1010'
regexPattern: null
color: null
children: null
- description: Taste
inputId: null
outputId: '1011'
regexPattern: null
color: null
children: null
overwrite: false
application/*+json:
schema:
$ref: '#/components/schemas/AddCodesIntoCodebooksBatchRequest'
example:
codebooksAndTheirCodes:
- codebookKey: 1234567
codes:
- description: Likes
inputId: null
outputId: '1000'
regexPattern: null
color: '#00FF00'
children:
- description: Color
inputId: null
outputId: '1001'
regexPattern: null
color: null
children: null
- description: Taste
inputId: null
outputId: '1002'
regexPattern: null
color: null
children: null
- description: Dislikes
inputId: null
outputId: '1003'
regexPattern: null
color: '#FF0000'
children:
- description: Color
inputId: null
outputId: '1004'
regexPattern: null
color: null
children: null
- description: Taste
inputId: null
outputId: '1005'
regexPattern: null
color: null
children: null
- codebookKey: 2345678
codes:
- description: Likes
inputId: null
outputId: '1006'
regexPattern: null
color: '#00FF00'
children:
- description: Color
inputId: null
outputId: '1007'
regexPattern: null
color: null
children: null
- description: Taste
inputId: null
outputId: '1008'
regexPattern: null
color: null
children: null
- description: Dislikes
inputId: null
outputId: '1009'
regexPattern: null
color: '#FF0000'
children:
- description: Color
inputId: null
outputId: '1010'
regexPattern: null
color: null
childr
# --- truncated at 32 KB (52 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/voxco/refs/heads/main/openapi/voxco-codebooks-api-openapi.yml