Custom_web_services | Community Creatio

Question

10:42 Oct 17, 2024

Hello Creatio Community,

I am working on a project where I need to either replace or override an existing Creatio web service with a custom implementation. Specifically, I want to extend or modify the functionality of a base Creatio web service (e.g., CallServiceSchemaService) to fit my business requirements.

Here’s what I want to achieve:

Create a custom web service in a separate package without affecting the existing functionality of the base service.
Either extend the existing service (if possible) or completely replace it with my custom implementation.
I want to customize the behavior of how service requests and responses are handled, while ensuring that all references to the original service use my new service.

Questions:

What is the best approach to achieve this in Creatio? Should I extend or replace the service, and what are the steps to do so?
How can I ensure that the system references my custom service in place of the base service without breaking existing functionality?
Are there any best practices or limitations I should keep in mind when implementing custom web services in Creatio?

I would appreciate any guidance, examples, or documentation that can help me with this process.

Thank you!

0 comments

Show all comments

Question

Custom web services return hierarchical data

M Khaerul Anwar

10:15 Jul 16, 2024

Hello community,
I want to create API Service from creatio that return object data with the detail (json with hierarchical data). lets say i want to get 'Account' with Orders, Lead, and else that connected with 'Account' in one endpoint.

I think about create Custom web services, anyone have script with similar case or have suggestion for this case?

2 comments

Best reply

Ryan Farley

18:02 Jul 16, 2024

You'll just need to design the objects you're returning and make it something like this:

[DataContract]
public class OrderPayload
{
    [DataMember(Name = "id")]
    public Guid Id { get; set; }
    [DataMember(Name = "Number")]
    public string Number { get; set; }
}
 
[DataContract]
public class AccountPayload
{
    [DataMember(Name = "name")]
    public string Name { get; set; }
    [DataMember(Name = "orders")]
    public List&lt;OrderPayload&gt; Orders { get; set; }
}

Then you populate that as needed in the webserivce. The AccountPayload is the top level of the objects, so that is what the method would return. You'd populate like this (obviously from some data you read from an ESQ etc):

var account = new AccountPayload();
account.Name = "Some account";
 
account.Orders = new List&lt;OrderPayload&gt;();
account.Orders.Add(someOrder1);
account.Orders.Add(someOrder2);
 
// now return account

Hope this helps get you started in the right direction.

Ryan

Ryan Farley

18:02 Jul 16, 2024

You'll just need to design the objects you're returning and make it something like this:

[DataContract]
public class OrderPayload
{
    [DataMember(Name = "id")]
    public Guid Id { get; set; }
    [DataMember(Name = "Number")]
    public string Number { get; set; }
}
 
[DataContract]
public class AccountPayload
{
    [DataMember(Name = "name")]
    public string Name { get; set; }
    [DataMember(Name = "orders")]
    public List&lt;OrderPayload&gt; Orders { get; set; }
}

var account = new AccountPayload();
account.Name = "Some account";
 
account.Orders = new List&lt;OrderPayload&gt;();
account.Orders.Add(someOrder1);
account.Orders.Add(someOrder2);
 
// now return account

Hope this helps get you started in the right direction.

Ryan