Locations

A location contains the physical address for an event if the event has one. If the event meets on line, then the location can contain the Url for the event.

Authentication

This method requires Authentication

Resource Structure

This resource conforms to the following XSD

Methods

Members ::

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

Method: list [GET]

The list method will return a list of locations in context of an event.

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/events/v1/events/{id}/locations.{format}
    • [GET] https://demo.fellowshiponeapi.com/events/v1/events/{id}/locations?format={format}
    • [Header] Accept : {Content-type}

Sample Response ::

Given: [GET] https://demo.fellowshiponeapi.com/events/v1/events/8296/locations

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/events/v1/events/8296/locations
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Fri, 03 Dec 2010 16:22:51 GMT
Content-Length: 1285

<?xml version="1.0" encoding="utf-8"?>
<locations>
  <location id="2058" uri="https://demo.fellowshiponeapi.com/events/v1/locations/2058">
    <name>Jingyi's House</name>
    <description>Small mansion in the hills.</description>
    <isOnline>false</isOnline>
    <url>www.google.com</url>
    <address>
      <address1>400 N. Aspen</address1>
      <address2></address2>
      <address3></address3>
      <city>Broken Arrow</city>
      <stProvince>OK</stProvince>
      <postalCode>74012</postalCode>
      <county></county>
      <country></country>
      <carrierRoute></carrierRoute>
      <deliveryPoint></deliveryPoint>
      <latitude>36.0561150</latitude>
      <longitude>-95.8175860</longitude>
      <createdDate>2010-12-01T16:45:35</createdDate>
      <createdByPerson id="28912161" uri="{{CONSUMER_ROOT_DOMAIN}}/people/28912161" />
      <lastUpdatedDate>2010-12-03T09:17:56</lastUpdatedDate>
      <lastUpdatedByPerson id=" uri=" />
    </address>
    <createdDate>2010-12-01T16:45:35</createdDate>
    <createdByPerson id="28912161" uri="{{CONSUMER_ROOT_DOMAIN}}/people/28912161" />
    <lastUpdatedDate>2010-12-03T09:17:56</lastUpdatedDate>
    <lastUpdatedByPerson id=" uri=" />
  </location>
</locations>

Sample Response ::

Given: [GET] https://demo.fellowshiponeapi.com/events/v1/events/8296/locations.json

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/events/v1/events/8296/locations.json
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Fri, 03 Dec 2010 16:24:40 GMT
Content-Length: 909

{
   "locations":{
      "location":{
         "@id":"2058",
         "@uri":"https://demo.fellowshiponeapi.com/events/v1/locations/2058",
         "name":"Jingyi's House",
         "description":"Small mansion in the hills.",
         "isOnline":"false",
         "url":"www.google.com",
         "address":{
            "address1":"400 N. Aspen",
            "address2":null,
            "address3":null,
            "city":"Broken Arrow",
            "stProvince":"OK",
            "postalCode":"74012",
            "county":null,
            "country":null,
            "carrierRoute":null,
            "deliveryPoint":null,
            "latitude":"36.0561150",
            "longitude":"-95.8175860",
            "createdDate":"2010-12-01T16:45:35",
            "createdByPerson":{
               "@id":"28912161",
               "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/28912161"
            },
            "lastUpdatedDate":"2010-12-03T09:17:56",
            "lastUpdatedByPerson":{
               "@id":",
               "@uri":"
            }
         },
         "createdDate":"2010-12-01T16:45:35",
         "createdByPerson":{
            "@id":"28912161",
            "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/28912161"
         },
         "lastUpdatedDate":"2010-12-03T09:17:56",
         "lastUpdatedByPerson":{
            "@id":",
            "@uri":"
         }
      }
   }
}

Method: show [GET]

