The claims of several members

GET /members/claims

The status, person data and claims of each member code in keys. The Studio does not call this operation at present.

Authentication

appsolut_m2m (sent in the header x-api-key): The "API key" entered in the register's connection in the Studio, sent with every call. The Studio keeps it encrypted and never shows it again. Answer 401 or 403 to a wrong key.

Parameters

Name	In	Required	Type	Description
`keys`	query	Yes	string[]	The member codes to look up, the parameter repeated for each: `?keys=100001&keys=100002`. Example: `["100001","100002"]`.
`x-tenant-id`	header	Yes	string	The "Tenant ID" entered in the register's connection in the Studio, sent unchanged with every call. Your register can use it to tell apart the organisations it serves. Example: `pannoniqa`.
`x-custom-scope`	header	Yes	string	The "Scope" entered in the register's connection in the Studio, sent unchanged with every call. Your register can use it to choose the data set it answers from. Example: `employees`.

Responses

200

One element per member code found. A member the register holds without data may answer empty params and claims.

Content type: application/json

Field	Type	Required	Description
`[].memberCode`	string	Yes	The member code, the person's identifier in the organisation.
`[].source`	string	Yes	The name of your data source, such as "SAP HR".
`[].status`	object	Yes
`[].status.statusCode`	string	Yes	The member's status in the register. Filters in the membership definition and in communities can check it. Allowed values: `active`, `inactive`, `pending`.
`[].params`	object	Yes	The person data the register holds. Every field is optional in the contract, but where the Studio compares facts it needs the first name, last name and birth date. The address is member data a frontend may show its signed-in member.
`[].params.firstName`	string	No	First name.
`[].params.lastName`	string	No	Last name.
`[].params.memberCode`	string	No	The member code as the register holds it.
`[].params.birthDate`	string (date)	No	Birth date, YYYY-MM-DD.
`[].params.zip`	string	No	Postal code.
`[].params.city`	string	No	City.
`[].params.street`	string	No	Street and house number.
`[].params.country`	string	No	Country code, such as AT.
`[].claims`	object	Yes	Facts about the member that the membership definition and communities can filter on. All are optional and any may be null, such as for a claim the register does not know; what null means is the claim's own (for `leavingDate`, still employed). A register may send claims of its own beyond these.
`[].claims.entitled`	boolean or null	No	Whether the member is entitled to community benefits.
`[].claims.discountLevel`	integer or null	No	Discount level, in percent. At least 0. At most 100.
`[].claims.companyName`	string or null	No	The company the member works for.
`[].claims.employeeGroup`	string or null	No	The member's employee group.
`[].claims.employmentLevel`	integer or null	No	Employment level, in percent of full time. At least 0. At most 100.
`[].claims.leavingDate`	string (date) or null	No	The date the member left, YYYY-MM-DD; a date-time is accepted too. Null while employed.
`[].claims.isAnnualSalaryAbove50k`	boolean or null	No	Whether the annual salary is above 50,000.
`[].claims.numberOfKids`	integer or null	No	Number of children. At least 0.
`[].claims.childAllowance`	boolean or null	No	Whether the member receives child allowance.
`[].claims.soleEarner`	boolean or null	No	Whether the member is a sole earner.
`[].claims.mealVoucher`	number or null	No	Amount of the meal voucher. At least 0.

Example

[
  {
    "memberCode": "100001",
    "source": "SAP HR",
    "status": {
      "statusCode": "active"
    },
    "params": {
      "firstName": "Anna",
      "lastName": "Berger",
      "memberCode": "100001",
      "birthDate": "1979-02-02",
      "zip": "7100",
      "city": "Neusiedl am See",
      "street": "Musterweg 3",
      "country": "AT"
    },
    "claims": {
      "numberOfKids": 2,
      "employeeGroup": "Production",
      "isAnnualSalaryAbove50k": false,
      "discountLevel": 10,
      "employmentLevel": 100,
      "leavingDate": null,
      "companyName": "Pannoniqa AG"
    }
  },
  {
    "memberCode": "100002",
    "source": "SAP HR",
    "status": {
      "statusCode": "active"
    },
    "params": {
      "firstName": "Markus",
      "lastName": "Horvath",
      "memberCode": "100002",
      "birthDate": "1985-11-23",
      "zip": "7000",
      "city": "Eisenstadt",
      "street": "Beispielgasse 12",
      "country": "AT"
    },
    "claims": {
      "numberOfKids": 0,
      "employeeGroup": "Administration",
      "isAnnualSalaryAbove50k": true,
      "discountLevel": 10,
      "employmentLevel": 80,
      "leavingDate": null,
      "companyName": "Pannoniqa AG"
    }
  },
  {
    "memberCode": "100004",
    "source": "SAP HR",
    "status": {
      "statusCode": "inactive"
    },
    "params": {},
    "claims": {}
  }
]

400

The register could not process the request. The Studio treats it as the register being unavailable and does not read the body.

Content type: text/plain

Type: string

Example

Bad request

401

The API key is wrong. The Studio reports the credentials as rejected (it does the same for 403) and treats the register as unavailable.

Content type: text/plain

Type: string

Example

Unauthorized

