Relationships

Resource Representation ↑

Example:
{
  "id": 1,
  "code": "relationship_1",
  "name": "Relationship 1"
}

Supported Formats

json
>>>

GET /api/v2/relationships
List relationships

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

Response:
  {
      "page": 1,
      "per_page": 50,
      "total_pages": 1,
      "total_entries": 1,
      "entries": [
          {
              "id": 1,
              "code": "relationship_1",
              "name": "Relationship 1"
          }
      ]
  }

Params

Param name Description
per_page
optional

Number of objects in one response. Default is 50

Validations:

  • Must be a number.
page
optional

Page number. Default is 1

Validations:

  • Must be a number.
created_time_from
optional

ISO_8601 format 2016-05-30T05:13:26Z

Validations:

  • Must be a String
created_time_to
optional

ISO_8601 format 2016-05-30T05:13:26Z

Validations:

  • Must be a String
updated_time_from
optional

ISO_8601 format 2016-05-30T05:13:26Z

Validations:

  • Must be a String
updated_time_to
optional

ISO_8601 format 2016-05-30T05:13:26Z

Validations:

  • Must be a String
id
optional

Relationship ID

Validations:

  • Must be a String
>>>

POST /api/v2/relationships
Create or update relationship

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

request:
  {
    "relationship": {
      "code": "relationship_1",
      "name": "Relation new name 1"
    }
  }

response:
  {
      "id": 3,
      "code": "relationship_1",
      "created_at": "2019-06-18T13:31:16.763+10:00",
      "updated_at": "2019-06-18T13:31:16.763+10:00",
      "name": "Relationship new name 1"
  }

Params

Param name Description
relationship
required

Validations:

  • Must be a Hash
relationship[code]
required

Code of the relationship

Validations:

  • Must be a String
relationship[name]
required

Name of the relationship

Validations:

  • Must be a String
>>>

DELETE /api/v2/relationships/:id
Delete a relationship

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

response:
  {
    "id": 1
  }