Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel3
outlinefalse
styledefault
typelist
printablefalse

...

Operation/Type of operation

Behavior

Examples

1

Any operation that creates a customer resource.

  • If business_entity_id is provided, the customer resource is created and linked to it.

  • If business_entity_id is not provided, the customer resource is created under the default business entity of the site.

2

Create a resource other than customer

 

  • If business_entity_id is provided, and it is the same as that linked to the target resource: the resource is created and linked to the business entity provided.

  • If business_entity_id is provided, and it is not the same as that linked to the target resource, a 404 Not Found response is sent because the resource cannot be found in the context of the business entity specified.

  • If business_entity_id is not provided, the resource is created and linked to the business entity of the target resource.

3

Update/delete a resource

  • If business_entity_id is provided, and it is the same as that linked to theresource, the operation proceeds successfully.

  • If business_entity_id is provided, and it is not the same as that linked to the resource, a 404 Not Found response is sent because the resource cannot be found in the context of the business entity specified.

  • If business_entity_id is not provided, the operation proceeds successfully.

4

List resources

  • If business_entity_id is provided, then only those resources linked to the business entity are returned since the context of the operation is now restricted to the business entity specified.

  • If business_entity_id is not provided,then all resources in the site are returned.

5

Retrieve a resource

  • If business_entity_id is provided, and it is the same as that linked to theresource, the resource is retrieved successfully.

  • If business_entity_id is provided, and it is not the same as that linked to the resource, a 404 Not Found response is sent because the resource cannot be found in the context of the business entity specified.

  • If business_entity_id is not provided, the resource is retrieved successfully.

Terminology

This section defines some useful terms for describing how business entities work.

...