Developer Login

Description

This login method allows you to authenticate with the web service API as a developer. A SessionId will be returned and placed in a cookie, if cookies are enabled. If cookies are enabled, then the sessionId in the cookie will be read allowing access to the rest of the API. If cookies are not enabled, then the sessionId will need to be passed on the query string of each request.

Version

2011-02-02

URI

REST URI [GET]:
/v11.02/Authenticate.svc/DeveloperLogin?developerId={developerId}&password={password}

Example

Request GET
http://wsdev.onegreatfamily.com/v11.02/Authenticate.svc/DeveloperLogin?developerId=myid&password=gl4q23cwofpshi55sg1dvc3o
Success Response Payload
<AuthenticationResult xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<Result>Success</Result> 
	<SessionId>7BD502AF-8D29-4D7A-982F-D1E95C266BA0</SessionId> 
</AuthenticationResultWS>
Failed Response Payload
<AuthenticationResult xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<Result>Invalid developer credentials</Result> 
	<SessionId></SessionId> 
</AuthenticationResultWS>
 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

developerId

The web service developerId used to access the web service API. Send and email to: devws@onegreatfamily.com to obtain a developer ID.

Type: String

Default: None

Constraints: Must be a valid developer Id.

Yes

Password

The Password associated with the developerId

Type: String

Default: None

Constraints: Must be the valid password.

Yes

Response Elements

Name DeDescription

AuthenticationResult

This operation returns an AuthenticationResult aggregate which contains the result and sessionId for the authentication request.

Type: AuthenticationResult

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.