Is there any official XML-schema (XSD) for the SO REST-API?

Hi!

We have customer that has started to use the built in REST-API in SuperOffice 8.4 R04.
They have the following question

==== 

So far we are only using Person and Contact objects and noticed that those Entities are specified in the wsdl for the SOAP web service: https://community.superoffice.com/documentation/sdk/SO.NetServer.Web.Services/html/Reference-SOAP-Services86-Services86Contact.htm. But when using the REST-API with XML the returned  root objects is ContactEntityWithLinks or PersonEntityWithLinks which is not specified in the wsdl.

 

It wasn’t that hard to figure out the difference between the Entities with links and without (the <_Links>-list) so for now I have created my own schema for Person- and ContactEntityWithLinks that extends Person- and ContactEntity from the wsdl but it would feel better to use the official XML-schema if there is one.

====

Best Regards
Anders

RE: Is there any official XML-schema (XSD) for the SO REST-API?

Hi Anders,

Correct, SOAP WSDL != REST Schema. The closest think you have to a REST schema is the swagger files:

https://community.superoffice.com/documentation/sdk/SO.NetServer.Web.Services/swagger/Swagger-v1-REST.json
https://community.superoffice.com/documentation/sdk/SO.NetServer.Web.Services/swagger/Swagger-v1-Agents.json

Other than that, please see the WebAPI REST documentation for the structure of the REST API's:

https://community.superoffice.com/documentation/sdk/SO.NetServer.Web.Services/html/v1ContactEntity_GetContactEntity.htm
https://community.superoffice.com/documentation/sdk/SO.NetServer.Web.Services/html/v1PersonEntity_GetPersonEntity.htm

Best regards.

By: Tony Yates 16 Jan 2019

RE: Is there any official XML-schema (XSD) for the SO REST-API?

Thanks Tony!

I will tell the customer to look at you answers.

Best regards
/Anders

By: Anders Larsson 17 Jan 2019