Reference for http://www.grantsoffice.com/GrantsOfficeServices.svc/JsonGetExpandedGrant?grantId={GRANTID}&userid={USERID}&token={TOKEN}
Gets a grant with expanded data to include category ID's, eligibility ID's, funder type ID's, etc
Url: http://www.grantsoffice.com/GrantsOfficeServices.svc/JsonGetExpandedGrant?grantId={GRANTID}&userid={USERID}&token={TOKEN}
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:
<GrantExpandedResponse 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> <Grant> <additionalInfo xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models">String content</additionalInfo> <authority xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models">String content</authority> <awardAmount xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models">String content</awardAmount> <awardDesc xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models">String content</awardDesc> <cfdaNumbers xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models">String content</cfdaNumbers> <contacts xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models"> <Contact> <address>String content</address> <city>String content</city> <company>String content</company> <department>String content</department> <email>String content</email> <fax>String content</fax> <miscInfo>String content</miscInfo> <name>String content</name> <postalCode>String content</postalCode> <state>String content</state> <telephone>String content</telephone> <url>String content</url> </Contact> <Contact> <address>String content</address> <city>String content</city> <company>String content</company> <department>String content</department> <email>String content</email> <fax>String content</fax> <miscInfo>String content</miscInfo> <name>String content</name> <postalCode>String content</postalCode> <state>String content</state> <telephone>String content</telephone> <url>String content</url> </Contact> </contacts> <createDate xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models">String content</createDate> <created_by xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models">String content</created_by> <deadlineDesc xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models">String content</deadlineDesc> <deadlines xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models">String content</deadlines> <eligibilityDesc xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models">String content</eligibilityDesc> <expirationDate xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models">String content</expirationDate> <funderType xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models">String content</funderType> <fundingHistory xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models">String content</fundingHistory> <id xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models">2147483647</id> <itClassification xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models">String content</itClassification> <summary xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models">String content</summary> <title xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models">String content</title> <categories xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models"> <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int> <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int> </categories> <classification xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models">2147483647</classification> <eligibilities xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models"> <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int> <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int> </eligibilities> <funder_type xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models">2147483647</funder_type> <grant_geos xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models"> <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int> <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int> </grant_geos> <last_updated xmlns="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models">String content</last_updated> </Grant> </GrantExpandedResponse>
The following is an example response Json body:
{ "Acknowledge":0, "Build":"String content", "Message":"String content", "ServerTime":"String content", "Version":"String content", "Grant":{ "additionalInfo":"String content", "authority":"String content", "awardAmount":"String content", "awardDesc":"String content", "cfdaNumbers":"String content", "contacts":[{ "address":"String content", "city":"String content", "company":"String content", "department":"String content", "email":"String content", "fax":"String content", "miscInfo":"String content", "name":"String content", "postalCode":"String content", "state":"String content", "telephone":"String content", "url":"String content" }], "createDate":"String content", "created_by":"String content", "deadlineDesc":"String content", "deadlines":"String content", "eligibilityDesc":"String content", "expirationDate":"String content", "funderType":"String content", "fundingHistory":"String content", "id":2147483647, "itClassification":"String content", "summary":"String content", "title":"String content", "categories":[2147483647], "classification":2147483647, "eligibilities":[2147483647], "funder_type":2147483647, "grant_geos":[2147483647], "last_updated":"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.Models" /> <xs:import namespace="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models.MessageBase" /> <xs:complexType name="GrantExpandedResponse"> <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="Grant" nillable="true" xmlns:q2="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models" type="q2:GrantExpanded" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="GrantExpandedResponse" nillable="true" type="tns:GrantExpandedResponse" /> </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.Models" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/GrantsOffice.Modules.GrantsOffice.Models" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <xs:complexType name="GrantExpanded"> <xs:complexContent mixed="false"> <xs:extension base="tns:Grant"> <xs:sequence> <xs:element minOccurs="0" name="categories" nillable="true" xmlns:q1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q1:ArrayOfint" /> <xs:element minOccurs="0" name="classification" type="xs:int" /> <xs:element minOccurs="0" name="eligibilities" nillable="true" xmlns:q2="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q2:ArrayOfint" /> <xs:element minOccurs="0" name="funder_type" type="xs:int" /> <xs:element minOccurs="0" name="grant_geos" nillable="true" xmlns:q3="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q3:ArrayOfint" /> <xs:element minOccurs="0" name="last_updated" nillable="true" type="xs:string" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="GrantExpanded" nillable="true" type="tns:GrantExpanded" /> <xs:complexType name="Grant"> <xs:sequence> <xs:element minOccurs="0" name="additionalInfo" nillable="true" type="xs:string" /> <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="awardDesc" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="cfdaNumbers" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="contacts" nillable="true" type="tns:ArrayOfContact" /> <xs:element minOccurs="0" name="createDate" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="created_by" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="deadlineDesc" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="deadlines" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="eligibilityDesc" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="expirationDate" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="funderType" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="fundingHistory" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="id" type="xs:int" /> <xs:element minOccurs="0" name="itClassification" nillable="true" type="xs:string" /> <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="Grant" nillable="true" type="tns:Grant" /> <xs:complexType name="ArrayOfContact"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="Contact" nillable="true" type="tns:Contact" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfContact" nillable="true" type="tns:ArrayOfContact" /> <xs:complexType name="Contact"> <xs:sequence> <xs:element minOccurs="0" name="address" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="city" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="company" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="department" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="email" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="fax" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="miscInfo" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="name" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="postalCode" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="state" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="telephone" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="url" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="Contact" nillable="true" type="tns:Contact" /> </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>