POST api/v1/User?companyID={companyID}&authKey={authKey}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
companyID | integer |
Required |
|
authKey | string |
Required |
Body Parameters
UserName | Description | Type | Additional information |
---|---|---|---|
ID | integer |
None. |
|
FullName | string |
None. |
|
CompanyID | integer |
None. |
|
Login | string |
None. |
|
UserPrograms | Collection of UserProgram |
None. |
|
UserParameters | Collection of UserParameter |
None. |
Request Formats
application/json, text/json
Sample:
{ "ID": 1, "FullName": "sample string 2", "CompanyID": 1, "Login": "sample string 3", "UserPrograms": [ { "ID": 1, "ProgramID": 1, "UserID": 1, "Program": { "ID": 1, "DisplayName": "sample string 2", "FullPath": "sample string 3", "Arguments": "sample string 4", "CompanyID": 1, "ImagePath": "sample string 5" } }, { "ID": 1, "ProgramID": 1, "UserID": 1, "Program": { "ID": 1, "DisplayName": "sample string 2", "FullPath": "sample string 3", "Arguments": "sample string 4", "CompanyID": 1, "ImagePath": "sample string 5" } } ], "UserParameters": [ { "ID": 1, "Name": "sample string 2", "UserID": 1, "Content": "sample string 3", "Display": "sample string 2 : sample string 3" }, { "ID": 1, "Name": "sample string 2", "UserID": 1, "Content": "sample string 3", "Display": "sample string 2 : sample string 3" } ] }
text/xml
Sample:
<User xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PlanetLauncherAPI.Models"> <CompanyID>1</CompanyID> <FullName>sample string 2</FullName> <ID>1</ID> <Login>sample string 3</Login> <UserParameters> <UserParameter> <Content>sample string 3</Content> <ID>1</ID> <Name>sample string 2</Name> <UserID>1</UserID> </UserParameter> <UserParameter> <Content>sample string 3</Content> <ID>1</ID> <Name>sample string 2</Name> <UserID>1</UserID> </UserParameter> </UserParameters> <UserPrograms> <UserProgram> <ID>1</ID> <Program> <Arguments>sample string 4</Arguments> <CompanyID>1</CompanyID> <DisplayName>sample string 2</DisplayName> <FullPath>sample string 3</FullPath> <ID>1</ID> <ImagePath>sample string 5</ImagePath> </Program> <ProgramID>1</ProgramID> <UserID>1</UserID> </UserProgram> <UserProgram> <ID>1</ID> <Program> <Arguments>sample string 4</Arguments> <CompanyID>1</CompanyID> <DisplayName>sample string 2</DisplayName> <FullPath>sample string 3</FullPath> <ID>1</ID> <ImagePath>sample string 5</ImagePath> </Program> <ProgramID>1</ProgramID> <UserID>1</UserID> </UserProgram> </UserPrograms> </User>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |