POST api/Sync/CreateUserAccount

Allow an owner's account to create an administrador user, also an email will send to the user's e-mail with his login information.

Request Information

URI Parameters

None.

Body Parameters

CreateUserAccountModel
NameDescriptionTypeAdditional information
UserEmail

The user's email address.

string

Required

Data type: EmailAddress

Matching regular expression pattern: ^([a-zA-Z0-9_\-\.]+)@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.)|(([a-zA-Z0-9\-]+\.)+))([a-zA-Z]{2,4}|[0-9]{1,3})(\]?)$

String length: inclusive between 0 and 100

UserFullName

The user's display name.

string

Required

String length: inclusive between 0 and 100

UserTaxID

The user's unique tax ID

string

None.

UserBirthDate

The user's birth date.

date

None.

AccountCode

The unique ID of the account.

string

Required

AccountName

The name of the account.

string

Required

AccountState

Represent the state of the account.

string

None.

AccountCity

Represent the city of the account.

string

None.

AccountAddress

Represent the address of the account.

string

None.

AccountContactEmail

Represent the email address of the account.

string

None.

AccountPhoneNumber

Represent the phone number of the account.

string

None.

OwnerTaxID

The owner's unique tax ID of the account.

string

Required

OwnerFullName

The owner's fullname of the account.

string

Required

OwnerPhoneNumber

The owner's phone number.

string

None.

CountryCode

Represent the country code of account. (ex: Chile=CL, Brasil=BR, ..)

string

Required

Message

Return a message when the operation was created successfully.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "UserEmail": "sample string 1",
  "UserFullName": "sample string 2",
  "UserTaxID": "sample string 3",
  "UserBirthDate": "2024-05-08T23:41:24.0908041+00:00",
  "AccountCode": "sample string 4",
  "AccountName": "sample string 5",
  "AccountState": "sample string 6",
  "AccountCity": "sample string 7",
  "AccountAddress": "sample string 8",
  "AccountContactEmail": "sample string 9",
  "AccountPhoneNumber": "sample string 10",
  "OwnerTaxID": "sample string 11",
  "OwnerFullName": "sample string 12",
  "OwnerPhoneNumber": "sample string 13",
  "CountryCode": "sample string 14",
  "Message": "sample string 15"
}

application/xml, text/xml

Sample:
<CreateUserAccountModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gosocket.Web.Api.Models">
  <AccountAddress>sample string 8</AccountAddress>
  <AccountCity>sample string 7</AccountCity>
  <AccountCode>sample string 4</AccountCode>
  <AccountContactEmail>sample string 9</AccountContactEmail>
  <AccountName>sample string 5</AccountName>
  <AccountPhoneNumber>sample string 10</AccountPhoneNumber>
  <AccountState>sample string 6</AccountState>
  <CountryCode>sample string 14</CountryCode>
  <Message>sample string 15</Message>
  <OwnerFullName>sample string 12</OwnerFullName>
  <OwnerPhoneNumber>sample string 13</OwnerPhoneNumber>
  <OwnerTaxID>sample string 11</OwnerTaxID>
  <UserBirthDate>2024-05-08T23:41:24.0908041+00:00</UserBirthDate>
  <UserEmail>sample string 1</UserEmail>
  <UserFullName>sample string 2</UserFullName>
  <UserTaxID>sample string 3</UserTaxID>
</CreateUserAccountModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.