Activity

Use to return the activity objects stored in Donor Strategy.

APIDescription
GET api/Activity

Returns all the possible activities

GET api/Activity/{id}

Returns all actitivies that a fellow has by Id.

PUT api/Activity

Unchecks all activities in DS and then select the supplied activities

GET api/Activity/{index}/{rows}/{field}/{order}

Returns all the possible activities

GET api/Activity/{index}/{rows}/{field}/{order}?id={id}

Returns all actitivies that a fellow has by Id.

PUT api/Activity/{index}/{rows}/{field}/{order}

Unchecks all activities in DS and then select the supplied activities

GET api/Activity/{index}/{rows}

Returns all the possible activities

GET api/Activity/{index}/{rows}?id={id}

Returns all actitivies that a fellow has by Id.

PUT api/Activity/{index}/{rows}

Unchecks all activities in DS and then select the supplied activities

Address

Use to return the address objects stored in Donor Strategy.

APIDescription
GET api/Address/{id}

Returns all addresses for a fellow by Id.

GET api/Address/{index}/{rows}/{field}/{order}?id={id}

Returns all addresses for a fellow by Id.

GET api/Address/{index}/{rows}?id={id}

Returns all addresses for a fellow by Id.

Anybody

Used to return anybody from Donor Strategy.

APIDescription
GET api/Anybody/{id}

Returns anybody by their Id.

PUT api/Anybody

Updates anybody in Donor Strategy.

GET api/Anybody/{index}/{rows}/{field}/{order}?id={id}

Returns anybody by their Id.

PUT api/Anybody/{index}/{rows}/{field}/{order}

Updates anybody in Donor Strategy.

GET api/Anybody/{index}/{rows}?id={id}

Returns anybody by their Id.

PUT api/Anybody/{index}/{rows}

Updates anybody in Donor Strategy.

Award

Use to return the award objects stored in Donor Strategy.

APIDescription
GET api/Award

Returns all the possible awards

GET api/Award/{id}

Returns all awards that a fellow has by Id.

GET api/Award/{index}/{rows}/{field}/{order}

Returns all the possible awards

GET api/Award/{index}/{rows}/{field}/{order}?id={id}

Returns all awards that a fellow has by Id.

GET api/Award/{index}/{rows}

Returns all the possible awards

GET api/Award/{index}/{rows}?id={id}

Returns all awards that a fellow has by Id.

AwardPhoto

Manages photos for Awards.

APIDescription
GET api/AwardPhoto/{id}

Gets the image for an award by Id.

POST api/AwardPhoto

Creates an image for an award.

PUT api/AwardPhoto

Modifies existing image for an award.

GET api/AwardPhoto/{index}/{rows}/{field}/{order}?id={id}

Gets the image for an award by Id.

POST api/AwardPhoto/{index}/{rows}/{field}/{order}

Creates an image for an award.

PUT api/AwardPhoto/{index}/{rows}/{field}/{order}

Modifies existing image for an award.

GET api/AwardPhoto/{index}/{rows}?id={id}

Gets the image for an award by Id.

POST api/AwardPhoto/{index}/{rows}

Creates an image for an award.

PUT api/AwardPhoto/{index}/{rows}

Modifies existing image for an award.

Committee

Use to return the committee objects stored in Donor Strategy.

APIDescription
GET api/Committee

Returns all the committees from Donor Strategy that are currently marked as active

GET api/Committee?index={index}&rows={rows}

Returns paged list of committees

GET api/Committee/{id}

Returns a committee by id or name, with or without hypens.

GET api/Committee/{index}/{rows}/{field}/{order}?id={id}

Returns a committee by id or name, with or without hypens.

GET api/Committee/{index}/{rows}?id={id}

Returns a committee by id or name, with or without hypens.

CommitteeMember

Use to return the committees with fully populated members.

APIDescription
GET api/CommitteeMember/{id}

