Client

APIDescription
GET api/client/{pps}/{dob}

Provides identity information for a single Client based on the PPS Number and dob.

GET api/client/{pps}/{dob}/entitlements/{fromDate}/{toDate}

Provides the entitled allowance information for a single Client between a specific date range.

GET api/client/{pps}/{dob}/childbenefit/{parentOnePPSN}/{parentTwoPPSN}

Provides information for a single Client which is a child to see if there is a child benefit claim for that customer which has an adult associaated with one of the parents that were passed in as paramaters to the call. Note - Does having the route called ParentOnePPSN imply that the ppsn passed in must be the parent? Should it be renamed to adultOnePPSN to cater for a parent or a guardian ppsn

GET api/client/{pps}/{dob}/means

Means Factor information gathered in relation to an individual client.

GET api/client/{pps}/{DOB}/householdaddress

Household address information for a single Client based on the PPS Number and date of birth combination. This service is not available to all consumers of the API.

GET api/client/{pps}/{DOB}/CorrespondenceAddress

CorrespondenceAddress information for a single Client based on the PPS Number and date of birth combination. This service is not available to all consumers of the API.

GET api/client/{pps}/{DOB}/contributions/{fromyear}/{toyear}

Household address information for a single Client based on the PPS Number and date of birth combination. This service is not available to all consumers of the API.

GET api/client/{pps}/{DOB}/claim/{fromDate}/{toDate}

See open, awarded, pending claims for an individual customer

GET api/client/{pps}/{dob}/payments/{fromDate}/{toDate}

Payments that a customer has received within a specified date range.

GET api/client/{pps}/{dob}/schemeindicator/{listOfSchemes}/{childppsn}

See if an individual customer is currently in receipt of a claim where the scheme type is on a user defined list of schemes. This service is not available to all consumers of the API.

MeansFactor

APIDescription
GET api/meanslist

Provides DSP SchemeTypes that are available to view by external agencies via the DSPAPI This list is the first draft of externally viewable list of schemes and may change over the next few sprints.

Employer

APIDescription
GET api/employer/{EmployerNumber}

Employer name and address information for a single Employer. This service is not available to all consumers of the API.

Scheme

APIDescription
GET api/schemes

Provides DSP SchemeTypes that are available to view by external agencies via the DSPAPI This list is the first draft of externally viewable list of schemes and may change over the next few sprints.