Reference for http://www.grantsoffice.com/GrantsOfficeServices.svc/Search?userid={USERID}&token={TOKEN}&page={PAGE}&count={COUNT}&isadvancedsearch={ISADVANCEDSEARCH}
Searches the database for grants by search terms
Url: http://www.grantsoffice.com/GrantsOfficeServices.svc/Search?userid={USERID}&token={TOKEN}&page={PAGE}&count={COUNT}&isadvancedsearch={ISADVANCEDSEARCH}
HTTP Method: POST
| Message direction | Format | Body |
|---|---|---|
| Request | Xml | Example,Schema |
| Request | Json | Example |
| Response | Xml | Example,Schema |
| Response | Json | Example |
The following is an example request Xml body:
<SearchDto xmlns="GrantsOffice">
<CDFA>String content</CDFA>
<CategoryIds>
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
</CategoryIds>
<ClassificationIds>
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
</ClassificationIds>
<DeadlineAfter>String content</DeadlineAfter>
<DeadlineBefore>String content</DeadlineBefore>
<ElegibilityIds>
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
</ElegibilityIds>
<FunderTypeIds>
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
</FunderTypeIds>
<GeographyIds>
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
</GeographyIds>
<IncludePastDeadlines>true</IncludePastDeadlines>
<Term>String content</Term>
</SearchDto>
The following is an example request Json body:
{
"CDFA":"String content",
"CategoryIds":[2147483647],
"ClassificationIds":[2147483647],
"DeadlineAfter":"String content",
"DeadlineBefore":"String content",
"ElegibilityIds":[2147483647],
"FunderTypeIds":[2147483647],
"GeographyIds":[2147483647],
"IncludePastDeadlines":true,
"Term":"String content"
}
The following is an example response Xml body:
<SearchResponse xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models.Messages">
<Acknowledge xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models.MessageBase">Failure</Acknowledge>
<Build xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models.MessageBase">String content</Build>
<Message xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models.MessageBase">String content</Message>
<ServerTime xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models.MessageBase">String content</ServerTime>
<Version xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models.MessageBase">String content</Version>
<Grants>
<GrantInfoBasic xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Services.Models">
<authority>String content</authority>
<awardAmount>String content</awardAmount>
<deadlines>String content</deadlines>
<id>2147483647</id>
<summary>String content</summary>
<title>String content</title>
</GrantInfoBasic>
<GrantInfoBasic xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Services.Models">
<authority>String content</authority>
<awardAmount>String content</awardAmount>
<deadlines>String content</deadlines>
<id>2147483647</id>
<summary>String content</summary>
<title>String content</title>
</GrantInfoBasic>
</Grants>
<TotalRecords>2147483647</TotalRecords>
</SearchResponse>
The following is an example response Json body:
{
"Acknowledge":0,
"Build":"String content",
"Message":"String content",
"ServerTime":"String content",
"Version":"String content",
"Grants":[{
"authority":"String content",
"awardAmount":"String content",
"deadlines":"String content",
"id":2147483647,
"summary":"String content",
"title":"String content"
}],
"TotalRecords":2147483647
}
The following is the request Xml Schema:
<xs:schema xmlns:tns="GrantsOffice" elementFormDefault="qualified" targetNamespace="GrantsOffice" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
<xs:complexType name="SearchDto">
<xs:sequence>
<xs:element minOccurs="0" name="CDFA" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CategoryIds" nillable="true" xmlns:q1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q1:ArrayOfint" />
<xs:element minOccurs="0" name="ClassificationIds" nillable="true" xmlns:q2="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q2:ArrayOfint" />
<xs:element minOccurs="0" name="DeadlineAfter" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="DeadlineBefore" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ElegibilityIds" nillable="true" xmlns:q3="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q3:ArrayOfint" />
<xs:element minOccurs="0" name="FunderTypeIds" nillable="true" xmlns:q4="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q4:ArrayOfint" />
<xs:element minOccurs="0" name="GeographyIds" nillable="true" xmlns:q5="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q5:ArrayOfint" />
<xs:element minOccurs="0" name="IncludePastDeadlines" type="xs:boolean" />
<xs:element minOccurs="0" name="Term" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="SearchDto" nillable="true" type="tns:SearchDto" />
</xs:schema>
Additional request Xml Schemas:
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="anyType" nillable="true" type="xs:anyType" />
<xs:element name="anyURI" nillable="true" type="xs:anyURI" />
<xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
<xs:element name="boolean" nillable="true" type="xs:boolean" />
<xs:element name="byte" nillable="true" type="xs:byte" />
<xs:element name="dateTime" nillable="true" type="xs:dateTime" />
<xs:element name="decimal" nillable="true" type="xs:decimal" />
<xs:element name="double" nillable="true" type="xs:double" />
<xs:element name="float" nillable="true" type="xs:float" />
<xs:element name="int" nillable="true" type="xs:int" />
<xs:element name="long" nillable="true" type="xs:long" />
<xs:element name="QName" nillable="true" type="xs:QName" />
<xs:element name="short" nillable="true" type="xs:short" />
<xs:element name="string" nillable="true" type="xs:string" />
<xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
<xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
<xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
<xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
<xs:element name="char" nillable="true" type="tns:char" />
<xs:simpleType name="char">
<xs:restriction base="xs:int" />
</xs:simpleType>
<xs:element name="duration" nillable="true" type="tns:duration" />
<xs:simpleType name="duration">
<xs:restriction base="xs:duration">
<xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
<xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
<xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
</xs:restriction>
</xs:simpleType>
<xs:element name="guid" nillable="true" type="tns:guid" />
<xs:simpleType name="guid">
<xs:restriction base="xs:string">
<xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
</xs:restriction>
</xs:simpleType>
<xs:attribute name="FactoryType" type="xs:QName" />
<xs:attribute name="Id" type="xs:ID" />
<xs:attribute name="Ref" type="xs:IDREF" />
</xs:schema>
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/Arrays" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexType name="ArrayOfint">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="int" type="xs:int" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfint" nillable="true" type="tns:ArrayOfint" />
</xs:schema>
<xs:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="schema">
<xs:complexType />
</xs:element>
</xs:schema>
The following is the response Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models.Messages" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models.Messages" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:import namespace="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Services.Models" />
<xs:import namespace="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models.MessageBase" />
<xs:complexType name="SearchResponse">
<xs:complexContent mixed="false">
<xs:extension xmlns:q1="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models.MessageBase" base="q1:ResponseBase">
<xs:sequence>
<xs:element minOccurs="0" name="Grants" nillable="true" xmlns:q2="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Services.Models" type="q2:ArrayOfGrantInfoBasic" />
<xs:element minOccurs="0" name="TotalRecords" type="xs:int" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="SearchResponse" nillable="true" type="tns:SearchResponse" />
</xs:schema>
Additional response Xml Schemas:
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="anyType" nillable="true" type="xs:anyType" />
<xs:element name="anyURI" nillable="true" type="xs:anyURI" />
<xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
<xs:element name="boolean" nillable="true" type="xs:boolean" />
<xs:element name="byte" nillable="true" type="xs:byte" />
<xs:element name="dateTime" nillable="true" type="xs:dateTime" />
<xs:element name="decimal" nillable="true" type="xs:decimal" />
<xs:element name="double" nillable="true" type="xs:double" />
<xs:element name="float" nillable="true" type="xs:float" />
<xs:element name="int" nillable="true" type="xs:int" />
<xs:element name="long" nillable="true" type="xs:long" />
<xs:element name="QName" nillable="true" type="xs:QName" />
<xs:element name="short" nillable="true" type="xs:short" />
<xs:element name="string" nillable="true" type="xs:string" />
<xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
<xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
<xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
<xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
<xs:element name="char" nillable="true" type="tns:char" />
<xs:simpleType name="char">
<xs:restriction base="xs:int" />
</xs:simpleType>
<xs:element name="duration" nillable="true" type="tns:duration" />
<xs:simpleType name="duration">
<xs:restriction base="xs:duration">
<xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
<xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
<xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
</xs:restriction>
</xs:simpleType>
<xs:element name="guid" nillable="true" type="tns:guid" />
<xs:simpleType name="guid">
<xs:restriction base="xs:string">
<xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
</xs:restriction>
</xs:simpleType>
<xs:attribute name="FactoryType" type="xs:QName" />
<xs:attribute name="Id" type="xs:ID" />
<xs:attribute name="Ref" type="xs:IDREF" />
</xs:schema>
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models.MessageBase" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models.MessageBase" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexType name="ResponseBase">
<xs:sequence>
<xs:element minOccurs="0" name="Acknowledge" type="tns:AcknowledgeType" />
<xs:element minOccurs="0" name="Build" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Message" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ServerTime" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Version" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="ResponseBase" nillable="true" type="tns:ResponseBase" />
<xs:simpleType name="AcknowledgeType">
<xs:restriction base="xs:string">
<xs:enumeration value="Failure" />
<xs:enumeration value="Success" />
</xs:restriction>
</xs:simpleType>
<xs:element name="AcknowledgeType" nillable="true" type="tns:AcknowledgeType" />
</xs:schema>
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Services.Models" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Services.Models" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexType name="ArrayOfGrantInfoBasic">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="GrantInfoBasic" nillable="true" type="tns:GrantInfoBasic" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfGrantInfoBasic" nillable="true" type="tns:ArrayOfGrantInfoBasic" />
<xs:complexType name="GrantInfoBasic">
<xs:sequence>
<xs:element minOccurs="0" name="authority" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="awardAmount" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="deadlines" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="id" type="xs:int" />
<xs:element minOccurs="0" name="summary" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="title" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="GrantInfoBasic" nillable="true" type="tns:GrantInfoBasic" />
</xs:schema>
<xs:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="schema">
<xs:complexType />
</xs:element>
</xs:schema>