Returns a committee by name with fully populated members

GET api/CommitteeMember/{index}/{rows}/{field}/{order}?id={id}

Returns a committee by name with fully populated members

GET api/CommitteeMember/{index}/{rows}?id={id}

Returns a committee by name with fully populated members

CommitteePhoto

Manages photos for Committees.

APIDescription
GET api/CommitteePhoto/{id}

Gets the image for a Committee by Id.

POST api/CommitteePhoto

Creates an image for a Committee.

PUT api/CommitteePhoto

Modifies existing image for a Committee.

GET api/CommitteePhoto/{index}/{rows}/{field}/{order}?id={id}

Gets the image for a Committee by Id.

POST api/CommitteePhoto/{index}/{rows}/{field}/{order}

Creates an image for a Committee.

PUT api/CommitteePhoto/{index}/{rows}/{field}/{order}

Modifies existing image for a Committee.

GET api/CommitteePhoto/{index}/{rows}?id={id}

Gets the image for a Committee by Id.

POST api/CommitteePhoto/{index}/{rows}

Creates an image for a Committee.

PUT api/CommitteePhoto/{index}/{rows}

Modifies existing image for a Committee.

CommitteeType

Use to return the committee type objects stored in Donor Strategy.

APIDescription
GET api/CommitteeType

Returns all the different types that a committee could be

GET api/CommitteeType/{index}/{rows}/{field}/{order}

Returns all the different types that a committee could be

GET api/CommitteeType/{index}/{rows}

Returns all the different types that a committee could be

Company

Use to return the company objects stored in Donor Strategy.

APIDescription
GET api/Company

Returns all the companies in Donor Strategy that is related to a Fellow or External Member in an active committee

GET api/Company/{id}

Returns a company by the company Id

GET api/Company/{index}/{rows}/{field}/{order}

Returns all the companies in Donor Strategy that is related to a Fellow or External Member in an active committee

GET api/Company/{index}/{rows}/{field}/{order}?id={id}

Returns a company by the company Id

GET api/Company/{index}/{rows}

Returns all the companies in Donor Strategy that is related to a Fellow or External Member in an active committee

GET api/Company/{index}/{rows}?id={id}

Returns a company by the company Id

Country

Use to return the country objects stored in Donor Strategy using two letter country codes. More information can be found on this here https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2

APIDescription
GET api/Country

Returns all the countries in Donor Strategy

GET api/Country/{id}

Returns all countries that a fellow has by Id.

PUT api/Country

Updates countries a Fellow is associated with.

GET api/Country/{index}/{rows}/{field}/{order}

Returns all the countries in Donor Strategy

GET api/Country/{index}/{rows}/{field}/{order}?id={id}

Returns all countries that a fellow has by Id.

PUT api/Country/{index}/{rows}/{field}/{order}

Updates countries a Fellow is associated with.

GET api/Country/{index}/{rows}

Returns all the countries in Donor Strategy

GET api/Country/{index}/{rows}?id={id}

Returns all countries that a fellow has by Id.

PUT api/Country/{index}/{rows}

Updates countries a Fellow is associated with.

DsGmsSyncLog

Used to read and write DS-GMS sync logs.

APIDescription
GET api/DsGmsSyncLog

Returns logs for the past week.

GET api/DsGmsSyncLog/{id}

Returns last push date per type.

POST api/DsGmsSyncLog

Creates a log.

GET api/DsGmsSyncLog/{index}/{rows}/{field}/{order}

Returns logs for the past week.

GET api/DsGmsSyncLog/{index}/{rows}/{field}/{order}?id={id}

Returns last push date per type.

POST api/DsGmsSyncLog/{index}/{rows}/{field}/{order}

Creates a log.

GET api/DsGmsSyncLog/{index}/{rows}

Returns logs for the past week.

GET api/DsGmsSyncLog/{index}/{rows}?id={id}

Returns last push date per type.

