GET api/BrandBox/Register
Request Information
URI Parameters
None.
Body Parameters
UserDTOName | Description | Type | Additional information |
---|---|---|---|
Credentials | CredentialDTO |
None. |
|
UserProfileID | integer |
None. |
|
ContactName | string |
None. |
|
PracticeName | string |
None. |
|
Address | string |
None. |
|
City | string |
None. |
|
State | string |
None. |
|
Zip | string |
None. |
|
Telephone | string |
None. |
|
EmailAddress | string |
None. |
|
RegistrationDate | date |
None. |
|
UserName | string |
None. |
|
Password | string |
None. |
|
EmailSubscribe | boolean |
None. |
|
Address2 | string |
None. |
|
DateModified | date |
None. |
|
GUID_ID | globally unique identifier |
None. |
|
Status | integer |
None. |
|
BDMAdded | string |
None. |
|
Brand | string |
None. |
|
LastLogin | date |
None. |
|
Firstname | string |
None. |
|
Lastname | string |
None. |
|
CountryCode | integer |
None. |
|
PayerNumber | string |
None. |
|
LoginAttempts | integer |
None. |
|
LockableRegistration | boolean |
None. |
|
CreatedDate | date |
None. |
|
CreatedBy | integer |
None. |
|
UpdatedDate | date |
None. |
|
UpdatedBy | integer |
None. |
|
Token | globally unique identifier |
None. |
|
ExpirationDate | date |
None. |
|
OktaUser | boolean |
None. |
|
ResetPasswordToken | globally unique identifier |
None. |
|
ActivationToken | string |
None. |
|
Activated | boolean |
None. |
|
ActivationTokenDate | date |
None. |
|
ActivationEmailSent | boolean |
None. |
|
ActivatedDate | date |
None. |
|
OKTAStatus | string |
None. |
|
LoggedIn_UserId | integer |
None. |
|
OktaUserId | string |
None. |
|
CurrentPassword | string |
None. |
|
TnCAccepted | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{ "Credentials": { "$id": "2", "UserName": "sample string 1", "Password": "sample string 2", "AccessKey": "sample string 3", "SecurityQuestion": "sample string 4", "SecurityAnswer": "sample string 5" }, "UserProfileID": 1, "ContactName": "sample string 2", "PracticeName": "sample string 3", "Address": "sample string 4", "City": "sample string 5", "State": "sample string 6", "Zip": "sample string 7", "Telephone": "sample string 8", "EmailAddress": "sample string 9", "RegistrationDate": "2024-05-07T19:58:58.2210931-07:00", "UserName": "sample string 11", "Password": "sample string 12", "EmailSubscribe": true, "Address2": "sample string 14", "DateModified": "2024-05-07T19:58:58.2210931-07:00", "GUID_ID": "35210f32-50f6-479b-92e3-7ba1b0923850", "Status": 16, "BDMAdded": "sample string 17", "Brand": "sample string 18", "LastLogin": "2024-05-07T19:58:58.2210931-07:00", "Firstname": "sample string 19", "Lastname": "sample string 20", "CountryCode": 1, "PayerNumber": "sample string 21", "LoginAttempts": 22, "LockableRegistration": true, "CreatedDate": "2024-05-07T19:58:58.2210931-07:00", "CreatedBy": 1, "UpdatedDate": "2024-05-07T19:58:58.2210931-07:00", "UpdatedBy": 1, "Token": "8f32cea6-75a1-495d-a807-9b544d2c3bd6", "ExpirationDate": "2024-05-07T19:58:58.2210931-07:00", "OktaUser": true, "ResetPasswordToken": "5a634f9e-f9e1-476d-bc06-650808f8e972", "ActivationToken": "sample string 26", "Activated": true, "ActivationTokenDate": "2024-05-07T19:58:58.2210931-07:00", "ActivationEmailSent": true, "ActivatedDate": "2024-05-07T19:58:58.2210931-07:00", "OKTAStatus": "sample string 29", "LoggedIn_UserId": 30, "OktaUserId": "sample string 31", "CurrentPassword": "sample string 32", "TnCAccepted": true }
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
IBTResponseDTOName | Description | Type | Additional information |
---|---|---|---|
Status | Response |
None. |
|
Message | string |
None. |
|
ResponseObject | Object |
None. |
|
AuthorizationSet | AuthorizationDTO |
None. |
|
User | Object |
None. |
Response Formats
application/json, text/json
Sample:
Sample not available.