Members

A Member represents an individual that is either a leader or member of a group.

Authentication

This method requires Authentication

Resource Structure

This resource conforms to the following XSD

Methods

Members ::

  • search [GET] https://demo.fellowshiponeapi.com/groups/v1/groups/{id}/members/search?{parameters}
  • list [GET] https://demo.fellowshiponeapi.com/groups/v1/groups/{id}/members
  • show [GET] https://demo.fellowshiponeapi.com/groups/v1/groups/{id}/members/{id}
  • new [GET] https://demo.fellowshiponeapi.com/groups/v1/groups/{id}/members/new
  • edit [GET] https://demo.fellowshiponeapi.com/groups/v1/groups/{id}/members/{id}/edit
  • create [POST] https://demo.fellowshiponeapi.com/groups/v1/groups/{id}/members
  • update [PUT] [POST(Low REST)] https://demo.fellowshiponeapi.com/groups/v1/groups/{id}/members/{id}
  • delete [DELETE] https://demo.fellowshiponeapi.com/groups/v1/groups/{id}/members/{id}
  • delete [GET(Low REST)] https://demo.fellowshiponeapi.com/groups/v1/groups/{id}/members/{id}/delete

Method: search [GET]

The search keyword will return a collection of member for the parameters provided.

Notes ::

  • Search by Member Name: https://demo.fellowshiponeapi.com/groups/v1/groups/{id}/members/search?searchfor=jeff
    • All values passed in via searchFor must be url encoded (ex: Test Member needs to be Test%20Member)
    • wild card parameters will be used to search for partial matches for passed SearchFor value
  • Search by Member Type: https://demo.fellowshiponeapi.com/groups/v1/groups/{id}/members/search?membertypeid=1
    • Will return all users of the group that match the member type (member and/or leaders).
  • Search by Person ID: https://demo.fellowshiponeapi.com/groups/v1/members/search?personid=123456
    • Will return all the groups that the person is a member or leader of.
  • By passing in the content-type of application/xsd in the accept header or using the {format} parameter xsd the API will return an xsd for a single version of this resource (authentication not required)
  • If the recordsPerPage parameter is not used or its value is less than 1, the API will default the parameter to 20
  • If the recordsPerPage parameter's value is less than 10, the API will default the parameter to 10
  • If the page parameter is not used or its value is less than 1, the API will default the parameter to 1

Content-types ::

  • application/json
  • application/xml
  • application/xsd
  • application/help

Format ::

  • json
  • xml
  • xsd
  • help

Parameters ::

  • {format}
    • [GET] https://demo.fellowshiponeapi.com/groups/v1/groups/{id}/members.{format}?{search parameters}
    • [GET] https://demo.fellowshiponeapi.com/groups/v1/groups/{id}/members?format={format}&{search parameters}
    • [Header] Accept : {Content-type}
  • {search parameters}
    • searchfor = Name of the member you are searching for
      • ex. searchfor=test%2Member
    • membertypeid = the type of member you are searching for (member or leader) *ex. membertypeid=1
    • personid = return all groups that the passed personid is a leader or member of.
      • ex. personid=12345678

Sample Response ::

Given: [GET] https://demo.fellowshiponeapi.com/groups/v1/groups/38/members/search?searchfor=jeff

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/groups/v1/groups/235812/members/search
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Mon, 12 Apr 2010 17:47:11 GMT
Content-Length: 5652

<?xml version="1.0" encoding="utf-8"?>
<members count="2" pageNumber="1" totalRecords="2" additionalPages="0">
  <member json:Array="true" id="649" uri="https://demo.fellowshiponeapi.com/groups/v1/groups/235812/members/649">   
    <group id="235812" uri="https://demo.fellowshiponeapi.com/groups/v1/groups/235812">
        <name>Test</name>
    </group>
    <person id="13745947" uri="{{CONSUMER_ROOT_DOMAIN}}/people/13745947">
      <name>Jeff Coulson</name>
    </person>
    <membertype id="2" uri="https://demo.fellowshiponeapi.com/groups/v1/membertypes/2">
      <name>Member</name>
    </membertype>
    <createdDate>2007-11-14T14:29:20</createdDate>
    <createdByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
    <lastUpdatedDate></lastUpdatedDate>
    <lastUpdatedByPerson id="" uri="" />
  </member>
  <member json:Array="true" id="648" uri="https://demo.fellowshiponeapi.com/groups/v1/groups/235812/members/648">
    <person id="1632378" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1632378">
      <name>Jeff Hook</name>
    </person>
    ...
  </member>