POST api/DsGmsSyncLog/{index}/{rows}

Creates a log.

Fellow

Use to return the fellows stored in Donor Strategy.

APIDescription
GET api/Fellow

Returns all the fellows in Donor Strategy

GET api/Fellow?index={index}&rows={rows}

Returns paged list of contacts

GET api/Fellow?index={index}&rows={rows}&field={field}&order={order}

Returns paged list of contacts ordered by electedyear or lastname

GET api/Fellow/{id}

Returns a fellow by their Id.

PUT api/Fellow

Updates a fellow in Donor Strategy*.

GET api/Fellow/{index}/{rows}/{field}/{order}?id={id}

Returns a fellow by their Id.

PUT api/Fellow/{index}/{rows}/{field}/{order}

Updates a fellow in Donor Strategy*.

GET api/Fellow/{index}/{rows}?field={field}&order={order}

Returns paged list of contacts ordered by electedyear or lastname

GET api/Fellow/{index}/{rows}?id={id}

Returns a fellow by their Id.

PUT api/Fellow/{index}/{rows}

Updates a fellow in Donor Strategy*.

Gender

Use to return the gender objects stored in Donor Strategy.

APIDescription
GET api/Gender

Returns all genders

GET api/Gender/{index}/{rows}/{field}/{order}

Returns all genders

GET api/Gender/{index}/{rows}

Returns all genders

GmsCommittee

Use to return the committees that need to be pushed to Flexi-Grant.

APIDescription
GET api/GmsCommittee/{id}

Returns all the committees in Donor Strategy that are marked for use in the GMS and have an 'updated' date older than the last push, plus those that have failed in previous pushes and need to be resent.

GET api/GmsCommittee/{index}/{rows}/{field}/{order}?id={id}

Returns all the committees in Donor Strategy that are marked for use in the GMS and have an 'updated' date older than the last push, plus those that have failed in previous pushes and need to be resent.

GET api/GmsCommittee/{index}/{rows}?id={id}

Returns all the committees in Donor Strategy that are marked for use in the GMS and have an 'updated' date older than the last push, plus those that have failed in previous pushes and need to be resent.

GmsOrganisation

Use to return the organisations that have been marked in Donor Strategy for use in the GMS.

APIDescription
GET api/GmsOrganisation

Returns all the organisations in Donor Strategy that are marked for use in the GMS

GET api/GmsOrganisation/{id}

Returns all the organisations in Donor Strategy that are marked for use in the GMS and have an 'updated' date older than the last push, plus those that have failed in previous pushes and need to be resent.

GET api/GmsOrganisation/{index}/{rows}/{field}/{order}

Returns all the organisations in Donor Strategy that are marked for use in the GMS

GET api/GmsOrganisation/{index}/{rows}/{field}/{order}?id={id}

Returns all the organisations in Donor Strategy that are marked for use in the GMS and have an 'updated' date older than the last push, plus those that have failed in previous pushes and need to be resent.

GET api/GmsOrganisation/{index}/{rows}

Returns all the organisations in Donor Strategy that are marked for use in the GMS

GET api/GmsOrganisation/{index}/{rows}?id={id}

Returns all the organisations in Donor Strategy that are marked for use in the GMS and have an 'updated' date older than the last push, plus those that have failed in previous pushes and need to be resent.

GmsPanel

Use to return gmsPanels

APIDescription
GET api/GmsPanel

Returns all GMS panels.

POST api/GmsPanel

Creates a GMS panel.

DELETE api/GmsPanel/{id}

Deletes a GMS panel.

GET api/GmsPanel/{index}/{rows}/{field}/{order}

Returns all GMS panels.

POST api/GmsPanel/{index}/{rows}/{field}/{order}

Creates a GMS panel.

DELETE api/GmsPanel/{index}/{rows}/{field}/{order}?id={id}

Deletes a GMS panel.

GET api/GmsPanel/{index}/{rows}

