POST api/Register
Request Information
URI Parameters
None.
Body Parameters
ContributorRegisterRequest| Name | Description | 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": "6cbccd00-f736-49f9-bf2b-52e389f50fc7",
"ContributorUserAppP": "9d3c7305-aaf7-4239-af49-f28c0282bbd3",
"ContributorPin": "sample string 10",
"Facility": "sample string 11",
"ContributorCentreGUID": "fbb8ca00-d91a-4586-860a-fef182412199",
"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>fbb8ca00-d91a-4586-860a-fef182412199</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>9d3c7305-aaf7-4239-af49-f28c0282bbd3</ContributorUserAppP> <ContributorUserAppU>6cbccd00-f736-49f9-bf2b-52e389f50fc7</ContributorUserAppU> <Facility>sample string 11</Facility> <InstitutionCode>sample string 1</InstitutionCode> <TermsAgreedId>7</TermsAgreedId> </ContributorRegisterRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
ContributorRegisterResponse| Name | Description | 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": "498ce7a5-4b2e-4999-b12b-a6cbed5e5986",
"InstitutionUUID": "24a634d7-d53d-4f6a-8dbb-7a4ebc00c837",
"IsSuccess": true,
"ErrorMessage": "sample string 4",
"ContributorUserAppU": "bf570d8e-d229-441d-8f66-93d1c143079e",
"ContributorUserAppP": "40842df9-fe05-48cb-adad-e0214d285d78",
"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>40842df9-fe05-48cb-adad-e0214d285d78</ContributorUserAppP> <ContributorUserAppU>bf570d8e-d229-441d-8f66-93d1c143079e</ContributorUserAppU> <ErrorMessage>sample string 4</ErrorMessage> <InstitutionUUID>24a634d7-d53d-4f6a-8dbb-7a4ebc00c837</InstitutionUUID> <IsSuccess>true</IsSuccess> <OnlineContributorUUID>498ce7a5-4b2e-4999-b12b-a6cbed5e5986</OnlineContributorUUID> <UsesCentres>true</UsesCentres> </ContributorRegisterResponse>