</members>

Given: [GET] https://demo.fellowshiponeapi.com/groups/v1/groups/235812/members/search.json?searchfor=jeff

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/groups/v1/groups/235812/members/search.json
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Tue, 13 Apr 2010 18:51:01 GMT
Content-Length: 4366

{
    "members":
    {
        "@count":"2",
        "@pageNumber":"1",
        "@totalRecords":"2",
        "@additionalPages":"0",
        "member":
        [
            {"
                @array":"true",
                "@id":"649",
                "@uri":"https://demo.fellowshiponeapi.com/groups/v1/groups/235812/members/649",
                "group":
                {
                    "@id":"235812",
                    "@uri":"https://demo.fellowshiponeapi.com/groups/v1/groups/235812",
                    "name":"Test"
                },
                "person":
                {
                    "@id":"13745947",
                    "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/13745947",
                    "name":"Jeff Coulson"
                },
                "membertype":
                {
                    "@id":"2",
                    "@uri":"https://demo.fellowshiponeapi.com/groups/v1/membertypes/2",
                    "name":"Member"
                },
                "createdDate":"2007-11-14T14:29:20",
                "createdByPerson":
                {
                    "@id":"1999191",
                    "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
                },
                "lastUpdatedDate":null,
                "lastUpdatedByPerson":
                {
                    "@id":"",
                    "@uri":""
                }
            },
            {
                "@array":"true",
                "@id":"648",
                "@uri":"https://demo.fellowshiponeapi.com/groups/v1/groups/235812/members/648",
                "person":
                {
                    "@id":"1632378",
                    "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1632378",
                    "name":"Jeff Hook"
                }
                ...
            }
        ]
    }
}

Method: list [GET]

The list method will return a list of group members.

Notes ::

  • By passing in the content-type of application/xsd in the accept header or using the {format} parameter xsd the API will return an xsd for a single version of this resource (authentication not required)

Content-types ::

  • application/json
  • application/xml
  • application/xsd
  • application/help

Format ::

  • json
  • xml
  • xsd
  • help

Parameters ::

  • {format}
    • [GET] https://demo.fellowshiponeapi.com/groups/v1/groups/{id}/members.{format}
    • [GET] https://demo.fellowshiponeapi.com/groups/v1/groups/{id}/members?format={format}
    • [Header] Accept : {Content-type}

Sample Response ::

Given: [GET] https://demo.fellowshiponeapi.com/groups/v1/groups/26649/members

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/groups/v1/groups/26649/members
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Thu, 02 Dec 2010 20:45:18 GMT
Content-Length: 8063

<?xml version="1.0" encoding="utf-8"?>
<members>
  <member json:Array="true" id="2857522" uri="https://demo.fellowshiponeapi.com/groups/v1/groups/26649/members/2857522">
    <group id="26649" uri="https://demo.fellowshiponeapi.com/groups/v1/groups/26649">
      <name>test</name>
    </group>
    <person id="1633065" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1633065">
      <name>Aaron Smith</name>
    </person>
    <memberType id="2" uri="https://demo.fellowshiponeapi.com/groups/v1/membertypes/2">
      <name>Member</name>
    </memberType>
    <createdDate>2008-01-16T00:13:00</createdDate>
    <createdByPerson id="0" uri="{{CONSUMER_ROOT_DOMAIN}}/people/0" />
    <lastUpdatedDate></lastUpdatedDate>
    <lastUpdatedByPerson id="" uri="" />
  </member>
  <member json:Array="true" id="1684844" uri="https://demo.fellowshiponeapi.com/groups/v1/groups/26649/members/1684844">
    ...
  </member>
</members>

Given: [GET] https://demo.fellowshiponeapi.com/groups/v1/groups/26649/members.json

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/groups/v1/groups/26649/members.json
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Thu, 02 Dec 2010 20:48:11 GMT
Content-Length: 6728

