亏损的原因
交易损失原因API提供了一个简单的界面来管理交易损失原因。该API允许您创建、删除和更新丢失原因。您可以检索单个原因以及所有原因的列表。
JSON格式
的名字 | 只读 | 类型 | 描述 |
---|---|---|---|
id |
真正的 | 数量 | 丢失原因的唯一标识符。 |
creator_id |
真正的 | 数量 | 创建丢失原因的用户的唯一标识符。 |
的名字 |
假 | 字符串 | 人类友好的损失原因解释。 |
created_at |
真正的 | 字符串 | UTC ISO8601格式的创建日期和时间。 |
updated_at |
真正的 | 字符串 | UTC ISO8601格式的最近一次更新日期和时间。 |
找回所有原因
得到/v2/loss_reasons
根据提供的参数返回用户可用的所有交易损失原因。
参数
的名字 | 要求 | 类型 | 在 | 描述 |
---|---|---|---|---|
页面 |
假 | 数量 | 查询 | 开始的页码。页码以1为基础并省略页面 参数将返回第一页。 |
per_page |
假 | 数量 | 查询 | 每页要返回的记录数。默认限制为25可以返回的最大数量是One hundred.. |
sort_by |
假 | 字符串 | 查询 | 一个可以排序的领域。默认的顺序是提升.如果要将排序顺序改为降序,请添加: desc 到田野去。sort_by =名字:desc .可能的值:id ,的名字 ,updated_at ,created_at |
id |
假 | 字符串 | 查询 | 以逗号分隔的交易失败原因列表,在请求中返回唯一标识符。 |
的名字 |
假 | 字符串 | 查询 | 要查找的丢失原因名称。该参数在严格意义上使用。 |
允许
- 代理
使用旋度
旋度-v -X GET https://api.getbase.com/v2/loss_reasons\
- h“接受:application / json”\
- h“授权:持票人ACCESS_TOKEN美元"
示例响应
HTTP /1.1200好吧
内容类型:application / json;charset = utf8
内容语言:在
{
“项目”:[
{
“数据”:{
“id”:1,
“creator_id”:1,
“名称”:“我们太贵了”,
“created_at”:“2014 - 08 - 27 - t16:32:56z”,
“updated_at”:“2014 - 08 - 27 - t16:32:56z”
},
“元”:{
“类型”:“loss_reason”
}
},
{
“数据”:{
“id”:2,
“creator_id”:1,
“名称”:“选择竞争对手”,
“created_at”:“2014 - 08 - 27 - t16:32:57z”,
“updated_at”:“2014 - 08 - 27 - t16:32:57z”
},
“元”:{
“类型”:“loss_reason”
}
},
{
“数据”:{
“id”:3.,
“creator_id”:1,
“名称”:“糟糕的跟进”,
“created_at”:“2014 - 08 - 27 - t16:32:58z”,
“updated_at”:“2014 - 08 - 27 - t16:32:58z”
},
“元”:{
“类型”:“loss_reason”
}
}
],
“元”:{
“类型”:“收集”,
“数”:3.,
“链接”:{
“自我”:“http://api.getbase.com/v2/loss_reasons.json”
}
}
}
造成损失原因
帖子/v2/loss_reasons
创建一个新的损失原因。损失原因名称必须是唯一的。
参数
的名字 | 要求 | 类型 | 在 | 描述 |
---|---|---|---|---|
的名字 |
真正的 | 字符串 | 身体 | 必须是唯一的。如。缺乏沟通 |
允许
- 代理
使用旋度
旋度-v -X POST https://api.getbase.com/v2/loss_reasons\
- h“接受:application / json”\
- h“application / json内容类型:\
- h“授权:持票人ACCESS_TOKEN美元"\
- d”{
"数据":{
"name": "缺乏沟通"
},
"元":{
“类型”:“loss_reason”
}
} '
示例响应
HTTP /1.1200好吧
内容类型:application / json;charset = utf8
内容语言:在
{
“数据”:{
“id”:4,
“creator_id”:1,
“名称”:“缺乏沟通”,
“created_at”:“2014 - 08 - 27 - t16:33:00z”,
“updated_at”:“2014 - 08 - 27 - t16:33:00z”
},
“元”:{
“类型”:“loss_reason”
}
}
找回一个原因
得到/v2/loss_reasons/:id
通过提供的id返回用户可用的单个丢失原因。如果所提供的唯一标识符的丢失原因不存在,则返回错误。
参数
的名字 | 要求 | 类型 | 在 | 描述 |
---|---|---|---|---|
id |
真正的 | 数量 | 查询 | 丢失原因的唯一标识符。 |
允许
- 代理
使用旋度
旋度-v -X GET https://api.getbase.com/v2/loss_reasons/4\
- h“接受:application / json”\
- h“授权:持票人ACCESS_TOKEN美元"
示例响应
HTTP /1.1200好吧
内容类型:application / json;charset = utf8
内容语言:在
{
“数据”:{
“id”:4,
“creator_id”:1,
“名称”:“缺乏沟通”,
“created_at”:“2014 - 08 - 27 - t16:33:00z”,
“updated_at”:“2014 - 08 - 27 - t16:33:00z”
},
“元”:{
“类型”:“loss_reason”
}
}
更新丢失原因
把/v2/loss_reasons/:id
更新丢失原因信息。如果指定的丢失原因不存在,请求将返回一个错误。
如果你想更新损失原因的话必须确保原因名称是唯一的。
参数
的名字 | 要求 | 类型 | 在 | 描述 |
---|---|---|---|---|
id |
真正的 | 数量 | 查询 | 丢失原因的唯一标识符。 |
的名字 |
假 | 字符串 | 身体 | 必须是唯一的。 |
允许
- 代理
使用旋度
旋度-v -X PUT https://api.getbase.com/v2/loss_reasons/4\
- h“接受:application / json”\
- h“application / json内容类型:\
- h“授权:持票人ACCESS_TOKEN美元"\
- d”{
"数据":{
“姓名”:“缺乏与联系人的沟通”
}
} '
示例响应
HTTP /1.1200好吧
内容类型:application / json;charset = utf8
内容语言:在
{
“数据”:{
“id”:4,
“creator_id”:1,
“名称”:“缺乏沟通与联系”,
“created_at”:“2014 - 08 - 27 - t16:33:00z”,
“updated_at”:“2014 - 08 - 27 - t16:33:01z”
},
“元”:{
“类型”:“loss_reason”
}
}
删除一个理由
删除/v2/loss_reasons/:id
删除已存在的丢失原因。如果提供的唯一标识符的原因不存在,则返回错误。该操作无法恢复。
参数
的名字 | 要求 | 类型 | 在 | 描述 |
---|---|---|---|---|
id |
真正的 | 数量 | 查询 | 丢失原因的唯一标识符。 |
允许
- 代理
使用旋度
旋度-v -X DELETE https://api.getbase.com/v2/loss_reasons/1\
- h“授权:持票人ACCESS_TOKEN美元"
示例响应
HTTP/1.1204没有内容