POST api/Account/Edit?authToken={authToken}
Edits the user specified by the authentication token.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
authToken |
The authentication token. |
string |
Required |
RemoveIdDocumentFile | boolean |
None. |
|
RemoveCriminalRecordFile | boolean |
None. |
|
RemoveDriverLicenseFile | boolean |
None. |
|
RemoveNIFFile | boolean |
None. |
|
RemoveIBANFile | boolean |
None. |
|
IdDocumentFile | HttpPostedFileBase |
Data type: Upload |
|
CriminalRecordFile | HttpPostedFileBase |
Data type: Upload |
|
DriverLicenseFile | HttpPostedFileBase |
Data type: Upload |
|
NIFFile | HttpPostedFileBase |
Data type: Upload |
|
IBANFile | HttpPostedFileBase |
Data type: Upload |
|
Name | string |
Required Max length: 256 |
|
PhoneNumberPrefix | string |
Required Max length: 128 |
|
PhoneNumber | string |
Required Matching regular expression pattern: ^(9|2{1})+([1-9]{1})+([0-9]{7})$ |
|
IsClient | boolean |
None. |
|
IsCarrier | boolean |
None. |
|
Address | string |
Max length: 256 |
|
City | string |
Max length: 128 |
|
ZipCode | string |
Matching regular expression pattern: ^([a-zA-Z0-9]{4})([a-zA-Z0-9]{3})?$ Max length: 128 |
|
IDDocumentType | IdDocumentType |
None. |
|
IDDocumentNumber | string |
Max length: 128 |
|
CountryId | globally unique identifier |
None. |
|
AllowNewsletter | boolean |
None. |
|
CommunicationLanguage | SupportedLanguage |
None. |
|
IBAN | string |
Max length: 128 |
Body Parameters
None.
Response Information
Resource Description
ServiceResultOfAuthModelName | Description | Type | Additional information |
---|---|---|---|
Result | AuthModel |
None. |
|
ErrorCode | ServiceErrorCode |
None. |
|
ErrorMessage | Collection of string |
None. |
|
Success | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{ "Result": { "AuthToken": "sample string 1", "Name": "sample string 2", "IsCompany": true, "CompanyName": "sample string 4", "UserRoles": [ "sample string 1", "sample string 2" ], "EntityState": 1, "HasOngoingAuctions": true, "HasDeliveries": true, "RequiresPasswordChange": true }, "ErrorCode": 0, "ErrorMessage": [ "sample string 1", "sample string 2" ], "Success": true }
application/xml, text/xml
Sample:
<ServiceResultOfAuthModel_PTu2eKdN xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOP.Common.Infrastructure.ApiObjects.Results"> <ErrorCode>None</ErrorCode> <ErrorMessage xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </ErrorMessage> <Success>true</Success> <Result> <AuthToken>sample string 1</AuthToken> <CompanyName>sample string 4</CompanyName> <EntityState>Pending</EntityState> <HasDeliveries>true</HasDeliveries> <HasOngoingAuctions>true</HasOngoingAuctions> <IsCompany>true</IsCompany> <Name>sample string 2</Name> <RequiresPasswordChange>true</RequiresPasswordChange> <UserRoles xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </UserRoles> </Result> </ServiceResultOfAuthModel_PTu2eKdN>