Request Information

URI Parameters

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList

None.

Body Parameters (LoginParameter)

User name and password must be sent into this object.

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
UserName string Required

User Name of the user who is being logged in.

Password string Required

Password of the user who is being logged in.

Request Formats

application/xml, text/xml

Sample
<LoginParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <UserName>sample string 1</UserName>
  <Password>sample string 2</Password>
</LoginParameter>

application/json, text/json

Sample
{
  "UserName": "sample string 1",
  "Password": "sample string 2"
}

Response Information

Resource Description (AuthToken)

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
Site globally unique identifier

Token string

UserName string

Response Formats

application/xml, text/xml

Sample
<AuthToken xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Connections.Common.Model">
  <Site>5a9e3d34-ef8b-4cf3-aeb8-fdb743fe1550</Site>
  <Token>sample string 2</Token>
  <UserName>sample string 3</UserName>
</AuthToken>

application/json, text/json

Sample
{
  "Site": "5a9e3d34-ef8b-4cf3-aeb8-fdb743fe1550",
  "Token": "sample string 2",
  "UserName": "sample string 3"
}