Returns all GMS panels.

POST api/GmsPanel/{index}/{rows}

Creates a GMS panel.

DELETE api/GmsPanel/{index}/{rows}?id={id}

Deletes a GMS panel.

IsFellow

APIDescription
GET api/IsFellow/{id}

Returns boolean value to say whether the pcode actually belongs to a Fellow.

GET api/IsFellow/{index}/{rows}/{field}/{order}?id={id}

Returns boolean value to say whether the pcode actually belongs to a Fellow.

GET api/IsFellow/{index}/{rows}?id={id}

Returns boolean value to say whether the pcode actually belongs to a Fellow.

Language

Use to return the languages stored in Donor Strategy.

APIDescription
GET api/Language

Returns all languages in Donor Strategy

GET api/Language/{id}

Returns all languages in Donor Strategy for a given user

PUT api/Language

Updates languages for a Fellow.

GET api/Language/{index}/{rows}/{field}/{order}

Returns all languages in Donor Strategy

GET api/Language/{index}/{rows}/{field}/{order}?id={id}

Returns all languages in Donor Strategy for a given user

PUT api/Language/{index}/{rows}/{field}/{order}

Updates languages for a Fellow.

GET api/Language/{index}/{rows}

Returns all languages in Donor Strategy

GET api/Language/{index}/{rows}?id={id}

Returns all languages in Donor Strategy for a given user

PUT api/Language/{index}/{rows}

Updates languages for a Fellow.

Member

Use to return the members stored in Donor Strategy who are not fellows and a member of an active committee.

APIDescription
GET api/Member

Returns all the members in Donor Strategy that are not fellows and are on an active committee

GET api/Member?index={index}&rows={rows}

Returns paged list of external members

GET api/Member/{id}

Returns a member by their id or pcode.

GET api/Member/{index}/{rows}/{field}/{order}?id={id}

Returns a member by their id or pcode.

GET api/Member/{index}/{rows}?id={id}

Returns a member by their id or pcode.

MemberCommittee

Use to return the committee objects for a given member.

APIDescription
GET api/MemberCommittee/{id}

Returns all committees for a fellow by Id.

GET api/MemberCommittee/{index}/{rows}/{field}/{order}?id={id}

Returns all committees for a fellow by Id.

GET api/MemberCommittee/{index}/{rows}?id={id}

Returns all committees for a fellow by Id.

MemberType

Use to return the types of members stored in Donor Strategy.

APIDescription
GET api/MemberType

Returns all member types in Donor Strategy

GET api/MemberType/{id}

Returns a Fellows member type from Donor Strategy

GET api/MemberType/{index}/{rows}/{field}/{order}

Returns all member types in Donor Strategy

GET api/MemberType/{index}/{rows}/{field}/{order}?id={id}

Returns a Fellows member type from Donor Strategy

GET api/MemberType/{index}/{rows}

Returns all member types in Donor Strategy

GET api/MemberType/{index}/{rows}?id={id}

Returns a Fellows member type from Donor Strategy

Photo

Use to return photos for Fellows or Research Fellows

APIDescription
GET api/photo/{id}/{type}/{category}

Returns photo for a Research Fellow by their Id

Photo

Use to return photos for Fellows or Research Fellows

APIDescription
GET api/Photo

Returns photo for a Fellow by their Id

GET api/Photo/{id}

Returns photo for a Fellow by their Id

GET api/Photo/{id}?type={type}&category={category}

Returns photo for a Research Fellow by their Id

POST api/Photo

Creates a photo.

PUT api/Photo

Update a photo

GET api/Photo/{index}/{rows}/{field}/{order}

Returns photo for a Fellow by their Id

GET api/Photo/{index}/{rows}/{field}/{order}?id={id}

Returns photo for a Fellow by their Id

GET api/Photo/{index}/{rows}/{field}/{order}?id={id}&type={type}&category={category}

Returns photo for a Research Fellow by their Id

