BusinessOwnerApi


Delete Business Owner

Delete an existing business owner.

URL

http://apis.wso2.com/api/appm/publisher/v1.1/administration/businessowner/{businessOwnerId}

HTTP Method

DELETE

Scope

appm:administration

CURL Example

curl -X DELETE -H "Authorization: Bearer 68f8872882b2dca493328564942251b6" "http://localhost:9763/api/appm/publisher/v1.1/administration/businessowner/3"

Sample Response

HTTP/1.1 200 OK

Parameters

Type Name Description Schema Default
Path

businessOwnerId

required

Business owner ID.

Integer

Header

If-Match

optional

Validator for conditional requests; based on the ETag.

String

Header

If-Unmodified-Since

optional

Validator for conditional requests; based on the Last Modified header.

String

Responses

HTTP Code Description Schema

200

OK. Resource successfully deleted.

403

Forbidden. The request must be conditional but no condition has been specified.

Error

404

Not Found. Resource to be deleted does not exist.

Error

412

Precondition Failed. The request has not been performed because one of the preconditions is not met.

Error

Get business owners by ID

Get business owners by ID.

URL

http://apis.wso2.com/api/appm/publisher/v1.1/administration/businessowner/{businessOwnerId}

HTTP Method

GET

Scope

appm:read

CURL Example

curl -X GET -H "Authorization: Bearer 68f8872882b2dca493328564942251b6" "http://localhost:9763/api/appm/publisher/v1.1/administration/businessowner/1"

Sample Response

{"site": "test.lk","email": "testOwner@gmail.com","description": "this is a test description","name": "testOwner","properties": [{"isVisible": false,"value": "903334238V","key": "nic"}],"id": 1}

Parameters

Type Name Description Schema Default
Path

businessOwnerId

required

Business owner ID.

Integer

Header

Accept

optional

Media types acceptable for the response. Default is JSON.

String

JSON

Header

If-None-Match

optional

Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource.

String

Responses

HTTP Code Description Schema

200

OK.

BusinessOwner

400

Bad Request. Invalid request or validation error.

Error

403

Forbidden. The request must be conditional but no condition has been specified.

Error

404

Not Found. The resource to be updated does not exist.

Error

Update an existing business owner

Update an existing business owner.

URL

http://apis.wso2.com/api/appm/publisher/v1.1/administration/businessowner/{businessOwnerId}

HTTP Method

PUT

Scope

appm:administration

CURL Example

curl -X PUT -H "Authorization: Bearer 68f8872882b2dca493328564942251b6" -H "Content-Type: application/json" -d '{"site": "sysUser.lk","email": "sysUser@gmail.com","description": "this is a test description","name": "sysUser","properties": [{"isVisible": true,"value": "0112345678","key": "telephone"}],"id": 1}' "http://localhost:9763/api/appm/publisher/v1.1/administration/businessowner/1"

Sample Request

{"site": "newSysUser.lk","email": "newSysUser@gmail.com","description":"this is a test description","name": "sysUser","properties": [{"isVisible": true,"value": "0112345678","key": "telephone"}]}

Sample Response

HTTP/1.1 200 OK

Parameters

Type Name Description Schema Default
Path

businessOwnerId

required

Business owner ID.

Integer

Body

body

required

Business Owner object that needs to be added.

BusinessOwner (BusinessOwner)

Header

Content-Type

required

Media type of the entity in the body. Default is JSON.

String

JSON

Header

If-Match

optional

Validator for conditional requests; based on the ETag.

String

Header

If-Unmodified-Since

optional

Validator for conditional requests; based on the Last Modified header.

String

Responses

HTTP Code Description Schema

200

OK.

400

Bad Request. Invalid request or validation error.

Error

403

Forbidden. The request must be conditional but no condition has been specified.

Error

404

Not Found. The resource to be updated does not exist.

Error

412

Precondition Failed. The request has not been performed because one of the preconditions is not met.

Error

Get all Business owners

Get a list of available Apps qualifying under a given search condition.

URL

http://apis.wso2.com/api/appm/publisher/v1.1/administration/businessowner

HTTP Method

GET

Scope

appm:read

CURL Example

curl -X GET -H "Authorization: Bearer 68f8872882b2dca493328564942251b6" "http://localhost:9763/api/appm/publisher/v1.1/administration/businessowner"

Sample Response

{"businessOwnerList": [{"site": "test.lk","email": "testOwner@gmail.com","description": "this is a test description","name": "testOwner","properties": [{"isVisible": false,"value": "903334238V","key": "nic"}],"id": 1}]}

Parameters

Type Name Description Schema Default
Header

Accept

optional

Media types acceptable for the response. Default is JSON.

String

JSON

Header

If-None-Match

optional

Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource.

String

Responses

HTTP Code Description Schema

200

OK. List of qualifying business owners is returned.

BusinessOwnerList

400

Bad Request. Invalid request or validation error.

Error

403

Forbidden. The request must be conditional but no condition has been specified.

Error

404

Not Found. The resource to be updated does not exist.

Error

Create a new Business Owner

Create a new business owner.

URL

http://apis.wso2.com/api/appm/publisher/v1.1/administration/businessowner

HTTP Method

POST

Scope

appm:administration

CURL Example

curl -X POST -H "Authorization: Bearer 56bbab397e7baa757e6e5847e789727d" -H "Host: 127.0.0.1:9763" -H "Content-Type:application/json" -d '{"site": "testUser.lk","email": "testUser@gmail.com","description": "this is a test description","name":"testUser","properties": [{"isVisible": true,"value": "0112345678","key": "telephone"}]}' "http://localhost:9763/api/appm/publisher/v1.1/administration/businessowner"

Sample Request

{"site": "testUser.lk","email": "testUser@gmail.com","description": "this is a test description","name":"testUser","properties": [{"isVisible": true,"value": "0112345678","key": "telephone"}]}

Sample Response

{"id": 4}

Parameters

Type Name Description Schema Default
Body

body

required

Business Owner object that needs to be added.

BusinessOwner (BusinessOwner)

Header

Content-Type

required

Media type of the entity in the body. Default is JSON.

String

JSON

Header

If-Modified-Since

optional

Validator for conditional requests; based on the Last Modified header of the formerly retrieved variant of the resource.

String

Responses

HTTP Code Description Schema

201

Created. Successful response with the newly created object as the entity in the body. Location header contains the URL of the newly created entity.

BusinessOwner

400

Bad Request. Invalid request or validation error.

Error

415

Unsupported Media Type. The entity of the request was in a not supported format.

Error