api.herdin.ph Open in urlscan Pro
122.49.209.99  Public Scan

Form analysis
0 forms found in the DOM

Text Content

HERDIN API documentation
Health Research and Development Information Network
 * Documentation

Select a publication type

Book Book of Abstracts Copyright Document Industrial Design Document Journal
Patent Document Policy Brief Proceedings Resident Research Output
Technical/Terminal Report Technology Brief Thesis/Dissertations Trademark
Document Utility Model Document

Logging-in

Getting the Token

Saving

How to use

Rules

research_details

source_details

author_details

abstract

references

location_details

subject_details

Getting the Token

Route

Required Headers

POST

/api/v1/api-login

Accept
application/json
username
Your given username.
password
Your given password.

Saving

Route

Required Headers

POST

/api/v1/research/save

Accept
application/json
Authorization
Token that came from logging-in.

research_details

Field

Type

research_title

required
This field is required.
string
This field expects a text.
max:500
This field expects a maximum length of 500.

source_details

Field

Type

publication_sub_type

required
This field is required.
string
This field expects a text.
in
This field expects a value from one of: Book Chapter,Guidebook,Manual,Monograph.

year_published

required
This field is required.
numeric
This field expects a number.
min:1970
This field expects a minimum length of 1970.
max:2024
This field expects a maximum length of 2024.

research_category

required
This field is required.
string
This field expects a text.
in
This field expects a value from one of:
Institutional,Collaborative,Commissioned.

research_type

required
This field is required.
string
This field expects a text.
in
This field expects a value from one of: Basic,Applied,Experimental.

place_publication

sometimes
This field is optional.
string
This field expects a text.
in
This filed expects a country.

city_publication

sometimes
This field is optional.
string
This field expects a text.
max:200
This field expects a maximum length of 200.

edition

sometimes
This field is optional.
string
This field expects a text.
max:30
This field expects a maximum length of 30.

isbn

sometimes
This field is optional.
string
This field expects a text.
max:50
This field expects a maximum length of 50.

book_title

sometimes
This field is optional.
string
This field expects a text.
max:300
This field expects a maximum length of 300.
required_if:source_details.publication_sub_type,Book Chapter
This field is required when source_details.publication_sub_type value is Book
Chapter.

author_details

Field

Type

author

sometimes
This field is optional.
array
This field expects a collection of data.
max:100
This field expects a maximum length of 100.

author.*.first_name

sometimes
This field is optional.
string
This field expects a text.
min:2
This field expects a minimum length of 2.
max:50
This field expects a maximum length of 50.

author.*.middle_name

sometimes
This field is optional.
string
This field expects a text.
min:1
This field expects a minimum length of 1.
max:20
This field expects a maximum length of 20.

author.*.surname

string
This field expects a text.
min:2
This field expects a minimum length of 2.
max:20
This field expects a maximum length of 20.
required_with:author_details.author.*.first_name
This field is required when author_details.author.*.first_name is present.

author.*.suffix

sometimes
This field is optional.
string
This field expects a text.
in
This field expects a value from one of: I,II,III,IV,Jr.,Sr.,V,VI,VII,VIII.

author.*.role

sometimes
This field is optional.
array
This field expects a collection of data.
max:24
This field expects a maximum length of 24.

author.*.role.*

sometimes
This field is optional.
string
This field expects a text.
max:255
This field expects a maximum length of 255.
in
This field expects a value from one of: Project Proponent,Program
Leader,Consultant,Adviser,Author,Researcher,Principal Investigator,Supervising
Investigator,Chairman,Presentor,Project Leader,Study Director,Editor,Project
Staff,Reviewer,Assistant Project Leader,Research
Assistant,Co-Investigator,Technical Panel,Collaborator,Co-Author.

author.*.institution

sometimes
This field is optional.
array
This field expects a collection of data.

author.*.institution.*

sometimes
This field is optional.
numeric
This field expects a number.

related_institution

