Reference for http://www.grantsoffice.com/GrantsOfficeServices.svc/JsonGetSearchFilters?userid={USERID}&token={TOKEN}&deadlinerequired={DEADLINEREQUIRED}
Get all of the search filters available for GoStream. Useful for rendering a search panel without making multiple Ajax requests for data
Url: http://www.grantsoffice.com/GrantsOfficeServices.svc/JsonGetSearchFilters?userid={USERID}&token={TOKEN}&deadlinerequired={DEADLINEREQUIRED}
HTTP Method: GET
This operation supports JSONP responses. The callback function can be specified using the "callback" Url query parameter.
Message direction | Format | Body |
---|---|---|
Request | N/A | The Request body is empty. |
Response | Xml | Example,Schema |
Response | Json | Example |
The following is an example response Xml body:
<SearchFiltersResponse 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> <Categories> <GroupCount xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Services.Models"> <grantcount>2147483647</grantcount> <id>2147483647</id> <name>String content</name> </GroupCount> <GroupCount xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Services.Models"> <grantcount>2147483647</grantcount> <id>2147483647</id> <name>String content</name> </GroupCount> </Categories> <Classifications> <Classification xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Services.Models"> <criteria>String content</criteria> <id>2147483647</id> <identifier>String content</identifier> </Classification> <Classification xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Services.Models"> <criteria>String content</criteria> <id>2147483647</id> <identifier>String content</identifier> </Classification> </Classifications> <Eligibilities> <GroupCount xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Services.Models"> <grantcount>2147483647</grantcount> <id>2147483647</id> <name>String content</name> </GroupCount> <GroupCount xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Services.Models"> <grantcount>2147483647</grantcount> <id>2147483647</id> <name>String content</name> </GroupCount> </Eligibilities> <FunderTypes> <GroupCount xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Services.Models"> <grantcount>2147483647</grantcount> <id>2147483647</id> <name>String content</name> </GroupCount> <GroupCount xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Services.Models"> <grantcount>2147483647</grantcount> <id>2147483647</id> <name>String content</name> </GroupCount> </FunderTypes> <States> <Geography xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Services.Models"> <abbrev>String content</abbrev> <id>2147483647</id> <name>String content</name> </Geography> <Geography xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Services.Models"> <abbrev>String content</abbrev> <id>2147483647</id> <name>String content</name> </Geography> </States> </SearchFiltersResponse>
The following is an example response Json body:
{ "Acknowledge":0, "Build":"String content", "Message":"String content", "ServerTime":"String content", "Version":"String content", "Categories":[{ "grantcount":2147483647, "id":2147483647, "name":"String content" }], "Classifications":[{ "criteria":"String content", "id":2147483647, "identifier":"String content" }], "Eligibilities":[{ "grantcount":2147483647, "id":2147483647, "name":"String content" }], "FunderTypes":[{ "grantcount":2147483647, "id":2147483647, "name":"String content" }], "States":[{ "abbrev":"String content", "id":2147483647, "name":"String content" }] }
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="SearchFiltersResponse"> <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="Categories" nillable="true" xmlns:q2="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Services.Models" type="q2:ArrayOfGroupCount" /> <xs:element minOccurs="0" name="Classifications" nillable="true" xmlns:q3="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Services.Models" type="q3:ArrayOfClassification" /> <xs:element minOccurs="0" name="Eligibilities" nillable="true" xmlns:q4="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Services.Models" type="q4:ArrayOfGroupCount" /> <xs:element minOccurs="0" name="FunderTypes" nillable="true" xmlns:q5="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Services.Models" type="q5:ArrayOfGroupCount" /> <xs:element minOccurs="0" name="States" nillable="true" xmlns:q6="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Services.Models" type="q6:ArrayOfGeography" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="SearchFiltersResponse" nillable="true" type="tns:SearchFiltersResponse" /> </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="ArrayOfGroupCount"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="GroupCount" nillable="true" type="tns:GroupCount" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfGroupCount" nillable="true" type="tns:ArrayOfGroupCount" /> <xs:complexType name="GroupCount"> <xs:sequence> <xs:element minOccurs="0" name="grantcount" type="xs:int" /> <xs:element minOccurs="0" name="id" type="xs:int" /> <xs:element minOccurs="0" name="name" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="GroupCount" nillable="true" type="tns:GroupCount" /> <xs:complexType name="ArrayOfClassification"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="Classification" nillable="true" type="tns:Classification" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfClassification" nillable="true" type="tns:ArrayOfClassification" /> <xs:complexType name="Classification"> <xs:sequence> <xs:element minOccurs="0" name="criteria" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="id" type="xs:int" /> <xs:element minOccurs="0" name="identifier" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="Classification" nillable="true" type="tns:Classification" /> <xs:complexType name="ArrayOfGeography"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="Geography" nillable="true" type="tns:Geography" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfGeography" nillable="true" type="tns:ArrayOfGeography" /> <xs:complexType name="Geography"> <xs:sequence> <xs:element minOccurs="0" name="abbrev" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="id" type="xs:int" /> <xs:element minOccurs="0" name="name" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="Geography" nillable="true" type="tns:Geography" /> </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>