{
   "members":{
      "member":[
         {
            "@array":"true",
            "@id":"2857522",
            "@uri":"https://demo.fellowshiponeapi.com/groups/v1/groups/26649/members/2857522",
            "group":{
               "@id":"26649",
               "@uri":"https://demo.fellowshiponeapi.com/groups/v1/groups/26649",
               "name":"test"
            },
            "person":{
               "@id":"1633065",
               "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1633065",
               "name":"Aaron Smith"
            },
            "memberType":{
               "@id":"2",
               "@uri":"https://demo.fellowshiponeapi.com/groups/v1/v1/membertypes/2",
               "name":"Member"
            },
            "createdDate":"2008-01-16T00:13:00",
            "createdByPerson":{
               "@id":"0",
               "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/0"
            },
            "lastUpdatedDate":null,
            "lastUpdatedByPerson":{
               "@id":"",
               "@uri":""
            }
         },
         {
            "@array":"true",
            "@id":"1684844",
            "@uri":"https://demo.fellowshiponeapi.com/groups/v1/groups/26649/members/1684844",
            ...          
         }
      ]
   }
}

Method: show [GET]

The show keyword will return a single Member with the given id.

Notes ::

  • By passing in the content-type of application/xsd in the accept header or using the {format} parameter xsd the API will return an xsd for a single version of this resource (authentication not required)

Content-types ::

  • application/json
  • application/xml
  • application/xsd
  • application/help

Format ::

  • json
  • xml
  • xsd
  • help

Parameters ::

  • {format}
    • [GET] https://demo.fellowshiponeapi.com/groups/v1/groups/{id}/members/{id}.{format}
    • [GET] https://demo.fellowshiponeapi.com/groups/v1/groups/{id}/members/{id}?format={format}
    • [Header] Accept : {Content-type}
  • {id}
    • [GET] https://demo.fellowshiponeapi.com/groups/v1/groups/{id}members/{id}

Sample Response ::

Given: [GET] https://demo.fellowshiponeapi.com/groups/v1/groups/235812/members/649

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/groups/v1/groups/235812/members/649
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Mon, 12 Apr 2010 18:07:34 GMT
Content-Length: 284

<?xml version="1.0" encoding="utf-8"?>
<member id="649" uri="https://demo.fellowshiponeapi.com/groups/v1/groups/235812/members/649">
    <group id="235812" uri="https://demo.fellowshiponeapi.com/groups/v1/groups/235812">
        <name>Test</name>
    </group>
    <person id="13745947" uri="{{CONSUMER_ROOT_DOMAIN}}/people/13745947">
      <name>Jeff Coulson</name>
    </person>
    <membertype id="2" uri="https://demo.fellowshiponeapi.com/groups/v1/membertypes/2">
      <name>Member</name>
    </membertype>
    <createdDate>2007-11-14T14:29:20</createdDate>
    <createdByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
    <lastUpdatedDate></lastUpdatedDate>
    <lastUpdatedByPerson id="" uri="" />
 </member>

Method: new [GET]

The new keyword will return a single Member. The purpose of the new method is to retrieve an empty resource with the proper structure.

Notes ::

  • By passing in the content-type of application/xsd in the accept header or using the {format} parameter xsd the API will return an xsd for a single version of this resource (authentication not required)

Content-types ::

  • application/json
  • application/xml
  • application/xsd
  • application/help

Format ::

  • json
  • xml
  • xsd
  • help

Parameters ::

  • {format}
    • [GET] https://demo.fellowshiponeapi.com/groups/v1/groups/{id}/members/new.{format}
    • [GET] https://demo.fellowshiponeapi.com/groups/v1/groups/{id}/members/new?format={format}
    • [Header] Accept : {Content-type}

Sample Response ::

Given: [GET] https://demo.fellowshiponeapi.com/groups/v1/groups/{id}/members/new

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Tue, 13 Apr 2010 15:07:03 GMT
Content-Length: 211

