Webservice: Tenant

handling of tenants [Commercial editions only]

Index Method Request(s) Response Description
1 deleteTenant sid
tenantId
deletes an existing tenant
2 listTenants sid
tenant gets all existing tenants
3 storeTenant sid
tenant
tenantId creates/updates a tenant; returns the identifier of the created/updated instance
4 getTenantById sid
tenantId
tenant gets a specific tenant by it's identifier
5 getTenant sid
name
tenant gets a specific tenant by it's name

Method #1: deleteTenant

deletes an existing tenant

Request

Name Type Required Multiple Description
     sid
String Y
     tenantId
Long Y

Method #2: listTenants

gets all existing tenants

Request

Name Type Required Multiple Description
     sid
String Y

Response

Name Type Required Multiple Description
     tenant
WSTenant Y Y

Method #3: storeTenant

creates/updates a tenant; returns the identifier of the created/updated instance

Request

Name Type Required Multiple Description
     sid
String Y
     tenant
WSTenant Y

Response

Name Type Required Multiple Description
     tenantId
Long Y

Method #4: getTenantById

gets a specific tenant by it's identifier

Request

Name Type Required Multiple Description
     sid
String Y
     tenantId
Long Y

Response

Name Type Required Multiple Description
     tenant
WSTenant Y

Method #5: getTenant

gets a specific tenant by it's name

Request

Name Type Required Multiple Description
     sid
String Y
     name
String Y

Response

Name Type Required Multiple Description
     tenant
WSTenant Y