POST accounts/users

[HTTP POST] ~/accounts/users

Description: Creates a new User record

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
userInfo		UserInfo	None.
sendWelcomeEmail		boolean	None.

Formats

application/json, text/json

Sample:

{
  "userInfo": {
    "Id": 1,
    "UserName": "sample string 2",
    "FirstName": "sample string 3",
    "Surname": "sample string 4",
    "WorkPhone": "sample string 5",
    "Mobile": "sample string 6",
    "JobTitle": "sample string 7",
    "StaffId": "sample string 8",
    "DocumentGroups": [
      1,
      2
    ],
    "AccountId": 9,
    "Access": 10,
    "Roles": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "sendWelcomeEmail": true
}

application/csp-report

Sample:

{"userInfo":{"Id":1,"UserName":"sample string 2","FirstName":"sample string 3","Surname":"sample string 4","WorkPhone":"sample string 5","Mobile":"sample string 6","JobTitle":"sample string 7","StaffId":"sample string 8","DocumentGroups":[1,2],"AccountId":9,"Access":10,"Roles":["sample string 1","sample string 2"]},"sendWelcomeEmail":true}

application/xml, text/xml

Sample:

<CreateUserRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/W50API.Models.DTO">
  <sendWelcomeEmail>true</sendWelcomeEmail>
  <userInfo>
    <Access>10</Access>
    <AccountId>9</AccountId>
    <DocumentGroups xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </DocumentGroups>
    <FirstName>sample string 3</FirstName>
    <Id>1</Id>
    <JobTitle>sample string 7</JobTitle>
    <Mobile>sample string 6</Mobile>
    <Roles xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Roles>
    <StaffId>sample string 8</StaffId>
    <Surname>sample string 4</Surname>
    <UserName>sample string 2</UserName>
    <WorkPhone>sample string 5</WorkPhone>
  </userInfo>
</CreateUserRequest>

Response Information

Description

Successful Response - OK (200):

Response Content : UserInfo

Name	Description	Type	Additional information
Id	The Id of the User	integer	None.
UserName		string	None.
FirstName		string	None.
Surname		string	None.
WorkPhone		string	None.
Mobile		string	None.
JobTitle		string	None.
StaffId		string	None.
DocumentGroups		Collection of integer	None.
AccountId		integer	None.
Access	Flag for the User's access level on the Account	integer	None.
Roles	The custom Roles associated with this user for this account	Collection of string	None.

Response Codes:

200 - OK
401 - Unauthorized

Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "UserName": "sample string 2",
  "FirstName": "sample string 3",
  "Surname": "sample string 4",
  "WorkPhone": "sample string 5",
  "Mobile": "sample string 6",
  "JobTitle": "sample string 7",
  "StaffId": "sample string 8",
  "DocumentGroups": [
    1,
    2
  ],
  "AccountId": 9,
  "Access": 10,
  "Roles": [
    "sample string 1",
    "sample string 2"
  ]
}

application/csp-report

Sample:

{"Id":1,"UserName":"sample string 2","FirstName":"sample string 3","Surname":"sample string 4","WorkPhone":"sample string 5","Mobile":"sample string 6","JobTitle":"sample string 7","StaffId":"sample string 8","DocumentGroups":[1,2],"AccountId":9,"Access":10,"Roles":["sample string 1","sample string 2"]}

application/xml, text/xml

Sample:

<UserInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/W50API.Models.DTO">
  <Access>10</Access>
  <AccountId>9</AccountId>
  <DocumentGroups xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </DocumentGroups>
  <FirstName>sample string 3</FirstName>
  <Id>1</Id>
  <JobTitle>sample string 7</JobTitle>
  <Mobile>sample string 6</Mobile>
  <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>
  <StaffId>sample string 8</StaffId>
  <Surname>sample string 4</Surname>
  <UserName>sample string 2</UserName>
  <WorkPhone>sample string 5</WorkPhone>
</UserInfo>