User Login

Description

The UserLogin operation allows you to retrieve the user record for a user of OneGreatfamily system.

Version

2011-02-02

URI

REST URI [GET]:
/v11.02/User.svc/login?username={Username}&password={Password}&sessionid={SessionId}

Example

Request GET
http://wsdev.onegreatfamily.com/v11.02/User.svc/login?username=billsmith&password=billspass&sessionid=bqyfeoyt2mfcmqd2pplwmdm1
Success Response Payload 
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">bqyfeoyt2mfcmqd2pplwmdm1</string>
Fault Response Payload 
<RestFault xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<ErrorCode>551</ErrorCode>
	<FaultMessage>An unhandled exception has occurred</FaultMessage>
</RestFault>

Query String Parameters

Name Description Required

Username

The username for the user

Type: String

Default: None

Constraints: Must be a valid username.

Yes

Password

The password for the user

Type: String

Default: None

Constraints: Must be a valid password.

Yes

SessionId

The session id for the currently logged in user

Type: String

Default: None

Constraints: Must be a valid session id.

Yes

Response Elements

Name Description

SessionId

This operation returns the SessionId required by many of the calls in the API. Otherwise an error is returned.

Type: String

HTTP Status Code

The Web Server returns a status code which indicates if the operation was successful. Anything other than 200 should be regarded as a failure.

HTTP Status Code of 417

The Web Server threw an exception and contains a RestFault aggregate. Retrieve the RestFault from the Webexception response property.