Veetro Web Service Methods


Click here for a complete list of operations.

GetProposalSearchResults

[Permission: Employee]
Returns Proposals for the specified search criteria

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /xml HTTP/1.1
Host: admin.worketc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://schema.veetro.com/GetProposalSearchResults"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetProposalSearchResults xmlns="http://schema.veetro.com">
      <e>
        <StartIndex>int</StartIndex>
        <FetchSize>int</FetchSize>
        <Sort>ProposalID or DateCreated or DateLastModified</Sort>
        <Ascending>boolean</Ascending>
        <TemplateID>int</TemplateID>
        <EntityID_Relation>int</EntityID_Relation>
        <EntityID_Owner>int</EntityID_Owner>
      </e>
    </GetProposalSearchResults>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetProposalSearchResultsResponse xmlns="http://schema.veetro.com">
      <GetProposalSearchResultsResult>
        <RecordCount>int</RecordCount>
        <Description>string</Description>
        <FetchSize>int</FetchSize>
        <StartIndex>int</StartIndex>
        <EndIndex>int</EndIndex>
        <Results>
          <Proposal>
            <ProposalID>int</ProposalID>
            <Name>string</Name>
            <Value>double</Value>
            <OriginalTemplateID>int</OriginalTemplateID>
            <Owner xsi:nil="true" />
            <Relation xsi:nil="true" />
            <Status>Draft or Approved or Archived</Status>
            <DateCreated>dateTime</DateCreated>
            <DateLastModified>dateTime</DateLastModified>
            <Html>string</Html>
            <Fields xsi:nil="true" />
            <Delete>boolean</Delete>
          </Proposal>
          <Proposal>
            <ProposalID>int</ProposalID>
            <Name>string</Name>
            <Value>double</Value>
            <OriginalTemplateID>int</OriginalTemplateID>
            <Owner xsi:nil="true" />
            <Relation xsi:nil="true" />
            <Status>Draft or Approved or Archived</Status>
            <DateCreated>dateTime</DateCreated>
            <DateLastModified>dateTime</DateLastModified>
            <Html>string</Html>
            <Fields xsi:nil="true" />
            <Delete>boolean</Delete>
          </Proposal>
        </Results>
      </GetProposalSearchResultsResult>
    </GetProposalSearchResultsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /xml HTTP/1.1
Host: admin.worketc.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetProposalSearchResults xmlns="http://schema.veetro.com">
      <e>
        <StartIndex>int</StartIndex>
        <FetchSize>int</FetchSize>
        <Sort>ProposalID or DateCreated or DateLastModified</Sort>
        <Ascending>boolean</Ascending>
        <TemplateID>int</TemplateID>
        <EntityID_Relation>int</EntityID_Relation>
        <EntityID_Owner>int</EntityID_Owner>
      </e>
    </GetProposalSearchResults>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetProposalSearchResultsResponse xmlns="http://schema.veetro.com">
      <GetProposalSearchResultsResult>
        <RecordCount>int</RecordCount>
        <Description>string</Description>
        <FetchSize>int</FetchSize>
        <StartIndex>int</StartIndex>
        <EndIndex>int</EndIndex>
        <Results>
          <Proposal>
            <ProposalID>int</ProposalID>
            <Name>string</Name>
            <Value>double</Value>
            <OriginalTemplateID>int</OriginalTemplateID>
            <Owner xsi:nil="true" />
            <Relation xsi:nil="true" />
            <Status>Draft or Approved or Archived</Status>
            <DateCreated>dateTime</DateCreated>
            <DateLastModified>dateTime</DateLastModified>
            <Html>string</Html>
            <Fields xsi:nil="true" />
            <Delete>boolean</Delete>
          </Proposal>
          <Proposal>
            <ProposalID>int</ProposalID>
            <Name>string</Name>
            <Value>double</Value>
            <OriginalTemplateID>int</OriginalTemplateID>
            <Owner xsi:nil="true" />
            <Relation xsi:nil="true" />
            <Status>Draft or Approved or Archived</Status>
            <DateCreated>dateTime</DateCreated>
            <DateLastModified>dateTime</DateLastModified>
            <Html>string</Html>
            <Fields xsi:nil="true" />
            <Delete>boolean</Delete>
          </Proposal>
        </Results>
      </GetProposalSearchResultsResult>
    </GetProposalSearchResultsResponse>
  </soap12:Body>
</soap12:Envelope>