POST api/Photo/{index}/{rows}/{field}/{order}

Creates a photo.

PUT api/Photo/{index}/{rows}/{field}/{order}

Update a photo

GET api/Photo/{index}/{rows}

Returns photo for a Fellow by their Id

GET api/Photo/{index}/{rows}?id={id}

Returns photo for a Fellow by their Id

GET api/Photo/{index}/{rows}?id={id}&type={type}&category={category}

Returns photo for a Research Fellow by their Id

POST api/Photo/{index}/{rows}

Creates a photo.

PUT api/Photo/{index}/{rows}

Update a photo

PhotoGeneration

Used to handle preprocessing of images

APIDescription
GET api/PhotoGeneration/{id}

Use to generate images stored in the ExternalDB.

GET api/PhotoGeneration/{index}/{rows}/{field}/{order}?id={id}

Use to generate images stored in the ExternalDB.

GET api/PhotoGeneration/{index}/{rows}?id={id}

Use to generate images stored in the ExternalDB.

Position

Use to return positions

APIDescription
GET api/Position/{id}

Returns all Fellow positions for a given Fellow

POST api/Position

Sends the DS administrator an email to create a position in donor strategy.

PUT api/Position

Sends the DS administrator an email to update a position in donor strategy.

DELETE api/Position

Sends the DS administrator an email to delete a position in donor strategy.

GET api/Position/{index}/{rows}/{field}/{order}?id={id}

Returns all Fellow positions for a given Fellow

POST api/Position/{index}/{rows}/{field}/{order}

Sends the DS administrator an email to create a position in donor strategy.

PUT api/Position/{index}/{rows}/{field}/{order}

Sends the DS administrator an email to update a position in donor strategy.

DELETE api/Position/{index}/{rows}/{field}/{order}

Sends the DS administrator an email to delete a position in donor strategy.

GET api/Position/{index}/{rows}?id={id}

Returns all Fellow positions for a given Fellow

POST api/Position/{index}/{rows}

Sends the DS administrator an email to create a position in donor strategy.

PUT api/Position/{index}/{rows}

Sends the DS administrator an email to update a position in donor strategy.

DELETE api/Position/{index}/{rows}

Sends the DS administrator an email to delete a position in donor strategy.

PubsDelivery

Returns all options available in Donor Strategy for delivery of publications.

APIDescription
GET api/PubsDelivery

Returns all the options.

GET api/PubsDelivery/{id}

Returns preferred way of delivering publications (hard and/or electronic copies) for a contact.

PUT api/PubsDelivery

Updates preferred way of delivering publications for a contact in Donor Strategy.

GET api/PubsDelivery/{index}/{rows}/{field}/{order}

Returns all the options.

GET api/PubsDelivery/{index}/{rows}/{field}/{order}?id={id}

Returns preferred way of delivering publications (hard and/or electronic copies) for a contact.

PUT api/PubsDelivery/{index}/{rows}/{field}/{order}

Updates preferred way of delivering publications for a contact in Donor Strategy.

GET api/PubsDelivery/{index}/{rows}

Returns all the options.

GET api/PubsDelivery/{index}/{rows}?id={id}

Returns preferred way of delivering publications (hard and/or electronic copies) for a contact.

PUT api/PubsDelivery/{index}/{rows}

Updates preferred way of delivering publications for a contact in Donor Strategy.

ResearchArea

Use to return Research Areas from Donor Strategy

APIDescription
GET api/ResearchArea

Returns all Research Areas

GET api/ResearchArea/{id}

Returns all Research Areas for a Fellow

POST api/ResearchArea

Adds a new Research Areas for a Fellow

PUT api/ResearchArea

Updates a new Research Areas for a Fellow

DELETE api/ResearchArea

Delete a new Research Areas for a Fellow

GET api/ResearchArea/{index}/{rows}/{field}/{order}

Returns all Research Areas

