TemplateService
Templates are specially customized tabs throughout the Finago Office system that are set up for our clients by one of our consultants. Once set up, the client can set custom values for a given customer, project, sales opportunity and other elements in the Finago Office system.
TemplateServiceTemplateService WSDL
Guides
Getting Data
To get data from a template you send a request to GetTemplateList to identify the template you wish to use.
You can then send a request to GetTemplateValues to get a list of field values for a given templateId, idType and id. The id specified is for the given type, so if the idType is Customer the id must be a Customer Id. If the idType is Project the id must be a Project Id and so on. You can get a list of Type Ids by sending a request to GetTypeDefinitions.
Send a request to GetTemplateFields to get a list with a description of all the fields for a given template.
Saving Data
When saving data you need to Specify:
- FieldId (This is set if you are updating an existing value. You get the value from GetTemplateFields )
- Value (the value you wish to save)
- OrderId
- TemplateId (which you get from GetTemplates)
- Id (e.g. Customer Id, Project Id)
If you want to set an option, e.g. in a dropdown menu, you send a request to GetTemplateFieldOptions to get the value for the option you wish to specify.
Methods
| Method | Input type | Return type | Description |
|---|---|---|---|
| GetTemplateList | - | Template[] | Returns a list of templates |
| GetTemplateFields | templateId | TemplateField[] | Returns a list of TemplateFields for the specified template |
| GetTemplateFieldOptions | templateId, fieldId | KeyValuePair[] | Returns a list of the field options for the specified field. Key = Option Id, Value = Option Name. |
| GetTemplateValues | Int32, TemplateType, Int32 | TemplateValue[] | Gets a list of values for the specified template and type id |
| SaveTemplateValues | TemplateValue[] | Saves the template values. Date values must be XML-formatted (yyyy-MM-ddThh:mm:ssZ) | |
| GetTypeDefinitions | - | KeyValuePair | Gets a list of id types. Key = Id, Value = Name |
| DeleteTemplateValues | TemplateValue[] | Int | Deletes a list of Template Values |