Reference for http://api2.redtailtechnology.com/crm/v1/rest/opportunities/open?page={PAGE}
Url: http://api2.redtailtechnology.com/crm/v1/rest/opportunities/open?page={PAGE}
HTTP Method: GET
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:
<Opportunities_Result xmlns="http://schemas.datacontract.org/2004/07/REDTAIL.Model.Responses.v1"> <Opportunities> <Opportunity xmlns="http://schemas.datacontract.org/2004/07/REDTAIL.Model"> <Amount>12678967.543233</Amount> <AssignedTo>2147483647</AssignedTo> <CloseDate>1999-05-31T11:20:00</CloseDate> <DatabaseID>2147483647</DatabaseID> <Deleted>true</Deleted> <DeletedBy>2147483647</DeletedBy> <DeletedOn>1999-05-31T11:20:00</DeletedOn> <Description>String content</Description> <Name>String content</Name> <NextStep>String content</NextStep> <NumberOfContacts>2147483647</NumberOfContacts> <Probability>2147483647</Probability> <RecAdd>1999-05-31T11:20:00</RecAdd> <RecAddUser>2147483647</RecAddUser> <RecID>2147483647</RecID> <Source>String content</Source> <SourceID>2147483647</SourceID> <Stage>String content</Stage> <StageID>2147483647</StageID> <Type>String content</Type> <TypeID>2147483647</TypeID> </Opportunity> <Opportunity xmlns="http://schemas.datacontract.org/2004/07/REDTAIL.Model"> <Amount>12678967.543233</Amount> <AssignedTo>2147483647</AssignedTo> <CloseDate>1999-05-31T11:20:00</CloseDate> <DatabaseID>2147483647</DatabaseID> <Deleted>true</Deleted> <DeletedBy>2147483647</DeletedBy> <DeletedOn>1999-05-31T11:20:00</DeletedOn> <Description>String content</Description> <Name>String content</Name> <NextStep>String content</NextStep> <NumberOfContacts>2147483647</NumberOfContacts> <Probability>2147483647</Probability> <RecAdd>1999-05-31T11:20:00</RecAdd> <RecAddUser>2147483647</RecAddUser> <RecID>2147483647</RecID> <Source>String content</Source> <SourceID>2147483647</SourceID> <Stage>String content</Stage> <StageID>2147483647</StageID> <Type>String content</Type> <TypeID>2147483647</TypeID> </Opportunity> </Opportunities> <TotalRecords>2147483647</TotalRecords> </Opportunities_Result>
The following is an example response Json body:
{ "Opportunities":[{ "Amount":12678967.543233, "AssignedTo":2147483647, "CloseDate":"\/Date(928174800000-0700)\/", "DatabaseID":2147483647, "Deleted":true, "DeletedBy":2147483647, "DeletedOn":"\/Date(928174800000-0700)\/", "Description":"String content", "Name":"String content", "NextStep":"String content", "NumberOfContacts":2147483647, "Probability":2147483647, "RecAdd":"\/Date(928174800000-0700)\/", "RecAddUser":2147483647, "RecID":2147483647, "Source":"String content", "SourceID":2147483647, "Stage":"String content", "StageID":2147483647, "Type":"String content", "TypeID":2147483647 }], "TotalRecords":2147483647 }
The following is the response Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/REDTAIL.Model.Responses.v1" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/REDTAIL.Model.Responses.v1" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://schemas.datacontract.org/2004/07/REDTAIL.Model" /> <xs:complexType name="Opportunities_Result"> <xs:sequence> <xs:element minOccurs="0" name="Opportunities" nillable="true" xmlns:q1="http://schemas.datacontract.org/2004/07/REDTAIL.Model" type="q1:ArrayOfOpportunity" /> <xs:element minOccurs="0" name="TotalRecords" type="xs:int" /> </xs:sequence> </xs:complexType> <xs:element name="Opportunities_Result" nillable="true" type="tns:Opportunities_Result" /> </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/REDTAIL.Model" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/REDTAIL.Model" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:complexType name="ArrayOfOpportunity"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="Opportunity" nillable="true" type="tns:Opportunity" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfOpportunity" nillable="true" type="tns:ArrayOfOpportunity" /> <xs:complexType name="Opportunity"> <xs:sequence> <xs:element minOccurs="0" name="Amount" type="xs:decimal" /> <xs:element minOccurs="0" name="AssignedTo" type="xs:int" /> <xs:element minOccurs="0" name="CloseDate" type="xs:dateTime" /> <xs:element minOccurs="0" name="DatabaseID" type="xs:int" /> <xs:element minOccurs="0" name="Deleted" type="xs:boolean" /> <xs:element minOccurs="0" name="DeletedBy" type="xs:int" /> <xs:element minOccurs="0" name="DeletedOn" type="xs:dateTime" /> <xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="NextStep" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="NumberOfContacts" type="xs:int" /> <xs:element minOccurs="0" name="Probability" type="xs:int" /> <xs:element minOccurs="0" name="RecAdd" type="xs:dateTime" /> <xs:element minOccurs="0" name="RecAddUser" type="xs:int" /> <xs:element minOccurs="0" name="RecID" type="xs:int" /> <xs:element minOccurs="0" name="Source" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="SourceID" type="xs:int" /> <xs:element minOccurs="0" name="Stage" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="StageID" type="xs:int" /> <xs:element minOccurs="0" name="Type" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="TypeID" type="xs:int" /> </xs:sequence> </xs:complexType> <xs:element name="Opportunity" nillable="true" type="tns:Opportunity" /> </xs:schema>
<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema"> <tns:element name="schema"> <tns:complexType /> </tns:element> </tns:schema>