The show keyword will return a single location 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/events/v1/events/{id}/locations/{id}.{format}
    • [GET] https://demo.fellowshiponeapi.com/events/v1/events/{id}/locations/{id}?format={format}
    • [Header] Accept : {Content-type}
  • {id}
    • [GET] https://demo.fellowshiponeapi.com/events/v1/events/{id}/locations/{id}

Sample Response ::

Given: [GET] https://demo.fellowshiponeapi.com/events/v1/events/8296/locations/2058

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/events/v1/events/8296/locations/2058
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"?>

<location id="2058" uri="https://demo.fellowshiponeapi.com/events/v1/locations/2058">
  <name>Jingyi's House</name>
  <description>Small mansion in the hills.</description>
  <isOnline>false</isOnline>
  <url></url>
  <address>
    <address1>400 N. Aspen</address1>
    <address2></address2>
    <address3></address3>
    <city>Broken Arrow</city>
    <stProvince>OK</stProvince>
    <postalCode>74012</postalCode>
    <county></county>
    <country></country>
    <carrierRoute></carrierRoute>
    <deliveryPoint></deliveryPoint>
    <latitude>36.0561150</latitude>
    <longitude>-95.8175860</longitude>
    <createdDate>2010-12-01T16:45:35</createdDate>
    <createdByPerson id="28912161" uri="{{CONSUMER_ROOT_DOMAIN}}/people/28912161" />
    <lastUpdatedDate>2010-12-03T09:17:56</lastUpdatedDate>
    <lastUpdatedByPerson id=" uri=" />
  </address>
  <createdDate>2010-12-01T16:45:35</createdDate>
  <createdByPerson id="28912161" uri="{{CONSUMER_ROOT_DOMAIN}}/people/28912161" />
  <lastUpdatedDate>2010-12-03T09:17:56</lastUpdatedDate>
  <lastUpdatedByPerson id=" uri=" />
</location>

Sample Response ::

Given: [GET] https://demo.fellowshiponeapi.com/events/v1/events/8296/locations/2060.json

Response:

{
   "location":{
      "@id":"2060",
      "@uri":"https://demo.fellowshiponeapi.com/events/v1/locations/2060",
      "name":"Jingyi's House",
      "description":"Small mansion in the hills.",
      "isOnline":"false",
      "url":null,
      "address":{
         "address1":"400 N. Aspen",
         "address2":null,
         "address3":null,
         "city":"Broken Arrow",
         "stProvince":"OK",
         "postalCode":"74012",
         "county":null,
         "country":"US",
         "carrierRoute":null,
         "deliveryPoint":null,
         "latitude":"36.0561150",
         "longitude":"-95.8175860",
         "createdDate":"2010-12-03T10:49:11",
         "createdByPerson":{
            "@id":"1999191",
            "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
         },
         "lastUpdatedDate":"2010-12-03T11:00:25",
         "lastUpdatedByPerson":{
            "@id":"1999191",
            "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
         }
      },
      "createdDate":"2010-12-03T10:49:11",
      "createdByPerson":{
         "@id":"1999191",
         "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
      },
      "lastUpdatedDate":"2010-12-03T11:00:25",
      "lastUpdatedByPerson":{
         "@id":"1999191",
         "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
      }
   }
}

Method: new [GET]

The new keyword will return a single location. 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/events/v1/events/{id}/locations/new.{format}
    • [GET] https://demo.fellowshiponeapi.com/events/v1/events/{id}/locations/new?format={format}
    • [Header] Accept : {Content-type}

Sample Response ::

Given: [GET] https://demo.fellowshiponeapi.com/events/v1/events/{id}/locations/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: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Fri, 03 Dec 2010 16:30:19 GMT
Content-Length: 834

