POST api/v3/Account/Register

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Email	string	Required
FamilyName	string	Required
GivenName	string	Required
DateOfBirth	string	Required
OdsCode	string	Required
PhoneNumber	string	Required
NhsNumber	string	Required
AccountId	string	Required
LinkageKey	string	Required

Request Formats

application/json, text/json

Sample:

{
  "Email": "sample string 1",
  "FamilyName": "sample string 2",
  "GivenName": "sample string 3",
  "DateOfBirth": "sample string 4",
  "OdsCode": "sample string 5",
  "PhoneNumber": "sample string 6",
  "NhsNumber": "sample string 7",
  "AccountId": "sample string 8",
  "LinkageKey": "sample string 9"
}

application/xml, text/xml

Sample:

<NHSUserRegisterModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CodaPharma.Api.Models">
  <AccountId>sample string 8</AccountId>
  <DateOfBirth>sample string 4</DateOfBirth>
  <Email>sample string 1</Email>
  <FamilyName>sample string 2</FamilyName>
  <GivenName>sample string 3</GivenName>
  <LinkageKey>sample string 9</LinkageKey>
  <NhsNumber>sample string 7</NhsNumber>
  <OdsCode>sample string 5</OdsCode>
  <PhoneNumber>sample string 6</PhoneNumber>
</NHSUserRegisterModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseModel

Name	Type	Additional information
Status	ResStatus	None.
ErrorMessage	string	None.
Data	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "Status": 0,
  "ErrorMessage": "sample string 1",
  "Data": {}
}

application/xml, text/xml

Sample:

<ResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CodaPharma.Api.Models">
  <Data />
  <ErrorMessage>sample string 1</ErrorMessage>
  <Status>Fail</Status>
</ResponseModel>