Rateplans API

create new entry

POST /api/rest/admin/rateplans

Parameters

Name Description
data[type] Resource type (rateplans)
data[attributes][name] Name
data[attributes][profit-control-mode-id] Profit control mode id

Request

Headers

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE4NCwiYXVkIjpbImFkbWluIl0sImV4cCI6MTc3MjIxMjAwOX0.coQ3QVqMPM0Lx1GTeObSBer12-0czYWF5wmD58AAgkM
Host: example.org
Cookie: 

Route

POST /api/rest/admin/rateplans

Body

{"data":{"type":"rateplans","attributes":{"name":"name","profit-control-mode-id":2}}}

Response

Headers

x-frame-options: SAMEORIGIN
x-xss-protection: 0
x-content-type-options: nosniff
x-permitted-cross-domain-policies: none
referrer-policy: strict-origin-when-cross-origin
content-type: application/vnd.api+json
location: http://example.org/api/rest/admin/rateplans/24
vary: Accept
etag: W/"ebb7d027f1892d2dc7cf180943cec8ed"
cache-control: max-age=0, private, must-revalidate
x-request-id: d2d000fd-10de-4c41-bee5-0b9f8a871c0c
x-runtime: 0.009635
content-length: 276

Status

201 Created

Body

{
  "data": {
    "id": "24",
    "type": "rateplans",
    "links": {
      "self": "http://example.org/api/rest/admin/rateplans/24"
    },
    "attributes": {
      "name": "name",
      "profit-control-mode-id": 2
    },
    "relationships": {
      "rate-groups": {
        "links": {
          "related": "http://example.org/api/rest/admin/rateplans/24/rate-groups"
        }
      }
    }
  }
}