(GET) All Businesses API 

Description

This API Endpoint will allow a customer to retrieve business information from PDS, from the hierarchy

URL

https://apiprod.pdsglobal.com/V2/api/business/V1

There are two non-production environments that can be used for testing.

Request

Mandatory Fields are denoted by *

Type

GET

Headers

Content-Type = application/json

Parameters

Api_key*
This is required for authentication. If you do not have your API key please contact PDS Support (support@pdsglobal.com).

Response

After sending through your data, the API call will return a response entity with a body and a status. The response entity will let you know if the data you sent through was successful or unsuccessful.

Status

200 - HTTP Response OK
400 - HTTP Response Bad Request

-          Missing API Key 
403 - HTTP Response Forbidden

-          Invalid/Incorrect API Key
-          Non “API User” role.
500 - HTTP Response Internal Server Error

Body

Object: ResponseEntity

The ResponseEntity object will contain a string or object value. This will have an error or success message – examples below:
- List of all businesses

- Missing API Key

- Invalid/Incorrect API Key

- Non “API User” role.

 

prev next
Was this article helpful?
0 out of 0 found this helpful

Articles in this section

prev next

Related sections