POST api/Register

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
InstitutionCode	string	None.
ContributorName	string	None.
ContributorHospital	string	None.
ContributorProfession	string	None.
ContributorEmail	string	None.
ContributorCountry	string	None.
TermsAgreedId	integer	None.
ContributorUserAppU	globally unique identifier	None.
ContributorUserAppP	globally unique identifier	None.
ContributorPin	string	None.
Facility	string	None.
ContributorCentreGUID	globally unique identifier	None.
AppVersion	decimal number	None.

Request Formats

application/json, text/json

Sample:

{
  "InstitutionCode": "sample string 1",
  "ContributorName": "sample string 2",
  "ContributorHospital": "sample string 3",
  "ContributorProfession": "sample string 4",
  "ContributorEmail": "sample string 5",
  "ContributorCountry": "sample string 6",
  "TermsAgreedId": 7,
  "ContributorUserAppU": "15deacfa-2ec9-426e-9a4b-ced4680fe178",
  "ContributorUserAppP": "3aa87a44-61b1-4fbd-9a14-6801a6f3d153",
  "ContributorPin": "sample string 10",
  "Facility": "sample string 11",
  "ContributorCentreGUID": "f8d57b99-b1f3-4ea8-9caf-6bacd9ea4be1",
  "AppVersion": 1.1
}

text/xml

Sample:

<ContributorRegisterRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/gbddcwebapi.Models">
  <AppVersion>1.1</AppVersion>
  <ContributorCentreGUID>f8d57b99-b1f3-4ea8-9caf-6bacd9ea4be1</ContributorCentreGUID>
  <ContributorCountry>sample string 6</ContributorCountry>
  <ContributorEmail>sample string 5</ContributorEmail>
  <ContributorHospital>sample string 3</ContributorHospital>
  <ContributorName>sample string 2</ContributorName>
  <ContributorPin>sample string 10</ContributorPin>
  <ContributorProfession>sample string 4</ContributorProfession>
  <ContributorUserAppP>3aa87a44-61b1-4fbd-9a14-6801a6f3d153</ContributorUserAppP>
  <ContributorUserAppU>15deacfa-2ec9-426e-9a4b-ced4680fe178</ContributorUserAppU>
  <Facility>sample string 11</Facility>
  <InstitutionCode>sample string 1</InstitutionCode>
  <TermsAgreedId>7</TermsAgreedId>
</ContributorRegisterRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ContributorRegisterRequest'.

Response Information

Resource Description

ContributorRegisterResponse

Name	Type	Additional information
OnlineContributorUUID	globally unique identifier	None.
InstitutionUUID	globally unique identifier	None.
IsSuccess	boolean	None.
ErrorMessage	string	None.
ContributorUserAppU	globally unique identifier	None.
ContributorUserAppP	globally unique identifier	None.
AllowPhotos	boolean	None.
AllowRecording	boolean	None.
UsesCentres	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "OnlineContributorUUID": "adea8872-b746-4870-9eff-ad193ee4d3c8",
  "InstitutionUUID": "9a6c9c20-d5f8-4c2d-acb5-b776b03d21b0",
  "IsSuccess": true,
  "ErrorMessage": "sample string 4",
  "ContributorUserAppU": "1df78b2d-7dd7-4024-9cc3-73898c649e57",
  "ContributorUserAppP": "3a89d583-9ff3-4ad4-84fb-dfcb2adfa4c4",
  "AllowPhotos": true,
  "AllowRecording": true,
  "UsesCentres": true
}

text/xml

Sample:

<ContributorRegisterResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/gbddcwebapi.Models">
  <AllowPhotos>true</AllowPhotos>
  <AllowRecording>true</AllowRecording>
  <ContributorUserAppP>3a89d583-9ff3-4ad4-84fb-dfcb2adfa4c4</ContributorUserAppP>
  <ContributorUserAppU>1df78b2d-7dd7-4024-9cc3-73898c649e57</ContributorUserAppU>
  <ErrorMessage>sample string 4</ErrorMessage>
  <InstitutionUUID>9a6c9c20-d5f8-4c2d-acb5-b776b03d21b0</InstitutionUUID>
  <IsSuccess>true</IsSuccess>
  <OnlineContributorUUID>adea8872-b746-4870-9eff-ad193ee4d3c8</OnlineContributorUUID>
  <UsesCentres>true</UsesCentres>
</ContributorRegisterResponse>