developers:api:service
Differences
This shows you the differences between two versions of the page.
|
developers:api:service [2014/10/16 13:09] Jaco van Wyk created |
developers:api:service [2014/10/18 12:11] (current) Jaco van Wyk |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== Services ====== | ====== Services ====== | ||
| + | ===== /v1/client/id/add_service ===== | ||
| + | |||
| + | Adds a service to a client. | ||
| + | |||
| + | <code php> | ||
| + | $ curl -u user:pass -d "service_type_id=596&package=Delicious%20Pancakes&term=1" \ | ||
| + | > https://api.snapbill.com/v1/client/158958/add_service.json | ||
| + | </code> | ||
| + | |||
| + | <source examples/service.txt-1.json> | ||
| + | |||
| + | ==== Add Service Parameters ==== | ||
| + | |||
| + | ^Name ^Availability ^Description^ | ||
| + | |service_type_id |add |The id of the service to add. This field is required| | ||
| + | |package |add |The name of the package to use in the service. This field is required| | ||
| + | |term |add |The renewal term. This field is required| | ||
| + | |data-*customfieldname* |add |Optionally specify custom fields for a package.| | ||
| + | |||
| + | ===== /v1/service/id/remove ===== | ||
| + | |||
| + | Removes a service from a client. | ||
| + | |||
| + | <code php> | ||
| + | $ curl -u user:pass -d "" https://api.snapbill.com/v1/service/155685/remove.json | ||
| + | </code> | ||
| + | |||
| + | <source examples/service.txt-2.json> | ||
| + | |||
| + | ==== Parameter listing ==== | ||
| + | |||
| + | ^Name ^Availability ^Description^ | ||
| + | |depth |get |The depth parameter signals the amount of data for the service that was provided. depth=0 is the highest level that provides full detail.| | ||
| + | |id |get |The id of the service in the system. This is guaranteed to be unique only over a single account.| | ||
| + | |xid |get |The xid of the service in the system. This is guaranteed to be unique over all accounts (see Concepts - Xid)| | ||
| + | |||
| + | ===== /v1/service/list ===== | ||
| + | |||
| + | List all services associated with this account. | ||
| + | |||
| + | Results can optionally be filtered by the filters listed below. | ||
| + | |||
| + | ==== List Service Filters ==== | ||
| + | |||
| + | ^Name ^Availability ^Description^ | ||
| + | |service_type |get |The service_type of the services.| | ||
| + | |name |get |The name of the services.| | ||
| + | |page |get |The page of results to return.| | ||
| + | |perpage |get |The number of results per page to return.| | ||
developers/api/service.txt ยท Last modified: 2014/10/18 12:11 by Jaco van Wyk
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: GNU Free Documentation License 1.3
