Viviot.Api

<back to all web services

GetServiceExternalProducts

Requires Authentication
Requires any of the roles:Admin, TenantAdmin, MarketplaceAdmin
The following routes are available for this service:
GET/service/products/externalGets a list of external products for a given external invoicing provider Id.
GetServiceExternalProducts Parameters:
NameParameterData TypeRequiredDescription
InvoicingProviderIdquerystringYesExternal invoicing provider Id (GUID)
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
ServiceExternalProductsResponse Parameters:
NameParameterData TypeRequiredDescription
DataformDictionary<int, string>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /service/products/external HTTP/1.1 
Host: api.4spaces.io 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"data":{"0":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}