DeveloperLogin

Description

This login method allows you to authenticate with the web service API. 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 passed on the query string as part of the URL. NOTE: If you are not using cookies, the sessionId will need to be passed as part of the request with the key of SessionId.

History

2009-03-18 REST authentication introduced

SOAP URI:
Not applicable to SOAP

REST URI [GET|POST]:
/Authentication/2009-03-18/Authenticate.svc/DeveloperLogin?developerId={developerId}&password={password}

Request 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 AuthenticationResultWS aggregate which contains the result and sessionId for the authentication request.

Type: AuthenticationResultWS