<?xml version="1.0" encoding="utf-8"?>
<location id=" uri=">
  <name></name>
  <description></description>
  <isOnline>false</isOnline>
  <url></url>
  <address>
    <address1></address1>
    <address2></address2>
    <address3></address3>
    <city></city>
    <stProvince></stProvince>
    <postalCode></postalCode>
    <county></county>
    <country></country>
    <carrierRoute></carrierRoute>
    <deliveryPoint></deliveryPoint>
    <latitude></latitude>
    <longitude></longitude>
    <createdDate></createdDate>
    <createdByPerson id=" uri=" />
    <lastUpdatedDate></lastUpdatedDate>
    <lastUpdatedByPerson id=" uri=" />
  </address>
  <createdDate></createdDate>
  <createdByPerson id=" uri=" />
  <lastUpdatedDate></lastUpdatedDate>
  <lastUpdatedByPerson id=" uri=" />
</location>

Given: [GET] https://demo.fellowshiponeapi.com/events/v1/events/8296/locations/new.json

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Fri, 03 Dec 2010 16:31:04 GMT
Content-Length: 553

{
   "location":{
      "@id":",
      "@uri":",
      "name":null,
      "description":null,
      "isOnline":"false",
      "url":null,
      "address":{
         "address1":null,
         "address2":null,
         "address3":null,
         "city":null,
         "stProvince":null,
         "postalCode":null,
         "county":null,
         "country":null,
         "carrierRoute":null,
         "deliveryPoint":null,
         "latitude":null,
         "longitude":null,
         "createdDate":null,
         "createdByPerson":{
            "@id":",
            "@uri":"
         },
         "lastUpdatedDate":null,
         "lastUpdatedByPerson":{
            "@id":",
            "@uri":"
         }
      },
      "createdDate":null,
      "createdByPerson":{
         "@id":",
         "@uri":"
      },
      "lastUpdatedDate":null,
      "lastUpdatedByPerson":{
         "@id":",
         "@uri":"
      }
   }
}

Method: edit [GET]

The edit method will return a single location 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/events/v1/events/{id}/locations/{id}/edit.{format}
    • [GET] https://demo.fellowshiponeapi.com/events/v1/events/{id}/locations/{id}/edit?format={format}
    • [Header] Accept : {Content-type}
  • {id}
    • [GET] https://demo.fellowshiponeapi.com/events/v1/events/{id}/locations/{id}/edit

Sample Response ::

Given: [GET] https://demo.fellowshiponeapi.com/events/v1/events/235812/locations/649/edit

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/events/v1/events/8296/locations/2058/edit
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Fri, 03 Dec 2010 16:33:22 GMT
Content-Length: 1265

<?xml version="1.0" encoding="utf-8"?>
<location id="2058" uri="https://demo.fellowshiponeapi.com/events/v1/locations/2058">
  <name>Jingyi's House</name>
  <description>Small mansion in the hills.</description>
  <isOnline>false</isOnline>
  <url>www.google.com</url>
  <address>
    <address1>400 N. Aspen</address1>
    <address2></address2>
    <address3></address3>
    <city>Broken Arrow</city>
    <stProvince>OK</stProvince>
    <postalCode>74012</postalCode>
    <county></county>
    <country>US</country>
    <carrierRoute></carrierRoute>
    <deliveryPoint></deliveryPoint>
    <latitude>36.0561150</latitude>
    <longitude>-95.8175860</longitude>
    <createdDate>2010-12-03T09:17:56</createdDate>
    <createdByPerson id="28912161" uri="{{CONSUMER_ROOT_DOMAIN}}/people/28912161" />
    <lastUpdatedDate>2010-12-03T09:17:56</lastUpdatedDate>
    <lastUpdatedByPerson id="28912161" uri="{{CONSUMER_ROOT_DOMAIN}}/people/28912161" />
  </address>
  <createdDate>2010-12-01T16:45:35</createdDate>
  <createdByPerson id="28912161" uri="{{CONSUMER_ROOT_DOMAIN}}//people/28912161" />
  <lastUpdatedDate>2010-12-03T09:17:56</lastUpdatedDate>
  <lastUpdatedByPerson id=" uri=" />
</location>