sometimes
This field is optional.
array
This field expects a collection of data.
max:200
This field expects a maximum length of 200.

related_institution.*.name

sometimes
This field is optional.
string
This field expects a text.
max:255
This field expects a maximum length of 255.

related_institution.*.section

sometimes
This field is optional.
string
This field expects a text.
max:255
This field expects a maximum length of 255.

related_institution.*.country

sometimes
This field is optional.
string
This field expects a text.

related_institution.*.region

sometimes
This field is optional.
string
This field expects a text.

related_institution.*.province

sometimes
This field is optional.
string
This field expects a text.

related_institution.*.city

sometimes
This field is optional.
string
This field expects a text.

related_institution.*.roles

array
This field expects a collection of data.
required_with:author_details.related_institution.*
This field is required when author_details.related_institution.* is present.

related_institution.*.roles.*

string
This field expects a text.
in
This field expects a value from one of: Collaborating,Cooperating,Corporate
Author,Funding,Implementing,Monitoring.

related_institution.*.mother_agency

sometimes
This field is optional.
string
This field expects a text.
max:255
This field expects a maximum length of 255.

abstract

Field

Type

type

sometimes
This field is optional.
in
This field expects a value from one of: full,structured.

structured

array
This field expects a collection of data.
max:100
This field expects a maximum length of 100.
required_if:abstract.type,structured
This field is required when abstract.type value is structured.

structured.*.structure_name

string
This field expects a text.
max:100
This field expects a maximum length of 100.
required_if:abstract.type,structured
This field is required when abstract.type value is structured.

structured.*.content

string
This field expects a text.
required_if:abstract.type,structured
This field is required when abstract.type value is structured.

full

string
This field expects a text.
required_if:abstract.type,full
This field is required when abstract.type value is full.

references

Field

Type

references

sometimes
This field is optional.
string
This field expects a text.

location_details

Field

Type

location_details

sometimes
This field is optional.
array
This field expects a collection of data.
max:100
This field expects a maximum length of 100.

*.format

sometimes
This field is optional.
string
This field expects a text.
in
This field expects a value from one of: Print,Non-Print.

*.location

string
This field expects a text.
max:300
This field expects a maximum length of 300.
required_with:location_details.*.format
This field is required when location_details.*.format is present.

*.location_number

sometimes
This field is optional.
string
This field expects a text.
max:300
This field expects a maximum length of 300.

*.text_availability

required_with:location_details.*.format
This field is required when location_details.*.format is present.
in
This field expects a value from one of: Abstract,Full-text.

*.mode_access

in
This field expects a value from one of: Request to Institution,Room use Only,Not
available to the public,Online Request,Publicly accessible,Not available to the
public.

*.institution_email

email:rfc,dns
This field expects a valid email address.
required_if:location_details.*.mode_access,Request to Institution
This field is required when location_details.*.mode_access value is Request to
Institution.

*.url

url
This field expects a valid URL.
max:255
This field expects a maximum length of 255.

*.file

file
This field expects a file.
mimes:pdf
This field expects a file of type pdf.
max:100000
This field expects a maximum length of 100000.

subject_details

Field

Type

subject

sometimes
This field is optional.
array
This field expects a collection of data.
max:6
This field expects a maximum length of 6.

subject.*

sometimes
This field is optional.
string
This field expects a text.
in
This field expects a value from one of:
Human,Plants,Animals,Fungi,Bacteria,Algea.
distinct
This field should have no duplicate values.

human_sex

sometimes
This field is optional.
array
This field expects a collection of data.
max:2
This field expects a maximum length of 2.

human_sex.*

sometimes
This field is optional.
string
This field expects a text.
distinct
This field should have no duplicate values.
in
This field expects a value from one of: Male,Female.

age_group

sometimes
This field is optional.
array
This field expects a collection of data.
max:100
This field expects a maximum length of 100.

age_group.*