The claims of several members

GET /members/claims

The status, person data and claims of each member code in keys. The Studio does not call this operation at present.

Authentication

appsolut_m2m (sent in the header x-api-key): The "API key" entered in the register's connection in the Studio, sent with every call. The Studio keeps it encrypted and never shows it again. Answer 401 or 403 to a wrong key.

Parameters

Name	In	Required	Type	Description
`keys`	query	Yes	string[]	The member codes to look up, the parameter repeated for each: `?keys=100001&keys=100002`. Example: `["100001","100002"]`.
`x-tenant-id`	header	Yes	string	The "Tenant ID" entered in the register's connection in the Studio, sent unchanged with every call. Your register can use it to tell apart the organisations it serves. Example: `pannoniqa`.
`x-custom-scope`	header	Yes	string	The "Scope" entered in the register's connection in the Studio, sent unchanged with every call. Your register can use it to choose the data set it answers from. Example: `employees`.

Responses

200

One element per member code found. A member the register holds without data may answer empty params and claims.

Content type: application/json

Field	Type	Required	Description
`[].memberCode`	string	Yes	The member code, the person's identifier in the organisation.
`[].source`	string	Yes	The name of your data source, such as "SAP HR".
`[].status`	object	Yes
`[].status.statusCode`	string	Yes	The member's status in the register. Filters in the membership definition and in communities can check it. Allowed values: `active`, `inactive`, `pending`.
`[].params`	object	Yes	The person data the register holds. Every field is optional in the contract, but where the Studio compares facts it needs the first name, last name and birth date. The address is member data a frontend may show its signed-in member.
`[].params.firstName`	string	No	First name.
`[].params.lastName`	string	No	Last name.
`[].params.memberCode`	string	No	The member code as the register holds it.
`[].params.birthDate`	string (date)	No	Birth date, YYYY-MM-DD.
`[].params.zip`	string	No	Postal code.
`[].params.city`	string	No	City.
`[].params.street`	string	No	Street and house number.
`[].params.country`	string	No	Country code, such as AT.
`[].claims`	object	Yes	Facts about the member that the membership definition and communities can filter on. All are optional and any may be null, such as for a claim the register does not know; what null means is the claim's own (for `leavingDate`, still employed). A register may send claims of its own beyond these.
`[].claims.entitled`	boolean or null	No	Whether the member is entitled to community benefits.
`[].claims.discountLevel`	integer or null	No	Discount level, in percent. At least 0. At most 100.
`[].claims.companyName`	string or null	No	The company the member works for.
`[].claims.employeeGroup`	string or null	No	The member's employee group.
`[].claims.employmentLevel`	integer or null	No	Employment level, in percent of full time. At least 0. At most 100.
`[].claims.leavingDate`	string (date) or null	No	The date the member left, YYYY-MM-DD; a date-time is accepted too. Null while employed.
`[].claims.isAnnualSalaryAbove50k`	boolean or null	No	Whether the annual salary is above 50,000.
`[].claims.numberOfKids`	integer or null	No	Number of children. At least 0.
`[].claims.childAllowance`	boolean or null	No	Whether the member receives child allowance.
`[].claims.soleEarner`	boolean or null	No	Whether the member is a sole earner.
`[].claims.mealVoucher`	number or null	No	Amount of the meal voucher. At least 0.

Example

[
  {
    "memberCode": "100001",
    "source": "SAP HR",
    "status": {
      "statusCode": "active"
    },
    "params": {
      "firstName": "Anna",
      "lastName": "Berger",
      "memberCode": "100001",
      "birthDate": "1979-02-02",
      "zip": "7100",
      "city": "Neusiedl am See",
      "street": "Musterweg 3",
      "country": "AT"
    },
    "claims": {
      "numberOfKids": 2,
      "employeeGroup": "Production",
      "isAnnualSalaryAbove50k": false,
      "discountLevel": 10,
      "employmentLevel": 100,
      "leavingDate": null,
      "companyName": "Pannoniqa AG"
    }
  },
  {
    "memberCode": "100002",
    "source": "SAP HR",
    "status": {
      "statusCode": "active"
    },
    "params": {
      "firstName": "Markus",
      "lastName": "Horvath",
      "memberCode": "100002",
      "birthDate": "1985-11-23",
      "zip": "7000",
      "city": "Eisenstadt",
      "street": "Beispielgasse 12",
      "country": "AT"
    },
    "claims": {
      "numberOfKids": 0,
      "employeeGroup": "Administration",
      "isAnnualSalaryAbove50k": true,
      "discountLevel": 10,
      "employmentLevel": 80,
      "leavingDate": null,
      "companyName": "Pannoniqa AG"
    }
  },
  {
    "memberCode": "100004",
    "source": "SAP HR",
    "status": {
      "statusCode": "inactive"
    },
    "params": {},
    "claims": {}
  }
]

400

The register could not process the request. The Studio treats it as the register being unavailable and does not read the body.

Content type: text/plain

Type: string

Example

Bad request

401

The API key is wrong. The Studio reports the credentials as rejected (it does the same for 403) and treats the register as unavailable.

Content type: text/plain

Type: string

Example

Unauthorized