<?xml version="1.0" encoding="utf-8"?>
<member id="" uri="">
    <group id="" uri="">
        <name></name>
    </group>
    <person id="" uri="">
        <name></name>
    </person>
    <membertype id="" uri="">
        <name></name>
    </membertype>
    <createdDate></createdDate>
    <createdByPerson id="" uri="" />
    <lastUpdatedDate></lastUpdatedDate>
    <lastUpdatedByPerson id="" uri="" />
</member>

Given: [GET] https://demo.fellowshiponeapi.com/groups/v1/groups/235812/members/new.json

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Tue, 13 Apr 2010 18:48:40 GMT
Content-Length: 132

{
    "member":
    {
        "@id":"",
        "@uri":"",
        "group":
        {
            "@id":"",
            "@uri":"",
            "name":""
        },
        "person":
        {
            "@id":"",
            "@uri":"",
            "name":null
        },
        "membertype":
        {
            "@id":"",
            "@uri":"",
            "name":null
        },
        "createdDate":null,
        "createdByPerson":
        {
            "@id":"",
            "@uri":""
        },
        "lastUpdatedDate":null,
        "lastUpdatedByPerson":
        {
            "@id":"",
            "@uri":""
        }
    }
}

Method: edit [GET]

The edit method will return a single Member for a given id. The purpose of the edit method is to retrieve a resource in its most recent condition with its latest values.

Content-types ::

  • application/json
  • application/xml
  • application/help

Format ::

  • json
  • xml
  • help

Parameters ::

  • {format}
    • [GET] https://demo.fellowshiponeapi.com/groups/v1/groups/{id}/members/{id}/edit.{format}
    • [GET] https://demo.fellowshiponeapi.com/groups/v1/groups/{id}/members/{id}/edit?format={format}
    • [Header] Accept : {Content-type}
  • {id}
    • [GET] https://demo.fellowshiponeapi.com/groups/v1/groups/{id}members/{id}/edit

Sample Response ::

Given: [GET] https://demo.fellowshiponeapi.com/groups/v1/groups/235812/members/649/edit

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Tue, 13 Apr 2010 19:37:20 GMT
Content-Length: 291

<?xml version="1.0" encoding="utf-8"?>
<member id="649" uri="https://demo.fellowshiponeapi.com/groups/v1/groups/235812/members/649">
    <group id="235812" uri="https://demo.fellowshiponeapi.com/groups/v1/groups/235812">
        <name>Test</name>
    </group>
    <person id="13745947" uri="{{CONSUMER_ROOT_DOMAIN}}/people/13745947">
      <name>Jeff Coulson</name>
    </person>
    <membertype id="2" uri="https://demo.fellowshiponeapi.com/groups/v1/membertypes/2">
      <name>Member</name>
    </membertype>
    <createdDate>2007-11-14T14:29:20</createdDate>
    <createdByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
    <lastUpdatedDate></lastUpdatedDate>
    <lastUpdatedByPerson id="" uri="" />
 </member>

Given: [GET] https://demo.fellowshiponeapi.com/groups/v1/groups/235812/members/649/edit.json

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Tue, 13 Apr 2010 19:38:03 GMT
Content-Length: 208

{
    "member":
    {
        "@id":"649",
        "@uri":"https://demo.fellowshiponeapi.com/groups/v1/groups/235812/members/649",
        "group":
        {
            "@id":"235812",
            "@uri":"https://demo.fellowshiponeapi.com/groups/v1/groups/235812",
            "name":"Test"
        },
        "person":
        {
            "@id":"13745947",
            "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/13745947",
            "name":"Jeff Coulson"
        },
        "membertype":
        {
            "@id":"2",
            "@uri":"https://demo.fellowshiponeapi.com/groups/v1/membertypes/2",
            "name":"Member"
        },
        "createdDate":"2007-11-14T14:29:20",
        "createdByPerson":
        {
            "@id":"1999191",
            "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
        },
        "lastUpdatedDate":null,
        "lastUpdatedByPerson":
        {
            "@id":"",
            "@uri":""
        }
    }
}

Method: create [POST]

The create method will create a single member.

Notes ::

  • This method will return a 201 - Created if successfully created

Content-types ::

  • application/json
  • application/xml

Format ::

  • json
  • xml

Parameters ::

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

Required Fields ::

  • group
  • person
  • membertype

Sample Response ::

