POST api/v2/requestnewuseraccount
Request Information
URI Parameters
None.
Body Parameters
RequestNewUserAccountObjectName | Description | Type | Additional information |
---|---|---|---|
AccountNumber | string |
None. |
|
string |
None. |
||
RefType | ObjectTypes |
None. |
|
RefID | integer |
None. |
|
NameOption | NameOptions |
None. |
|
URLForEmailLink | string |
None. |
|
UnitAddress | string |
None. |
|
UnitNumber | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "AccountNumber": "sample string 1", "Email": "sample string 2", "RefType": 0, "RefID": 3, "NameOption": 0, "URLForEmailLink": "sample string 4", "UnitAddress": "sample string 5", "UnitNumber": "sample string 6" }
application/xml, text/xml
Sample:
<RequestNewUserAccountObject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaliberAPI"> <AccountNumber>sample string 1</AccountNumber> <Email>sample string 2</Email> <NameOption>Contact1</NameOption> <RefID>3</RefID> <RefType>Division</RefType> <URLForEmailLink>sample string 4</URLForEmailLink> <UnitAddress>sample string 5</UnitAddress> <UnitNumber>sample string 6</UnitNumber> </RequestNewUserAccountObject>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
Collection of PersonName | Description | Type | Additional information |
---|---|---|---|
RefType | ObjectTypes |
None. |
|
RefID | integer |
None. |
|
NameOption | NameOptions |
None. |
|
Name | string |
None. |
|
ManagementCompanyID | integer |
None. |
|
AccountExists | boolean |
None. |
|
string |
None. |
||
AccountNumber | string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "RefType": 0, "RefID": 1, "NameOption": 0, "Name": "sample string 2", "ManagementCompanyID": 3, "AccountExists": true, "Email": "sample string 5", "AccountNumber": "sample string 6" }, { "RefType": 0, "RefID": 1, "NameOption": 0, "Name": "sample string 2", "ManagementCompanyID": 3, "AccountExists": true, "Email": "sample string 5", "AccountNumber": "sample string 6" } ]
application/xml, text/xml
Sample:
<ArrayOfPerson xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaliberAPI"> <Person> <AccountExists>true</AccountExists> <AccountNumber>sample string 6</AccountNumber> <Email>sample string 5</Email> <ManagementCompanyID>3</ManagementCompanyID> <Name>sample string 2</Name> <NameOption>Contact1</NameOption> <RefID>1</RefID> <RefType>Division</RefType> </Person> <Person> <AccountExists>true</AccountExists> <AccountNumber>sample string 6</AccountNumber> <Email>sample string 5</Email> <ManagementCompanyID>3</ManagementCompanyID> <Name>sample string 2</Name> <NameOption>Contact1</NameOption> <RefID>1</RefID> <RefType>Division</RefType> </Person> </ArrayOfPerson>