...
OpenAPI-specificaties
Swagger integration |
---|
{ "openapi": "3.0.0", "info": { "title": "Certificates Endpoint", "version": '"1.0'", "description": |- "# Certificates API This \n\nThis documentation contains the API description that is expected from a source of certificates that is supplying certificates to the Burgerprofiel platform of the Flemish Government." }, "servers": [ { - "url": "https://burgerprofiel.vlaanderen.be/v1", "description": "Burgerprofiel" paths: /certificates/{ssn}: ], get "paths": { tags:"/certificates/{ssn}": { "get": { - Certificates summary"tags": Certificates[ List parameters: "Certificates" - name: ssn ], in"summary": path"Certificates List", description: Social security number"parameters": [ { required: true "name": "ssn", style: simple explode: false"in": "path", schema"description": "Social security number", type: string "required": true, responses: '200'"style": "simple", description: OK "explode": false, content: "schema": { application/hal+json: "type": "string" schema: } $ref: '#/components/schemas/List-Certificates' } ], examples: "responses": { "200": { Full Example: "description": "OK", value "content": { "application/json": { certificates: "schema": { - id: 85144567-7043-4469-9e79-279f4eb31e27 "$ref": "#/components/schemas/List-Certificates" language:}, nl "examples": { name: Dienstencheques 2019 "Full Example": { year: 2019 "value": { links: "certificates": [ - rel: self { href: https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/"id": "85144567-7043-4469-9e79-279f4eb31e27/nl", - rel"language": download"nl", "name": href: https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/nl/download"Dienstencheques 2019", - id: 85144567-7043-4469-9e79-279f4eb31e27 "year": 2019, language: en name: Dienstencheques 2019"links": [ year: 2019 { links: - rel: self"rel": "self", "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/ennl" -}, rel: download { href: https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/en/download - id: 8a4faf91-300e-46f0-8dad-0e1e572dbca1"rel": "download", language: nl"href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/nl/download" name: Sportkamp} Tennis community: 23088] year:}, 2018 { links: "id": "85144567-7043-4469- rel: self9e79-279f4eb31e27", "language": "en", href: https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/8a4faf91-300e-46f0-8dad-0e1e572dbca1 "name": "Dienstencheques 2019", - rel: download "year": 2019, href: https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/8a4faf91-300e-46f0-8dad-0e1e572dbca1/download "links": [ - id: 25da5b3c-4de4-457c-a803-cea5cafbfff5 { language: nl name: Dienstencheques 2018 "rel": "self", year: 2018 "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/en" links: }, - rel: self { href: https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/25da5b3c-4de4-457c-a803-cea5cafbfff5 - rel"rel": "download", "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/25da5b3c85144567-4de47043-457c4469-a8039e79-cea5cafbfff5279f4eb31e27/en/download" - id: 8e3405ea-ef23-4d8a-b5b4-9cb645ac312b } language: nl ] name: Deelname opleiding}, recreatiemedewerker { year: 2019 links"id": "8a4faf91-300e-46f0-8dad-0e1e572dbca1", - rel"language": self"nl", "name": href: https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/8e3405ea-ef23-4d8a-b5b4-9cb645ac312b"Sportkamp Tennis", "community": 23088, - rel: download "year": 2018, href: https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/8e3405ea-ef23-4d8a-b5b4-9cb645ac312b/download "links": -[ id: 8df1a0b0-1278-46a7-a3dc-cce7f593d02c language: nl { name: Sportkamp tennis "rel": "self", community: 11002 "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/8a4faf91-300e-46f0-8dad-0e1e572dbca1" year: 2012 }, links: { - "rel": self"download", "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/8df1a0b08a4faf91-1278300e-46a746f0-a3dc-cce7f593d02c8dad-0e1e572dbca1/download" - rel: download} ] href: https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/8df1a0b0-1278-46a7-a3dc-cce7f593d02c/download }, - id: 34492c86-7bf8-4d96-9e61-e3c2f51d172a { language: nl "id": name: Dienstencheques 2015"25da5b3c-4de4-457c-a803-cea5cafbfff5", year"language": 2015"nl", links: "name": "Dienstencheques 2018", "year": 2018, - rel: self "links": [ { href: https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/34492c86-7bf8-4d96-9e61-e3c2f51d172a - "rel": download"self", "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/34492c8625da5b3c-7bf84de4-4d96457c-9e61-e3c2f51d172a/downloada803-cea5cafbfff5" - id: a681c382-8e99-4757-9fdb-487b9b6aeb78 }, language: nl { name: Trainersopleiding voetbal "rel": "download", community: 71053 "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/25da5b3c-4de4-457c-a803-cea5cafbfff5/download" year: 2013 } links: ] - rel: self }, href: https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/a681c382-8e99-4757-9fdb-487b9b6aeb78 { - rel: download "id": "8e3405ea-ef23-4d8a-b5b4-9cb645ac312b", href: https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/a681c382-8e99-4757-9fdb-487b9b6aeb78/download "language": "nl", - id: 6973ab14-15c6-4ee7-944c-9d1162d9de71 "name": "Deelname opleiding recreatiemedewerker", language: nl "year": 2019, name: Dienstencheques 2014 "links": [ year: 2014 { links: - "rel": "self", "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/6973ab148e3405ea-15c6ef23-4ee74d8a-944cb5b4-9d1162d9de719cb645ac312b" - rel: download}, href: https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/6973ab14-15c6-4ee7-944c-9d1162d9de71/download{ - id: d61fdf2e-8099-4757-93d9-2709f1ce1ae2 "rel": "download", language: nl name: Vlaamse kinderbijslag"href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/8e3405ea-ef23-4d8a-b5b4-9cb645ac312b/download" year: 2019 } links: ] - rel: self }, { href: https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/d61fdf2e-8099-4757-93d9-2709f1ce1ae2 "id": "8df1a0b0-1278-46a7-a3dc-cce7f593d02c", - rel: download "language": "nl", href: https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/d61fdf2e-8099-4757-93d9-2709f1ce1ae2/download pageMetadata"name": "Sportkamp tennis", number: 1 "community": 11002, size: 10 "year": 2012, totalElements: 40 "links": [ totalPages: 4 { links: - "rel": "self", "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302?limit=10&page=0/8df1a0b0-1278-46a7-a3dc-cce7f593d02c" - rel: next }, href: https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302?limit=10&page=1 { - rel: start "rel": "download", href: https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302?limit=10&page=0 - rel: last"href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/8df1a0b0-1278-46a7-a3dc-cce7f593d02c/download" href: https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302?limit=10&page=3 } Last page, no more next page: ] value: }, certificates: { - id: 85144567-7043-4469-9e79-279f4eb31e27 "id": "34492c86-7bf8-4d96-9e61-e3c2f51d172a", language: nl "language": "nl", name: Dienstencheques 2019 "name": "Dienstencheques 2015", year: 2019 links"year": 2015, - rel"links": self[ href: https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27{ - "rel": download"self", "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/8514456734492c86-70437bf8-44694d96-9e79-279f4eb31e27/download9e61-e3c2f51d172a" - id: 57faeea1-ff3b-4c65-989c-e2175610c2b0 }, language: nl { name: Sportkamp Volleybal "rel": "download", community: 21004 "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/34492c86-7bf8-4d96-9e61-e3c2f51d172a/download" year: 2019 } links: ] - rel: self }, href: https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/57faeea1-ff3b-4c65-989c-e2175610c2b0 { - rel: download "id": "a681c382-8e99-4757-9fdb-487b9b6aeb78", href: https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/57faeea1-ff3b-4c65-989c-e2175610c2b0/download "language": "nl", - id: 8a4faf91-300e-46f0-8dad-0e1e572dbca1 "name": "Trainersopleiding voetbal", language: nl "community": 71053, name: Sportkamp Tennis "year": 2013, community: 23088 "links": [ year: 2018 { links: - "rel": "self", "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/8a4faf91a681c382-300e8e99-46f04757-8dad-0e1e572dbca19fdb-487b9b6aeb78" }, - rel: download { href: https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/8a4faf91-300e-46f0-8dad-0e1e572dbca1/download pageMetadata"rel": "download", number: 3 "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/a681c382-8e99-4757-9fdb-487b9b6aeb78/download" size: 10 } totalElements: 23 ] totalPages: 3 }, links: { - rel: self href: https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302?limit=10&page=2"id": "6973ab14-15c6-4ee7-944c-9d1162d9de71", - rel"language": start"nl", href: https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302?limit=10&page=0"name": "Dienstencheques 2014", - rel"year": last2014, href: https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302?limit=10&page=2 "links": [ First page is last page: { value: certificates"rel": "self", - id: 85144567-7043-4469-9e79-279f4eb31e27 "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/6973ab14-15c6-4ee7-944c-9d1162d9de71" language: nl }, name: Dienstencheques 2019 { year: 2019 "rel": "download", links: "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/6973ab14-15c6-4ee7-944c-9d1162d9de71/download" - rel: self } href: https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27 ] - rel: download }, href: https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/download { - "id": 57faeea1"d61fdf2e-ff3b8099-4c654757-989c-e2175610c2b093d9-2709f1ce1ae2", "language": "nl", "name": Sportkamp Volleybal"Vlaamse kinderbijslag", community"year": 210042019, year: 2019"links": [ { links: - "rel": "self", "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/57faeea1d61fdf2e-ff3b8099-4c654757-989c-e2175610c2b093d9-2709f1ce1ae2" }, - rel: download { href: https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/57faeea1-ff3b-4c65-989c-e2175610c2b0/download "rel": "download", - id: 8a4faf91-300e-46f0-8dad-0e1e572dbca1 language: nl"href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/d61fdf2e-8099-4757-93d9-2709f1ce1ae2/download" name: Sportkamp Tennis } community: 23088 ] year: 2018 } links:], "pageMetadata": { - rel: self "number": 1, href: https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/8a4faf91-300e-46f0-8dad-0e1e572dbca1 "size": 10, - rel: download href: https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/8a4faf91-300e-46f0-8dad-0e1e572dbca1/download"totalElements": 40, pageMetadata: number: 1"totalPages": 4 size:}, 10 totalElements"links": 3[ totalPages: 1 { links: - rel: self"rel": "self", "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302?limit=10&page=0" - rel: start }, { href: https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302?limit=10&page=0 - rel: last"rel": "next", "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302?limit=10&page=01" '403': description: Access Denied }, content: application/json: { schema: $ref: '#/components/schemas/ProblemDetails'"rel": "start", examples: Example:"href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302?limit=10&page=0" value: }, title: An error occurred! { detail: Access Denied "rel": "last", status: 403 '404': "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302?limit=10&page=3" description: Not Found content: } application/json: schema: ] $ref: '#/components/schemas/ProblemDetails' } examples: }, Example: "Last page, no more next valuepage": { title"value": An{ error occurred! detail"certificates": Could[ not find the certificate you are looking for. { status: 404 '500': description: Internal Server Error"id": "85144567-7043-4469-9e79-279f4eb31e27", content: application/json: "language": "nl", schema: $ref: '#/components/schemas/ProblemDetails'"name": "Dienstencheques 2019", examples: "year": 2019, Example: value: "links": [ title: An error occurred! { detail: <description of the internal server error> "rel": "self", status: 500 /certificates/{ssn}/{certificateId}/{language}: get: tags: "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27" Certificates summary: Certificate Details description: '' parameters: }, - name: ssn in: path { description: Social security number required: true style: simple "rel": "download", explode: false schema: type: string"href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/download" - name: certificateId in: path } description: ID of the certificate, defined as path parameter here (can be query parameter too) ] required: true style: simple }, explode: false schema: { type: string - name: language in"id": path"57faeea1-ff3b-4c65-989c-e2175610c2b0", description: Language of the certificate, defined as path parameter here (can be query parameter too) "language": "nl", required: true style: simple "name": "Sportkamp Volleybal", explode: false schema: type"community": string21004, responses: '200': description"year": OK2019, content: application/hal+json: "links": [ schema: $ref: '#/components/schemas/Item-Certificate' { examples: only-required"rel": "self", value: id: 85144567-7043-4469-9e79-279f4eb31e27"href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/57faeea1-ff3b-4c65-989c-e2175610c2b0" language: nl }, name: certificate-1234 { links: - "rel": self "download", "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/8514456757faeea1-7043ff3b-44694c65-9e79989c-279f4eb31e27/nle2175610c2b0/download" - rel: download } href: https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/nl/download ] only-year: }, value: { id: 85144567-7043-4469-9e79-279f4eb31e27 language"id": nl"8a4faf91-300e-46f0-8dad-0e1e572dbca1", name: certificate-1234 "language": "nl", year: 2019 "name": "Sportkamp Tennis", links: "community": 23088, - rel: self "year": 2018, href: https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/nl - rel: download"links": [ { href: https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/nl/download only-community: "rel": "self", value: id: 85144567-7043-4469-9e79-279f4eb31e27"href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/8a4faf91-300e-46f0-8dad-0e1e572dbca1" language: nl }, name: certificate-1234 { community: 21004 links"rel": "download", - rel: self href"href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/851445678a4faf91-7043300e-446946f0-9e798dad-279f4eb31e270e1e572dbca1/nldownload" - rel: download } href: https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/nl/download ] full-certificate: } value: ], id: 85144567-7043-4469-9e79-279f4eb31e27 "pageMetadata": { language: nl name"number": certificate-12343, community: 21004 "size": 10, year: 2019 "totalElements": 23, links: "totalPages": 3 }, - rel: self "links": [ { href: https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/nl - "rel": download"self", "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/nl/download?limit=10&page=2" '403': description: Access Denied }, content: application/json: { schema: $ref: '#/components/schemas/ProblemDetails'"rel": "start", examples: "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302?limit=10&page=0" Example: value: }, title: An error occurred! { detail: Access Denied "rel": "last", status: 403 '404': "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302?limit=10&page=2" description: Not Found content: } application/json: schema:] $ref: '#/components/schemas/ProblemDetails' } examples: }, Example: "First page is last page": { value: title"value": An{ error occurred! detail"certificates": Could[ not find the certificate you are looking for. { status: 404 '500': description: Internal Server Error"id": "85144567-7043-4469-9e79-279f4eb31e27", content: application/json: "language": "nl", schema: $ref: '#/components/schemas/ProblemDetails' "name": "Dienstencheques 2019", examples: Example"year": 2019, value: "links": [ title: An error occurred! { detail: <description of the internal server error> status"rel": 500 components:"self", schemas: ProblemDetails: title: Problem details required: "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27" - type - title - detail }, - status type: object properties: title: { type: string detail: type"rel": string"download", status: format: int32 type: integer"href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/download" example: title: Er heeft zich een fout voorgedaan! } detail: '' status: 400 Item-Certificate: title:] Certificate required: - id }, - links - name type: object { properties: id: type: string "id": "57faeea1-ff3b-4c65-989c-e2175610c2b0", name: type: string "language": "nl", type: string year: "name": "Sportkamp Volleybal", type: integer community: type"community": integer21004, links: $ref: '#/components/schemas/Common-Item-Links' Common-General-Link"year": 2019, title: Link required: - href "links": [ - rel type: object properties: { rel: type: string "rel": "self", "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/57faeea1-ff3b-4c65-989c-e2175610c2b0" }, { "rel": "download", "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/57faeea1-ff3b-4c65-989c-e2175610c2b0/download" } ] }, { "id": "8a4faf91-300e-46f0-8dad-0e1e572dbca1", "language": "nl", "name": "Sportkamp Tennis", "community": 23088, "year": 2018, "links": [ { "rel": "self", "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/8a4faf91-300e-46f0-8dad-0e1e572dbca1" }, { "rel": "download", "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/8a4faf91-300e-46f0-8dad-0e1e572dbca1/download" } ] } ], "pageMetadata": { "number": 1, "size": 10, "totalElements": 3, "totalPages": 1 }, "links": [ { "rel": "self", "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302?limit=10&page=0" }, { "rel": "start", "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302?limit=10&page=0" }, { "rel": "last", "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302?limit=10&page=0" } ] } } } } } }, "403": { "description": "Access Denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "examples": { "Example": { "value": { "title": "An error occurred!", "detail": "Access Denied", "status": 403 } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "examples": { "Example": { "value": { "title": "An error occurred!", "detail": "Could not find the certificate you are looking for.", "status": 404 } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "examples": { "Example": { "value": { "title": "An error occurred!", "detail": "<description of the internal server error>", "status": 500 } } } } } } } } }, "/certificates/{ssn}/{certificateId}/{language}": { "get": { "tags": [ "Certificates" ], "summary": "Certificate Details", "description": "", "parameters": [ { "name": "ssn", "in": "path", "description": "Social security number", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "certificateId", "in": "path", "description": "ID of the certificate, defined as path parameter here (can be query parameter too)", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "language", "in": "path", "description": "Language of the certificate, defined as path parameter here (can be query parameter too)", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Item-Certificate" }, "examples": { "only-required": { "value": { "id": "85144567-7043-4469-9e79-279f4eb31e27", "language": "nl", "name": "certificate-1234", "links": [ { "rel": "self", "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/nl" }, { "rel": "download", "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/nl/download" } ] } }, "only-year": { "value": { "id": "85144567-7043-4469-9e79-279f4eb31e27", "language": "nl", "name": "certificate-1234", "year": 2019, "links": [ { "rel": "self", "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/nl" }, { "rel": "download", "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/nl/download" } ] } }, "only-community": { "value": { "id": "85144567-7043-4469-9e79-279f4eb31e27", "language": "nl", "name": "certificate-1234", "community": 21004, "links": [ { "rel": "self", "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/nl" }, { "rel": "download", "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/nl/download" } ] } }, "full-certificate": { "value": { "id": "85144567-7043-4469-9e79-279f4eb31e27", "language": "nl", "name": "certificate-1234", "community": 21004, "year": 2019, "links": [ { "rel": "self", "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/nl" }, { "rel": "download", "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/nl/download" } ] } } } } } }, "403": { "description": "Access Denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "examples": { "Example": { "value": { "title": "An error occurred!", "detail": "Access Denied", "status": 403 } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "examples": { "Example": { "value": { "title": "An error occurred!", "detail": "Could not find the certificate you are looking for.", "status": 404 } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "examples": { "Example": { "value": { "title": "An error occurred!", "detail": "<description of the internal server error>", "status": 500 } } } } } } } } } }, "components": { "schemas": { "ProblemDetails": { "title": "Problem details", "required": [ "type", "title", "detail", "status" ], "type": "object", "properties": { "title": { "type": "string" }, "detail": { "type": "string" }, "status": { "format": "int32", "type": "integer" } }, "example": { "title": "Er heeft zich een fout voorgedaan!", "detail": "", "status": 400 } }, "Item-Certificate": { "title": "Certificate", "required": [ "id", "links", "name" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "language": { "type": "string" }, "year": { "type": "integer" }, "community": { "type": "integer" }, "links": { "$ref": "#/components/schemas/Common-Item-Links" } } }, "Common-General-Link": { "title": "Link", "required": [ "href", "rel" ], "type": "object", "properties": { "rel": { "type": "string" }, "href": { "type": "string" } } }, "Common-Item-Links": { "title": "Links For Item", "type": "array", "items": { "$ref": "#/components/schemas/Common-General-Link" } }, "Common-List-Links": { "title": "Links For List", "type": "array", "items": { "$ref": "#/components/schemas/Common-General-Link" } }, "Common-List-PageMetadata": { "title": "PageMetadata", "required": [ "number", "size", "totalElements", "totalPages" href: ], "type": string "object", Common-Item-Links:"properties": { title "size": Links{ For Item "type": array"integer" }, items"totalElements": { $ref: '#/components/schemas/Common-General-Link' "type": "integer" }, Common-List-Links: "totalPages": { title: Links For List "type": array"number" items: }, $ref: '#/components/schemas/Common-General-Link' Common-List-PageMetadata"number": { title: PageMetadata required:"type": "number" - number } - size} }, - totalElements "List-Certificates": { - totalPages "required": [ type: object properties: "certificates", size: "links", type: integer "pageMetaData" totalElements: ], "type": integer"object", totalPages"properties": { type"certificates": number{ number"type": "array", type: number "items": { List-Certificates: required: "$ref": "#/components/schemas/Item-Certificate" - certificates } - links -}, pageMetaData type: object "links": { properties: certificates"$ref": "#/components/schemas/Common-List-Links" type: array}, items"pageMetaData": { "$ref": '"#/components/schemas/Item-Certificate'Common-List-PageMetadata" links: } $ref: '#/components/schemas/Common-List-Links'} } pageMetaData: } $ref: '#/components/schemas/Common-List-PageMetadata' } } |
View file | ||
---|---|---|
|
JSON
We gebruiken application/hal+json
als standaard. Deze specifieke JSON geeft aan dat de payload voldoet aan de HATEOAS-standaard.
...
number
: het paginanummersize
: het paginanummer in het totaal aantal pagina’s aantal items per paginatotalElements
: het totale aantal items in de collectietotalPages
: het totale aantal pagina’s in de collectie
...
Header:
Authorization: Bearer XyZAbCd1234
Method: GET
URL:
https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/nl
...
Respons (voorbeeld)
Code Block |
---|
{ "id": "85144567-7043-4469-9e79-279f4eb31e27", "language" : "nl", "name": "certificate-1234", "links": [ { "rel": "self", "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/nl" }, { "rel": "download", "href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/nl/download" } ] } |
...