Difference between revisions of "API relationships"

From Charitylog Manual
Jump to: navigation, search
(Creating Relationships)
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
[[API Details|Go to API overview]]
 
[[API Details|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:
+
=Creating Relationships=
 +
Relationships are created by passing the id numbers of the 2 people in the URL. An example call to create a relatiionship between person 37 and person 59 would look like:
  
  [PUT] https<nowiki/>://api.dizions.co.uk/v2/clients/relationship_details/set/37/59
+
  [PUT] https<nowiki/>://api.dizions.co.uk/v2/relationship_details/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:
+
Put the relationships in the body, and optionally whether the relationship is a major relationship.
 +
 
 +
  [
 +
    {
 +
        "relation_first_to_second": "6",
 +
        "relation_second_to_first": "5",
 +
        "major": "Y"
 +
    }
 +
  ]
 +
 
 +
To get a list of relationships, use the dictionary:
  
 
  [GET] https<nowiki/>://api.dizions.co.uk/v2/dictionary/relationships
 
  [GET] https<nowiki/>://api.dizions.co.uk/v2/dictionary/relationships
  
 +
Carer relationships can be created in the same way:
 
   [
 
   [
 
     {
 
     {
 
         "relation_first_to_second": "6",
 
         "relation_first_to_second": "6",
 
         "relation_second_to_first": "5",
 
         "relation_second_to_first": "5",
         "major": "Y"
+
         "carer_relation_first_to_second": "1",
 +
        "carer_relation_second_to_first": "2",
 +
    }
 +
  ]
 +
NB, if the carer relationship is specified, the "standard" relationship must be specified as well, i.e. this is not valid:
 +
  [
 +
    {
 +
        "carer_relation_first_to_second": "1",
 +
        "carer_relation_second_to_first": "2",
 
     }
 
     }
 
   ]
 
   ]
 +
 +
To get a list of carer relationships, use the dictionary:
 +
 +
[GET] https<nowiki/>://api.dizions.co.uk/v2/dictionary/carer_relationships
 +
 +
=Getting relationships=
 +
Relationships can be selected along with other clients fields, like this:
 +
[GET] https<nowiki/>://api.dizions.co.uk/v2/clients/id/37/field/postcode;email;relationship_details

Revision as of 10:12, 25 October 2021

Go to API overview

Creating Relationships

Relationships are created by passing the id numbers of the 2 people 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/relationship_details/37/59

Put the relationships in the body, and optionally whether the relationship is a major relationship.

 [
   {
       "relation_first_to_second": "6",
       "relation_second_to_first": "5",
       "major": "Y"
   }
 ]

To get a list of relationships, use the dictionary:

[GET] https://api.dizions.co.uk/v2/dictionary/relationships

Carer relationships can be created in the same way:

 [
   {
       "relation_first_to_second": "6",
       "relation_second_to_first": "5",
       "carer_relation_first_to_second": "1",
       "carer_relation_second_to_first": "2",
   }
 ]

NB, if the carer relationship is specified, the "standard" relationship must be specified as well, i.e. this is not valid:

 [
   {
       "carer_relation_first_to_second": "1",
       "carer_relation_second_to_first": "2",
   }
 ]

To get a list of carer relationships, use the dictionary:

[GET] https://api.dizions.co.uk/v2/dictionary/carer_relationships

Getting relationships

Relationships can be selected along with other clients fields, like this:

[GET] https://api.dizions.co.uk/v2/clients/id/37/field/postcode;email;relationship_details