Platform API - Help Page

Introduction

This is an internal API for ChronosHub.

Publication

API	Description
GET API/{profileId}/Publications/OutputTypes	Get List of Article Types
GET API/{profileId}/Publications/AuthorTypes	Get List of Author Types. Gets default values in addition to profile specific values.
GET API/Publications/Search/Title?q={q}&maxResults={maxResults}	Search Publications on Title
GET API/Publications/Search/DOI?q={q}&maxResults={maxResults}	Search Publications on Title
GET API/Publications/Search?q={q}&maxResults={maxResults}	Search Publications - If search string starts with "10." as every DOI, it searches DOI. It also searches by matching q with title of publicaions.

Journal

API	Description
GET API/Journals/Search/OpenAlex?q={q}	Search Journals on Header.
GET API/Journals/Search/Name?q={q}&maxResults={maxResults}	Search Journals on Header.
GET API/Journals/Search/ISSN?q={q}&maxResults={maxResults}	Search Journals on ISSN.
GET API/Journals/Search/EISSN?q={q}&maxResults={maxResults}	Search Journals on EISSN.
GET API/Journals/Search/JournalCode?q={q}&maxResults={maxResults}	Search Journals on Journal Code.

Funder

API	Description
GET API/Funders/Search/Name?q={q}&maxResults={maxResults}	Search Funders on Name
GET API/Funders/Search/FunderId?q={q}&maxResults={maxResults}	Search Funders on FunderId
GET API/{profileID}/Funder	Get Funder from ProfileID

PaymentEligibility

Controller to Perform Payment Eligibility Checks

API	Description
GET API/{profileId}/PaymentEligibility/Requestor?email={email}&location={location}	PaymentEligibilityChecks for Requestor
GET API/{profileId}/PaymentEligibility/Author?email={email}&location={location}	PaymentEligibilityChecks for Author
GET API/{profileId}/PaymentEligibility/PublicationType?publicationType={publicationType}&location={location}	PaymentEligibilityCheck for PublicationType
GET API/{profileId}/PaymentEligibility/PublicationDateAccepted?location={location}&dateAccepted={dateAccepted}	PaymentEligibilityCheck for Funding Acknowledgement
GET API/{profileId}/PaymentEligibility/PublicationDatePublished?location={location}&datePublished={datePublished}	PaymentEligibilityCheck for Funding Acknowledgement
GET API/{profileId}/PaymentEligibility/Journal?openAlexID={openAlexID}&location={location}	PaymentEligibilityChecks for Journal
GET API/{profileId}/PaymentEligibility/Publication/RightsRetentionStatement?hasRightsRetentionStatement={hasRightsRetentionStatement}&location={location}	PaymentEligibilityCheck for rights retention statement
GET API/{profileId}/PaymentEligibility/Journal/SpecialIssue?isSpecialIssue={isSpecialIssue}&dateSubmitted={dateSubmitted}&location={location}	PaymentEligibilityCheck for special issues
GET API/{profileId}/PaymentEligibility/License?licenseID={licenseID}&location={location}	PaymentEligibilityCheck for License Allowed
GET API/{profileId}/PaymentEligibility/FundingAcknowledgement?fundingAcknowledgement={fundingAcknowledgement}&location={location}	PaymentEligibilityCheck for Funding Acknowledgement
POST API/{profileId}/PaymentEligibility/Funding?location={location}	PaymentEligibilityChecks for Funding
GET API/{profileId}/PaymentEligibility/InvoiceAPCCap?currency={currency}&apcAmount={apcAmount}&location={location}	PaymentEligibilityCheck for APC Cap

License

API	Description
GET API/{profileId}/Licenses	Get List of Licenses for Profle

Inflow

API	Description
OPTIONS API/{profileId}/Inflow/Save	Needed for CORS pre-flight checks
OPTIONS API/{profileId}/Inflow/Files/Save	Needed for CORS pre-flight checks
POST API/{profileId}/Inflow/Save	Post Inflow Object - Generates Magic Link and stores inflow progress
POST API/{profileId}/Inflow/Files/Save?inflowId={inflowId}	Process uploaded files and extract manuscript data.
GET API/{profileId}/Inflow/Manuscript/Get/{inflowId}	Get extracted manuscript.
GET API/{profileId}/Inflow/Invoice/Get/{inflowId}	Get scanned invoice.

User

Handles requests that concern users of the ChronosHub system.

API	Description
GET API/Users/Search/Email?q={q}	Search Users by email

Customer

API	Description
GET API/Customers/Search/Ringgold?q={q}	Search Customers on RinggoldId. If Customer is found in the database it is updated with Ringgold and returned. If the customer is not found in the database it is created with Ringgold and returned.
GET API/Customers/Search/Isni?q={q}	Search Customers on ISNI. If Customer is found in the database it is updated with Ringgold and returned. If the customer is not found in the database it is created with Ringgold and returned.
GET API/Customers/Search/Name?q={q}&maxResults={maxResults}	Search Customers by Name
GET API/Customers/Search/Grid?q={q}	Search Customers by GridId
GET API/Customers/Search/Ror?q={q}	Search Customers by RORID
GET API/Customers/{profileID}/Departments	Get Faculties for Profile Customer
GET API/Customers/{profileID}/Faculties	Get Faculties for Profile Customer
GET API/Customers/Faculty/{facultyID}/Departments	Get Departments for Faculty

SupportingData

Supporting Data Like Currencies and Countries

API	Description
GET API/SupportingData/Currencies	Get List of Currencies
GET API/SupportingData/Countries	Get List of Countries

Grants

API	Description
GET API/User/{userId}/Grants?funderID={funderID}	Get UserGrants by UserId
GET API/{profileID}/Grants/Search/{searchString}?maxResults={maxResults}	Search Grants by either Name or Grant ID in Database