Veetro Web Service Methods Web Service

Veetro Web Service Methods

Click here for a complete list of operations.

GetWebFormsWebSafe

[Permission: Any Authenticated]
Gets Proposal document search results having Proposal.Type Form

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/GetWebFormsWebSafe"

<?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>
    <GetWebFormsWebSafe xmlns="http://schema.veetro.com">
      <e>
        <PageSize>int</PageSize>
        <Index>int</Index>
        <SearchKeyword>string</SearchKeyword>
        <SortAsc>boolean</SortAsc>
        <SortBy>string</SortBy>
        <EntityID>int</EntityID>
      </e>
    </GetWebFormsWebSafe>
  </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>
    <GetWebFormsWebSafeResponse xmlns="http://schema.veetro.com">
      <GetWebFormsWebSafeResult>
        <RecordCount>int</RecordCount>
        <Description>string</Description>
        <FetchSize>int</FetchSize>
        <StartIndex>int</StartIndex>
        <EndIndex>int</EndIndex>
        <Results>
          <Template>
            <Type>Form or Email or Letter or Invoice</Type>
            <TemplateID>int</TemplateID>
            <Notifications xsi:nil="true" />
            <Name>string</Name>
            <Description>string</Description>
            <ConfirmationInfo>string</ConfirmationInfo>
            <OriginalFileName>string</OriginalFileName>
            <DateModified>dateTime</DateModified>
            <Html>string</Html>
            <Plain>string</Plain>
            <Subject>string</Subject>
            <EmailFrom>string</EmailFrom>
            <EmailFromName>string</EmailFromName>
            <Fields xsi:nil="true" />
            <MailingLists xsi:nil="true" />
            <MailingStarted>boolean</MailingStarted>
            <Flags>None or Creates_Lead_Profile or Creates_Support_Case or Auto_Archive or Group_Timesheet_Activities or Group_Timesheet_Root_Projects or Group_Timesheet_Sub_Projects or Group_Timesheet_ByDay or Label_Top_Aligned or Label_Left_Aligned or WebForm_Confirmation_Show_Text or WebForm_Confirmation_Redirect or WebForm_Creates_Account or WebForm_Captcha_On or WebForm_Captcha_Off or WebForm_Disable_Account_Updates or WebForm_Send_Confirmation_Email or WebForm_Send_Notification_Email or Login_Required or Disable_Support_Case_AutoReply or WebForm_CP_ShowAllUsers or WebForm_CP_ShowUserList or WebForm_CP_ShowUserTags or WebForm_CP_Internal</Flags>
            <ConfirmationConfig xsi:nil="true" />
            <ObjectCreationConfig xsi:nil="true" />
            <Delete>boolean</Delete>
            <RemoveParentLinks>boolean</RemoveParentLinks>
            <SubmissionCount>int</SubmissionCount>
          </Template>
          <Template>
            <Type>Form or Email or Letter or Invoice</Type>
            <TemplateID>int</TemplateID>
            <Notifications xsi:nil="true" />
            <Name>string</Name>
            <Description>string</Description>
            <ConfirmationInfo>string</ConfirmationInfo>
            <OriginalFileName>string</OriginalFileName>
            <DateModified>dateTime</DateModified>
            <Html>string</Html>
            <Plain>string</Plain>
            <Subject>string</Subject>
            <EmailFrom>string</EmailFrom>
            <EmailFromName>string</EmailFromName>
            <Fields xsi:nil="true" />
            <MailingLists xsi:nil="true" />
            <MailingStarted>boolean</MailingStarted>
            <Flags>None or Creates_Lead_Profile or Creates_Support_Case or Auto_Archive or Group_Timesheet_Activities or Group_Timesheet_Root_Projects or Group_Timesheet_Sub_Projects or Group_Timesheet_ByDay or Label_Top_Aligned or Label_Left_Aligned or WebForm_Confirmation_Show_Text or WebForm_Confirmation_Redirect or WebForm_Creates_Account or WebForm_Captcha_On or WebForm_Captcha_Off or WebForm_Disable_Account_Updates or WebForm_Send_Confirmation_Email or WebForm_Send_Notification_Email or Login_Required or Disable_Support_Case_AutoReply or WebForm_CP_ShowAllUsers or WebForm_CP_ShowUserList or WebForm_CP_ShowUserTags or WebForm_CP_Internal</Flags>
            <ConfirmationConfig xsi:nil="true" />
            <ObjectCreationConfig xsi:nil="true" />
            <Delete>boolean</Delete>
            <RemoveParentLinks>boolean</RemoveParentLinks>
            <SubmissionCount>int</SubmissionCount>
          </Template>
        </Results>
      </GetWebFormsWebSafeResult>
    </GetWebFormsWebSafeResponse>
  </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>
    <GetWebFormsWebSafe xmlns="http://schema.veetro.com">
      <e>
        <PageSize>int</PageSize>
        <Index>int</Index>
        <SearchKeyword>string</SearchKeyword>
        <SortAsc>boolean</SortAsc>
        <SortBy>string</SortBy>
        <EntityID>int</EntityID>
      </e>
    </GetWebFormsWebSafe>
  </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>
    <GetWebFormsWebSafeResponse xmlns="http://schema.veetro.com">
      <GetWebFormsWebSafeResult>
        <RecordCount>int</RecordCount>
        <Description>string</Description>
        <FetchSize>int</FetchSize>
        <StartIndex>int</StartIndex>
        <EndIndex>int</EndIndex>
        <Results>
          <Template>
            <Type>Form or Email or Letter or Invoice</Type>
            <TemplateID>int</TemplateID>
            <Notifications xsi:nil="true" />
            <Name>string</Name>
            <Description>string</Description>
            <ConfirmationInfo>string</ConfirmationInfo>
            <OriginalFileName>string</OriginalFileName>
            <DateModified>dateTime</DateModified>
            <Html>string</Html>
            <Plain>string</Plain>
            <Subject>string</Subject>
            <EmailFrom>string</EmailFrom>
            <EmailFromName>string</EmailFromName>
            <Fields xsi:nil="true" />
            <MailingLists xsi:nil="true" />
            <MailingStarted>boolean</MailingStarted>
            <Flags>None or Creates_Lead_Profile or Creates_Support_Case or Auto_Archive or Group_Timesheet_Activities or Group_Timesheet_Root_Projects or Group_Timesheet_Sub_Projects or Group_Timesheet_ByDay or Label_Top_Aligned or Label_Left_Aligned or WebForm_Confirmation_Show_Text or WebForm_Confirmation_Redirect or WebForm_Creates_Account or WebForm_Captcha_On or WebForm_Captcha_Off or WebForm_Disable_Account_Updates or WebForm_Send_Confirmation_Email or WebForm_Send_Notification_Email or Login_Required or Disable_Support_Case_AutoReply or WebForm_CP_ShowAllUsers or WebForm_CP_ShowUserList or WebForm_CP_ShowUserTags or WebForm_CP_Internal</Flags>
            <ConfirmationConfig xsi:nil="true" />
            <ObjectCreationConfig xsi:nil="true" />
            <Delete>boolean</Delete>
            <RemoveParentLinks>boolean</RemoveParentLinks>
            <SubmissionCount>int</SubmissionCount>
          </Template>
          <Template>
            <Type>Form or Email or Letter or Invoice</Type>
            <TemplateID>int</TemplateID>
            <Notifications xsi:nil="true" />
            <Name>string</Name>
            <Description>string</Description>
            <ConfirmationInfo>string</ConfirmationInfo>
            <OriginalFileName>string</OriginalFileName>
            <DateModified>dateTime</DateModified>
            <Html>string</Html>
            <Plain>string</Plain>
            <Subject>string</Subject>
            <EmailFrom>string</EmailFrom>
            <EmailFromName>string</EmailFromName>
            <Fields xsi:nil="true" />
            <MailingLists xsi:nil="true" />
            <MailingStarted>boolean</MailingStarted>
            <Flags>None or Creates_Lead_Profile or Creates_Support_Case or Auto_Archive or Group_Timesheet_Activities or Group_Timesheet_Root_Projects or Group_Timesheet_Sub_Projects or Group_Timesheet_ByDay or Label_Top_Aligned or Label_Left_Aligned or WebForm_Confirmation_Show_Text or WebForm_Confirmation_Redirect or WebForm_Creates_Account or WebForm_Captcha_On or WebForm_Captcha_Off or WebForm_Disable_Account_Updates or WebForm_Send_Confirmation_Email or WebForm_Send_Notification_Email or Login_Required or Disable_Support_Case_AutoReply or WebForm_CP_ShowAllUsers or WebForm_CP_ShowUserList or WebForm_CP_ShowUserTags or WebForm_CP_Internal</Flags>
            <ConfirmationConfig xsi:nil="true" />
            <ObjectCreationConfig xsi:nil="true" />
            <Delete>boolean</Delete>
            <RemoveParentLinks>boolean</RemoveParentLinks>
            <SubmissionCount>int</SubmissionCount>
          </Template>
        </Results>
      </GetWebFormsWebSafeResult>
    </GetWebFormsWebSafeResponse>
  </soap12:Body>
</soap12:Envelope>