Follow

API release notes for April 2015 release

The following changes will be released to Visma Severa's API in the next release (2015):

General changes to API

Change (identifier)

Error logging of API has been improved so that errors, which come from API, contain only relevant information. (4567)
When a validation error happens, API was previously throwing GeneralFailureException. Now these have been changed to ValidationException.
When an invalid GUID is used in API call, exception is GeneralFailureException. This change applies for example to methods that have been named "Get..ByGUID".

Interface changes

Interface name

Change (identifier)

IAccount AddNewAccount method: If addressInfo was not given and contactInfo was given, error occurred because non existing address was tried to assign to the contact. Fixed so that address is only assigned to contact when it has been given. (4437)
IAccountGroup AddNewAccountGroup method documentation has been improved. When adding a new account group, it is automatically updated as Active, regardless of IsActive information in the entity. (4437)
IActivityType AddNewActivityType method documentation has been improved. When adding a new activity type, it is automatically updated as Active, regardless of IsActive information in the entity. (4437)
IActivityType AddNewActivityType method throws ValidationException when given activity type does not meet validation rules.
ICase Adding account's contact person to a case of different account was possible. This has been fixed so that contact person of a case can be only from the case's account. (4641)
ICase Adding user as case member wasn't working if user had been a member on the case before, and membership had been removed. This has been fixed so that user can be added as case member. (3491)
IContact AddNewContact method throws ValidationException when given contact does not meet validation rules.
IExtranet Added new contract to API. Contains two methods: GetExtranetCaseByCaseGUID, which provides Extranet sharing information of a case, and GetExtranetContactCaseRightsByContactGUID, which tells what rights each contact person has in Extranet. This feature can be used when there is a service which provides "extranet-like" functionality to customer's contact persons. See more from Extranet sharing article in support portal. (3665)
IHourEntry AddNewHourEntry method had incorrect documentation, which has been corrected. (4602)
IHourEntry AddNewHourEntry method throws ValidationException when given entry does not meet validation rules. Previously it was throwing GeneralFailureException.
IIndustry AddNewIndustry method documentation has been improved. When adding a new industry, it is automatically updated as Active, regardless of IsActive information in the entity. (4437)
IInvoice GetInvoicesByStatus method has new parameter maxInvoices. It can be used to provide the maximum amount of invoices to return in the API call. By default there is no limit, which means that there is no change in the behavior of the method. (2568)
IItem AddNewItem method throws GeneralFailureException instead of FaultException.
IResource AddNewResource method documentation has been improved. When adding a new resource, it is automatically updated as Active, regardless of IsActive information in the entity. (4437)
ITag AddNewCaseTag, AddNewFileTag, AddNewUserTag and AddNewContactTag method documentations have been improved. When adding a new tag, it is automatically updated as Active, regardless of IsActive information in the entity. (4437)
IUser AddNewUser method documentation has been improved. When adding a new user, it is automatically updated as Active, regardless of IsActive information in the entity. (4437)
IWorkType AddNewWorkType method documentation has been improved. When adding a new work type, it is automatically updated as Active, regardless of IsActive information in the entity. (4437)

Entity changes

Entity name

Change (identifier)

Account Documentation regarding InsertTs and UpdateTs has been improved. (3288)
ActivityType Documentation has been improved to contain allowed values for Category and Icon members exactly as they should be entered. (4437)
BusinessUnit Documentation regarding InsertTs and UpdateTs has been improved. (3288)
Case Documentation regarding InsertTs and UpdateTs has been improved. (3288)
Case Added CurrentCaseStatusInsertTs: The time in UTC when the case got its current status. (3659)
Case Added SharedToExtranet: Tells if the case in question has been shared to be shown in Extranet. See more from Extranet sharing article in support portal. (3665)
ExtranetCase New entity, which contains information about Severa's case which has been shared to Extranet for customers to view. See more from Extranet sharing article in support portal. (3665)
ExtranetCaseRights New entity containing information about what case details are available in Extranet to be viewed. See more from Extranet sharing article in support portal. (3665)
ExtranetContact New entity, which represents account contact as Extranet user. See more from Extranet sharing article in support portal. (3665)
ExtranetContactCaseRights New entity, which contains information about contact's access rights to a certain case in Extranet. See more from Extranet sharing article in support portal. (3665)
ExtranetContactRights New entity, which contains information about contact's access rights to Extranet functionality. See more from Extranet sharing article in support portal. (3665)
Search Visible in API documentation even contained no functionality. (4707)
SearchResultColumn Visible in API documentation even contained no functionality. (4707)

Other changes

API documentation formatting has been improved. (4541)
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Powered by Zendesk