MemberData API
API change historyAdd a batch of member data to the exercise.
Request
Request URL
Request parameters
-
string
Format - uuid.
Request headers
-
string
-
(optional)stringMedia type of the body sent to the API.
Request body
{
"memberRecords": [
{
"memberId": "Member1",
"status": "A",
"gender": "M",
"salary": 20000.0,
"salaryDate": "2021-02-03T00:00:00Z",
"postCodeProxyCode": "string",
"occupation": "M",
"pension": 20000.0,
"pensionDate": "2021-02-03T00:00:00Z",
"retirementHealth": "N",
"firstLifeAggregationGroup": "AGGGroupA",
"firstLifeAge": 20,
"secondLifePension": 20000.0,
"secondLifeAggregationGroup": "AGGGroupB"
}
]
}{
"required": [
"memberRecords"
],
"type": "object",
"properties": {
"memberRecords": {
"type": "array",
"items": {
"required": [
"gender",
"memberId",
"status"
],
"type": "object",
"properties": {
"memberId": {
"type": "string",
"description": "A unique ID for each member, generated for the purposes of this interface.\r\nNote – this should not be a personal data item ID such employee number or NI number.",
"example": "Member1"
},
"status": {
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "Indication of the member's current status, or the status they are to be assessed as (A/D/P/W).",
"example": "A"
},
"gender": {
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "The gender of the member (M/F).",
"example": "M"
},
"salary": {
"type": "number",
"description": "The salary associated with this member for affluence mapping.",
"format": "double",
"nullable": true,
"example": 20000.0
},
"salaryDate": {
"type": "string",
"description": "The date at which the salary was recorded.",
"format": "date-time",
"nullable": true,
"example": "2021-02-03T00:00:00Z"
},
"postCodeProxyCode": {
"type": "string",
"description": "Obfuscated Post Code",
"nullable": true,
"example": "string"
},
"occupation": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "Manual/non-manual indicator (M/O/P).",
"nullable": true,
"example": "M"
},
"pension": {
"type": "number",
"description": "Pension amount in payment or pension in deferment for a deferred pensioner.",
"format": "double",
"nullable": true,
"example": 20000.0
},
"pensionDate": {
"type": "string",
"description": "The effective date of the pension recorded in the previous column.",
"format": "date-time",
"nullable": true,
"example": "2021-02-03T00:00:00Z"
},
"retirementHealth": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "Indicator as to the health of the member at retirement (N/I/A).",
"nullable": true,
"example": "N"
},
"firstLifeAggregationGroup": {
"type": "string",
"description": "The group in which the member is to be placed into for VitaCurvesLITE aggregation purposes (if VitaCurvesLITE are\r\nto\r\nbe provided).",
"nullable": true,
"example": "AGGGroupA"
},
"firstLifeAge": {
"type": "integer",
"description": "The age of the member for use in estimating liabilities for VitaCurvesLITE aggregation (if VitaCurvesLITE are to be\r\nprovided).",
"format": "int32",
"nullable": true,
"example": 20
},
"secondLifePension": {
"type": "number",
"description": "The pension amount to be used in mapping the contingent spouse's VitaCurves (and calculating VitaCurvesLITE\r\nweighting). Pension date will be assumed to be same as 1st life pension date.",
"format": "double",
"nullable": true,
"example": 20000.0
},
"secondLifeAggregationGroup": {
"type": "string",
"description": "The group in which the contingent spouse is to be placed into for VitaCurvesLITE aggregation purposes (if\r\nVitaCurvesLITE are to be provided).",
"nullable": true,
"example": "AGGGroupB"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}{
"memberRecords": [
{
"memberId": "Member1",
"status": "A",
"gender": "M",
"salary": 20000.0,
"salaryDate": "2021-02-03T00:00:00Z",
"postCodeProxyCode": "string",
"occupation": "M",
"pension": 20000.0,
"pensionDate": "2021-02-03T00:00:00Z",
"retirementHealth": "N",
"firstLifeAggregationGroup": "AGGGroupA",
"firstLifeAge": 20,
"secondLifePension": 20000.0,
"secondLifeAggregationGroup": "AGGGroupB"
}
]
}{
"required": [
"memberRecords"
],
"type": "object",
"properties": {
"memberRecords": {
"type": "array",
"items": {
"required": [
"gender",
"memberId",
"status"
],
"type": "object",
"properties": {
"memberId": {
"type": "string",
"description": "A unique ID for each member, generated for the purposes of this interface.\r\nNote – this should not be a personal data item ID such employee number or NI number.",
"example": "Member1"
},
"status": {
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "Indication of the member's current status, or the status they are to be assessed as (A/D/P/W).",
"example": "A"
},
"gender": {
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "The gender of the member (M/F).",
"example": "M"
},
"salary": {
"type": "number",
"description": "The salary associated with this member for affluence mapping.",
"format": "double",
"nullable": true,
"example": 20000.0
},
"salaryDate": {
"type": "string",
"description": "The date at which the salary was recorded.",
"format": "date-time",
"nullable": true,
"example": "2021-02-03T00:00:00Z"
},
"postCodeProxyCode": {
"type": "string",
"description": "Obfuscated Post Code",
"nullable": true,
"example": "string"
},
"occupation": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "Manual/non-manual indicator (M/O/P).",
"nullable": true,
"example": "M"
},
"pension": {
"type": "number",
"description": "Pension amount in payment or pension in deferment for a deferred pensioner.",
"format": "double",
"nullable": true,
"example": 20000.0
},
"pensionDate": {
"type": "string",
"description": "The effective date of the pension recorded in the previous column.",
"format": "date-time",
"nullable": true,
"example": "2021-02-03T00:00:00Z"
},
"retirementHealth": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "Indicator as to the health of the member at retirement (N/I/A).",
"nullable": true,
"example": "N"
},
"firstLifeAggregationGroup": {
"type": "string",
"description": "The group in which the member is to be placed into for VitaCurvesLITE aggregation purposes (if VitaCurvesLITE are\r\nto\r\nbe provided).",
"nullable": true,
"example": "AGGGroupA"
},
"firstLifeAge": {
"type": "integer",
"description": "The age of the member for use in estimating liabilities for VitaCurvesLITE aggregation (if VitaCurvesLITE are to be\r\nprovided).",
"format": "int32",
"nullable": true,
"example": 20
},
"secondLifePension": {
"type": "number",
"description": "The pension amount to be used in mapping the contingent spouse's VitaCurves (and calculating VitaCurvesLITE\r\nweighting). Pension date will be assumed to be same as 1st life pension date.",
"format": "double",
"nullable": true,
"example": 20000.0
},
"secondLifeAggregationGroup": {
"type": "string",
"description": "The group in which the contingent spouse is to be placed into for VitaCurvesLITE aggregation purposes (if\r\nVitaCurvesLITE are to be provided).",
"nullable": true,
"example": "AGGGroupB"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}{
"memberRecords": [
{
"memberId": "Member1",
"status": "A",
"gender": "M",
"salary": 20000.0,
"salaryDate": "2021-02-03T00:00:00Z",
"postCodeProxyCode": "string",
"occupation": "M",
"pension": 20000.0,
"pensionDate": "2021-02-03T00:00:00Z",
"retirementHealth": "N",
"firstLifeAggregationGroup": "AGGGroupA",
"firstLifeAge": 20,
"secondLifePension": 20000.0,
"secondLifeAggregationGroup": "AGGGroupB"
}
]
}{
"required": [
"memberRecords"
],
"type": "object",
"properties": {
"memberRecords": {
"type": "array",
"items": {
"required": [
"gender",
"memberId",
"status"
],
"type": "object",
"properties": {
"memberId": {
"type": "string",
"description": "A unique ID for each member, generated for the purposes of this interface.\r\nNote – this should not be a personal data item ID such employee number or NI number.",
"example": "Member1"
},
"status": {
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "Indication of the member's current status, or the status they are to be assessed as (A/D/P/W).",
"example": "A"
},
"gender": {
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "The gender of the member (M/F).",
"example": "M"
},
"salary": {
"type": "number",
"description": "The salary associated with this member for affluence mapping.",
"format": "double",
"nullable": true,
"example": 20000.0
},
"salaryDate": {
"type": "string",
"description": "The date at which the salary was recorded.",
"format": "date-time",
"nullable": true,
"example": "2021-02-03T00:00:00Z"
},
"postCodeProxyCode": {
"type": "string",
"description": "Obfuscated Post Code",
"nullable": true,
"example": "string"
},
"occupation": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "Manual/non-manual indicator (M/O/P).",
"nullable": true,
"example": "M"
},
"pension": {
"type": "number",
"description": "Pension amount in payment or pension in deferment for a deferred pensioner.",
"format": "double",
"nullable": true,
"example": 20000.0
},
"pensionDate": {
"type": "string",
"description": "The effective date of the pension recorded in the previous column.",
"format": "date-time",
"nullable": true,
"example": "2021-02-03T00:00:00Z"
},
"retirementHealth": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "Indicator as to the health of the member at retirement (N/I/A).",
"nullable": true,
"example": "N"
},
"firstLifeAggregationGroup": {
"type": "string",
"description": "The group in which the member is to be placed into for VitaCurvesLITE aggregation purposes (if VitaCurvesLITE are\r\nto\r\nbe provided).",
"nullable": true,
"example": "AGGGroupA"
},
"firstLifeAge": {
"type": "integer",
"description": "The age of the member for use in estimating liabilities for VitaCurvesLITE aggregation (if VitaCurvesLITE are to be\r\nprovided).",
"format": "int32",
"nullable": true,
"example": 20
},
"secondLifePension": {
"type": "number",
"description": "The pension amount to be used in mapping the contingent spouse's VitaCurves (and calculating VitaCurvesLITE\r\nweighting). Pension date will be assumed to be same as 1st life pension date.",
"format": "double",
"nullable": true,
"example": 20000.0
},
"secondLifeAggregationGroup": {
"type": "string",
"description": "The group in which the contingent spouse is to be placed into for VitaCurvesLITE aggregation purposes (if\r\nVitaCurvesLITE are to be provided).",
"nullable": true,
"example": "AGGGroupB"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}{
"memberRecords": [
{
"memberId": "Member1",
"status": "A",
"gender": "M",
"salary": 20000.0,
"salaryDate": "2021-02-03T00:00:00Z",
"postCodeProxyCode": "string",
"occupation": "M",
"pension": 20000.0,
"pensionDate": "2021-02-03T00:00:00Z",
"retirementHealth": "N",
"firstLifeAggregationGroup": "AGGGroupA",
"firstLifeAge": 20,
"secondLifePension": 20000.0,
"secondLifeAggregationGroup": "AGGGroupB"
}
]
}{
"required": [
"memberRecords"
],
"type": "object",
"properties": {
"memberRecords": {
"type": "array",
"items": {
"required": [
"gender",
"memberId",
"status"
],
"type": "object",
"properties": {
"memberId": {
"type": "string",
"description": "A unique ID for each member, generated for the purposes of this interface.\r\nNote – this should not be a personal data item ID such employee number or NI number.",
"example": "Member1"
},
"status": {
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "Indication of the member's current status, or the status they are to be assessed as (A/D/P/W).",
"example": "A"
},
"gender": {
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "The gender of the member (M/F).",
"example": "M"
},
"salary": {
"type": "number",
"description": "The salary associated with this member for affluence mapping.",
"format": "double",
"nullable": true,
"example": 20000.0
},
"salaryDate": {
"type": "string",
"description": "The date at which the salary was recorded.",
"format": "date-time",
"nullable": true,
"example": "2021-02-03T00:00:00Z"
},
"postCodeProxyCode": {
"type": "string",
"description": "Obfuscated Post Code",
"nullable": true,
"example": "string"
},
"occupation": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "Manual/non-manual indicator (M/O/P).",
"nullable": true,
"example": "M"
},
"pension": {
"type": "number",
"description": "Pension amount in payment or pension in deferment for a deferred pensioner.",
"format": "double",
"nullable": true,
"example": 20000.0
},
"pensionDate": {
"type": "string",
"description": "The effective date of the pension recorded in the previous column.",
"format": "date-time",
"nullable": true,
"example": "2021-02-03T00:00:00Z"
},
"retirementHealth": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "Indicator as to the health of the member at retirement (N/I/A).",
"nullable": true,
"example": "N"
},
"firstLifeAggregationGroup": {
"type": "string",
"description": "The group in which the member is to be placed into for VitaCurvesLITE aggregation purposes (if VitaCurvesLITE are\r\nto\r\nbe provided).",
"nullable": true,
"example": "AGGGroupA"
},
"firstLifeAge": {
"type": "integer",
"description": "The age of the member for use in estimating liabilities for VitaCurvesLITE aggregation (if VitaCurvesLITE are to be\r\nprovided).",
"format": "int32",
"nullable": true,
"example": 20
},
"secondLifePension": {
"type": "number",
"description": "The pension amount to be used in mapping the contingent spouse's VitaCurves (and calculating VitaCurvesLITE\r\nweighting). Pension date will be assumed to be same as 1st life pension date.",
"format": "double",
"nullable": true,
"example": 20000.0
},
"secondLifeAggregationGroup": {
"type": "string",
"description": "The group in which the contingent spouse is to be placed into for VitaCurvesLITE aggregation purposes (if\r\nVitaCurvesLITE are to be provided).",
"nullable": true,
"example": "AGGGroupB"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}Responses
202 Accepted
Success
Representations
{
"links": {
"self": {
"href": "string"
},
"exercise": {
"href": "string"
},
"start": {
"href": "string"
}
}
}{
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"exercise": {
"type": "object",
"properties": {
"href": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"start": {
"type": "object",
"properties": {
"href": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Code samples
@ECHO OFF
curl -v -X PUT "https://hymans-api.co.uk/evitacurves/memberdata/{exerciseId}"
-H "Accept: application/hal+json;v=1"
-H "Content-Type: application/json-patch+json; v=1.0"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Accept.Add(MediaTypeWithQualityHeaderValue.Parse("application/hal+json;v=1"));
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
var uri = "https://hymans-api.co.uk/evitacurves/memberdata/{exerciseId}?" + queryString;
HttpResponseMessage response;
// Request body
byte[] byteData = Encoding.UTF8.GetBytes("{body}");
using (var content = new ByteArrayContent(byteData))
{
content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
response = await client.PutAsync(uri, content);
}
}
}
} // // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://hymans-api.co.uk/evitacurves/memberdata/{exerciseId}");
URI uri = builder.build();
HttpPut request = new HttpPut(uri);
request.setHeader("Accept", "application/hal+json;v=1");
request.setHeader("Content-Type", "application/json-patch+json; v=1.0");
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
};
$.ajax({
url: "https://hymans-api.co.uk/evitacurves/memberdata/{exerciseId}?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Accept","application/hal+json;v=1");
xhrObj.setRequestHeader("Content-Type","application/json-patch+json; v=1.0");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "PUT",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://hymans-api.co.uk/evitacurves/memberdata/{exerciseId}";
NSArray* array = @[
// Request parameters
@"entities=true",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"PUT"];
// Request headers
[_request setValue:@"application/hal+json;v=1" forHTTPHeaderField:@"Accept"];
[_request setValue:@"application/json-patch+json; v=1.0" forHTTPHeaderField:@"Content-Type"];
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://hymans-api.co.uk/evitacurves/memberdata/{exerciseId}');
$url = $request->getUrl();
$headers = array(
// Request headers
'Accept' => 'application/hal+json;v=1',
'Content-Type' => 'application/json-patch+json; v=1.0',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_PUT);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Accept': 'application/hal+json;v=1',
'Content-Type': 'application/json-patch+json; v=1.0',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('hymans-api.co.uk')
conn.request("PUT", "/evitacurves/memberdata/{exerciseId}?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Accept': 'application/hal+json;v=1',
'Content-Type': 'application/json-patch+json; v=1.0',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('hymans-api.co.uk')
conn.request("PUT", "/evitacurves/memberdata/{exerciseId}?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################require 'net/http'
uri = URI('https://hymans-api.co.uk/evitacurves/memberdata/{exerciseId}')
request = Net::HTTP::Put.new(uri.request_uri)
# Request headers
request['Accept'] = 'application/hal+json;v=1'
# Request headers
request['Content-Type'] = 'application/json-patch+json; v=1.0'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body