sometimes
This field is optional.
string
This field expects a text.
in
This field expects a value from one of: Aged: 65-79 yrs old,Middle Aged: 45-64
yrs old,Adult: 25-44 yrs old,Young Adult: 19-24 yrs old,Adolescent: 13-18 yrs
old,Child: 6-12 yrs old,Child Preschool: 2-5 yrs old,Infant: 1-23 months,Infant
newborn: First 28 days after birth.
distinct
This field should have no duplicate values.

mesh

sometimes
This field is optional.
array
This field expects a collection of data.
max:500
This field expects a maximum length of 500.

mesh.*

sometimes
This field is optional.
string
This field expects a text.
distinct
This field should have no duplicate values.

non_mesh

sometimes
This field is optional.
array
This field expects a collection of data.
max:500
This field expects a maximum length of 500.

non_mesh.*

sometimes
This field is optional.
string
This field expects a text.
distinct
This field should have no duplicate values.

Example request: BASH

curl -X POST https://api.herdin.ph/api/v1/api-login

-H "Accept: application/json"

-H "username: your username goes here."

-H "password: your password goes here."

Example responses: JSON

{

/** status: 200 */

"token": "9|uwa5revl5lPjc3WLLyfWtoSDt9Umj8NnrVRlLOCC45"

}

{

/** status: 401 */

"error": "Invalid credentials."

}

Example request: BASH

curl -X POST https://api.herdin.ph/api/v1/research/save

-H "Accept: application/json"

-H "Authorization: Bearer your token goes here"

Example responses: JSON

{

/** status: 200 */

"message": "Research saved.",

"record_number": "100133-24052713216745"

}

{

/** status: 403 */

"error": "Access is denied"

}

{

/** status: 422 */

"error": "source details.date issued from is not a valid date"

}

{

/** status: 500 */

"error": "An unexpected error occurred while validating data."

}

Example data: JSON
"publication_type": "Book",
"research_details": {
"research_title": "Harum id ratione eum ipsam impedit similique. Dolor error
recusandae aut eum."
},
Example data: JSON
"source_details": {
"publication_sub_type": "Guidebook",
"year_published": "1995",
"research_category": "Commissioned",
"research_type": "Applied",
"place_publication": "Philippines",
"city_publication": "South Olin",
"isbn": "9789110698857",
"book_title": "Nesciunt quas."
},
Example data: JSON
"author_details": {
"author":  [
{
"first_name": "Glenna",
"middle_name": "Fisher",
"surname": "Hahn",
"suffix": "Sr.",
"role": [
"Project Leader", "Technical Panel"
],
"institution": [
"0"
]
 }

],

"related_institution":  [
{
"name": "Koss PLC",
"section": "Dooley-Effertz",
"country": "Philippines",
"region": "Quia iste.",
"province": "Rem.",
"city": "New Lauryfort",
"roles": [
"Funding", "Monitoring"
],
"mother_agency": "Quisquam mollitia."
 }

]

},
Example data: JSON
"abstract": {
"type": "full",
"full": "Omnis et illo quis. Fugit dolorem et delectus accusantium ullam."
},
Example data: JSON
"references": "--- Id ut quisquam aut voluptatibus.--- Ut earum dolorem
consectetur vitae.--- Ab laborum sit voluptates delectus sed repellat.",
Example data: JSON
"location_details":  [
{
"format": "Non-Print",
"location": "Philippine Council for Health Research and Development",
"url": "http://www.reinger.com/",
"text_availability": "Full-text",
"mode_access": "Online Request"
 }

],

Example data: JSON
"subject_details": {
"subject": [
"Human"
],
"human_sex": [
"Male", "Female"
],
"age_group": [
"Adult: 25-44 yrs old", "Infant newborn: First 28 days after birth"
],
"mesh": [
"occaecati", "dolores", "aut", "assumenda", "mollitia"
],
"non_mesh": [
"sed", "perferendis", "nisi", "beatae", "aliquid"
]
}