Given: [POST] https://demo.fellowshiponeapi.com/groups/v1/groups/235812/members

Request body:

<?xml version="1.0" encoding="utf-8"?>
<member id="" uri="">
    <group id="">
        <name/>
    </group>
    <person id="13745947">
      <name></name>
    </person>
    <memberType id="2" uri="">
      <name></name>
    </memberType>
    <createdDate></createdDate>
    <createdByPerson id="" uri="" />
    <lastUpdatedDate></lastUpdatedDate>
    <lastUpdatedByPerson id="" uri="" />
</member>

Response:

HTTP/1.1 201 Created
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Location: https://demo.fellowshiponeapi.com/groups/v1/groups/235812/members/76975186
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Tue, 13 Apr 2010 22:17:08 GMT
Content-Length: 296

<?xml version="1.0" encoding="utf-8"?>
<member id="76975186" uri="https://demo.fellowshiponeapi.com/groups/v1/groups/235812/members/76975186">
    <group id="235812" uri="https://demo.fellowshiponeapi.com/groups/v1/groups/235812">
        <name>Test</name>
    </group>
    <person id="13745947" uri="{{CONSUMER_ROOT_DOMAIN}}/people/13745947">
        <name>Jeff Coulson</name>
    </person>
    <memberType id="2" uri="https://demo.fellowshiponeapi.com/groups/v1/membertypes/2">
        <name>Member</name>
    </memberType>
    <createdDate>2010-11-05T16:27:26</createdDate>
    <createdByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
    <lastUpdatedDate></lastUpdatedDate>
    <lastUpdatedByPerson id="" uri="" />
</member>

Given: [POST] https://demo.fellowshiponeapi.com/groups/v1/member.json

Request body:

{
    "member":
    {
        "@id":"",
        "@uri":"",
        "group":
        {
            "@id":"",
            "@uri":"",
            "name":""
        },
        "person":
        {
            "@id":"13745947",
            "@uri":"",
            "name":""
        },
        "memberType":
        {
            "@id":"2",
            "@uri":"",
            "name":""
        },
        "createdDate":"",
        "createdByPerson":
        {
            "@id":"",
            "@uri":""
        },
        "lastUpdatedDate":null,
        "lastUpdatedByPerson":
        {
            "@id":"",
            "@uri":""
        }
    }
}

Response:

HTTP/1.1 201 Created
Cache-Control: private
Content-Type: application/json; charset=utf-8
Location: https://demo.fellowshiponeapi.com/groups/v1/groups/235812/members/649.json
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Tue, 13 Apr 2010 22:18:58 GMT
Content-Length: 213

{
    "member":
    {
        "@id":"649",
        "@uri":"https://demo.fellowshiponeapi.com/groups/v1/groups/235812/members/649",
        "group":
        {
            "@id":"235812",
            "@uri":"https://demo.fellowshiponeapi.com/groups/v1/groups/235812",
            "name":"Test"
        },
        "person":
        {
            "@id":"13745947",
            "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/13745947",
            "name":"Jeff Coulson"
        },
        "memberType":
        {
            "@id":"2",
            "@uri":"https://demo.fellowshiponeapi.com/groups/v1/membertypes/2",
            "name":"Member"
        },
        "createdDate":"2007-11-14T14:29:20",
        "createdByPerson":
        {
            "@id":"1999191",
            "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
        },
        "lastUpdatedDate":null,
        "lastUpdatedByPerson":
        {
            "@id":"",
            "@uri":""
        }
    }
}

Method: update [PUT] [POST (Low REST)]

The update method will update a single member.

Content-types ::

  • application/json
  • application/xml

Format ::

  • json
  • xml

Parameters ::

  • {format}
    • [PUT] https://demo.fellowshiponeapi.com/groups/v1/groups/{id}/members/{id}.{format}
    • [PUT] https://demo.fellowshiponeapi.com/groups/v1/groups/{id}/members/{id}?format={format}
    • [Header] Accept : {Content-type}
  • {id}
    • [PUT] https://demo.fellowshiponeapi.com/groups/v1/groups/{id}/members/{id}

Required Fields ::

  • group id
  • member id
  • member type id

Sample Response ::

