Read Specialist

Returns the specialist associated with the id provided by the request.

GET /speciality/v1/specialists/{id}

Path Parameters

id

string required

Id of the desired resource.

Query Parameters

includes

string

Relationships to include with the requested resource.

For a specialist, the supported relationships are :

  • service
  • parent
  • children
includes=service,partner,children

Examples

Read Specialist

curl -X GET "https://api.clinia.ca/speciality/v1/specialists/${ID}?includes=service,parent,children" \
-H "Content-Type: application/vnd.api+json"
{
"data": {
"attributes": {
"translations": {
"en": {
"name": {
"value": "Psychologist"
},
"wordCloud": []
},
"fr": {
"name": {
"value": "Psychologue"
},
"wordCloud": []
}
},
"createdAt": "2020-10-22T22:06:38.092Z",
"updatedAt": "2020-10-22T22:06:38.092Z",
"publishedAt": null
},
"relationships": {
"service": {
"links": {
"self": "http://speciality-api/v1/specialists/c7a8abeb-7fa7-4907-abd3-c127e9528f63/relationships/service",
"related": "http://speciality-api/v1/specialists/c7a8abeb-7fa7-4907-abd3-c127e9528f63/service"
},
"data": {
"type": "services",
"id": "213107a6-a3d0-40f3-9522-92cbc977b89d"
}
},
"parent": {
"links": {
"self": "http://speciality-api/v1/specialists/c7a8abeb-7fa7-4907-abd3-c127e9528f63/relationships/parent",
"related": "http://speciality-api/v1/specialists/c7a8abeb-7fa7-4907-abd3-c127e9528f63/parent"
}
},
"children": {
"links": {
"self": "http://speciality-api/v1/specialists/c7a8abeb-7fa7-4907-abd3-c127e9528f63/relationships/children",
"related": "http://speciality-api/v1/specialists/c7a8abeb-7fa7-4907-abd3-c127e9528f63/children"
},
"meta": {
"totalRecords": 0
},
"data": []
},
"ancestors": {
"links": {
"self": "http://speciality-api/v1/specialists/c7a8abeb-7fa7-4907-abd3-c127e9528f63/relationships/ancestors",
"related": "http://speciality-api/v1/specialists/c7a8abeb-7fa7-4907-abd3-c127e9528f63/ancestors"
},
"meta": {
"totalRecords": 0
},
"data": []
}
},
"type": "specialists",
"id": "c7a8abeb-7fa7-4907-abd3-c127e9528f63"
},
"included": [
{
"attributes": {
"translations": {
"en": {
"name": {
"value": "Psychology"
},
"wordCloud": []
},
"fr": {
"name": {
"value": "Psychologie"
},
"wordCloud": []
}
},
"createdAt": "2020-10-22T22:06:36.809Z",
"updatedAt": "2020-10-22T22:06:36.809Z",
"publishedAt": null,
"legacyId": null
},
"relationships": {
"specialist": {
"links": {
"self": "http://speciality-api/v1/services/213107a6-a3d0-40f3-9522-92cbc977b89d/relationships/specialist",
"related": "http://speciality-api/v1/services/213107a6-a3d0-40f3-9522-92cbc977b89d/specialist"
}
},
"parent": {
"links": {
"self": "http://speciality-api/v1/services/213107a6-a3d0-40f3-9522-92cbc977b89d/relationships/parent",
"related": "http://speciality-api/v1/services/213107a6-a3d0-40f3-9522-92cbc977b89d/parent"
}
},
"children": {
"links": {
"self": "http://speciality-api/v1/services/213107a6-a3d0-40f3-9522-92cbc977b89d/relationships/children",
"related": "http://speciality-api/v1/services/213107a6-a3d0-40f3-9522-92cbc977b89d/children"
}
},
"ancestors": {
"links": {
"self": "http://speciality-api/v1/services/213107a6-a3d0-40f3-9522-92cbc977b89d/relationships/ancestors",
"related": "http://speciality-api/v1/services/213107a6-a3d0-40f3-9522-92cbc977b89d/ancestors"
}
}
},
"type": "services",
"id": "213107a6-a3d0-40f3-9522-92cbc977b89d"
}
],
"meta": {
"materializedPath": ""
}
}