POST api/CreateClientUser_V1

Create User

Request Information

URI Parameters

None.

Body Parameters

Create User request

WS_Repository.Models.Requests.ClientDetails.CreateUserRequest
NameDescriptionTypeAdditional information
WS_Key

Client Webservice Key

string

None.

FirstName

First Name

string

None.

LastName

Last Name

string

None.

Email

string

None.

Telephone

string

None.

UserName

string

None.

Password

string

None.

CountryCode

string

None.

Province

string

None.

City

string

None.

Address1

string

None.

Address2

string

None.

PostalCode

string

None.

LocationId

integer

None.

LocationName

string

None.

Company

string

None.

SendEmailConfirmation

Set to true, to have 2Ship send an email to the user to confirm their email address (default is false)

boolean

None.

SignupCode

This is the Signup code assigned to the user in 2Ship who's profile will be copied over to your new user.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "WS_Key": "sample string 1",
  "FirstName": "sample string 2",
  "LastName": "sample string 3",
  "Email": "sample string 4",
  "Telephone": "sample string 5",
  "UserName": "sample string 6",
  "Password": "sample string 7",
  "CountryCode": "sample string 8",
  "Province": "sample string 9",
  "City": "sample string 10",
  "Address1": "sample string 11",
  "Address2": "sample string 12",
  "PostalCode": "sample string 13",
  "LocationId": 14,
  "LocationName": "sample string 15",
  "Company": "sample string 16",
  "SendEmailConfirmation": true,
  "SignupCode": "sample string 18"
}

application/xml, text/xml

Sample:
<CreateUserRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Requests.ClientDetails">
  <Address1>sample string 11</Address1>
  <Address2>sample string 12</Address2>
  <City>sample string 10</City>
  <Company>sample string 16</Company>
  <CountryCode>sample string 8</CountryCode>
  <Email>sample string 4</Email>
  <FirstName>sample string 2</FirstName>
  <LastName>sample string 3</LastName>
  <LocationId>14</LocationId>
  <LocationName>sample string 15</LocationName>
  <Password>sample string 7</Password>
  <PostalCode>sample string 13</PostalCode>
  <Province>sample string 9</Province>
  <SendEmailConfirmation>true</SendEmailConfirmation>
  <SignupCode>sample string 18</SignupCode>
  <Telephone>sample string 5</Telephone>
  <UserName>sample string 6</UserName>
  <WS_Key>sample string 1</WS_Key>
</CreateUserRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'WS_Repository.Models.Requests.ClientDetails.CreateUserRequest'.

Response Information

Resource Description

Create User Response

WS_Repository.Models.Responses.ClientDetails.CreateUserResponse
NameDescriptionTypeAdditional information
WS_Key

User Webservice Key

string

None.

Response Formats

application/json, text/json

Sample:
{
  "WS_Key": "sample string 1"
}

application/xml, text/xml

Sample:
<CreateUserResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Responses.ClientDetails">
  <WS_Key>sample string 1</WS_Key>
</CreateUserResponse>