Mock sample for your project: DriveBC's Open511 API
Integrate with "DriveBC's Open511 API" from gov.bc.ca in no time with Mockoon's ready to use mock sample
DriveBC's Open511 API
Version: 1.0.0
Speed up your application development by using "DriveBC's Open511 API" ready-to-use mock sample. Mocking this API will allow you to start working in no time. No more accounts to create, API keys to provision, accesses to configure, unplanned downtime, just work.
It also improves your integration tests' quality and reliability by accounting for random failures, slow response time, etc.
Description
This API is DriveBC's implementation of the Open511 specification. It provides information about known road events (traffic accidents, construction, etc.) in British Columbia, Canada. Please note that you may experience issues when submitting requests to the delivery or test environment if using this OpenAPI specification in other API console viewers.
Other APIs by gov.bc.ca
BC Data Catalogue API
This API provides live access to the BC Data Catalogue. Further documentation on the API is available from http://docs.ckan.org/en/latest/ Confirm the version of the API available from the catalogue by requesting https://catalogue.data.gov.bc.ca/api/3/action/status_show.
Please note that you may experience issues when submitting requests to the delivery or test environment if using this OpenAPI specification in other API console viewers.
Please note that you may experience issues when submitting requests to the delivery or test environment if using this OpenAPI specification in other API console viewers.
BC Route Planner REST API
Finds shortest/fastest route between a start point and one or more stop points on British Columbia's public road network. The BC Route planner webpage provides additional information. Here are some geocoded addresses to play with: 18 Douglas St,Victoria -123.36962,48.40892 1002 Johnson St, Victoria -123.355745,48.426206 543 Johnson St, Victoria, BC -123.36907,48.42770 14 Centennial Sq, Victoria, BC -123.36564,48.42863 1105 Royal Ave,New Westminster -122.92009,49.20063 808 Jackson Cres, New Westminster -122.90762,49.22558 10810 McDonald Rd, Chilliwack -121.93808,49.19859 3950 June Springs Rd, Kelowna -119.40751,49.83960 1201 Riondel Rd, Kootenay Bay -116.85402,49.74448 1201 Riondel Rd, Kootenay Bay -116.832759,49.730500 (parcelPoint) 2499 Walbran Pl, Courtenay -124.97295,49.71518 2013 Smoke Bluff Rd, Squamish -123.13946,49.70401 235 Kelvin Grove Way, Lions Bay -123.23524,49.45035 Please see our data collection notice.
Please note that you may experience issues when submitting requests to the delivery or test environment if using this OpenAPI specification in other API console viewers.
Developer API keys are unique and can be acquired with a GitHub account. Production government applications may use organization API keys acquired by contacting DataBC.
Please note that you may experience issues when submitting requests to the delivery or test environment if using this OpenAPI specification in other API console viewers.
Developer API keys are unique and can be acquired with a GitHub account. Production government applications may use organization API keys acquired by contacting DataBC.
GeoMark Web Service REST API
The Geomark Web Service allows you to create and share geographic areas of interest over the web in a variety of formats and coordinate systems. This service is especially helpful when you need to share an area of interest with people who require that the data be in a different format, or they use different mapping software.
Please note that you may experience issues when submitting requests to the delivery or test environment if using this OpenAPI specification in other API console viewers.
Please note that you may experience issues when submitting requests to the delivery or test environment if using this OpenAPI specification in other API console viewers.
BC Geographical Names Web Service - REST API
This REST API provides searchable access to information about geographical names in the province of British Columbia, including name status and details about the corresponding geographic feature.
Please note that you may experience issues when submitting requests to the delivery or test environment if using this OpenAPI specification in other API console viewers.
Please note that you may experience issues when submitting requests to the delivery or test environment if using this OpenAPI specification in other API console viewers.
Groundwater Wells, Aquifers and Registry API
gov.bc.ca
The groundwater wells, aquifers and registry API contains information related to groundwater wells and aquifers as well as a register of qualified well drillers and well pump installers registered to operate in B.C.
Geocoder REST API
This API represents address cleaning, correction, completion, geocoding, reverse geocoding, and proximity resources for intersection addresses, physical addresses and their occupants in British Columbia. Please read our data collection notice.
Please note that you may experience issues when submitting requests to the delivery or test environment if using this OpenAPI specification in other API console viewers.
Developer API keys are unique and can be acquired with a GitHub account. Production government applications may use organization API keys acquired by contacting DataBC. API keys are further described in the Developer guide.
Notification: If you have applications or web pages that link to the BC Address Geocoder you must use the following URL.
https://geocoder.api.gov.bc.ca
Please note that the following URLs were deprecated in September 2018 More Details.
http://apps.gov.bc.ca/pub/geocoder
https://apps.gov.bc.ca/pub/geocoder
\
\
Please note that you may experience issues when submitting requests to the delivery or test environment if using this OpenAPI specification in other API console viewers.
Developer API keys are unique and can be acquired with a GitHub account. Production government applications may use organization API keys acquired by contacting DataBC. API keys are further described in the Developer guide.
Notification: If you have applications or web pages that link to the BC Address Geocoder you must use the following URL.
https://geocoder.api.gov.bc.ca
Please note that the following URLs were deprecated in September 2018 More Details.
http://apps.gov.bc.ca/pub/geocoder
https://apps.gov.bc.ca/pub/geocoder
\
\
WorkBC Job Posting API
gov.bc.ca
This API allows you to receive a feed of jobs from WorkBC's Job Board. Please see our data collection notice. Please note that you may experience issues when submitting requests to the delivery or test environment if using this OpenAPI specification in other API console viewers.
Other APIs in the same category
SBI General Insurance Company Ltd
apisetu.gov.in
Insurance Policies such as Car, Two Wheeler, Commercial Vehicle, Health and Travel issued by SBI General (https://www.sbigeneral.in) are now available for Customers to be fetched into their DigiLocker accounts
Benefits Intake
va.gov
The Benefits Intake API allows authorized third-party systems used by Veteran Service Organizations (VSOs), agencies, and Veterans to digitally submit VA benefits claim documents directly to the Veterans Benefits Administration's (VBA) claims intake process. This API handles documents related to the following benefit claim types:
Compensation
Pension/Survivors Benefits
Education
Fiduciary
Insurance
Veteran Readiness & Employment (VRE)
Board of Veteran Appeals (BVA)
This API also provides submission status updates until documents are successfully established for VBA claim processing, eliminating the need for users to switch between systems to manually check whether documents have been successfully uploaded.
Background
This API provides a secure, efficient, and tracked alternative to mail or fax for VA benefit claim document submissions. Documents are uploaded directly to the VBA so they can be processed as quickly as possible.
Technical overview
The Benefits Intake API first provides an upload location and unique submission identifier, and then accepts a payload consisting of a document in PDF format, zero or more optional attachments in PDF format, and some JSON metadata.
The metadata describes the document and attachments, and identifies the person for whom it is being submitted. This payload is encoded as binary multipart/form-data (not base64). The unique identifier supplied with the payload can subsequently be used to request the processing status of the uploaded document package.
To avoid errors and processing delays, API consumers are encouraged to validate the zipcode,fileNumber, veteranFirstName, veteranLastName and businessLine fields before submission according to their description in the DocumentUploadMetadata model and use the 'businessLine' attribute for the most efficient processing. Additionally, please ensure no PDF user or owner passwords are used in submitted PDFs.
Attachment & file size limits
There is no limit on the number of files a payload can contain, but size limits do apply.
Uploaded documents cannot be larger than 21" x 21"
The entire payload cannot exceed 5 GB
No single file in a payload can exceed 100 MB
Date of receipt
The date that documents are successfully submitted through the Benefits Intake API is used as the official VA date of receipt. However, note that until a document status of received, processing, success, or vbms is returned, a client cannot consider the document received by VA.
A status of received means that the document package has been transmitted, but may not be validated. Any errors with the document package, such as unreadable PDFs or a Veteran not found, will cause the status to change to error.
If the document status is error, VA has not received the submission and cannot honor the submission date as the date of receipt.
Authentication and Authorization
API requests are authorized through a symmetric API token, provided in an HTTP header with name 'apikey'. Request an API key.
Testing in the sandbox environment
In the sandbox environment, the final status of a submission is received and submissions do not actually progress to the central mail repository or VBMS.
Progress beyond the received status can be simulated for testing. We allow passing in a Status-Override header on the /uploads/{id} endpoint so that you can change the status of your submission to simulate the various scenarios.
The available statuses are pending, uploaded, received, processing, success, vbms, and error. The meaning of the various statuses is listed below in Models under DocumentUploadStatusAttributes.
Test data
We use mock test data in the sandbox environment. Data is not sent upstream and it is not necessary to align submitted test data with any other systems' data.
Upload operation
Allows a client to upload a multi-part document package (form + attachments + metadata).
Client Request: POST https://sandbox-api.va.gov/services/vba_documents/v1/
No request body or parameters required
Service Response: A JSON API object with the following attributes:
guid: An identifier used for subsequent status requests
location: A URL to which the actual document package payload can be submitted in the next step. The URL is specific to this upload request, and should not be re-used for subsequent uploads. The URL is valid for 900 seconds (15 minutes) from the time of this response. If the location is not used within 15 minutes, the GUID will expire. Once expired, status checks on the GUID will return a status of expired.
Note: If, after you've submitted a document, the status hasn't changed to uploaded before 15 minutes has elapsed, we recommend retrying the upload in order to make sure the document properly reaches our servers. If the upload continues to fail, try encoding the payload as Base64 (See below).
Client Request: PUT to the location URL returned in Step 2.
Request body should be encoded as binary multipart/form-data (base64 also available - see details below), equivalent to that generated by an HTML form submission or using “curl -F…”. The format is described in more detail below.
No apikey authorization header is required for this request, as authorization is embedded in the signed location URL.
Service Response: The HTTP status indicates whether the upload was successful.
Additionally, the response includes an ETag header containing an MD5 hash of the submitted payload. This can be compared to the submitted payload to ensure data integrity of the upload.
Status caching
Due to current system limitations, data for the /uploads/report endpoint is cached for one hour.
A request to the /uploads/{id} endpoint will return a real-time status for that GUID, and update its status in /uploads/report.
The updated_at field indicates the last time the status for a given GUID was updated.
Optional Base64 encoding
Base64 is an encoding scheme that converts binary data into text format, so that encoded textual data can be easily transported over networks uncorrupted and without data loss.
Base64 can be used to encode binary multipart/form-data it in its entirety. Note that the whole payload must be encoded, not individual parts/attachments.
After encoding your payload, you'll be required to preface your base64 string with data:multipart/form-data;base64, in order to allow our system to distinguish the file type. Your final string payload would look something like data:multipart/form-data;base64,(encryption string)== and close with the standard == marker. Note that the multipart boundaries i.e. -----WebKitFormBoundaryVfOwzCyvug0JmWYo and ending ------WebKitFormBoundaryVfOwzCyvug0JmWYo- must also be included.
Consumer onboarding process
When you're ready to move to production, request a production API key.
Compensation
Pension/Survivors Benefits
Education
Fiduciary
Insurance
Veteran Readiness & Employment (VRE)
Board of Veteran Appeals (BVA)
This API also provides submission status updates until documents are successfully established for VBA claim processing, eliminating the need for users to switch between systems to manually check whether documents have been successfully uploaded.
Background
This API provides a secure, efficient, and tracked alternative to mail or fax for VA benefit claim document submissions. Documents are uploaded directly to the VBA so they can be processed as quickly as possible.
Technical overview
The Benefits Intake API first provides an upload location and unique submission identifier, and then accepts a payload consisting of a document in PDF format, zero or more optional attachments in PDF format, and some JSON metadata.
The metadata describes the document and attachments, and identifies the person for whom it is being submitted. This payload is encoded as binary multipart/form-data (not base64). The unique identifier supplied with the payload can subsequently be used to request the processing status of the uploaded document package.
To avoid errors and processing delays, API consumers are encouraged to validate the zipcode,fileNumber, veteranFirstName, veteranLastName and businessLine fields before submission according to their description in the DocumentUploadMetadata model and use the 'businessLine' attribute for the most efficient processing. Additionally, please ensure no PDF user or owner passwords are used in submitted PDFs.
Attachment & file size limits
There is no limit on the number of files a payload can contain, but size limits do apply.
Uploaded documents cannot be larger than 21" x 21"
The entire payload cannot exceed 5 GB
No single file in a payload can exceed 100 MB
Date of receipt
The date that documents are successfully submitted through the Benefits Intake API is used as the official VA date of receipt. However, note that until a document status of received, processing, success, or vbms is returned, a client cannot consider the document received by VA.
A status of received means that the document package has been transmitted, but may not be validated. Any errors with the document package, such as unreadable PDFs or a Veteran not found, will cause the status to change to error.
If the document status is error, VA has not received the submission and cannot honor the submission date as the date of receipt.
Authentication and Authorization
API requests are authorized through a symmetric API token, provided in an HTTP header with name 'apikey'. Request an API key.
Testing in the sandbox environment
In the sandbox environment, the final status of a submission is received and submissions do not actually progress to the central mail repository or VBMS.
Progress beyond the received status can be simulated for testing. We allow passing in a Status-Override header on the /uploads/{id} endpoint so that you can change the status of your submission to simulate the various scenarios.
The available statuses are pending, uploaded, received, processing, success, vbms, and error. The meaning of the various statuses is listed below in Models under DocumentUploadStatusAttributes.
Test data
We use mock test data in the sandbox environment. Data is not sent upstream and it is not necessary to align submitted test data with any other systems' data.
Upload operation
Allows a client to upload a multi-part document package (form + attachments + metadata).
Client Request: POST https://sandbox-api.va.gov/services/vba_documents/v1/
No request body or parameters required
Service Response: A JSON API object with the following attributes:
guid: An identifier used for subsequent status requests
location: A URL to which the actual document package payload can be submitted in the next step. The URL is specific to this upload request, and should not be re-used for subsequent uploads. The URL is valid for 900 seconds (15 minutes) from the time of this response. If the location is not used within 15 minutes, the GUID will expire. Once expired, status checks on the GUID will return a status of expired.
Note: If, after you've submitted a document, the status hasn't changed to uploaded before 15 minutes has elapsed, we recommend retrying the upload in order to make sure the document properly reaches our servers. If the upload continues to fail, try encoding the payload as Base64 (See below).
Client Request: PUT to the location URL returned in Step 2.
Request body should be encoded as binary multipart/form-data (base64 also available - see details below), equivalent to that generated by an HTML form submission or using “curl -F…”. The format is described in more detail below.
No apikey authorization header is required for this request, as authorization is embedded in the signed location URL.
Service Response: The HTTP status indicates whether the upload was successful.
Additionally, the response includes an ETag header containing an MD5 hash of the submitted payload. This can be compared to the submitted payload to ensure data integrity of the upload.
Status caching
Due to current system limitations, data for the /uploads/report endpoint is cached for one hour.
A request to the /uploads/{id} endpoint will return a real-time status for that GUID, and update its status in /uploads/report.
The updated_at field indicates the last time the status for a given GUID was updated.
Optional Base64 encoding
Base64 is an encoding scheme that converts binary data into text format, so that encoded textual data can be easily transported over networks uncorrupted and without data loss.
Base64 can be used to encode binary multipart/form-data it in its entirety. Note that the whole payload must be encoded, not individual parts/attachments.
After encoding your payload, you'll be required to preface your base64 string with data:multipart/form-data;base64, in order to allow our system to distinguish the file type. Your final string payload would look something like data:multipart/form-data;base64,(encryption string)== and close with the standard == marker. Note that the multipart boundaries i.e. -----WebKitFormBoundaryVfOwzCyvug0JmWYo and ending ------WebKitFormBoundaryVfOwzCyvug0JmWYo- must also be included.
Consumer onboarding process
When you're ready to move to production, request a production API key.
Enterobase-API
warwick.ac.uk
API for EnteroBase (http://enterobase.warwick.ac.uk)
EnteroBase is a user-friendly online resource, where users can upload their
own sequencing data for de novo assembly by a stream-lined pipeline. The assemblies
are used for calling MLST and wgMLST patterns, allowing users to compare their strains
to publically available genotyping data from other EnteroBase users, GenBank and classical MLST databases.
Click here to find how to get and use an API token: http://bit.ly/1TKlaOU
EnteroBase is a user-friendly online resource, where users can upload their
own sequencing data for de novo assembly by a stream-lined pipeline. The assemblies
are used for calling MLST and wgMLST patterns, allowing users to compare their strains
to publically available genotyping data from other EnteroBase users, GenBank and classical MLST databases.
Click here to find how to get and use an API token: http://bit.ly/1TKlaOU
TheTVDB API v3
thetvdb.com
API v3 targets v2 functionality with a few minor additions. The API is accessible via https://api.thetvdb.com and provides the following REST endpoints in JSON format.
How to use this API documentation
You may browse the API routes without authentication, but if you wish to send requests to the API and see response data, then you must authenticate.
Obtain a JWT token by POSTing to the /login route in the Authentication section with your API key and credentials.
Paste the JWT token from the response into the "JWT Token" field at the top of the page and click the 'Add Token' button.
You will now be able to use the remaining routes to send requests to the API and get a response.
Language Selection
Language selection is done via the Accept-Language header. At the moment, you may only pass one language abbreviation in the header at a time. Valid language abbreviations can be found at the /languages route..
Authentication
Authentication to use the API is similar to the How-to section above. Users must POST to the /login route with their API key and credentials in the following format in order to obtain a JWT token.
{"apikey":"APIKEY","username":"USERNAME","userkey":"USERKEY"}
Note that the username and key are ONLY required for the /user routes. The user's key is labled Account Identifier in the account section of the main site.
The token is then used in all subsequent requests by providing it in the Authorization header. The header will look like: Authorization: Bearer . Currently, the token expires after 24 hours. You can GET the /refresh_token route to extend that expiration date.
Versioning
You may request a different version of the API by including an Accept header in your request with the following format: Accept:application/vnd.thetvdb.v$VERSION. This documentation automatically uses the version seen at the top and bottom of the page.
How to use this API documentation
You may browse the API routes without authentication, but if you wish to send requests to the API and see response data, then you must authenticate.
Obtain a JWT token by POSTing to the /login route in the Authentication section with your API key and credentials.
Paste the JWT token from the response into the "JWT Token" field at the top of the page and click the 'Add Token' button.
You will now be able to use the remaining routes to send requests to the API and get a response.
Language Selection
Language selection is done via the Accept-Language header. At the moment, you may only pass one language abbreviation in the header at a time. Valid language abbreviations can be found at the /languages route..
Authentication
Authentication to use the API is similar to the How-to section above. Users must POST to the /login route with their API key and credentials in the following format in order to obtain a JWT token.
{"apikey":"APIKEY","username":"USERNAME","userkey":"USERKEY"}
Note that the username and key are ONLY required for the /user routes. The user's key is labled Account Identifier in the account section of the main site.
The token is then used in all subsequent requests by providing it in the Authorization header. The header will look like: Authorization: Bearer . Currently, the token expires after 24 hours. You can GET the /refresh_token route to extend that expiration date.
Versioning
You may request a different version of the API by including an Accept header in your request with the following format: Accept:application/vnd.thetvdb.v$VERSION. This documentation automatically uses the version seen at the top and bottom of the page.
OpenTrials API
opentrials.local
rv API
Introduction
This API returns information about all of the verses in Rig Veda. The results are JSON objects that contain the name of the god, poet, and meter of the verses in Rig Veda, the category of the god and the poet, and the mandal and sukta number.
The API uses the Swagger 2.0 specification.
Authentication
This is an open API.
Try it out
This sandbox can be used to get data for only one kind of resource, that is, to fetch the data for a category being sung to.
The remaining resources work a similar fashion. For details, see the reference documentation.
This API returns information about all of the verses in Rig Veda. The results are JSON objects that contain the name of the god, poet, and meter of the verses in Rig Veda, the category of the god and the poet, and the mandal and sukta number.
The API uses the Swagger 2.0 specification.
Authentication
This is an open API.
Try it out
This sandbox can be used to get data for only one kind of resource, that is, to fetch the data for a category being sung to.
The remaining resources work a similar fashion. For details, see the reference documentation.
Bills API
API to get and search for information regarding Bills, their stages, associated amendments and publications.
vs API
Introduction
This API returns data regarding almost all nouns in vedic literature. The results are JSON objects that contain the word transliterated to the Roman script, the word in the Nagari script, the meaning of the word, and the category the word belongs to. Proper nouns are not included (yet).
The API uses the Swagger 2.0 specification.
Authentication
This is an open API.
Try it out
This sandbox can be used to get data for only one kind of resource, that is, to fetch data for a string contained in the meaning of any of the words.
The remaining resources work a similar fashion. For details, see the reference documentation.
This API returns data regarding almost all nouns in vedic literature. The results are JSON objects that contain the word transliterated to the Roman script, the word in the Nagari script, the meaning of the word, and the category the word belongs to. Proper nouns are not included (yet).
The API uses the Swagger 2.0 specification.
Authentication
This is an open API.
Try it out
This sandbox can be used to get data for only one kind of resource, that is, to fetch data for a string contained in the meaning of any of the words.
The remaining resources work a similar fashion. For details, see the reference documentation.
Acko General Insurance Limited
apisetu.gov.in
Insurance policies issued by Acko General Insurance (https://www.acko.com) can be fetched by the citizens in their Digilocker accounts.
CPCT-MAPIT, Madhya Pradesh
apisetu.gov.in
Computer Proficiency Certification Exam (https://cpct.mp.gov.in) is mandatory for data entry/IT Operator/Assistant Grade-3/steno/shorthand/typist and other similar Permanent/Contractual positions in the departments, corporations and agencies in MP. The CPCT Score Card of 2016 can be pulled into citizens' DigiLocker accounts.