This shows you the differences between two versions of the page.
Next revision | Previous revision Last revision Both sides next revision | ||
developers:api:service_type [2014/10/16 13:09] Jaco van Wyk created |
developers:api:service_type [2014/10/17 19:45] Jaco van Wyk |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== Service Types ====== | ====== Service Types ====== | ||
+ | |||
+ | ===== /v1/service_type/id/get ===== | ||
+ | |||
+ | Retrieve a service_type by id and return it's details. | ||
+ | |||
+ | ==== Parameter listing ==== | ||
+ | |||
+ | ^Name ^Availability ^Description^ | ||
+ | |depth |get |The depth parameter signals the amount of data for the payment method that was provided. depth=0 is the highest level that provides full detail.| | ||
+ | |id |get |The id of this service type. Unique over a single accounts.| | ||
+ | |xid |get |The xid of the service type. This is guaranteed to be unique over all accounts.| | ||
+ | |name |get |The name of the service type as chosen by the user.| | ||
+ | |||
+ | ===== /v1/service_type/list ===== | ||
+ | |||
+ | <code> | ||
+ | $ curl -u user:pass -d "perpage=2" \ | ||
+ | > https://api.snapbill.com/v1/service_type/list.json | ||
+ | </code> | ||
+ | <code> | ||
+ | { | ||
+ | code: 200, | ||
+ | type: "list", | ||
+ | page: 1, | ||
+ | numpages: 1, | ||
+ | class: "service_type", | ||
+ | list: [ | ||
+ | { | ||
+ | id: 596, | ||
+ | xid: "Clw:JU", | ||
+ | name: "Pancake Delivery" | ||
+ | } | ||
+ | ] | ||
+ | } | ||
+ | </code> | ||
+ | |||
+ | ==== List Service Types Filters ==== | ||
+ | |||
+ | ^Name ^Availability ^Description^ | ||
+ | |name |get |The name of the service types.| | ||
+ | |page |get |The number of pages of results to return.| | ||
+ | |perpage |get |The number of results per page to return.| | ||