Given: [PUT] https://demo.fellowshiponeapi.com/groups/v1/groups/235812/members/76975186

Request body:

<?xml version="1.0" encoding="utf-8"?>

<member id="76975186" uri="">
    <group id="" uri="">
        <name>Test</name>
    </group>
    <person id="13745947" uri="">
        <name></name>
    </person>
    <memberType id="1" uri="">
        <name></name>
    </memberType>
    <createdDate></createdDate>
    <createdByPerson id="" uri="" />
    <lastUpdatedDate></lastUpdatedDate>
    <lastUpdatedByPerson id="" uri="" />
</member>

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/groups/v1/groups/235812/members/76975186
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Tue, 13 Apr 2010 22:45:44 GMT
Content-Length: 318

<?xml version="1.0" encoding="utf-8"?>
<member id="76975186" uri="https://demo.fellowshiponeapi.com/groups/v1/members/76975186">
    <group id="235812" uri="https://demo.fellowshiponeapi.com/groups/v1/groups/235812">
        <name>Test</name>
    </group>
    <person id="13745947" uri="{{CONSUMER_ROOT_DOMAIN}}/people/13745947">
        <name>Jeff Coulson</name>
    </person>
    <memberType id="1" uri="https://demo.fellowshiponeapi.com/groups/v1/membertypes/1">
        <name>Leader</name>
    </memberType>
    <createdDate>2010-11-05T16:27:26</createdDate>
    <createdByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
    <lastUpdatedDate>2010-11-05T16:42:09</lastUpdatedDate>
    <lastUpdatedByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
</member>

Given: [PUT] https://demo.fellowshiponeapi.com/groups/v1/groups/235812/members/649.json

Request body:

{
    "member":
    {
        "@id":"649",
        "@uri":"",
        "group":
        {
            "@id":"",
            "@uri":"",
            "name":""
        },
        "person":
        {
            "@id":"13745947",
            "@uri":"",
            "name":""
        },
        "memberType":
        {
            "@id":"2",
            "@uri":"",
            "name":""
        },
        "createdDate":"",
        "createdByPerson":
        {
            "@id":"",
            "@uri":""
        },
        "lastUpdatedDate":null,
        "lastUpdatedByPerson":
        {
            "@id":"",
            "@uri":""
        }
    }
}

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/groups/v1/groups/235812/members/649.json
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Tue, 13 Apr 2010 22:47:28 GMT
Content-Length: 233

{
    "member":
    {
        "@id":"649",
        "@uri":"https://demo.fellowshiponeapi.com/groups/v1/members/649",
        "group":
        {
            "@id":"235812",
            "@uri":"https://demo.fellowshiponeapi.com/groups/v1/groups/235812",
            "name":"Test"
        },
        "person":
        {
            "@id":"13745947",
            "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/13745947",
            "name":"Jeff Coulson"
        },
        "memberType":
        {
            "@id":"2",
            "@uri":"https://demo.fellowshiponeapi.com/groups/v1/membertypes/2",
            "name":"Member"
        },
        "createdDate":"2007-11-14T14:29:20",
        "createdByPerson":
        {
            "@id":"1999191",
            "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
        },
        "lastUpdatedDate":null,
        "lastUpdatedByPerson":
        {
            "@id":"",
            "@uri":""
        }
    }
}

Method: delete [DELETE]

The delete method will delete a group member from the group.

Notes ::

  • If delete is called the resource will no longer be available from the API and will return a 410 - Entity is GONE if the resource is ever requested again
  • This method will return a 204 - No Content if a successful deletion occurs
  • Content-type and Format are not used by this action

Parameters ::

  • {id}
    • [GET(Low REST)] https://demo.fellowshiponeapi.com/groups/v1/groups/{id}/members/{id}/Delete
    • [DELETE] https://demo.fellowshiponeapi.com/groups/v1/groups/{id}/members/{id}

Sample Response ::

Given: [DELETE] https://demo.fellowshiponeapi.com/groups/v1/groups/26649/members/2857522

Response:

HTTP/1.1 204 The resource https://demo.fellowshiponeapi.com/groups/v1/groups/26649/members/2857522 has been deleted.
Cache-Control: private
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Tue, 07 Apr 2009 16:06:52 GMT