Hide If | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
|
Show If | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||
For every single of operation on the entities use the following templates and provide sample REST requests and responses.
GET API/billingManagement/ BillingAccount /{ID}Note that collections can be retrieved via GET /api/<RESOURCE> with no {ID}
We mandate L0 (equality) filtering in every specification as per REST Guidelines.
|
For every single of operation on the entities use the following templates and provide sample REST requests and responses.
Remember that the following Uniform Contract rules must be used :
Operation on Entities | Uniform API Operation | Description |
Query Entities | GET Resource | GET must be used to retrieve a representation of a resource. |
Create Entity | POST Resource | POST must be used to create a new resource |
Partial Update of an Entity | PATCH Resource | PATCH must be used to partially update a resource |
Complete Update of an Entity | PUT Resource | PUT must be used to completely update a resource identified by its resource URI |
Remove an Entity | DELETE Resource | DELETE must be used to remove a resource |
Execute an Action on an Entity | POST on TASK Resource | POST must be used to execute Task Resources |
Other Request Methods | POST on TASK Resource | GET and POST must not be used to tunnel other request methods. |
...
Note that collections can be retrieved via GET /api/<RESOURCE> with no {ID}
Description :
- Operation to retrieve BillingAccount (s) in a BillingAccount repository
- Filtering is enabled for all attributes
- Attribute selection is enabled for all attributes
- The resource is either a managed entity (query by id) or a collection (query with criteria)
- The resource identifier is a http uri
...
- Standard behavior and response codes for GET operations
We mandate L0 (equality) filtering in every specification as per REST Guidelines.
Example: Retrieve BillingAccount 65.
...
REQUEST
...
GET /billingManagement/billingAccount/65
Accept: application/json
...
RESPONSE
...
|
...
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
...
|
...
|
...
|
...
|
...
|
...
|
...
...
...
|
...
|
...
|
...
|
...
...
...
|
...
|
...
|
...
|
...
|
...
|
...
...
...
|
...
PUT API/BillingManagement/BillingAccount/{ID}No put operation for BillingAccount |
...
No put operation for BillingAccount
...
PATCH API/billingManagement/ BillingAccount /{ID}This Uniform Contract operation is used to partially update the representation of a managed entity or a task.
Behavior :
|
...
...
Mandatory attributes are :
Behavior :
Example : creation of a BillingAccount
|
...
DELETE API/billingManagement/BillingAccount/{ID}No delete operation for the BillingAccount.
|
...
...
POST API/bILLING Management/AppliedCustomerbillingchargeThis operation is used to create applied customer billing charges..
Mandatory attributes are :
|
...
GET API/bILLING Management/AppliedCustomerbillingchargeNote that collections can be retrieved via GET /api/<RESOURCE> with no {ID}
Behavior :
We mandate L0 (equality) filtering in every specification as per REST Guidelines
|
...
DELETE API/billingManagement/ appliedCustomerBillingCharge /{ID}No delete operation for the AppliedCustomerBillingCharge
|
...
PATCH API/billingManagement/ appliedCustomerBillingCharge /{ID}No patch operation for the AppliedCustomerBillingCharge
|
...
PUT API/billingManagement/ appliedCustomerBillingCharge /{ID}No put operation for the AppliedCustomerBillingCharge
|
...
...
|
...
GET API/bILLINGManagement/SettlementnoteADVICE /{ID}Note that collections can be retrieved via GET /api/<RESOURCE> with no {ID}
Behavior :
We mandate L0 (equality) filtering in every specification as per REST Guidelines
|
...
...
...
DELETE API/billingManagement/ Settlement note ADVICE /{ID}No delete operation for the SettlementNoteAdvice
|
...
...
...
PATCH API/billingManagement/ Settlement note ADVICE /{ID}No patch operation for the SettlementNoteAdvice
|
...
|
...
PUT API/billingManagement/ Settlement note ADVICE /{ID}No put operation for the SettlementNoteAdvice
|
...
POST API/billingManagement/ Settlement note ADVICE /{ID}No post operation for the SettlementNoteAdvice
|
...
|
...
GET API/bILLING Management/ CUSTOMER BILLING CYCLE SpecificationNote that collections can be retrieved via GET /api/<RESOURCE> with no {ID}
Behavior :
We mandate L0 (equality) filtering in every specification as per REST Guidelines
|
...
GET API/bILLING Management/ CUSTOMER BILL FormatNote that collections can be retrieved via GET /api/<RESOURCE> with no {ID}
Behavior :
We mandate L0 (equality) filtering in every specification as per REST Guidelines
|
...
...
...
GET API/bILLING Management/ CUSTOMER BILL Presentation MediaNote that collections can be retrieved via GET /api/<RESOURCE> with no {ID}
Behavior :
We mandate L0 (equality) filtering in every specification as per REST Guidelines
|
© TM Forum 2015. All Rights Reserved.