This endpoint allows you to upload a dependant meta data.
POST api/dependant/post/${tenantName}/${userId}/${dependantId}/metadata
See How to create API Clients to see how to obtain API Client IDs and secrets
Request
Body
Data requirements (mandatory data all items)
tenantName string subdomain name of the tenant
userId string id of the user dependantId string id of the dependant
"metadata" requirements
ICollection<ClientMetaDataFieldValueDTO>
fieldId int id of the metadata field value string value of the metadata field
tenantName | string | subdomain name of the tenant |
userId | string | id of the user |
dependantId | string | id of the dependant |
"metadata" requirements
ICollection<ClientMetaDataFieldValueDTO>
fieldId | int | id of the metadata field |
value | string | value of the metadata field |
Authorization
The following authorization header is required. The authorisation header should be set to a 'Bearer Token' type
Token |
C# Example:
var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Post, "https://{platform API url}/api/dependant/post/{tenantName}/{userId}/{dependantId}/metadata"); request.Headers.Add("Authorization", "••••••"); var content = new StringContent(" [\r\n {\r\n \"{fieldId}\": {filedId},\r\n \"value\": \"{value}\"\r\n } \r\n ]\r\n ", null, "application/json"); request.Content = content; var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());
cURL Example
curl --location 'https://{platform API url}/api/dependant/post/{tenantName}/{userId}/{dependantId}
/metadata' \--header 'Content-Type: application/json' \--header 'Authorization: ••••••' \--data ' [{"fieldId": "{fieldId}","value": "{value}"}]