Difference between revisions of "API relationships"
From Charitylog Manual
| Line 1: | Line 1: | ||
[[API Details|Go to API overview]] | [[API Details|Go to API overview]] | ||
| − | Relationships are created | + | 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 | + | [PUT] https<nowiki/>://api.dizions.co.uk/v2/relationship_details/set/37/59 |
Put the relationships in the body, and optionally whether the relationship is a major relationship. | Put the relationships in the body, and optionally whether the relationship is a major relationship. | ||
Revision as of 14:32, 11 September 2020
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/set/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
