MyCSI API - Documentation

GET Auth/{id}?Email={Email}

Method used to provide an authentication token for API use.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	API Token associated with the email address.	globally unique identifier	Required
Email	Email address associated with the API Token.	string	Required

Body Parameters

None.

Response Information

Resource Description

The AuthModel object, containing the authentication token.

AuthModel

Name	Description	Type	Additional information
ErrorMessage	Optional error message provided by the method call.	string	None.
Message	Optional message provided by the method call.	string	None.
StatusCode	The HTTP Status Code of the method call.	HttpStatusCode	None.
Success	Boolean flag indicating the success or failure of the method call.	boolean	None.
Token	Authentication token, used in all other API methods.	globally unique identifier	None.

Response Formats

application/json, text/json

Sample:

{
  "Token": "0f482d62-88f7-4113-a37e-ea087df03a82",
  "Success": true,
  "Message": "sample string 2",
  "ErrorMessage": "sample string 3",
  "StatusCode": 100
}

application/octet-stream

Sample:

{"Token":"0f482d62-88f7-4113-a37e-ea087df03a82","Success":true,"Message":"sample string 2","ErrorMessage":"sample string 3","StatusCode":100}

application/xml, text/xml

Sample:

<AuthModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CSI.MyCSI.WebAPI.Models">
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/CSI.MyCSI.WebAPI.Models.Shared">sample string 3</ErrorMessage>
  <Message xmlns="http://schemas.datacontract.org/2004/07/CSI.MyCSI.WebAPI.Models.Shared">sample string 2</Message>
  <StatusCode xmlns="http://schemas.datacontract.org/2004/07/CSI.MyCSI.WebAPI.Models.Shared">Continue</StatusCode>
  <Success xmlns="http://schemas.datacontract.org/2004/07/CSI.MyCSI.WebAPI.Models.Shared">true</Success>
  <Token>0f482d62-88f7-4113-a37e-ea087df03a82</Token>
</AuthModel>