Contractors API

create new entry

POST /api/rest/admin/contractors

Parameters

Name	Description
data[type]	Resource type (contractors)
data[attributes][name]	Name
data[attributes][vendor]	Vendor
data[attributes][customer]	Customer
data[attributes][enabled]	Enabled
data[attributes][description]	Description
data[attributes][address]	Address
data[attributes][phones]	Phones
data[attributes][external-id]	External id
data[relationships][smtp-connection]	Smtp connection

Request

Headers

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3MTAyNTQ3MjcsInN1YiI6NTJ9.hbNyG1zW1vGc9V5mQ33zkqM0fydDWfdT0BWBOERasnk
Host: example.org
Cookie: 

Route

POST /api/rest/admin/contractors

Body

{"data":{"type":"contractors","attributes":{"name":"Contractor name","vendor":true,"customer":true,"enabled":true,"description":"Description","address":"Address","phones":"Phones"}}}

Response

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 0
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/vnd.api+json
Vary: Accept
ETag: W/"4469962479e500391e06d36e0e00fe59"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: bc2b4b6e-c0bd-4648-ae98-21e1b967932b
X-Runtime: 0.013002
Content-Length: 492

Status

201 Created

Body

{
  "data": {
    "id": "34",
    "type": "contractors",
    "links": {
      "self": "http://example.org/api/rest/admin/contractors/34"
    },
    "attributes": {
      "name": "Contractor name",
      "enabled": true,
      "vendor": true,
      "customer": true,
      "description": "Description",
      "address": "Address",
      "phones": "Phones",
      "external-id": null
    },
    "relationships": {
      "smtp-connection": {
        "links": {
          "self": "http://example.org/api/rest/admin/contractors/34/relationships/smtp-connection",
          "related": "http://example.org/api/rest/admin/contractors/34/smtp-connection"
        }
      }
    }
  }
}