Veetro Web Service Methods
Click here for a complete list of operations.
GetCustomerPortalSettings
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.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/GetCustomerPortalSettings"
<?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>
<GetCustomerPortalSettings xmlns="http://schema.veetro.com" />
</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>
<GetCustomerPortalSettingsResponse xmlns="http://schema.veetro.com">
<GetCustomerPortalSettingsResult>
<SupportEmail>string</SupportEmail>
<EnableCustomBranding>boolean</EnableCustomBranding>
<AllowCustomCredits>boolean</AllowCustomCredits>
<CustomCompanyName>string</CustomCompanyName>
<CustomTagline>string</CustomTagline>
<CustomDashboardMessage>string</CustomDashboardMessage>
<LoginPage>string</LoginPage>
<CustomGreetingMessage>string</CustomGreetingMessage>
<CustomLogoEnabled>boolean</CustomLogoEnabled>
<CustomLogo>string</CustomLogo>
<CustomLogoUrl>string</CustomLogoUrl>
<CustomLoginLogo>string</CustomLoginLogo>
<CustomLoginLogoUrl>string</CustomLoginLogoUrl>
<LoginLayout>string</LoginLayout>
<CustomCSS>string</CustomCSS>
<Subdomain>string</Subdomain>
<AllowCustomDomainHandling>boolean</AllowCustomDomainHandling>
<CustomDomainName>string</CustomDomainName>
<ForceSSL>boolean</ForceSSL>
<OrganizationCulture>string</OrganizationCulture>
<OrganizationCustCurrencySymbol>string</OrganizationCustCurrencySymbol>
<ColorChoices>
<MainColor>string</MainColor>
<DarkHue>string</DarkHue>
<LightHue>string</LightHue>
<MenuHover>string</MenuHover>
<AlternateMain>string</AlternateMain>
<Anchors>string</Anchors>
</ColorChoices>
<FooterLinks>
<Links>
<FooterLink xsi:nil="true" />
<FooterLink xsi:nil="true" />
</Links>
</FooterLinks>
<ShowLegacyCustomersFooter>boolean</ShowLegacyCustomersFooter>
<SupportCaseNameCustomized>boolean</SupportCaseNameCustomized>
<SupportCaseSingularName>string</SupportCaseSingularName>
<SupportCasePluralName>string</SupportCasePluralName>
<EnableDeadlineForSupportCases>boolean</EnableDeadlineForSupportCases>
<ToDoNameCustomized>boolean</ToDoNameCustomized>
<ToDoNameSingular>string</ToDoNameSingular>
<ToDoNamePlural>string</ToDoNamePlural>
<Timezone>string</Timezone>
<TimezoneName>string</TimezoneName>
<StartHour>int</StartHour>
<EndHour>int</EndHour>
<StartOfWeekDay>Sunday or Monday or Tuesday or Wednesday or Thursday or Friday or Saturday</StartOfWeekDay>
<Priorities>
<EntryCustomStages>
<ID>int</ID>
<Ranking>int</Ranking>
<Value>int</Value>
<Label>string</Label>
<PortalLabel>string</PortalLabel>
<Colour>string</Colour>
<IsSysStage>boolean</IsSysStage>
<IsCompletedStage>boolean</IsCompletedStage>
<Description>string</Description>
<ForeColor>string</ForeColor>
<IsDarkColor>boolean</IsDarkColor>
</EntryCustomStages>
<EntryCustomStages>
<ID>int</ID>
<Ranking>int</Ranking>
<Value>int</Value>
<Label>string</Label>
<PortalLabel>string</PortalLabel>
<Colour>string</Colour>
<IsSysStage>boolean</IsSysStage>
<IsCompletedStage>boolean</IsCompletedStage>
<Description>string</Description>
<ForeColor>string</ForeColor>
<IsDarkColor>boolean</IsDarkColor>
</EntryCustomStages>
</Priorities>
<Categories>
<SupportCaseType>
<SupportCaseTypeID>int</SupportCaseTypeID>
<Name>string</Name>
<IncludeInCustomerPortal>boolean</IncludeInCustomerPortal>
<Delete>boolean</Delete>
<RemoveParentLinks>boolean</RemoveParentLinks>
</SupportCaseType>
<SupportCaseType>
<SupportCaseTypeID>int</SupportCaseTypeID>
<Name>string</Name>
<IncludeInCustomerPortal>boolean</IncludeInCustomerPortal>
<Delete>boolean</Delete>
<RemoveParentLinks>boolean</RemoveParentLinks>
</SupportCaseType>
</Categories>
<IsCompanyAccount>boolean</IsCompanyAccount>
<SPCustomSettings>
<Option>LeaveTicketsUnassigned or AssignAlwaysToList or ChooseFromList</Option>
<ContactsList>string</ContactsList>
</SPCustomSettings>
<ShortDatePattern>string</ShortDatePattern>
<ShortTimePattern>string</ShortTimePattern>
</GetCustomerPortalSettingsResult>
</GetCustomerPortalSettingsResponse>
</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>
<GetCustomerPortalSettings xmlns="http://schema.veetro.com" />
</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>
<GetCustomerPortalSettingsResponse xmlns="http://schema.veetro.com">
<GetCustomerPortalSettingsResult>
<SupportEmail>string</SupportEmail>
<EnableCustomBranding>boolean</EnableCustomBranding>
<AllowCustomCredits>boolean</AllowCustomCredits>
<CustomCompanyName>string</CustomCompanyName>
<CustomTagline>string</CustomTagline>
<CustomDashboardMessage>string</CustomDashboardMessage>
<LoginPage>string</LoginPage>
<CustomGreetingMessage>string</CustomGreetingMessage>
<CustomLogoEnabled>boolean</CustomLogoEnabled>
<CustomLogo>string</CustomLogo>
<CustomLogoUrl>string</CustomLogoUrl>
<CustomLoginLogo>string</CustomLoginLogo>
<CustomLoginLogoUrl>string</CustomLoginLogoUrl>
<LoginLayout>string</LoginLayout>
<CustomCSS>string</CustomCSS>
<Subdomain>string</Subdomain>
<AllowCustomDomainHandling>boolean</AllowCustomDomainHandling>
<CustomDomainName>string</CustomDomainName>
<ForceSSL>boolean</ForceSSL>
<OrganizationCulture>string</OrganizationCulture>
<OrganizationCustCurrencySymbol>string</OrganizationCustCurrencySymbol>
<ColorChoices>
<MainColor>string</MainColor>
<DarkHue>string</DarkHue>
<LightHue>string</LightHue>
<MenuHover>string</MenuHover>
<AlternateMain>string</AlternateMain>
<Anchors>string</Anchors>
</ColorChoices>
<FooterLinks>
<Links>
<FooterLink xsi:nil="true" />
<FooterLink xsi:nil="true" />
</Links>
</FooterLinks>
<ShowLegacyCustomersFooter>boolean</ShowLegacyCustomersFooter>
<SupportCaseNameCustomized>boolean</SupportCaseNameCustomized>
<SupportCaseSingularName>string</SupportCaseSingularName>
<SupportCasePluralName>string</SupportCasePluralName>
<EnableDeadlineForSupportCases>boolean</EnableDeadlineForSupportCases>
<ToDoNameCustomized>boolean</ToDoNameCustomized>
<ToDoNameSingular>string</ToDoNameSingular>
<ToDoNamePlural>string</ToDoNamePlural>
<Timezone>string</Timezone>
<TimezoneName>string</TimezoneName>
<StartHour>int</StartHour>
<EndHour>int</EndHour>
<StartOfWeekDay>Sunday or Monday or Tuesday or Wednesday or Thursday or Friday or Saturday</StartOfWeekDay>
<Priorities>
<EntryCustomStages>
<ID>int</ID>
<Ranking>int</Ranking>
<Value>int</Value>
<Label>string</Label>
<PortalLabel>string</PortalLabel>
<Colour>string</Colour>
<IsSysStage>boolean</IsSysStage>
<IsCompletedStage>boolean</IsCompletedStage>
<Description>string</Description>
<ForeColor>string</ForeColor>
<IsDarkColor>boolean</IsDarkColor>
</EntryCustomStages>
<EntryCustomStages>
<ID>int</ID>
<Ranking>int</Ranking>
<Value>int</Value>
<Label>string</Label>
<PortalLabel>string</PortalLabel>
<Colour>string</Colour>
<IsSysStage>boolean</IsSysStage>
<IsCompletedStage>boolean</IsCompletedStage>
<Description>string</Description>
<ForeColor>string</ForeColor>
<IsDarkColor>boolean</IsDarkColor>
</EntryCustomStages>
</Priorities>
<Categories>
<SupportCaseType>
<SupportCaseTypeID>int</SupportCaseTypeID>
<Name>string</Name>
<IncludeInCustomerPortal>boolean</IncludeInCustomerPortal>
<Delete>boolean</Delete>
<RemoveParentLinks>boolean</RemoveParentLinks>
</SupportCaseType>
<SupportCaseType>
<SupportCaseTypeID>int</SupportCaseTypeID>
<Name>string</Name>
<IncludeInCustomerPortal>boolean</IncludeInCustomerPortal>
<Delete>boolean</Delete>
<RemoveParentLinks>boolean</RemoveParentLinks>
</SupportCaseType>
</Categories>
<IsCompanyAccount>boolean</IsCompanyAccount>
<SPCustomSettings>
<Option>LeaveTicketsUnassigned or AssignAlwaysToList or ChooseFromList</Option>
<ContactsList>string</ContactsList>
</SPCustomSettings>
<ShortDatePattern>string</ShortDatePattern>
<ShortTimePattern>string</ShortTimePattern>
</GetCustomerPortalSettingsResult>
</GetCustomerPortalSettingsResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
GET /xml/GetCustomerPortalSettings? HTTP/1.1 Host: admin.worketc.com
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<CustomerPortalSettings xmlns="http://schema.veetro.com">
<SupportEmail>string</SupportEmail>
<EnableCustomBranding>boolean</EnableCustomBranding>
<AllowCustomCredits>boolean</AllowCustomCredits>
<CustomCompanyName>string</CustomCompanyName>
<CustomTagline>string</CustomTagline>
<CustomDashboardMessage>string</CustomDashboardMessage>
<LoginPage>string</LoginPage>
<CustomGreetingMessage>string</CustomGreetingMessage>
<CustomLogoEnabled>boolean</CustomLogoEnabled>
<CustomLogo>string</CustomLogo>
<CustomLogoUrl>string</CustomLogoUrl>
<CustomLoginLogo>string</CustomLoginLogo>
<CustomLoginLogoUrl>string</CustomLoginLogoUrl>
<LoginLayout>string</LoginLayout>
<CustomCSS>string</CustomCSS>
<Subdomain>string</Subdomain>
<AllowCustomDomainHandling>boolean</AllowCustomDomainHandling>
<CustomDomainName>string</CustomDomainName>
<ForceSSL>boolean</ForceSSL>
<OrganizationCulture>string</OrganizationCulture>
<OrganizationCustCurrencySymbol>string</OrganizationCustCurrencySymbol>
<ColorChoices>
<MainColor>string</MainColor>
<DarkHue>string</DarkHue>
<LightHue>string</LightHue>
<MenuHover>string</MenuHover>
<AlternateMain>string</AlternateMain>
<Anchors>string</Anchors>
</ColorChoices>
<FooterLinks>
<Links>
<FooterLink>
<Guid>string</Guid>
<Anchor>string</Anchor>
<Url>string</Url>
<IsNewTab>boolean</IsNewTab>
</FooterLink>
<FooterLink>
<Guid>string</Guid>
<Anchor>string</Anchor>
<Url>string</Url>
<IsNewTab>boolean</IsNewTab>
</FooterLink>
</Links>
</FooterLinks>
<ShowLegacyCustomersFooter>boolean</ShowLegacyCustomersFooter>
<SupportCaseNameCustomized>boolean</SupportCaseNameCustomized>
<SupportCaseSingularName>string</SupportCaseSingularName>
<SupportCasePluralName>string</SupportCasePluralName>
<EnableDeadlineForSupportCases>boolean</EnableDeadlineForSupportCases>
<ToDoNameCustomized>boolean</ToDoNameCustomized>
<ToDoNameSingular>string</ToDoNameSingular>
<ToDoNamePlural>string</ToDoNamePlural>
<Timezone>string</Timezone>
<TimezoneName>string</TimezoneName>
<StartHour>int</StartHour>
<EndHour>int</EndHour>
<StartOfWeekDay>Sunday or Monday or Tuesday or Wednesday or Thursday or Friday or Saturday</StartOfWeekDay>
<Priorities>
<EntryCustomStages>
<ID>int</ID>
<Ranking>int</Ranking>
<Value>int</Value>
<Label>string</Label>
<PortalLabel>string</PortalLabel>
<Colour>string</Colour>
<IsSysStage>boolean</IsSysStage>
<IsCompletedStage>boolean</IsCompletedStage>
<Description>string</Description>
<ForeColor>string</ForeColor>
<IsDarkColor>boolean</IsDarkColor>
</EntryCustomStages>
<EntryCustomStages>
<ID>int</ID>
<Ranking>int</Ranking>
<Value>int</Value>
<Label>string</Label>
<PortalLabel>string</PortalLabel>
<Colour>string</Colour>
<IsSysStage>boolean</IsSysStage>
<IsCompletedStage>boolean</IsCompletedStage>
<Description>string</Description>
<ForeColor>string</ForeColor>
<IsDarkColor>boolean</IsDarkColor>
</EntryCustomStages>
</Priorities>
<Categories>
<SupportCaseType>
<SupportCaseTypeID>int</SupportCaseTypeID>
<Name>string</Name>
<IncludeInCustomerPortal>boolean</IncludeInCustomerPortal>
<Delete>boolean</Delete>
<RemoveParentLinks>boolean</RemoveParentLinks>
</SupportCaseType>
<SupportCaseType>
<SupportCaseTypeID>int</SupportCaseTypeID>
<Name>string</Name>
<IncludeInCustomerPortal>boolean</IncludeInCustomerPortal>
<Delete>boolean</Delete>
<RemoveParentLinks>boolean</RemoveParentLinks>
</SupportCaseType>
</Categories>
<IsCompanyAccount>boolean</IsCompanyAccount>
<SPCustomSettings>
<Option>LeaveTicketsUnassigned or AssignAlwaysToList or ChooseFromList</Option>
<ContactsList>string</ContactsList>
</SPCustomSettings>
<ShortDatePattern>string</ShortDatePattern>
<ShortTimePattern>string</ShortTimePattern>
</CustomerPortalSettings>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /xml/GetCustomerPortalSettings HTTP/1.1 Host: admin.worketc.com Content-Type: application/x-www-form-urlencoded Content-Length: length
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<CustomerPortalSettings xmlns="http://schema.veetro.com">
<SupportEmail>string</SupportEmail>
<EnableCustomBranding>boolean</EnableCustomBranding>
<AllowCustomCredits>boolean</AllowCustomCredits>
<CustomCompanyName>string</CustomCompanyName>
<CustomTagline>string</CustomTagline>
<CustomDashboardMessage>string</CustomDashboardMessage>
<LoginPage>string</LoginPage>
<CustomGreetingMessage>string</CustomGreetingMessage>
<CustomLogoEnabled>boolean</CustomLogoEnabled>
<CustomLogo>string</CustomLogo>
<CustomLogoUrl>string</CustomLogoUrl>
<CustomLoginLogo>string</CustomLoginLogo>
<CustomLoginLogoUrl>string</CustomLoginLogoUrl>
<LoginLayout>string</LoginLayout>
<CustomCSS>string</CustomCSS>
<Subdomain>string</Subdomain>
<AllowCustomDomainHandling>boolean</AllowCustomDomainHandling>
<CustomDomainName>string</CustomDomainName>
<ForceSSL>boolean</ForceSSL>
<OrganizationCulture>string</OrganizationCulture>
<OrganizationCustCurrencySymbol>string</OrganizationCustCurrencySymbol>
<ColorChoices>
<MainColor>string</MainColor>
<DarkHue>string</DarkHue>
<LightHue>string</LightHue>
<MenuHover>string</MenuHover>
<AlternateMain>string</AlternateMain>
<Anchors>string</Anchors>
</ColorChoices>
<FooterLinks>
<Links>
<FooterLink>
<Guid>string</Guid>
<Anchor>string</Anchor>
<Url>string</Url>
<IsNewTab>boolean</IsNewTab>
</FooterLink>
<FooterLink>
<Guid>string</Guid>
<Anchor>string</Anchor>
<Url>string</Url>
<IsNewTab>boolean</IsNewTab>
</FooterLink>
</Links>
</FooterLinks>
<ShowLegacyCustomersFooter>boolean</ShowLegacyCustomersFooter>
<SupportCaseNameCustomized>boolean</SupportCaseNameCustomized>
<SupportCaseSingularName>string</SupportCaseSingularName>
<SupportCasePluralName>string</SupportCasePluralName>
<EnableDeadlineForSupportCases>boolean</EnableDeadlineForSupportCases>
<ToDoNameCustomized>boolean</ToDoNameCustomized>
<ToDoNameSingular>string</ToDoNameSingular>
<ToDoNamePlural>string</ToDoNamePlural>
<Timezone>string</Timezone>
<TimezoneName>string</TimezoneName>
<StartHour>int</StartHour>
<EndHour>int</EndHour>
<StartOfWeekDay>Sunday or Monday or Tuesday or Wednesday or Thursday or Friday or Saturday</StartOfWeekDay>
<Priorities>
<EntryCustomStages>
<ID>int</ID>
<Ranking>int</Ranking>
<Value>int</Value>
<Label>string</Label>
<PortalLabel>string</PortalLabel>
<Colour>string</Colour>
<IsSysStage>boolean</IsSysStage>
<IsCompletedStage>boolean</IsCompletedStage>
<Description>string</Description>
<ForeColor>string</ForeColor>
<IsDarkColor>boolean</IsDarkColor>
</EntryCustomStages>
<EntryCustomStages>
<ID>int</ID>
<Ranking>int</Ranking>
<Value>int</Value>
<Label>string</Label>
<PortalLabel>string</PortalLabel>
<Colour>string</Colour>
<IsSysStage>boolean</IsSysStage>
<IsCompletedStage>boolean</IsCompletedStage>
<Description>string</Description>
<ForeColor>string</ForeColor>
<IsDarkColor>boolean</IsDarkColor>
</EntryCustomStages>
</Priorities>
<Categories>
<SupportCaseType>
<SupportCaseTypeID>int</SupportCaseTypeID>
<Name>string</Name>
<IncludeInCustomerPortal>boolean</IncludeInCustomerPortal>
<Delete>boolean</Delete>
<RemoveParentLinks>boolean</RemoveParentLinks>
</SupportCaseType>
<SupportCaseType>
<SupportCaseTypeID>int</SupportCaseTypeID>
<Name>string</Name>
<IncludeInCustomerPortal>boolean</IncludeInCustomerPortal>
<Delete>boolean</Delete>
<RemoveParentLinks>boolean</RemoveParentLinks>
</SupportCaseType>
</Categories>
<IsCompanyAccount>boolean</IsCompanyAccount>
<SPCustomSettings>
<Option>LeaveTicketsUnassigned or AssignAlwaysToList or ChooseFromList</Option>
<ContactsList>string</ContactsList>
</SPCustomSettings>
<ShortDatePattern>string</ShortDatePattern>
<ShortTimePattern>string</ShortTimePattern>
</CustomerPortalSettings>