Index

POST Login

Login endpoint for authentication, a post should be made to this endpoint with a valid username and password and a token object will be return containing a Jwt token and expiry date.

Request Information

URI Parameters

None.

Body Parameters

CompanyTokenRequestModel

Name	Description	Type	Additional information
Username		globally unique identifier	None.
Password		string	None.

Request Formats

application/json, text/json

Sample:

{
    userName : 'spindogs',
    password : 'xdferA!S^%' 
}

application/xml, text/xml

Sample:

<CompanyTokenRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SalonPartner.Api.Models">
  <Password>sample string 2</Password>
  <Username>f66c26fc-8808-4a62-af02-b321cd1fbc77</Username>
</CompanyTokenRequestModel>

application/x-www-form-urlencoded

Sample:

username=foo&password=bar

Response Information

Resource Description

A UserToken model containing the a Jwt token along with the expiry date of the token

UserTokenModel

Name	Type	Additional information
Token	string	None.
UtcExpiry	date	None.
AccessLevelId	EmployeeAccessLevelEnum	None.
Username	string	None.
Surname	string	None.
Forenames	string	None.
Id	integer	None.
CompanyId	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "token": "sample string 1",
  "utcExpiry": "2026-01-01T14:12:10.4395291+00:00",
  "accessLevelId": 0,
  "username": "sample string 3",
  "surname": "sample string 4",
  "forenames": "sample string 5",
  "id": 6,
  "companyId": 7
}

application/xml, text/xml

Sample:

<UserTokenModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SalonPartner.Api.Models.User">
  <AccessLevelId>None</AccessLevelId>
  <CompanyId>7</CompanyId>
  <Forenames>sample string 5</Forenames>
  <Id>6</Id>
  <Surname>sample string 4</Surname>
  <Token>sample string 1</Token>
  <Username>sample string 3</Username>
  <UtcExpiry>2026-01-01T14:12:10.4395291+00:00</UtcExpiry>
</UserTokenModel>