Given: [GET] https://demo.fellowshiponeapi.com/events/v1/locations/8296/locations/2060/edit.json

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/events/v1/events/8296/locations/2058/edit.json
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Fri, 03 Dec 2010 16:36:51 GMT
Content-Length: 956

{
   "location":{
      "@id":"2058",
      "@uri":"https://demo.fellowshiponeapi.com/events/v1/locations/2058",
      "name":"Jingyi's House",
      "description":"Small mansion in the hills.",
      "isOnline":"false",
      "url":"www.google.com",
      "address":{
         "address1":"400 N. Aspen",
         "address2":null,
         "address3":null,
         "city":"Broken Arrow",
         "stProvince":"OK",
         "postalCode":"74012",
         "county":null,
         "country":"US",
         "carrierRoute":null,
         "deliveryPoint":null,
         "latitude":"36.0561150",
         "longitude":"-95.8175860",
         "createdDate":"2010-12-03T09:17:56",
         "createdByPerson":{
            "@id":"28912161",
            "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/28912161"
         },
         "lastUpdatedDate":"2010-12-03T09:17:56",
         "lastUpdatedByPerson":{
            "@id":"28912161",
            "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/28912161"
         }
      },
      "createdDate":"2010-12-01T16:45:35",
      "createdByPerson":{
         "@id":"28912161",
         "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/28912161"
      },
      "lastUpdatedDate":"2010-12-03T09:17:56",
      "lastUpdatedByPerson":{
         "@id":",
         "@uri":"
      }
   }
}

Method: create [POST]

The create method will create a location in the context of an event.

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/events/v1/events/{id}/locations.{format}
    • [POST] https://demo.fellowshiponeapi.com/events/v1/events/{id}/locations?format={format}
    • [Header] Accept : {Content-type}

Sample Response ::

Given: [POST] https://demo.fellowshiponeapi.com/events/v1/events/8296/locations

Request body:

<?xml version="1.0" encoding="utf-8"?>
<location>
  <name>Jingyi's House</name>
  <description>Small mansion in the hills.</description>
  <isOnline>false</isOnline>
  <url></url>
  <address>
    <address1>400 N. Aspen</address1>
    <address2></address2>
    <address3></address3>
    <city>Broken Arrow</city>
    <stProvince>OK</stProvince>
    <postalCode>74012</postalCode>
    <county></county>
    <country>US</country>
    <carrierRoute></carrierRoute>
    <deliveryPoint></deliveryPoint>
    <latitude>36.0561150</latitude>
    <longitude>-95.8175860</longitude>
    <createdDate></createdDate>
    <createdByPerson/>
    <lastUpdatedDate></lastUpdatedDate>
    <lastUpdatedByPerson/>
  </address>
  <createdDate></createdDate>
  <createdByPerson />
  <lastUpdatedDate></lastUpdatedDate>
  <lastUpdatedByPerson id=" uri=" />
</location>

Response:

HTTP/1.1 201 Created
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Location: https://demo.fellowshiponeapi.com/events/v1/events/8296/locations/2059
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Fri, 03 Dec 2010 16:44:50 GMT
Content-Length: 1127

<?xml version="1.0" encoding="utf-8"?>
<location id="2059" uri="https://demo.fellowshiponeapi.com/events/v1/locations/2059">
  <name>Jingyi's House</name>
  <description>Small mansion in the hills.</description>
  <isOnline>false</isOnline>
  <url></url>
  <address>
    <address1>400 N. Aspen</address1>
    <address2></address2>
    <address3></address3>
    <city>Broken Arrow</city>
    <stProvince>OK</stProvince>
    <postalCode>74012</postalCode>
    <county></county>
    <country>US</country>
    <carrierRoute></carrierRoute>
    <deliveryPoint></deliveryPoint>
    <latitude></latitude>
    <longitude></longitude>
    <createdDate>2010-12-03T10:44:50</createdDate>
    <createdByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
    <lastUpdatedDate></lastUpdatedDate>
    <lastUpdatedByPerson id=" uri=" />
  </address>
  <createdDate>2010-12-03T10:44:50</createdDate>
  <createdByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
  <lastUpdatedDate></lastUpdatedDate>
  <lastUpdatedByPerson id=" uri=" />
