...
/local-authority-file (GET/POST/PUT)
Code Block |
---|
theme | RDarkDJango |
---|
borderStyle | dashed |
---|
title | Local Authority File Example |
---|
collapse | true |
---|
|
{
"id": "cb58492d-018e-442d-9ce3-35aabfc524aa",
"name": "Test",
"type": "Subjects",
"prefix": "local",
"startWith": "000000001"
} |
Code Block |
---|
theme | Emacs |
---|
borderStyle | dashed |
---|
title | Local Authority File Schema |
---|
collapse | true |
---|
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An Authority local file",
"type": "object",
"properties": {
"id": {
"description": "unique ID of the Authority local file; a UUID",
"$ref": "uuid.json"
},
"name": {
"type": "string",
"description": "Authority local file name"
},
"type": {
"type": "string",
"description": "Type of authority records stored in local file"
},
"prefix": {
"type": "string",
"description": "Assign local file prefix"
},
"startWith": {
"type": "string",
"description": "Assign local file start with value"
},
"metadata": {
"type": "object",
"$ref": "raml-util/schemas/metadata.schema",
"readonly": true
}
},
"additionalProperties": false,
"required": [
"name",
"type",
"prefix",
"startWith"
]
} |
Code Block |
---|
theme | FadeToGrey |
---|
borderStyle | dashed |
---|
title | Local Authority Files Schema |
---|
collapse | true |
---|
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A collection of Authority local files",
"type": "object",
"properties": {
"authorityLocalFiles": {
"description": "List of Authority local files",
"id": "authorityLocalFile",
"type": "array",
"items": {
"type": "object",
"$ref": "authoritylocalfile.json"
}
},
"totalRecords": {
"description": "Estimated or exact total number of records",
"type": "integer"
}
},
"required": [
"authorityLocalFiles",
"totalRecords"
]
} |