POST fxo/User/WebUser

Request Information

URI Parameters

None.

Body Parameters

CreateWebUser
NameDescriptionTypeAdditional information
user_name

string

Required

full_name

string

Required

entity

IdValuePair

None.

password

string

Required

confirm_password

string

Required

email_address

string

Required

password_policy

IdValuePair

None.

time_zone

IdValuePair

None.

contact

IdValuePair

None.

status

string

Required

is_web_activated

string

None.

is_enable_two_fac_auth

string

None.

user_contact

string

None.

user_country_code

string

None.

auth_type

IdValuePair

None.

country_id

string

None.

Request Formats

application/json, text/json

Sample:
{
  "user_name": "sample string 1",
  "full_name": "sample string 2",
  "entity": {
    "value": "sample string 1",
    "id": 2
  },
  "password": "sample string 3",
  "confirm_password": "sample string 4",
  "email_address": "sample string 5",
  "password_policy": {
    "value": "sample string 1",
    "id": 2
  },
  "time_zone": {
    "value": "sample string 1",
    "id": 2
  },
  "contact": {
    "value": "sample string 1",
    "id": 2
  },
  "status": "sample string 6",
  "is_web_activated": "sample string 7",
  "is_enable_two_fac_auth": "sample string 8",
  "user_contact": "sample string 9",
  "user_country_code": "sample string 10",
  "auth_type": {
    "value": "sample string 1",
    "id": 2
  },
  "country_id": "sample string 11"
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CreateWebUser'.

application/xml

Sample:

An exception has occurred while using the formatter 'CustomXmlFormatter' to generate sample for media type 'application/xml'. Exception message: Cannot access a closed Stream.

text/xml

Sample:

An exception has occurred while using the formatter 'CustomXmlFormatter' to generate sample for media type 'text/xml'. Exception message: Cannot access a closed Stream.

Response Information

Resource Description

DSOutput
NameDescriptionTypeAdditional information
status

boolean

None.

data

Object

None.

code

integer

None.

message

string

None.

error

Error

None.

paging

Paging

None.

additional_codes

string

None.

Response Formats

application/json, text/json

Sample:
{
  "status": true,
  "data": {},
  "code": 0,
  "message": "sample string 3",
  "error": {
    "code": 0,
    "message": "sample string 1",
    "target": "sample string 2",
    "details": [
      {
        "code": 0,
        "target": "sample string 1",
        "message": "sample string 2"
      },
      {
        "code": 0,
        "target": "sample string 1",
        "message": "sample string 2"
      }
    ]
  },
  "paging": {
    "page_number": 1,
    "page_size": 2,
    "page_from": 3,
    "page_to": 4,
    "record_count": 5
  },
  "additional_codes": "sample string 4"
}

application/xml

Sample:

An exception has occurred while using the formatter 'CustomXmlFormatter' to generate sample for media type 'application/xml'. Exception message: Cannot access a closed Stream.

text/xml

Sample:

An exception has occurred while using the formatter 'CustomXmlFormatter' to generate sample for media type 'text/xml'. Exception message: Cannot access a closed Stream.