GetSites
- Morten Lindequist Køhler
- Michael Engesgaard (Unlicensed)
GetSites, not surprisingly, are used to retrieve any information about sites. In many installations, you do not really have anything to say about sites in Perfion, but in case you do, GetSites-method is available.
GetSites | |||
Parameters | Name | Mandatory | Description |
Channel | Yes | The channel you want sites from must be supplied. | |
Keys | No | The list of KeyField values for the sites you want fetched. | |
IncludeMappings | No | Specifies which mappings should be included. If nothing is specified all mappings are included. | |
ExcludeMappings | No | Specifies which mappings should be excluded. If nothing is specified it is assumed to that no mappings are excluded. | |
ForcedBinaryOutputKind | No | How binaries are output is controlled on the mapping. This parameter overrides the mapping and forces binaries to be output. Possible values are None, Url, File and Embedded. | |
IncludeModificationDates | No | When set to true, modification dates will be output on all elements in result. | |
IncludePerfionNamesOnFields | No | When set to true, the name of the feature from which a field comes from is added to output. | |
IncludePerfionItemIdsOnSelectables | No | When set to true, the id of a selectable feature output to a Field will be added to the output. | |
RemoveUnwantedFeaturesByConfiguration | No | When set to true, a wild-card mapping will only return Features/Fields which are configured for each individual item. | |
TimeZone | No | Available from Perfion 4.7 this parameter allows you to control in which time zone that is used to output modification dates when IncludeModificationDates is enabled. If this parameter is not supplied, the time zone supplied in Settings will be used (See section Timezone). If no time zone is supplied here either, the time zone of the Perfion Database will be used. This was also the time zone used by the EC API in earlier versions of Perfion. | |
OutputMultiValueFieldsIndividually | No | Available from Perfion 2024 R1 SR2: You can now output multi value features mapped to Fields as individual Fields-elements instead of the default of Value-subelements or a value attribute. | |
Sample Mappings |
| ||
Sample Data |
| ||
Sample request | <Execute method="GetSites" refreshconfiguration="true">
<Parameter id="Channel" value="My Channel" />
</Execute> | ||
Sample result | <Response>
<Result>
<Channel name="My Channel">
<Sites>
<Site id="1084">
<Fields>
<Field name="SiteId">Site A</Field>
<Field name="Name" culture="en-US">My Site</Field>
</Fields>
</Site>
<Site id="1172">
<Fields>
<Field name="SiteId">Site B</Field>
<Field name="Name" culture="en-US">My US Site</Field>
</Fields>
</Site>
</Sites>
</Channel>
</Result>
</Response> | ||
Table 1: GetSites-method.
All parameters supported by GetSites are working same as the same named parameter in GetProducts and GetCategories.
Note: GetSites fetches only root-item being of type “Catalog”. Neither Virtuals or Normals are fetched. If your root-items got the wrong type you can use “Convert”-function in the Perfion interface.