POST api/Users

Documentation for 'Authenticate'.

Request Information

Parameters

NameDescriptionAdditional information
request
Documentation for 'request'.

None.

user
Documentation for 'user'.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
{
  "UserName": "sample string 1",
  "UserId": 2,
  "CustomerIds": [
    1,
    2,
    3
  ],
  "Password": "anrmvzpJjGN4VUXKKH57IeNap9sfesstAHjJwcc0TD0=",
  "Language": "sample string 4",
  "Options": null,
  "FormatDate": "sample string 5",
  "FormatHour": "sample string 6",
  "InterCustomerId": 7
}

text/javascript

Sample:
{"UserName":"sample string 1","UserId":2,"CustomerIds":[1,2,3],"Password":"anrmvzpJjGN4VUXKKH57IeNap9sfesstAHjJwcc0TD0=","Language":"sample string 4","Options":null,"FormatDate":"sample string 5","FormatHour":"sample string 6","InterCustomerId":7}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response body formats

application/json, text/json

Sample:
{
  "Succeeded": true,
  "Token": "sample string 2",
  "Message": "sample string 3",
  "Language": "sample string 4",
  "HasImmo": true,
  "FormatDate": "sample string 6",
  "FormatHour": "sample string 7",
  "Logo": 8,
  "UserId": 9
}

text/javascript

Sample:
{"Succeeded":true,"Token":"sample string 2","Message":"sample string 3","Language":"sample string 4","HasImmo":true,"FormatDate":"sample string 6","FormatHour":"sample string 7","Logo":8,"UserId":9}

application/xml, text/xml

Sample:
<Status xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SAPI.WebService.Models">
  <FormatDate>sample string 6</FormatDate>
  <FormatHour>sample string 7</FormatHour>
  <HasImmo>true</HasImmo>
  <Language>sample string 4</Language>
  <Logo>8</Logo>
  <Message>sample string 3</Message>
  <Succeeded>true</Succeeded>
  <Token>sample string 2</Token>
  <UserId>9</UserId>
</Status>