Genders
Gender is a demographic type that is used in the definition of a group.
Notes ::
- By passing in the
content-type
ofapplication/help
in theaccept
header or using the {format} parameterhelp
from https://demo.fellowshiponeapi.com/groups/v1/grouptypes, the API will return an html representation of the help documents for this resource (authentication not required)
Authentication
This method requires Authentication
Resource Structure
This resource conforms to the following XSD
Methods
Genders ::
- list [GET] https://demo.fellowshiponeapi.com/groups/v1/genders
- show [GET] https://demo.fellowshiponeapi.com/groups/v1/genders/{id}
Method: list [GET]
The list
method will return a list of genders.
Notes ::
- By passing in the
content-type
ofapplication/xsd
in theaccept
header or using the {format} parameterxsd
the API will return anxsd
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/genders.{format}
- [GET] https://demo.fellowshiponeapi.com/groups/v1/genders?format={format}
- [Header] Accept : {Content-type}
Sample Response ::
Given: [GET] https://demo.fellowshiponeapi.com/groups/v1/genders
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/groups/v1/genders
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Wed, 14 Apr 2010 19:03:54 GMT
Content-Length: 1011
<?xml version="1.0" encoding="utf-8"?>
<genders>
<gender json:Array="true" id="0" uri="https://demo.fellowshiponeapi.com/groups/v1/genders/0">
<name>Coed</name>
</gender>
<gender json:Array="true" id="1" uri="https://demo.fellowshiponeapi.com/groups/v1/genders/1">
<name>Male</name>
</gender>
<gender json:Array="true" id="2" uri="https://demo.fellowshiponeapi.com/groups/v1/genders/2">
<name>Female</name>
</gender>
</genders>
Given: [GET] https://demo.fellowshiponeapi.com/groups/v1/genders.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/genders.json
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Tue, 02 Nov 2010 20:38:35 GMT
Content-Length: 5384
{
"genders":{
"gender":[
{
"@array":"true",
"@id":"0",
"@uri":"https://demo.fellowshiponeapi.com/groups/v1/genders/0",
"name":"Coed"
},
{
"@array":"true",
"@id":"1",
"@uri":"https://demo.fellowshiponeapi.com/groups/v1/genders/1",
"name":"Male"
},
{
"@array":"true",
"@id":"2",
"@uri":"https://demo.fellowshiponeapi.com/groups/v1/genders/2",
"name":"Female"
}
]
}
}
Method: show [GET]
The show
method will return a single gender
for a given id
.
Notes ::
- By passing in the
content-type
ofapplication/xsd
in theaccept
header or using the {format} parameterxsd
the API will return anxsd
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/genders/{id}.{format}
- [GET] https://demo.fellowshiponeapi.com/groups/v1/genders/{id}?format={format}
- [Header] Accept : {Content-type}
- {id}
- [GET] https://demo.fellowshiponeapi.com/groups/v1/genders/{id}
Sample Response ::
Given: [GET] https://demo.fellowshiponeapi.com/groups/v1/genders/1
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/groups/v1/genders/1
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Wed, 14 Apr 2010 19:09:54 GMT
Content-Length: 176
<gender id="1" uri="https://demo.fellowshiponeapi.com/groups/v1/genders/1">
<name>Male</name>
</gender>
Given: [GET] https://demo.fellowshiponeapi.com/groups/v1/genders/1.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/genders/1.json
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Wed, 14 Apr 2010 19:10:42 GMT
Content-Length: 119
{
"gender":
{
"@id":"1",
"@uri":"https://demo.fellowshiponeapi.com/groups/v1/genders/1",
"name":"Male"
}
}