POST api/v1/accounts/registerstaffwithagency
Request Information
URI Parameters
None.
Body Parameters
StaffRegistrationModel| Name | Description | Type | Additional information |
|---|---|---|---|
| UserName | string |
Required |
|
| Roles | Collection of string |
Required |
|
| EmailConfirmed | boolean |
None. |
|
| FirstName | string |
Required |
|
| LastName | string |
Required |
|
| EmailAddress | string |
Required Data type: EmailAddress |
|
| AgencyId | integer |
Required |
|
| ContactId | integer |
None. |
Request Formats
application/json, text/json, text/html
Sample:
{
"userName": "sample string 1",
"roles": [
"sample string 1",
"sample string 2"
],
"emailConfirmed": true,
"firstName": "sample string 3",
"lastName": "sample string 4",
"emailAddress": "sample string 5",
"agencyId": 6,
"contactId": 1
}
application/xml, text/xml
Sample:
<StaffRegistrationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VOL.API.Models">
<AgencyId>6</AgencyId>
<ContactId>1</ContactId>
<EmailAddress>sample string 5</EmailAddress>
<EmailConfirmed>true</EmailConfirmed>
<FirstName>sample string 3</FirstName>
<LastName>sample string 4</LastName>
<Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Roles>
<UserName>sample string 1</UserName>
</StaffRegistrationModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
UserRegistrationResult| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId | integer |
None. |
|
| ContactId | integer |
None. |
|
| ExistingUser | boolean |
None. |
|
| ExistingContact | boolean |
None. |
|
| Errors | Collection of string |
None. |
Response Formats
application/json, text/json, text/html
Sample:
{
"userId": 1,
"contactId": 2,
"existingUser": true,
"existingContact": true,
"errors": [
"sample string 1",
"sample string 2"
]
}
application/xml, text/xml
Sample:
<UserRegistrationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VOL.Core.CustomModels">
<ContactId>2</ContactId>
<Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Errors>
<ExistingContact>true</ExistingContact>
<ExistingUser>true</ExistingUser>
<UserId>1</UserId>
</UserRegistrationResult>