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": "4b696015-753b-4143-b427-359ba51d3dde",
"ContributorUserAppP": "7b973322-a6c2-485a-b152-489d9ad9ac03",
"ContributorPin": "sample string 10",
"Facility": "sample string 11",
"ContributorCentreGUID": "7c4f55b9-fdeb-483e-ac10-01f3e6e8768b",
"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>7c4f55b9-fdeb-483e-ac10-01f3e6e8768b</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>7b973322-a6c2-485a-b152-489d9ad9ac03</ContributorUserAppP> <ContributorUserAppU>4b696015-753b-4143-b427-359ba51d3dde</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": "4dc9d059-6ccc-4a71-af39-95ca6e987d10",
"InstitutionUUID": "73818fb2-a506-4dfa-9b17-a68db95aa17b",
"IsSuccess": true,
"ErrorMessage": "sample string 4",
"ContributorUserAppU": "2240f91c-3615-431c-8207-36673796eba6",
"ContributorUserAppP": "5f803f43-040d-4a12-9afd-ea7abc85ec12",
"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>5f803f43-040d-4a12-9afd-ea7abc85ec12</ContributorUserAppP> <ContributorUserAppU>2240f91c-3615-431c-8207-36673796eba6</ContributorUserAppU> <ErrorMessage>sample string 4</ErrorMessage> <InstitutionUUID>73818fb2-a506-4dfa-9b17-a68db95aa17b</InstitutionUUID> <IsSuccess>true</IsSuccess> <OnlineContributorUUID>4dc9d059-6ccc-4a71-af39-95ca6e987d10</OnlineContributorUUID> <UsesCentres>true</UsesCentres> </ContributorRegisterResponse>