</location>

Given: [POST] https://demo.fellowshiponeapi.com/events/v1/events/8296/locations.json

Request body:

{
   "location":{
      "@id":",
      "@uri":",
      "name":"Jingyi's House",
      "description":"Small mansion in the hills.",
      "isOnline":"false",
      "url":null,
      "address":{
         "address1":"400 N. Aspen",
         "address2":null,
         "address3":null,
         "city":"Broken Arrow",
         "stProvince":"OK",
         "postalCode":"74012",
         "county":null,
         "country":"US",
         "carrierRoute":null,
         "deliveryPoint":null,
         "latitude":"36.0561150",
         "longitude":"-95.8175860",
         "createdDate":",
         "createdByPerson":{
            "@id":",
            "@uri":"
         },
         "lastUpdatedDate":",
         "lastUpdatedByPerson":{
            "@id":",
            "@uri":"
         }
      },
      "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/events/v1/events/8296/locations.json/2060
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Fri, 03 Dec 2010 16:49:11 GMT
Content-Length: 828

{
   "location":{
      "@id":"2060",
      "@uri":"https://demo.fellowshiponeapi.com/events/v1/locations/2060",
      "name":"Jingyi's House",
      "description":"Small mansion in the hills.",
      "isOnline":"false",
      "url":null,
      "address":{
         "address1":"400 N. Aspen",
         "address2":null,
         "address3":null,
         "city":"Broken Arrow",
         "stProvince":"OK",
         "postalCode":"74012",
         "county":null,
         "country":"US",
         "carrierRoute":null,
         "deliveryPoint":null,
         "latitude":null,
         "longitude":null,
         "createdDate":"2010-12-03T10:49:11",
         "createdByPerson":{
            "@id":"1999191",
            "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
         },
         "lastUpdatedDate":null,
         "lastUpdatedByPerson":{
            "@id":",
            "@uri":"
         }
      },
      "createdDate":"2010-12-03T10:49:11",
      "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 location.

Content-types ::

  • application/json
  • application/xml

Format ::

  • json
  • xml

Parameters ::

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

Sample Response ::

Given: [PUT] https://demo.fellowshiponeapi.com/events/v1/events/8296/locations/2068

Request body:

<?xml version="1.0" encoding="utf-8"?>
<location>
  <name>Jingyi's House</name>
  <description>Small mansion in the hills.</description>
  <isOnline>false</isOnline>
  <url></url>
  <address>
    <address1>400 N. Aspen</address1>
    <address2></address2>
    <address3></address3>
    <city>Broken Arrow</city>
    <stProvince>OK</stProvince>
    <postalCode>74012</postalCode>
    <county></county>
    <country>US</country>
    <carrierRoute></carrierRoute>
    <deliveryPoint></deliveryPoint>
    <latitude>36.0561150</latitude>
    <longitude>-95.8175860</longitude>
    <createdDate></createdDate>
    <createdByPerson />
    <lastUpdatedDate></lastUpdatedDate>
    <lastUpdatedByPerson />
  </address>
  <createdDate></createdDate>
  <createdByPerson />
  <lastUpdatedDate></lastUpdatedDate>
  <lastUpdatedByPerson id=" uri=" />
</location>

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/events/v1/events/8296/locations/2060
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Fri, 03 Dec 2010 16:56:40 GMT
Content-Length: 1304

<?xml version="1.0" encoding="utf-8"?>
<location id="2060" uri="https://demo.fellowshiponeapi.com/events/v1/locations/2060">
  <name>Jingyi's House</name>
  <description>Small mansion in the hills.</description>
  <isOnline>false</isOnline>
  <url></url>
  <address>
    <address1>400 N. Aspen</address1>
    <address2></address2>
    <address3></address3>
    <city>Broken Arrow</city>
    <stProvince>OK</stProvince>
    <postalCode>74012</postalCode>
    <county></county>
    <country>US</country>
    <carrierRoute></carrierRoute>
    <deliveryPoint></deliveryPoint>
    <latitude>36.0561150</latitude>
    <longitude>-95.8175860</longitude>
    <createdDate>2010-12-03T10:49:11</createdDate>
    <createdByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
    <lastUpdatedDate>2010-12-03T10:56:40</lastUpdatedDate>
    <lastUpdatedByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
  </address>
  <createdDate>2010-12-03T10:49:11</createdDate>
  <createdByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
  <lastUpdatedDate>2010-12-03T10:56:40</lastUpdatedDate>
  <lastUpdatedByPerson id="1999191" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1999191" />
</location>

Given: [PUT] https://demo.fellowshiponeapi.com/events/v1/events/8296/locations/2060.json

Request body:

{
   "location":{
      "@id":",
      "@uri":",
      "name":"Jingyi's House",
      "description":"Small mansion in the hills.",
      "isOnline":"false",
      "url":null,
      "address":{
         "address1":"400 N. Aspen",
         "address2":null,
         "address3":null,
         "city":"Broken Arrow",
         "stProvince":"OK",
         "postalCode":"74012",
         "county":null,
         "country":"US",
         "carrierRoute":null,
         "deliveryPoint":null,
         "latitude":"36.0561150",
         "longitude":"-95.8175860",
         "createdDate":",
         "createdByPerson":{
            "@id":",
            "@uri":"
         },
         "lastUpdatedDate":",
         "lastUpdatedByPerson":{
            "@id":",
            "@uri":"
         }
      },
      "createdDate":",
      "createdByPerson":{
         "@id":",
         "@uri":"
      },
      "lastUpdatedDate":",
      "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/events/v1/events/8296/locations/2060.json
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Fri, 03 Dec 2010 17:00:25 GMT
Content-Length: 997

{
   "location":{
      "@id":"2060",
      "@uri":"https://demo.fellowshiponeapi.com/events/v1/locations/2060",
      "name":"Jingyi's House",
      "description":"Small mansion in the hills.",
      "isOnline":"false",
      "url":null,
      "address":{
         "address1":"400 N. Aspen",
         "address2":null,
         "address3":null,
         "city":"Broken Arrow",
         "stProvince":"OK",
         "postalCode":"74012",
         "county":null,
         "country":"US",
         "carrierRoute":null,
         "deliveryPoint":null,
         "latitude":"36.0561150",
         "longitude":"-95.8175860",
         "createdDate":"2010-12-03T10:49:11",
         "createdByPerson":{
            "@id":"1999191",
            "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
         },
         "lastUpdatedDate":"2010-12-03T11:00:25",
         "lastUpdatedByPerson":{
            "@id":"1999191",
            "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
         }
      },
      "createdDate":"2010-12-03T10:49:11",
      "createdByPerson":{
         "@id":"1999191",
         "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
      },
      "lastUpdatedDate":"2010-12-03T11:00:25",
      "lastUpdatedByPerson":{
         "@id":"1999191",
         "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
      }
   }
}

Method: delete [DELETE]

The delete method will delete a location from the event.

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/events/v1/events/{id}/locations/{id}/Delete
    • [DELETE] https://demo.fellowshiponeapi.com/events/v1/events/{id}/locations/{id}

Sample Response ::

Given: [DELETE] https://demo.fellowshiponeapi.com/events/v1/events/8296/locations/2060

Response:

HTTP/1.1 204 The resource https://demo.fellowshiponeapi.com/events/v1/events/26649/locations/2060 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