GET api/ResearchArea/{index}/{rows}/{field}/{order}?id={id}

Returns all Research Areas for a Fellow

POST api/ResearchArea/{index}/{rows}/{field}/{order}

Adds a new Research Areas for a Fellow

PUT api/ResearchArea/{index}/{rows}/{field}/{order}

Updates a new Research Areas for a Fellow

DELETE api/ResearchArea/{index}/{rows}/{field}/{order}

Delete a new Research Areas for a Fellow

GET api/ResearchArea/{index}/{rows}

Returns all Research Areas

GET api/ResearchArea/{index}/{rows}?id={id}

Returns all Research Areas for a Fellow

POST api/ResearchArea/{index}/{rows}

Adds a new Research Areas for a Fellow

PUT api/ResearchArea/{index}/{rows}

Updates a new Research Areas for a Fellow

DELETE api/ResearchArea/{index}/{rows}

Delete a new Research Areas for a Fellow

ResearchAward

Use to return Research Awards for Research Fellows or Fellows.

APIDescription
GET api/ResearchAward/{id}

Returns awards for a Research Fellow or a Fellow.

GET api/ResearchAward/{index}/{rows}/{field}/{order}?id={id}

Returns awards for a Research Fellow or a Fellow.

GET api/ResearchAward/{index}/{rows}?id={id}

Returns awards for a Research Fellow or a Fellow.

ResearchFellow

Use to return all Research Fellows

APIDescription
GET api/ResearchFellow

Returns all Research Fellows

GET api/ResearchFellow?index={index}&rows={rows}

Returns paged list of research fellows

GET api/ResearchFellow?index={index}&rows={rows}&field={field}&order={order}

Returns paged list of research fellows

GET api/ResearchFellow/{id}

Returns a Research Fellow

GET api/ResearchFellow/{index}/{rows}/{field}/{order}?id={id}

Returns a Research Fellow

GET api/ResearchFellow/{index}/{rows}?field={field}&order={order}

Returns paged list of research fellows

GET api/ResearchFellow/{index}/{rows}?id={id}

Returns a Research Fellow

ScientificDisciplineGroup

Use to return Scientific Disciplines and their nested Research Areas from Donor Strategy.

APIDescription
GET api/ScientificDisciplineGroup

Returns all Scientific Discipline groups

GET api/ScientificDisciplineGroup/{id}

Returns Scientific Discipline group by id

GET api/ScientificDisciplineGroup/{index}/{rows}/{field}/{order}

Returns all Scientific Discipline groups

GET api/ScientificDisciplineGroup/{index}/{rows}/{field}/{order}?id={id}

Returns Scientific Discipline group by id

GET api/ScientificDisciplineGroup/{index}/{rows}

Returns all Scientific Discipline groups

GET api/ScientificDisciplineGroup/{index}/{rows}?id={id}

Returns Scientific Discipline group by id

SitecoreUser

Use create or update existing users and their roles in Sitecore.

APIDescription
GET api/SitecoreUser?pcode={pcode}

Returns a Sitecore user by email address.

POST api/SitecoreUser

Send user information for updating / creating a user in Sitecore

GET api/SitecoreUser/{index}/{rows}/{field}/{order}?pcode={pcode}

Returns a Sitecore user by email address.

POST api/SitecoreUser/{index}/{rows}/{field}/{order}

Send user information for updating / creating a user in Sitecore

GET api/SitecoreUser/{index}/{rows}?pcode={pcode}

Returns a Sitecore user by email address.

POST api/SitecoreUser/{index}/{rows}

Send user information for updating / creating a user in Sitecore

Title

Use to return the titles stored in Donor Strategy.

APIDescription
GET api/Title

Returns all titles in Donor Strategy

GET api/Title/{index}/{rows}/{field}/{order}

Returns all titles in Donor Strategy

GET api/Title/{index}/{rows}

Returns all titles in Donor Strategy