Difference between revisions of "API relationships"

From Charitylog Manual
Jump to: navigation, search
Line 9: Line 9:
 
  [GET] https<nowiki/>://api.dizions.co.uk/v2/dictionary/relationships
 
  [GET] https<nowiki/>://api.dizions.co.uk/v2/dictionary/relationships
  
[
+
  [
  {
+
    {
      "relation_first_to_second": "6",
+
        "relation_first_to_second": "6",
      "relation_second_to_first": "5",
+
        "relation_second_to_first": "5",
      "major": "Y"
+
        "major": "Y"
  }
+
    }
]
+
  ]

Revision as of 14:19, 11 September 2020

Go to API overview

Relationships are created using the clients endpoint, passing the id numbers of the 2 clients in the URL. An example call to create a relatiionship between person 37 and person 59 would look like:

[PUT] https://api.dizions.co.uk/v2/clients/relationship_details/set/37/59

Put the relationships in the body, and optionally whether the relationship is a major relationship. To get a list of relationships, use the dictionary:

[GET] https://api.dizions.co.uk/v2/dictionary/relationships
 [
   {
       "relation_first_to_second": "6",
       "relation_second_to_first": "5",
       "major": "Y"
   }
 ]