Accounts

The account resource will create a new user login and either create a new individual or match to an existing individual based on first name, last name and email. After the inFellowship account is created and activated the user will be redirect to the URI specified in the urlRedirect field.

Authentication

These methods require Authentication

Resource Structure

This resource conforms to the following XSD

Methods

People ::

  • new [GET] https://demo.fellowshiponeapi.com/v1/Accounts/New
  • create [POST] https://demo.fellowshiponeapi.com/v1/Accounts

Method: new [GET]

The new method will return the structure of the account resource. The purpose of the new method is to retrieve an empty resource with the proper structure.

Content-types ::

  • application/json
  • application/xml

Format ::

  • json
  • xml

Parameters ::

  • {format}
    • [POST] https://demo.fellowshiponeapi.com/v1/Accounts/New.{format}
    • [POST] https://demo.fellowshiponeapi.com/v1/Accounts/New?format={format}
    • [Header] Accept : {Content-type}

Sample Response ::

Given: [POST] https://demo.fellowshiponeapi.com/v1/Accounts/New

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 3.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Tue, 04 Jun 2013 22:22:56 GMT
Content-Length: 126

<?xml version="1.0" encoding="utf-8"?>
<account>
  <firstName />
  <lastName />
  <email />
  <urlRedirect />
</account>

Method: create [POST]

The create method will create an user login.

Notes ::

  • This method will return a 204 - No Content if successfully created
  • If a user login already exsits for the email address being used then a 409 - Conflict.
  • If an existing individual is matched based on the first name, last name AND email address, then that individual will be associted to the new user login. If an existing individual could not be matched then a new individual will be created and associated to the user login.
  • The user login will be initially created but not activated. An email will be sent to the email address used in the request with a link that will allow the user to activate the account. If an existing individual was matched for the user login then the user will only be prompted for a password in order to activate the account. If a new individual was created for the user login the user will be prompted for a password, DOB, gender, phone and address. Only password, DOB and gender are required for activaition.
  • The urlRedirect field is the URL that the user will be redirected to once they have activated the account. This URL should be a page hosted by the calling entity and should explain to the user that there account was created and activated successfully. No data about the created account will be passed to the URL.

Content-types ::

  • application/json
  • application/xml

Format ::

  • json
  • xml

Parameters ::

  • {format}
    • [POST] https://demo.fellowshiponeapi.com/v1/Accounts.{format}
    • [POST] https://demo.fellowshiponeapi.com/v1/Accounts?format={format}
    • [Header] Accept : {Content-type}

Required Fields ::

  • firstName
  • lastName
  • email
  • urlRedirect

Sample Response ::

Given: [POST] https://demo.fellowshiponeapi.com/v1/Accounts

Request:

<account>
  <firstName>Markus</firstName>
  <lastName>Lindsleyus</lastName>
  <email>mrawr_tx@yahoo.com</email>
  <urlRedirect>www.google.com</urlRedirect>
</account>

Response:

HTTP/1.1 204 The resource has been created.
Cache-Control: private
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 3.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Tue, 04 Jun 2013 22:17:26 GMT