Unit - Resource

GET api/Unit

Using GET with a URI with no ID returns all items in the collection. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - There are no errors. Zero to n items are returned. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.

GET api/Unit/{ID}

Getting a single item is done by using a URI that includes an ID. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - The item is found and there are no errors. 404 - Not Found - The item requested was not found. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • ID The unique ID for an instance
    • Source: FromUri, Optional: False, Type: System.String

POST api/Unit

Using POST with a URI for a resource and the item data in the request attempts to add a new item to the collection. If the ID of the item exists in the collection, the action returns an error status of found, since this action is only for adding new items. If the action is successful, the response location header contains the location URI of the new item and a status of OK is returned. For possible outcomes, see the HTTP status codes below. HTTP status codes: 200 - OK - The resource is successfully created. 302 - Found - A record with a matching ID already exists in the collection. No changes are made to the system. 400 - Bad Request - The body might have error information; the data might not be valid. 404 - Not Found - Geocoding resulted in zero address candidates. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors. 503 - Service Unavailable - The geocoding service is unavailable.
Parameters:
  • Unit Unit Model class
    • Source: FromBody, Optional: False, Type: GeoLynx_API.Models.Unit

PUT api/Unit/{ID}

Using PUT with a URI for a resource and the item data in the request attempts to update the item based on its ID. The ID used to identify the item in the collection comes from the URI and not the data in the request. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - The resource is successfully updated. 400 - Bad Request - The body might have error information. 404 - Not Found - Attempts to update item by ID, where the item does not exist. Nothing is updated. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • ID The unique ID for a unit
    • Source: FromUri, Optional: False, Type: System.String
  • Unit Unit Model class
    • Source: FromBody, Optional: False, Type: GeoLynx_API.Models.Unit

DELETE api/Unit

Using DELETE with a URI for a resource and no ID present in the URI removes all items in the resource. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - There are no errors. All items have been deleted. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.

DELETE api/Unit/{ID}

Using DELETE with a URI for a resource with an ID deletes the specific items, if it exists. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - There are no errors. All items are deleted. 404 - Not Found - The ID supplied is not found. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • ID The unique ID for an instance
    • Source: FromUri, Optional: False, Type: System.String

GET api/Unit/GetAll

Using GET with a URI with no ID returns all items in the collection. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - There are no errors. Zero to n items are returned. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.

GET api/Unit/GetByID/{ID}

Getting a single item is done by using a URI that includes an ID. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - The item is found and there are no errors. 404 - Not Found - The item requested was not found. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • ID The unique ID for an instance
    • Source: FromUri, Optional: False, Type: System.String

POST api/Unit/PostUnit

Using POST with a URI for a resource and the item data in the request attempts to add a new item to the collection. If the ID of the item exists in the collection, the action returns an error status of found, since this action is only for adding new items. If the action is successful, the response location header contains the location URI of the new item and a status of OK is returned. For possible outcomes, see the HTTP status codes below. HTTP status codes: 200 - OK - The resource is successfully created. 302 - Found - A record with a matching ID already exists in the collection. No changes are made to the system. 400 - Bad Request - The body might have error information; the data might not be valid. 404 - Not Found - Geocoding resulted in zero address candidates. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors. 503 - Service Unavailable - The geocoding service is unavailable.
Parameters:
  • Unit Unit Model class
    • Source: FromBody, Optional: False, Type: GeoLynx_API.Models.Unit

PUT api/Unit/PutUnit/{ID}

Using PUT with a URI for a resource and the item data in the request attempts to update the item based on its ID. The ID used to identify the item in the collection comes from the URI and not the data in the request. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - The resource is successfully updated. 400 - Bad Request - The body might have error information. 404 - Not Found - Attempts to update item by ID, where the item does not exist. Nothing is updated. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • ID The unique ID for a unit
    • Source: FromUri, Optional: False, Type: System.String
  • Unit Unit Model class
    • Source: FromBody, Optional: False, Type: GeoLynx_API.Models.Unit

DELETE api/Unit/DeleteAll

Using DELETE with a URI for a resource and no ID present in the URI removes all items in the resource. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - There are no errors. All items have been deleted. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.

DELETE api/Unit/DeleteByID/{ID}

Using DELETE with a URI for a resource with an ID deletes the specific items, if it exists. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - There are no errors. All items are deleted. 404 - Not Found - The ID supplied is not found. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • ID The unique ID for an instance
    • Source: FromUri, Optional: False, Type: System.String

RawALI - Resource

POST api/RawALI

Using POST with a URI for a resource and the item data in the request attempts to add a new item to the collection. If the ID of the item exists in the collection, the action returns an error status of Found, since this action is only for adding new items. If the action is successful, the response location header contains the location URI of the new item and a status of OK is returned. For possible outcomes, see the HTTP status codes below. HTTP status codes: 200 - OK - The resource is successfully created. 302 - Found - A record with a matching ID already exists in the collection. No changes are made to the system. 400 - Bad Request - The body might have error information; the data might not be valid. 404 - Not Found - Geocoding resulted in zero address candidates. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors. 503 - Service Unavailable - The geocoding service is unavailable.
Parameters:
  • rawCall911 RawCall911 Model class
    • Source: FromBody, Optional: False, Type: GeoCommCall911.Model.RawCall911

POST api/RawALI/PostRawALI

Using POST with a URI for a resource and the item data in the request attempts to add a new item to the collection. If the ID of the item exists in the collection, the action returns an error status of Found, since this action is only for adding new items. If the action is successful, the response location header contains the location URI of the new item and a status of OK is returned. For possible outcomes, see the HTTP status codes below. HTTP status codes: 200 - OK - The resource is successfully created. 302 - Found - A record with a matching ID already exists in the collection. No changes are made to the system. 400 - Bad Request - The body might have error information; the data might not be valid. 404 - Not Found - Geocoding resulted in zero address candidates. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors. 503 - Service Unavailable - The geocoding service is unavailable.
Parameters:
  • rawCall911 RawCall911 Model class
    • Source: FromBody, Optional: False, Type: GeoCommCall911.Model.RawCall911

UnitPersonAssignment - Resource

GET api/UnitPersonAssignment

Using GET with a URI with no ID returns all items in the collection. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - There are no errors. Zero to n items are returned. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.

PUT api/UnitPersonAssignment

Using a PUT updates the GeoLynx API database with the UnitPersonAssignment data. This data will be spread across the tables, CadUnitStatus, Persons, Units, and PersonsUnits. HTTP status codes: 200 - OK - The data was successfully updated. 400 - Bad Request - The body might have error information; the data might not be valid. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • UnitPersonAssignment UnitPersonAssignment Model class
    • Source: FromBody, Optional: False, Type: GeoLynx_API.Models.UnitPersonAssignment

GET api/UnitPersonAssignment/GetAll

Using GET with a URI with no ID returns all items in the collection. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - There are no errors. Zero to n items are returned. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.

PUT api/UnitPersonAssignment/PutUnitPersonAssignment

Using a PUT updates the GeoLynx API database with the UnitPersonAssignment data. This data will be spread across the tables, CadUnitStatus, Persons, Units, and PersonsUnits. HTTP status codes: 200 - OK - The data was successfully updated. 400 - Bad Request - The body might have error information; the data might not be valid. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • UnitPersonAssignment UnitPersonAssignment Model class
    • Source: FromBody, Optional: False, Type: GeoLynx_API.Models.UnitPersonAssignment

MobileUnitIncidentAssignment - Resource

GET api/MobileUnitIncidentAssignment

Using GET with a URI with no ID returns all items in the collection. For possible outcomes, see the HTTP status codes. 200 - OK - There are no errors. Zero to n items are returned. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.

JSON Response Sample:

Content-Type: application/json; charset=utf-8
[{
 "IncidentID":"031312-0008",
 "UnitID":"934332",
 "Status":"Active",
 "PositionID":"1",
 "CADTimeStamp":"01/01 2010",
 "ReceivedTimeStamp":"0001-01-01T00:00:00"
 },
 {
 "IncidentID":"100711-0291",
 "UnitID":"134032",
 "Status":"Active",
 "PositionID":"8",
 "CADTimeStamp":"01/01 2010",
 "ReceivedTimeStamp":"0001-01-01T00:00:00"
 },
 {
 "IncidentID":"122111-036",
 "UnitID":"727332",
 "Status":"Active",
 "PositionID":"9",
 "CADTimeStamp":"01/01 2010",
 "ReceivedTimeStamp":"0001-01-01T00:00:00"
 }];

XML Response Sample:

Content-Type: application/xml; charset=utf-8
<ArrayOfMobileUnitIncidentAssignment 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <MobileUnitIncidentAssignment>
    <IncidentID>031312-0008</IncidentID>
    <UnitID>934332</UnitID>
    <Status>Active</Status>
    <PositionID>1</PositionID>
    <CADTimeStamp>01/01 2010</CADTimeStamp>
    <ReceivedTimeStamp>0001-01-01T00:00:00</ReceivedTimeStamp>
  </MobileUnitIncidentAssignment>
  <MobileUnitIncidentAssignment>
    <IncidentID>100711-0291</IncidentID>
    <UnitID>134032</UnitID>
    <Status>Active</Status>
    <PositionID>8</PositionID>
    <CADTimeStamp>01/01 2010</CADTimeStamp>
    <ReceivedTimeStamp>0001-01-01T00:00:00</ReceivedTimeStamp>
  </MobileUnitIncidentAssignment>
  <MobileUnitIncidentAssignment>
    <IncidentID>122111-036</IncidentID>
    <UnitID>727332</UnitID>
    <Status>Active</Status>
    <PositionID>9</PositionID>
    <CADTimeStamp>01/01 2010</CADTimeStamp>
    <ReceivedTimeStamp>0001-01-01T00:00:00</ReceivedTimeStamp>
  </MobileUnitIncidentAssignment>
</ArrayOfMobileUnitIncidentAssignment>

GET api/MobileUnitIncidentAssignment?IncidentID={IncidentID}

Get assignment(s) by IncidentID. Using GET with a URI and adding the IncidentID parameter to the URL returns the matching items in the collection. For possible outcomes, see the HTTP status codes. 200 - OK - The item was found and there were no errors. 404 - Not Found - The item requested was not found. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • IncidentID The ID of an incident
    • Source: FromUri, Optional: False, Type: System.String

JSON Response Sample:

Content-Type: application/json; charset=utf-8
[{
 "IncidentID":"031312-0008",
 "UnitID":"934332",
 "Status":"Active",
 "PositionID":"1",
 "CADTimeStamp":"01/01 2010",
 "ReceivedTimeStamp":"0001-01-01T00:00:00"
 },
 {
 "IncidentID":"100711-0291",
 "UnitID":"134032",
 "Status":"Active",
 "PositionID":"8",
 "CADTimeStamp":"01/01 2010",
 "ReceivedTimeStamp":"0001-01-01T00:00:00"
 },
 {
 "IncidentID":"122111-036",
 "UnitID":"727332",
 "Status":"Active",
 "PositionID":"9",
 "CADTimeStamp":"01/01 2010",
 "ReceivedTimeStamp":"0001-01-01T00:00:00"
 }];

XML Response Sample:

Content-Type: application/xml; charset=utf-8
<ArrayOfMobileUnitIncidentAssignment 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <MobileUnitIncidentAssignment>
    <IncidentID>031312-0008</IncidentID>
    <UnitID>934332</UnitID>
    <Status>Active</Status>
    <PositionID>1</PositionID>
    <CADTimeStamp>01/01 2010</CADTimeStamp>
    <ReceivedTimeStamp>0001-01-01T00:00:00</ReceivedTimeStamp>
  </MobileUnitIncidentAssignment>
  <MobileUnitIncidentAssignment>
    <IncidentID>100711-0291</IncidentID>
    <UnitID>134032</UnitID>
    <Status>Active</Status>
    <PositionID>8</PositionID>
    <CADTimeStamp>01/01 2010</CADTimeStamp>
    <ReceivedTimeStamp>0001-01-01T00:00:00</ReceivedTimeStamp>
  </MobileUnitIncidentAssignment>
  <MobileUnitIncidentAssignment>
    <IncidentID>122111-036</IncidentID>
    <UnitID>727332</UnitID>
    <Status>Active</Status>
    <PositionID>9</PositionID>
    <CADTimeStamp>01/01 2010</CADTimeStamp>
    <ReceivedTimeStamp>0001-01-01T00:00:00</ReceivedTimeStamp>
  </MobileUnitIncidentAssignment>
</ArrayOfMobileUnitIncidentAssignment>

GET api/MobileUnitIncidentAssignment?UnitID={UnitID}

Get assignment(s) for a unit given a UnitID. Using GET with a URI and adding the UnitID parameter to the URL returns the matching items in the collection. For possible outcomes, see the HTTP status codes. 200 - OK - The item was found and there were no errors. 404 - Not Found - The item requested was not found. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • UnitID ID of a unit
    • Source: FromUri, Optional: False, Type: System.String

JSON Response Sample:

Content-Type: application/json; charset=utf-8
[{
 "IncidentID":"031312-0008",
 "UnitID":"934332",
 "Status":"Active",
 "PositionID":"1",
 "CADTimeStamp":"01/01 2010",
 "ReceivedTimeStamp":"0001-01-01T00:00:00"
 },
 {
 "IncidentID":"100711-0291",
 "UnitID":"134032",
 "Status":"Active",
 "PositionID":"8",
 "CADTimeStamp":"01/01 2010",
 "ReceivedTimeStamp":"0001-01-01T00:00:00"
 },
 {
 "IncidentID":"122111-036",
 "UnitID":"727332",
 "Status":"Active",
 "PositionID":"9",
 "CADTimeStamp":"01/01 2010",
 "ReceivedTimeStamp":"0001-01-01T00:00:00"
 }];

XML Response Sample:

Content-Type: application/xml; charset=utf-8
<ArrayOfMobileUnitIncidentAssignment 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <MobileUnitIncidentAssignment>
    <IncidentID>031312-0008</IncidentID>
    <UnitID>934332</UnitID>
    <Status>Active</Status>
    <PositionID>1</PositionID>
    <CADTimeStamp>01/01 2010</CADTimeStamp>
    <ReceivedTimeStamp>0001-01-01T00:00:00</ReceivedTimeStamp>
  </MobileUnitIncidentAssignment>
  <MobileUnitIncidentAssignment>
    <IncidentID>100711-0291</IncidentID>
    <UnitID>134032</UnitID>
    <Status>Active</Status>
    <PositionID>8</PositionID>
    <CADTimeStamp>01/01 2010</CADTimeStamp>
    <ReceivedTimeStamp>0001-01-01T00:00:00</ReceivedTimeStamp>
  </MobileUnitIncidentAssignment>
  <MobileUnitIncidentAssignment>
    <IncidentID>122111-036</IncidentID>
    <UnitID>727332</UnitID>
    <Status>Active</Status>
    <PositionID>9</PositionID>
    <CADTimeStamp>01/01 2010</CADTimeStamp>
    <ReceivedTimeStamp>0001-01-01T00:00:00</ReceivedTimeStamp>
  </MobileUnitIncidentAssignment>
</ArrayOfMobileUnitIncidentAssignment>

POST api/MobileUnitIncidentAssignment

Using POST with a URI for a resource and the item data in the request attempts to add a new item to the collection. If the ID of the item exists in the collection, the action returns an error status of found, since this action is only for adding new items. If the action is successful, the response location header contains the location URI of the new item and a status of OK is returned. For possible outcomes, see the HTTP status codes below. 200 - OK - The resource is successfully created. 302 - Found - A record with a matching ID already exists in the collection. No changes are made to the system. 400 - Bad Request - The body might have error information; the data might not be valid. 404 - Not Found - Geocoding resulted in zero address candidates. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors. 503 - Service Unavailable - The geocoding service is unavailable.
Parameters:
  • Assignment Assignment data
    • Source: FromBody, Optional: False, Type: GeoLynx_API.Models.MobileUnitIncidentAssignment

JSON Response Sample:

Content-Type: application/json; charset=utf-8
[{
 "IncidentID":"031312-0008",
 "UnitID":"934332",
 "Status":"Active",
 "PositionID":"1",
 "CADTimeStamp":"01/01 2010",
 "ReceivedTimeStamp":"0001-01-01T00:00:00"
 },
 {
 "IncidentID":"100711-0291",
 "UnitID":"134032",
 "Status":"Active",
 "PositionID":"8",
 "CADTimeStamp":"01/01 2010",
 "ReceivedTimeStamp":"0001-01-01T00:00:00"
 },
 {
 "IncidentID":"122111-036",
 "UnitID":"727332",
 "Status":"Active",
 "PositionID":"9",
 "CADTimeStamp":"01/01 2010",
 "ReceivedTimeStamp":"0001-01-01T00:00:00"
 }];

XML Response Sample:

Content-Type: application/xml; charset=utf-8
<ArrayOfMobileUnitIncidentAssignment 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <MobileUnitIncidentAssignment>
    <IncidentID>031312-0008</IncidentID>
    <UnitID>934332</UnitID>
    <Status>Active</Status>
    <PositionID>1</PositionID>
    <CADTimeStamp>01/01 2010</CADTimeStamp>
    <ReceivedTimeStamp>0001-01-01T00:00:00</ReceivedTimeStamp>
  </MobileUnitIncidentAssignment>
  <MobileUnitIncidentAssignment>
    <IncidentID>100711-0291</IncidentID>
    <UnitID>134032</UnitID>
    <Status>Active</Status>
    <PositionID>8</PositionID>
    <CADTimeStamp>01/01 2010</CADTimeStamp>
    <ReceivedTimeStamp>0001-01-01T00:00:00</ReceivedTimeStamp>
  </MobileUnitIncidentAssignment>
  <MobileUnitIncidentAssignment>
    <IncidentID>122111-036</IncidentID>
    <UnitID>727332</UnitID>
    <Status>Active</Status>
    <PositionID>9</PositionID>
    <CADTimeStamp>01/01 2010</CADTimeStamp>
    <ReceivedTimeStamp>0001-01-01T00:00:00</ReceivedTimeStamp>
  </MobileUnitIncidentAssignment>
</ArrayOfMobileUnitIncidentAssignment>

DELETE api/MobileUnitIncidentAssignment

Using DELETE with a URI with no ID deletes all items in the collection. For possible outcomes, see the HTTP status codes. 200 - OK - There are no errors and all records are deleted 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.

DELETE api/MobileUnitIncidentAssignment?IncidentID={IncidentID}

Delete assignment(s) by IncidentID. Using DELETE with a URI and adding the IncidentID parameter to the URL deletes the matching items in the collection. For possible outcomes, see the HTTP status codes. 200 - OK - The item is found and there are no errors. 404 - Not Found - The item requested is not found. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • IncidentID ID of an incident
    • Source: FromUri, Optional: False, Type: System.String

DELETE api/MobileUnitIncidentAssignment?UnitID={UnitID}

Delete assignment(s) for a unit given a UnitID. Using DELETE with a URI and adding the UnitID parameter to the URL deletes the matching items in the collection. For possible outcomes, see the HTTP status codes. 200 - OK - The item is found and there are no errors. 404 - Not Found - The item requested is not found. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • UnitID the ID of a unit
    • Source: FromUri, Optional: False, Type: System.String

PUT api/MobileUnitIncidentAssignment?UnitID={UnitID}

Delete assignment(s) for a unit given a UnitID. Using DELETE with a URI and adding the UnitID parameter to the URL deletes the matching items in the collection. For possible outcomes, see the HTTP status codes. Using PUT with a URI and adding the UnitID parameter to the URL updates the matching assignment in the collection. For possible outcomes, see the HTTP status codes. 200 - OK - The resource is successfully updated. 400 - Bad Request - The body might have error information. 404 - Not Found - Attempts to update item by ID, where the item does not exist. Nothing is updated. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • UnitID ID of a unit
    • Source: FromUri, Optional: False, Type: System.String
  • Assignment Assignment data
    • Source: FromBody, Optional: False, Type: GeoLynx_API.Models.MobileUnitIncidentAssignment

JSON Response Sample:

Content-Type: application/json; charset=utf-8
[{
 "IncidentID":"031312-0008",
 "UnitID":"934332",
 "Status":"Active",
 "PositionID":"1",
 "CADTimeStamp":"01/01 2010",
 "ReceivedTimeStamp":"0001-01-01T00:00:00"
 },
 {
 "IncidentID":"100711-0291",
 "UnitID":"134032",
 "Status":"Active",
 "PositionID":"8",
 "CADTimeStamp":"01/01 2010",
 "ReceivedTimeStamp":"0001-01-01T00:00:00"
 },
 {
 "IncidentID":"122111-036",
 "UnitID":"727332",
 "Status":"Active",
 "PositionID":"9",
 "CADTimeStamp":"01/01 2010",
 "ReceivedTimeStamp":"0001-01-01T00:00:00"
 }];

XML Response Sample:

Content-Type: application/xml; charset=utf-8
<ArrayOfMobileUnitIncidentAssignment 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <MobileUnitIncidentAssignment>
    <IncidentID>031312-0008</IncidentID>
    <UnitID>934332</UnitID>
    <Status>Active</Status>
    <PositionID>1</PositionID>
    <CADTimeStamp>01/01 2010</CADTimeStamp>
    <ReceivedTimeStamp>0001-01-01T00:00:00</ReceivedTimeStamp>
  </MobileUnitIncidentAssignment>
  <MobileUnitIncidentAssignment>
    <IncidentID>100711-0291</IncidentID>
    <UnitID>134032</UnitID>
    <Status>Active</Status>
    <PositionID>8</PositionID>
    <CADTimeStamp>01/01 2010</CADTimeStamp>
    <ReceivedTimeStamp>0001-01-01T00:00:00</ReceivedTimeStamp>
  </MobileUnitIncidentAssignment>
  <MobileUnitIncidentAssignment>
    <IncidentID>122111-036</IncidentID>
    <UnitID>727332</UnitID>
    <Status>Active</Status>
    <PositionID>9</PositionID>
    <CADTimeStamp>01/01 2010</CADTimeStamp>
    <ReceivedTimeStamp>0001-01-01T00:00:00</ReceivedTimeStamp>
  </MobileUnitIncidentAssignment>
</ArrayOfMobileUnitIncidentAssignment>

GET api/MobileUnitIncidentAssignment/GetAll

Using GET with a URI with no ID returns all items in the collection. For possible outcomes, see the HTTP status codes. 200 - OK - There are no errors. Zero to n items are returned. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.

GET api/MobileUnitIncidentAssignment/GetByIncidentID?IncidentID={IncidentID}

Get assignment(s) by IncidentID. Using GET with a URI and adding the IncidentID parameter to the URL returns the matching items in the collection. For possible outcomes, see the HTTP status codes. 200 - OK - The item was found and there were no errors. 404 - Not Found - The item requested was not found. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • IncidentID The ID of an incident
    • Source: FromUri, Optional: False, Type: System.String

GET api/MobileUnitIncidentAssignment/GetByUnitID?UnitID={UnitID}

Get assignment(s) for a unit given a UnitID. Using GET with a URI and adding the UnitID parameter to the URL returns the matching items in the collection. For possible outcomes, see the HTTP status codes. 200 - OK - The item was found and there were no errors. 404 - Not Found - The item requested was not found. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • UnitID ID of a unit
    • Source: FromUri, Optional: False, Type: System.String

POST api/MobileUnitIncidentAssignment/PostAssignment

Using POST with a URI for a resource and the item data in the request attempts to add a new item to the collection. If the ID of the item exists in the collection, the action returns an error status of found, since this action is only for adding new items. If the action is successful, the response location header contains the location URI of the new item and a status of OK is returned. For possible outcomes, see the HTTP status codes below. 200 - OK - The resource is successfully created. 302 - Found - A record with a matching ID already exists in the collection. No changes are made to the system. 400 - Bad Request - The body might have error information; the data might not be valid. 404 - Not Found - Geocoding resulted in zero address candidates. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors. 503 - Service Unavailable - The geocoding service is unavailable.
Parameters:
  • Assignment Assignment data
    • Source: FromBody, Optional: False, Type: GeoLynx_API.Models.MobileUnitIncidentAssignment

DELETE api/MobileUnitIncidentAssignment/DeleteAll

Using DELETE with a URI with no ID deletes all items in the collection. For possible outcomes, see the HTTP status codes. 200 - OK - There are no errors and all records are deleted 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.

DELETE api/MobileUnitIncidentAssignment/DeleteByIncidentID?IncidentID={IncidentID}

Delete assignment(s) by IncidentID. Using DELETE with a URI and adding the IncidentID parameter to the URL deletes the matching items in the collection. For possible outcomes, see the HTTP status codes. 200 - OK - The item is found and there are no errors. 404 - Not Found - The item requested is not found. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • IncidentID ID of an incident
    • Source: FromUri, Optional: False, Type: System.String

DELETE api/MobileUnitIncidentAssignment/DeleteByUnitID?UnitID={UnitID}

Delete assignment(s) for a unit given a UnitID. Using DELETE with a URI and adding the UnitID parameter to the URL deletes the matching items in the collection. For possible outcomes, see the HTTP status codes. 200 - OK - The item is found and there are no errors. 404 - Not Found - The item requested is not found. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • UnitID the ID of a unit
    • Source: FromUri, Optional: False, Type: System.String

PUT api/MobileUnitIncidentAssignment/PutAssignmentByUnitID?UnitID={UnitID}

Delete assignment(s) for a unit given a UnitID. Using DELETE with a URI and adding the UnitID parameter to the URL deletes the matching items in the collection. For possible outcomes, see the HTTP status codes. Using PUT with a URI and adding the UnitID parameter to the URL updates the matching assignment in the collection. For possible outcomes, see the HTTP status codes. 200 - OK - The resource is successfully updated. 400 - Bad Request - The body might have error information. 404 - Not Found - Attempts to update item by ID, where the item does not exist. Nothing is updated. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • UnitID ID of a unit
    • Source: FromUri, Optional: False, Type: System.String
  • Assignment Assignment data
    • Source: FromBody, Optional: False, Type: GeoLynx_API.Models.MobileUnitIncidentAssignment

UnitRecommendation - Resource

GET api/UnitRecommendation?RequestID={RequestID}&units={units}&incidentID={incidentID}&sortBy={sortBy}&distanceUnitOfMeasure={distanceUnitOfMeasure}

Allows the client to submit a list of AVL Units and the unique ID of a single incident and receive a response of the estimated travel time and distance from each AVL unit’s current location to the location of the CAD incident. 200 - OK - Zero to n routes are calculated. 400 - Bad Request - Body might have error information. Data might not be valid. 401 - Unauthorized - The authentication token used is invalid. 403 - Forbidden - The server does not allow the requested access. Note: SSL is required. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors. 503 - Service Unavailable - The LTS service, geometry service or network analyst service is unavailable.
Parameters:
  • RequestID The unique value of the request.
    • Source: FromUri, Optional: True, Type: System.String
  • units The comma delimited list of units. Each represents a starting point of a route request.
    • Source: FromUri, Optional: True, Type: System.String
  • incidentID The incidentid or the end point of each route request.
    • Source: FromUri, Optional: True, Type: System.String
  • sortBy The parameter to order the return results by. Possible values are Time and Distance. If not provided defaults to time.
    • Source: FromUri, Optional: True, Type: System.String
  • distanceUnitOfMeasure The unit of measurement in which the distance parameter is returned. Possible values are: Feet, Miles, Meters or Kilometers. If not provided defaults to feet.
    • Source: FromUri, Optional: True, Type: System.String

GET api/UnitRecommendation/Get?RequestID={RequestID}&units={units}&incidentID={incidentID}&sortBy={sortBy}&distanceUnitOfMeasure={distanceUnitOfMeasure}

Allows the client to submit a list of AVL Units and the unique ID of a single incident and receive a response of the estimated travel time and distance from each AVL unit’s current location to the location of the CAD incident. 200 - OK - Zero to n routes are calculated. 400 - Bad Request - Body might have error information. Data might not be valid. 401 - Unauthorized - The authentication token used is invalid. 403 - Forbidden - The server does not allow the requested access. Note: SSL is required. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors. 503 - Service Unavailable - The LTS service, geometry service or network analyst service is unavailable.
Parameters:
  • RequestID The unique value of the request.
    • Source: FromUri, Optional: True, Type: System.String
  • units The comma delimited list of units. Each represents a starting point of a route request.
    • Source: FromUri, Optional: True, Type: System.String
  • incidentID The incidentid or the end point of each route request.
    • Source: FromUri, Optional: True, Type: System.String
  • sortBy The parameter to order the return results by. Possible values are Time and Distance. If not provided defaults to time.
    • Source: FromUri, Optional: True, Type: System.String
  • distanceUnitOfMeasure The unit of measurement in which the distance parameter is returned. Possible values are: Feet, Miles, Meters or Kilometers. If not provided defaults to feet.
    • Source: FromUri, Optional: True, Type: System.String

PositionsOnCall - Resource

GET api/PositionsOnCall

Using GET with a URI with no ID returns all items in the collection. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - There are no errors. Zero to n items are returned. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.

GET api/PositionsOnCall/{ID}

Getting a single item is done by using a URI that includes an ID. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - The item was found and there were no errors. 404 - Not Found - The item requested was not found. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • ID The unique ID for an instance
    • Source: FromUri, Optional: False, Type: System.String

GET api/PositionsOnCall/{ID}?PositionID={PositionID}

Getting a single item is done by using a URI that includes an ID. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - The item was found and there were no errors. 404 - Not Found - The item requested was not found. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • ID Unique ID for the Call
    • Source: FromUri, Optional: False, Type: System.String
  • PositionID Operator's position ID
    • Source: FromUri, Optional: False, Type: System.String

GET api/PositionsOnCall?positionID={positionID}

Use the given position ID to get a list of call IDs the position is on
Parameters:
  • positionID The given position ID
    • Source: FromUri, Optional: False, Type: System.String

POST api/PositionsOnCall

Using POST with a URI for a resource and the item data in the request attempts to add a new item to the collection. If the ID of the item exists in the collection, the action returns an error status of Found, since this action is only for adding new items. If the action is successful, the response location header contains the location URI of the new item and a status of OK is returned. For possible outcomes, see the HTTP status codes below. HTTP status codes: 200 - OK - The resource is successfully created. 302 - Found - A record with a matching CallID and PositionID already exists in the collection. No changes are made to the system. 400 - Bad Request - The body might have error information; the data might not be valid. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • positionOnCall
    • Source: FromBody, Optional: False, Type: GeoCommCall911.PositionOnCall

DELETE api/PositionsOnCall/{ID}

Using DELETE with a URI for a resource with an ID deletes the specific items, if it exists. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - There are no errors. All items are deleted. 404 - Not Found - The ID supplied is not found. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • ID The unique ID for an instance
    • Source: FromUri, Optional: False, Type: System.String

DELETE api/PositionsOnCall/{ID}?PositionID={PositionID}

Using DELETE with a URI for a resource with an ID and Position ID deletes the specific item, if it exists. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - There are no errors. All items are deleted. 404 - Not Found - The row with ID and PositionID supplied was not found. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • ID Unique ID for the Call
    • Source: FromUri, Optional: False, Type: System.String
  • PositionID Operator's position ID
    • Source: FromUri, Optional: False, Type: System.String

PUT api/PositionsOnCall/{id}

Sends the a GCE911 to publisher with the flag to use the AnsweredBySelf symbol, instead of the AnsweredByOthers symbol
Parameters:
  • id A call ID
    • Source: FromUri, Optional: False, Type: System.String
  • dtoSendCall911
    • Source: FromBody, Optional: False, Type: GeoCommCall911.Model.DTOSendCall911

PUT api/PositionsOnCall?callID={callID}

Sends a Deselect to publisher for each position on the call
Parameters:
  • callID A call ID
    • Source: FromUri, Optional: False, Type: System.String
  • positionID A position on the call
    • Source: FromBody, Optional: False, Type: System.String

GET api/PositionsOnCall/GetAll

Using GET with a URI with no ID returns all items in the collection. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - There are no errors. Zero to n items are returned. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.

GET api/PositionsOnCall/GetByID/{ID}

Getting a single item is done by using a URI that includes an ID. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - The item was found and there were no errors. 404 - Not Found - The item requested was not found. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • ID The unique ID for an instance
    • Source: FromUri, Optional: False, Type: System.String

GET api/PositionsOnCall/GetByIDAndPosition/{ID}?PositionID={PositionID}

Getting a single item is done by using a URI that includes an ID. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - The item was found and there were no errors. 404 - Not Found - The item requested was not found. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • ID Unique ID for the Call
    • Source: FromUri, Optional: False, Type: System.String
  • PositionID Operator's position ID
    • Source: FromUri, Optional: False, Type: System.String

GET api/PositionsOnCall/GetCallIDsByPositionID?positionID={positionID}

Use the given position ID to get a list of call IDs the position is on
Parameters:
  • positionID The given position ID
    • Source: FromUri, Optional: False, Type: System.String

POST api/PositionsOnCall/PostPositionOnCall

Using POST with a URI for a resource and the item data in the request attempts to add a new item to the collection. If the ID of the item exists in the collection, the action returns an error status of Found, since this action is only for adding new items. If the action is successful, the response location header contains the location URI of the new item and a status of OK is returned. For possible outcomes, see the HTTP status codes below. HTTP status codes: 200 - OK - The resource is successfully created. 302 - Found - A record with a matching CallID and PositionID already exists in the collection. No changes are made to the system. 400 - Bad Request - The body might have error information; the data might not be valid. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • positionOnCall
    • Source: FromBody, Optional: False, Type: GeoCommCall911.PositionOnCall

DELETE api/PositionsOnCall/DeleteByID/{ID}

Using DELETE with a URI for a resource with an ID deletes the specific items, if it exists. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - There are no errors. All items are deleted. 404 - Not Found - The ID supplied is not found. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • ID The unique ID for an instance
    • Source: FromUri, Optional: False, Type: System.String

DELETE api/PositionsOnCall/DeleteByID/{ID}?PositionID={PositionID}

Using DELETE with a URI for a resource with an ID and Position ID deletes the specific item, if it exists. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - There are no errors. All items are deleted. 404 - Not Found - The row with ID and PositionID supplied was not found. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • ID Unique ID for the Call
    • Source: FromUri, Optional: False, Type: System.String
  • PositionID Operator's position ID
    • Source: FromUri, Optional: False, Type: System.String

PUT api/PositionsOnCall/PutSendCall911/{id}

Sends the a GCE911 to publisher with the flag to use the AnsweredBySelf symbol, instead of the AnsweredByOthers symbol
Parameters:
  • id A call ID
    • Source: FromUri, Optional: False, Type: System.String
  • dtoSendCall911
    • Source: FromBody, Optional: False, Type: GeoCommCall911.Model.DTOSendCall911

PUT api/PositionsOnCall/PutSendDeselect?callID={callID}

Sends a Deselect to publisher for each position on the call
Parameters:
  • callID A call ID
    • Source: FromUri, Optional: False, Type: System.String
  • positionID A position on the call
    • Source: FromBody, Optional: False, Type: System.String

ServicesByLocation - Resource

GET api/ServicesByLocation?Latitude={Latitude}&Longitude={Longitude}

Parameters:
  • Latitude
    • Source: FromUri, Optional: False, Type: System.Double
  • Longitude
    • Source: FromUri, Optional: False, Type: System.Double

GET api/ServicesByLocation/GetByGeodetic?Latitude={Latitude}&Longitude={Longitude}

Parameters:
  • Latitude
    • Source: FromUri, Optional: False, Type: System.Double
  • Longitude
    • Source: FromUri, Optional: False, Type: System.Double

MapLayerQuery - Resource

GET api/MapLayerQuery?RequestID={RequestID}&searchLayer={searchLayer}&searchText={searchText}&searchFields={searchFields}&isExactMatch={isExactMatch}&returnGeometry={returnGeometry}

The response will contain the Request ID and an object containing the attributes of the matching record(s) along with the geometry and other layer information fields. HTTP status codes: 200 - OK - Zero to n routes are calculated. 400 - Bad Request - Body might have error information. Data might not be valid. 401 - Unauthorized - The authentication token used is invalid. 403 - Forbidden - The server does not allow the requested access. Note: SSL is required. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors. 503 - Service Unavailable - The map query service is unavailable.
Parameters:
  • RequestID The unique value of the request.
    • Source: FromUri, Optional: False, Type: System.String
  • searchLayer The layer to search.
    • Source: FromUri, Optional: False, Type: System.String
  • searchText The content to search for in the layer.
    • Source: FromUri, Optional: False, Type: System.String
  • searchFields The list of fields to search in the layer. The fields are specified as a comma-delimited list. If not provided all fields are searched.
    • Source: FromUri, Optional: True, Type: System.String
  • isExactMatch The Boolean value controls the type of search. If True only results which are an exact match for the search text will be returned. If False any field which “contains” the search text will be returned. Default value is False
    • Source: FromUri, Optional: True, Type: System.Boolean
  • returnGeometry The Boolean value which determines if the geometry is returned in the results or not. Default value is True.
    • Source: FromUri, Optional: True, Type: System.Boolean

GET api/MapLayerQuery?RequestID={RequestID}&searchLayer={searchLayer}&Latitude={Latitude}&Longitude={Longitude}&X={X}&Y={Y}&distance={distance}&distanceType={distanceType}&returnGeometry={returnGeometry}

Return all the elements in a map layer within the radial distance from a location. A required location of either an X and Y coordinate or a latitude and longitude should be used in the search parameters. HTTP status codes: 200 - OK - Zero to n elements are found. 400 - Bad Request - Body might have error information. Data might not be valid. 401 - Unauthorized - The authentication token used is invalid. 403 - Forbidden - The server does not allow the requested access. *Note: SSL is required. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors. 503 - Service Unavailable - The map query service or map layer service is unavailable.
Parameters:
  • RequestID The unique value of the request.
    • Source: FromUri, Optional: False, Type: System.String
  • searchLayer The layer to search.
    • Source: FromUri, Optional: False, Type: System.String
  • Latitude Latitude of the center point where the spatial search takes place. Valid values range from -90 to 90.
    • Source: FromUri, Optional: True, Type: System.Nullable`1[[System.Double, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
  • Longitude Longitude of the center point where the spatial search takes place. Valid values range from -180 to 180.
    • Source: FromUri, Optional: True, Type: System.Nullable`1[[System.Double, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
  • X X coordinate of the center point where the spatial search takes place.
    • Source: FromUri, Optional: True, Type: System.Nullable`1[[System.Double, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
  • Y Y coordinate of the center point where the spatial search takes place.
    • Source: FromUri, Optional: True, Type: System.Nullable`1[[System.Double, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
  • distance Radius of the spatial search. Default is 100.
    • Source: FromUri, Optional: True, Type: System.Double
  • distanceType String representing the type of unit the distance value is (I.E. feet, miles, kilometers, or meters). Default is meters.
    • Source: FromUri, Optional: True, Type: System.String
  • returnGeometry The Boolean value which determines if the geometry is returned in the results or not. Default value is True.
    • Source: FromUri, Optional: True, Type: System.Boolean

GET api/MapLayerQuery/Get?RequestID={RequestID}&searchLayer={searchLayer}&searchText={searchText}&searchFields={searchFields}&isExactMatch={isExactMatch}&returnGeometry={returnGeometry}

The response will contain the Request ID and an object containing the attributes of the matching record(s) along with the geometry and other layer information fields. HTTP status codes: 200 - OK - Zero to n routes are calculated. 400 - Bad Request - Body might have error information. Data might not be valid. 401 - Unauthorized - The authentication token used is invalid. 403 - Forbidden - The server does not allow the requested access. Note: SSL is required. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors. 503 - Service Unavailable - The map query service is unavailable.
Parameters:
  • RequestID The unique value of the request.
    • Source: FromUri, Optional: False, Type: System.String
  • searchLayer The layer to search.
    • Source: FromUri, Optional: False, Type: System.String
  • searchText The content to search for in the layer.
    • Source: FromUri, Optional: False, Type: System.String
  • searchFields The list of fields to search in the layer. The fields are specified as a comma-delimited list. If not provided all fields are searched.
    • Source: FromUri, Optional: True, Type: System.String
  • isExactMatch The Boolean value controls the type of search. If True only results which are an exact match for the search text will be returned. If False any field which “contains” the search text will be returned. Default value is False
    • Source: FromUri, Optional: True, Type: System.Boolean
  • returnGeometry The Boolean value which determines if the geometry is returned in the results or not. Default value is True.
    • Source: FromUri, Optional: True, Type: System.Boolean

GET api/MapLayerQuery/Get?RequestID={RequestID}&searchLayer={searchLayer}&Latitude={Latitude}&Longitude={Longitude}&X={X}&Y={Y}&distance={distance}&distanceType={distanceType}&returnGeometry={returnGeometry}

Return all the elements in a map layer within the radial distance from a location. A required location of either an X and Y coordinate or a latitude and longitude should be used in the search parameters. HTTP status codes: 200 - OK - Zero to n elements are found. 400 - Bad Request - Body might have error information. Data might not be valid. 401 - Unauthorized - The authentication token used is invalid. 403 - Forbidden - The server does not allow the requested access. *Note: SSL is required. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors. 503 - Service Unavailable - The map query service or map layer service is unavailable.
Parameters:
  • RequestID The unique value of the request.
    • Source: FromUri, Optional: False, Type: System.String
  • searchLayer The layer to search.
    • Source: FromUri, Optional: False, Type: System.String
  • Latitude Latitude of the center point where the spatial search takes place. Valid values range from -90 to 90.
    • Source: FromUri, Optional: True, Type: System.Nullable`1[[System.Double, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
  • Longitude Longitude of the center point where the spatial search takes place. Valid values range from -180 to 180.
    • Source: FromUri, Optional: True, Type: System.Nullable`1[[System.Double, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
  • X X coordinate of the center point where the spatial search takes place.
    • Source: FromUri, Optional: True, Type: System.Nullable`1[[System.Double, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
  • Y Y coordinate of the center point where the spatial search takes place.
    • Source: FromUri, Optional: True, Type: System.Nullable`1[[System.Double, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
  • distance Radius of the spatial search. Default is 100.
    • Source: FromUri, Optional: True, Type: System.Double
  • distanceType String representing the type of unit the distance value is (I.E. feet, miles, kilometers, or meters). Default is meters.
    • Source: FromUri, Optional: True, Type: System.String
  • returnGeometry The Boolean value which determines if the geometry is returned in the results or not. Default value is True.
    • Source: FromUri, Optional: True, Type: System.Boolean

Person - Resource

GET api/Person

Using GET with a URI with no ID returns all items in the collection. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - There are no errors. Zero to n items are returned. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.

GET api/Person/{ID}

Getting a single item is done by using a URI that includes an ID. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - The item is found and there are no errors. 404 - Not Found - The item requested was not found. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • ID The unique ID for an instance
    • Source: FromUri, Optional: False, Type: System.String

POST api/Person

Using POST with a URI for a resource and the item data in the request attempts to add a new item to the collection. If the ID of the item exists in the collection, the action returns an error status of found, since this action is only for adding new items. If the action is successful, the response location header contains the location URI of the new item and a status of OK is returned. For possible outcomes, see the HTTP status codes below. HTTP status codes: 200 - OK - The resource is successfully created. 302 - Found - A record with a matching ID already exists in the collection. No changes are made to the system. 400 - Bad Request - The body might have error information; the data might not be valid. 404 - Not Found - Geocoding resulted in zero address candidates. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors. 503 - Service Unavailable - The geocoding service is unavailable.
Parameters:
  • Person Person Model class
    • Source: FromBody, Optional: False, Type: GeoLynx_API.Models.Person

PUT api/Person/{ID}

Using PUT with a URI for a resource and the item data in the request attempts to update the item based on its ID. The ID used to identify the item in the collection comes from the URI and not the data in the request. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - The resource is successfully updated. 400 - Bad Request - The body might have error information. 404 - Not Found - Attempts to update item by ID, where the item does not exist. Nothing is updated. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • ID The unique ID for an instance
    • Source: FromUri, Optional: False, Type: System.String
  • Person Person Model class
    • Source: FromBody, Optional: False, Type: GeoLynx_API.Models.Person

DELETE api/Person

Using DELETE with a URI for a resource and no ID present in the URI removes all items in the resource. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - There are no errors. All items have been deleted. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.

DELETE api/Person/{ID}

Using DELETE with a URI for a resource with an ID deletes the specific items, if it exists. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - There are no errors. All items are deleted. 404 - Not Found - The ID supplied is not found. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • ID The unique ID for an instance
    • Source: FromUri, Optional: False, Type: System.String

GET api/Person/GetAll

Using GET with a URI with no ID returns all items in the collection. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - There are no errors. Zero to n items are returned. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.

GET api/Person/GetByID/{ID}

Getting a single item is done by using a URI that includes an ID. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - The item is found and there are no errors. 404 - Not Found - The item requested was not found. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • ID The unique ID for an instance
    • Source: FromUri, Optional: False, Type: System.String

POST api/Person/PostPerson

Using POST with a URI for a resource and the item data in the request attempts to add a new item to the collection. If the ID of the item exists in the collection, the action returns an error status of found, since this action is only for adding new items. If the action is successful, the response location header contains the location URI of the new item and a status of OK is returned. For possible outcomes, see the HTTP status codes below. HTTP status codes: 200 - OK - The resource is successfully created. 302 - Found - A record with a matching ID already exists in the collection. No changes are made to the system. 400 - Bad Request - The body might have error information; the data might not be valid. 404 - Not Found - Geocoding resulted in zero address candidates. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors. 503 - Service Unavailable - The geocoding service is unavailable.
Parameters:
  • Person Person Model class
    • Source: FromBody, Optional: False, Type: GeoLynx_API.Models.Person

PUT api/Person/PutPerson/{ID}

Using PUT with a URI for a resource and the item data in the request attempts to update the item based on its ID. The ID used to identify the item in the collection comes from the URI and not the data in the request. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - The resource is successfully updated. 400 - Bad Request - The body might have error information. 404 - Not Found - Attempts to update item by ID, where the item does not exist. Nothing is updated. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • ID The unique ID for an instance
    • Source: FromUri, Optional: False, Type: System.String
  • Person Person Model class
    • Source: FromBody, Optional: False, Type: GeoLynx_API.Models.Person

DELETE api/Person/DeleteAll

Using DELETE with a URI for a resource and no ID present in the URI removes all items in the resource. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - There are no errors. All items have been deleted. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.

DELETE api/Person/DeleteByID/{ID}

Using DELETE with a URI for a resource with an ID deletes the specific items, if it exists. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - There are no errors. All items are deleted. 404 - Not Found - The ID supplied is not found. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • ID The unique ID for an instance
    • Source: FromUri, Optional: False, Type: System.String

MapViewControl - Resource

POST api/MapViewControl?ZoomLevel={ZoomLevel}&Longitude={Longitude}&Latitude={Latitude}&PositionID={PositionID}

Center the map by longitude and latitude. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • ZoomLevel The requested zoom level or width of the map in miles.
    • Source: FromUri, Optional: False, Type: System.Double
  • Longitude The valid longitude value.
    • Source: FromUri, Optional: False, Type: System.Double
  • Latitude The valid latitude value.
    • Source: FromUri, Optional: False, Type: System.Double
  • PositionID The ID of the workstation requesting the map view.
    • Source: FromUri, Optional: False, Type: System.String

POST api/MapViewControl?ZoomLevel={ZoomLevel}&StreetAddress={StreetAddress}&Community={Community}&ESN={ESN}&PositionID={PositionID}

Center the map by an address. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • ZoomLevel The requested zoom level or width of the map in miles.
    • Source: FromUri, Optional: False, Type: System.Double
  • StreetAddress Street address to zoom to.
    • Source: FromUri, Optional: False, Type: System.String
  • Community Community to zoom to.
    • Source: FromUri, Optional: False, Type: System.String
  • ESN ESN (Emergency Service Number) to zoom to.
    • Source: FromUri, Optional: False, Type: System.String
  • PositionID The ID of the workstation requesting the map view.
    • Source: FromUri, Optional: False, Type: System.String

POST api/MapViewControl?ZoomLevel={ZoomLevel}&IncidentID={IncidentID}&PositionID={PositionID}

Center the map by an incident. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • ZoomLevel The requested zoom level or width of the map in miles.
    • Source: FromUri, Optional: False, Type: System.Double
  • IncidentID The unique value of the incident.
    • Source: FromUri, Optional: False, Type: System.String
  • PositionID The ID of the workstation requesting the map view.
    • Source: FromUri, Optional: False, Type: System.String

POST api/MapViewControl?ZoomLevel={ZoomLevel}&X={X}&Y={Y}&PositionID={PositionID}

Center the map by projected X value and projected Y value. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • ZoomLevel The requested zoom level or width of the map in miles.
    • Source: FromUri, Optional: False, Type: System.Double
  • X The valid projected X value.
    • Source: FromUri, Optional: False, Type: System.Double
  • Y The valid projected Y value.
    • Source: FromUri, Optional: False, Type: System.Double
  • PositionID The ID of the workstation requesting the map view.
    • Source: FromUri, Optional: False, Type: System.String

POST api/MapViewControl/PostViewByLongLat?ZoomLevel={ZoomLevel}&Longitude={Longitude}&Latitude={Latitude}&PositionID={PositionID}

Center the map by longitude and latitude. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • ZoomLevel The requested zoom level or width of the map in miles.
    • Source: FromUri, Optional: False, Type: System.Double
  • Longitude The valid longitude value.
    • Source: FromUri, Optional: False, Type: System.Double
  • Latitude The valid latitude value.
    • Source: FromUri, Optional: False, Type: System.Double
  • PositionID The ID of the workstation requesting the map view.
    • Source: FromUri, Optional: False, Type: System.String

POST api/MapViewControl/PostViewByAddress?ZoomLevel={ZoomLevel}&StreetAddress={StreetAddress}&Community={Community}&ESN={ESN}&PositionID={PositionID}

Center the map by an address. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • ZoomLevel The requested zoom level or width of the map in miles.
    • Source: FromUri, Optional: False, Type: System.Double
  • StreetAddress Street address to zoom to.
    • Source: FromUri, Optional: False, Type: System.String
  • Community Community to zoom to.
    • Source: FromUri, Optional: False, Type: System.String
  • ESN ESN (Emergency Service Number) to zoom to.
    • Source: FromUri, Optional: False, Type: System.String
  • PositionID The ID of the workstation requesting the map view.
    • Source: FromUri, Optional: False, Type: System.String

POST api/MapViewControl/PostViewByIncident?ZoomLevel={ZoomLevel}&IncidentID={IncidentID}&PositionID={PositionID}

Center the map by an incident. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • ZoomLevel The requested zoom level or width of the map in miles.
    • Source: FromUri, Optional: False, Type: System.Double
  • IncidentID The unique value of the incident.
    • Source: FromUri, Optional: False, Type: System.String
  • PositionID The ID of the workstation requesting the map view.
    • Source: FromUri, Optional: False, Type: System.String

POST api/MapViewControl/PostViewByXY?ZoomLevel={ZoomLevel}&X={X}&Y={Y}&PositionID={PositionID}

Center the map by projected X value and projected Y value. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • ZoomLevel The requested zoom level or width of the map in miles.
    • Source: FromUri, Optional: False, Type: System.Double
  • X The valid projected X value.
    • Source: FromUri, Optional: False, Type: System.Double
  • Y The valid projected Y value.
    • Source: FromUri, Optional: False, Type: System.Double
  • PositionID The ID of the workstation requesting the map view.
    • Source: FromUri, Optional: False, Type: System.String

Incident - Resource

GET api/Incident

Using GET with a URI with no ID returns all items in the collection. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - There are no errors. Zero to n items are returned. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.

JSON Response Sample:

Content-Type: application/json; charset=utf-8
[{
 "ID":"011712-0003",
 "Type":"Fire",
 "CallerName":"Bill Smith",
 "Longitude":94.33234,
 "Latitude":34.22222,
 "StreetAddress":"123 West Wilson Ave.",
 "Community":"Cloud City",
 "ESN":"3",
 "Jurisdiction":"",
 "PositionID":"5",
 "CADTimeStamp":"2012-03-22 08:16:10.000"
 },
 {
 "ID":"032212-0011",
 "Type":"Police",
 "CallerName":"Jim Anderson",
 "Longitude":94.33234,
 "Latitude":34.22222,
 "StreetAddress":"1190 North main street",
 "Community":"Cloud City",
 "ESN":"9",
 "Jurisdiction":"",
 "PositionID":"7",
 "CADTimeStamp":"2012-03-22 09:22:10.000"
 },
 {
 "ID":"122111-0365",
 "Type":"B and E",
 "CallerName":"Ann Smith",
 "Longitude":94.33234,
 "Latitude":34.22222,
 "StreetAddress":"1688 10th Ave S.E.",
 "Community":"",
 "ESN":"12",
 "Jurisdiction":"St. Cloud",
 "PositionID":"22",
 "CADTimeStamp":"2012-03-22 09:24:10.000"
 }];

XML Response Sample:

Content-Type: application/xml; charset=utf-8
<ArrayOfIncident 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Incident>
    <ID>011712-0003</ID>
    <Type>Fire</Type>
    <CallerName>Bill Smith</CallerName>
    <Longitude>94.33234</Longitude>
    <Latitude>34.22222</Latitude>
    <StreetAddress>123 West Wilson Ave.</StreetAddress>
    <Community>Cloud City</Community>
    <ESN>3</ESN>
    <Jurisdiction />
    <PositionID>5</PositionID>
    <CADTimeStamp>2012-03-22 08:16:10.000</CADTimeStamp>
  </Incident>
  <Incident>
    <ID>032212-0011</ID>
    <Type>Police</Type>
    <CallerName>Jim Anderson</CallerName>
    <Longitude>94.33234</Longitude>
    <Latitude>34.22222</Latitude>
    <StreetAddress>1190 North main street</StreetAddress>
    <Community>Cloud City</Community>
    <ESN>9</ESN>
    <Jurisdiction />
    <PositionID>7</PositionID>
    <CADTimeStamp>2012-03-22 09:22:10.000</CADTimeStamp>
  </Incident>
  <Incident>
    <ID>122111-0365</ID>
    <Type>B and E</Type>
    <CallerName>Ann Smith</CallerName>
    <Longitude>94.33234</Longitude>
    <Latitude>34.22222</Latitude>
    <StreetAddress>1688 10th Ave S.E.</StreetAddress>
    <Community />
    <ESN>12</ESN>
    <Jurisdiction>St. Cloud</Jurisdiction>
    <PositionID>22</PositionID>
    <CADTimeStamp>2012-03-22 09:24:10.000</CADTimeStamp>
  </Incident>
</ArrayOfIncident>

GET api/Incident/{ID}

Getting a single item is done by using a URI that includes an ID. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - The item was found and there were no errors. 404 - Not Found - The item requested was not found. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • ID The unique ID for an instance
    • Source: FromUri, Optional: False, Type: System.String

JSON Response Sample:

Content-Type: application/json; charset=utf-8
{
 "ID":"011712-0003",
 "Type":"Fire",
 "CallerName":"Bill Smith",
 "Longitude":94.33234,
 "Latitude":34.22222,
 "StreetAddress":"123 West Wilson Ave.",
 "Community":"Cloud City",
 "ESN":"3",
 "Jurisdiction":"",
 "PositionID":"5",
 "CADTimeStamp":"2012-03-22 08:16:10.000"
 };

XML Response Sample:

Content-Type: application/xml; charset=utf-8
<Incident 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ID>011712-0003</ID>
  <Type>Fire</Type>
  <CallerName>Bill Smith</CallerName>
  <Longitude>94.33234</Longitude>
  <Latitude>34.22222</Latitude>
  <StreetAddress>123 West Wilson Ave.</StreetAddress>
  <Community>Cloud City</Community>
  <ESN>3</ESN>
  <Jurisdiction />
  <PositionID>5</PositionID>
  <CADTimeStamp>2012-03-22 08:16:10.000</CADTimeStamp>
</Incident>

POST api/Incident

Using POST with a URI for a resource and the item data in the request attempts to add a new item to the collection. If the ID of the item exists in the collection, the action returns an error status of found, since this action is only for adding new items. If the action is successful, the response location header contains the location URI of the new item and a status of OK is returned. For possible outcomes, see the HTTP status codes below. HTTP status codes: 200 - OK - The resource is successfully created. 302 - Found - A record with a matching ID already exists in the collection. No changes are made to the system. 400 - Bad Request - The body might have error information; the data might not be valid. 404 - Not Found - Geocoding resulted in zero address candidates. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors. 503 - Service Unavailable - The geocoding service is unavailable.
Parameters:
  • Incident Incident Model class
    • Source: FromBody, Optional: False, Type: GeoLynx_API.Models.Incident

JSON Response Sample:

Content-Type: application/json; charset=utf-8
{
 "ID":"011712-0003",
 "Type":"Fire",
 "CallerName":"Bill Smith",
 "Longitude":94.33234,
 "Latitude":34.22222,
 "StreetAddress":"123 West Wilson Ave.",
 "Community":"Cloud City",
 "ESN":"3",
 "Jurisdiction":"",
 "PositionID":"5",
 "CADTimeStamp":"2012-03-22 08:16:10.000"
 };

XML Response Sample:

Content-Type: application/xml; charset=utf-8
<Incident 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ID>011712-0003</ID>
  <Type>Fire</Type>
  <CallerName>Bill Smith</CallerName>
  <Longitude>94.33234</Longitude>
  <Latitude>34.22222</Latitude>
  <StreetAddress>123 West Wilson Ave.</StreetAddress>
  <Community>Cloud City</Community>
  <ESN>3</ESN>
  <Jurisdiction />
  <PositionID>5</PositionID>
  <CADTimeStamp>2012-03-22 08:16:10.000</CADTimeStamp>
</Incident>

DELETE api/Incident

Using DELETE with a URI for a resource and no ID present in the URI removes all items in the resource. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - There are no errors. All items have been deleted. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.

DELETE api/Incident/{ID}

Using DELETE with a URI for a resource with an ID deletes the specific items, if it exists. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - There are no errors. All items are deleted. 404 - Not Found - The ID supplied is not found. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • ID The unique ID for an instance
    • Source: FromUri, Optional: False, Type: System.String

PUT api/Incident/{ID}

Using PUT with a URI for a resource and the item data in the request attempts to update the item based on its ID. The ID used to identify the item in the collection comes from the URI and not the data in the request. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - The resource is successfully updated. 400 - Bad Request - The body might have error information. 404 - Not Found - Attempts to update item by ID, where the item does not exist. Nothing is updated. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • ID The unique ID for an instance
    • Source: FromUri, Optional: False, Type: System.String
  • Incident Incident Model class
    • Source: FromBody, Optional: False, Type: GeoLynx_API.Models.Incident

JSON Response Sample:

Content-Type: application/json; charset=utf-8
{
 "ID":"011712-0003",
 "Type":"Fire",
 "CallerName":"Bill Smith",
 "Longitude":94.33234,
 "Latitude":34.22222,
 "StreetAddress":"123 West Wilson Ave.",
 "Community":"Cloud City",
 "ESN":"3",
 "Jurisdiction":"",
 "PositionID":"5",
 "CADTimeStamp":"2012-03-22 08:16:10.000"
 };

XML Response Sample:

Content-Type: application/xml; charset=utf-8
<Incident 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ID>011712-0003</ID>
  <Type>Fire</Type>
  <CallerName>Bill Smith</CallerName>
  <Longitude>94.33234</Longitude>
  <Latitude>34.22222</Latitude>
  <StreetAddress>123 West Wilson Ave.</StreetAddress>
  <Community>Cloud City</Community>
  <ESN>3</ESN>
  <Jurisdiction />
  <PositionID>5</PositionID>
  <CADTimeStamp>2012-03-22 08:16:10.000</CADTimeStamp>
</Incident>

GET api/Incident/GetAll

Using GET with a URI with no ID returns all items in the collection. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - There are no errors. Zero to n items are returned. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.

GET api/Incident/GetByID/{ID}

Getting a single item is done by using a URI that includes an ID. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - The item was found and there were no errors. 404 - Not Found - The item requested was not found. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • ID The unique ID for an instance
    • Source: FromUri, Optional: False, Type: System.String

POST api/Incident/PostIncident

Using POST with a URI for a resource and the item data in the request attempts to add a new item to the collection. If the ID of the item exists in the collection, the action returns an error status of found, since this action is only for adding new items. If the action is successful, the response location header contains the location URI of the new item and a status of OK is returned. For possible outcomes, see the HTTP status codes below. HTTP status codes: 200 - OK - The resource is successfully created. 302 - Found - A record with a matching ID already exists in the collection. No changes are made to the system. 400 - Bad Request - The body might have error information; the data might not be valid. 404 - Not Found - Geocoding resulted in zero address candidates. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors. 503 - Service Unavailable - The geocoding service is unavailable.
Parameters:
  • Incident Incident Model class
    • Source: FromBody, Optional: False, Type: GeoLynx_API.Models.Incident

DELETE api/Incident/DeleteAll

Using DELETE with a URI for a resource and no ID present in the URI removes all items in the resource. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - There are no errors. All items have been deleted. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.

DELETE api/Incident/DeleteByID/{ID}

Using DELETE with a URI for a resource with an ID deletes the specific items, if it exists. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - There are no errors. All items are deleted. 404 - Not Found - The ID supplied is not found. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • ID The unique ID for an instance
    • Source: FromUri, Optional: False, Type: System.String

PUT api/Incident/PutIncident/{ID}

Using PUT with a URI for a resource and the item data in the request attempts to update the item based on its ID. The ID used to identify the item in the collection comes from the URI and not the data in the request. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - The resource is successfully updated. 400 - Bad Request - The body might have error information. 404 - Not Found - Attempts to update item by ID, where the item does not exist. Nothing is updated. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • ID The unique ID for an instance
    • Source: FromUri, Optional: False, Type: System.String
  • Incident Incident Model class
    • Source: FromBody, Optional: False, Type: GeoLynx_API.Models.Incident

ValidateAddress - Resource

GET api/ValidateAddress?RequestID={RequestID}&StreetAddress={StreetAddress}&Community={Community}&ESN={ESN}&MaximumNumberOfCandidates={MaximumNumberOfCandidates}&MinimumMatchScore={MinimumMatchScore}

The ValidateAddress query resource causes no visible action on the map; it allows the client to submit an address and receive a response for match candidates. 200 - OK - Zero to n routes are calculated. 400 - Bad Request - Body might have error information. Data might not be valid. 401 - Unauthorized - The authentication token used is invalid. 403 - Forbidden - The server does not allow the requested access. Note: SSL is required. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors. 503 - Service Unavailable - The geocoding service is unavailable.
Parameters:
  • RequestID The unique value of the request.
    • Source: FromUri, Optional: False, Type: System.String
  • StreetAddress The address to validate.
    • Source: FromUri, Optional: False, Type: System.String
  • Community The community to validate.
    • Source: FromUri, Optional: True, Type: System.String
  • ESN The ESN to validate.
    • Source: FromUri, Optional: True, Type: System.String
  • MaximumNumberOfCandidates The maximum number of candidates to return in the results.
    • Source: FromUri, Optional: True, Type: System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
  • MinimumMatchScore The minimum score of match candidates to be returned. Possible values range from 0 to 100.
    • Source: FromUri, Optional: True, Type: System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

GET api/ValidateAddress/Get?RequestID={RequestID}&StreetAddress={StreetAddress}&Community={Community}&ESN={ESN}&MaximumNumberOfCandidates={MaximumNumberOfCandidates}&MinimumMatchScore={MinimumMatchScore}

The ValidateAddress query resource causes no visible action on the map; it allows the client to submit an address and receive a response for match candidates. 200 - OK - Zero to n routes are calculated. 400 - Bad Request - Body might have error information. Data might not be valid. 401 - Unauthorized - The authentication token used is invalid. 403 - Forbidden - The server does not allow the requested access. Note: SSL is required. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors. 503 - Service Unavailable - The geocoding service is unavailable.
Parameters:
  • RequestID The unique value of the request.
    • Source: FromUri, Optional: False, Type: System.String
  • StreetAddress The address to validate.
    • Source: FromUri, Optional: False, Type: System.String
  • Community The community to validate.
    • Source: FromUri, Optional: True, Type: System.String
  • ESN The ESN to validate.
    • Source: FromUri, Optional: True, Type: System.String
  • MaximumNumberOfCandidates The maximum number of candidates to return in the results.
    • Source: FromUri, Optional: True, Type: System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
  • MinimumMatchScore The minimum score of match candidates to be returned. Possible values range from 0 to 100.
    • Source: FromUri, Optional: True, Type: System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

AddressByLocation - Resource

GET api/AddressByLocation?RequestID={RequestID}&X={X}&Y={Y}&Latitude={Latitude}&Longitude={Longitude}

The AddressByLocation query resource causes no visible action on the map; it allows the client to submit an location and receive a response for a matching candidate. HTTP status codes: 200 - OK - Zero or one address candidates are found. 400 - Bad Request - Body might have error information. Data might not be valid. 401 - Unauthorized - The authentication token used is invalid. 403 - Forbidden - The server does not allow the requested access. Note: SSL is required. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors. 503 - Service Unavailable - The geocoding service is unavailable.
Parameters:
  • RequestID The unique value of the request.
    • Source: FromUri, Optional: False, Type: System.String
  • X The valid x-coordinate of the location in map units.
    • Source: FromUri, Optional: True, Type: System.Nullable`1[[System.Double, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
  • Y The valid y-coordinate of the location in map units.
    • Source: FromUri, Optional: True, Type: System.Nullable`1[[System.Double, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
  • Latitude The valid latitude of the location. Possible values range from -90 to 90.
    • Source: FromUri, Optional: True, Type: System.Nullable`1[[System.Double, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
  • Longitude The valid longitude of the location. Possible values range from -180 to 180.
    • Source: FromUri, Optional: True, Type: System.Nullable`1[[System.Double, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

GET api/AddressByLocation/Get?RequestID={RequestID}&X={X}&Y={Y}&Latitude={Latitude}&Longitude={Longitude}

The AddressByLocation query resource causes no visible action on the map; it allows the client to submit an location and receive a response for a matching candidate. HTTP status codes: 200 - OK - Zero or one address candidates are found. 400 - Bad Request - Body might have error information. Data might not be valid. 401 - Unauthorized - The authentication token used is invalid. 403 - Forbidden - The server does not allow the requested access. Note: SSL is required. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors. 503 - Service Unavailable - The geocoding service is unavailable.
Parameters:
  • RequestID The unique value of the request.
    • Source: FromUri, Optional: False, Type: System.String
  • X The valid x-coordinate of the location in map units.
    • Source: FromUri, Optional: True, Type: System.Nullable`1[[System.Double, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
  • Y The valid y-coordinate of the location in map units.
    • Source: FromUri, Optional: True, Type: System.Nullable`1[[System.Double, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
  • Latitude The valid latitude of the location. Possible values range from -90 to 90.
    • Source: FromUri, Optional: True, Type: System.Nullable`1[[System.Double, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
  • Longitude The valid longitude of the location. Possible values range from -180 to 180.
    • Source: FromUri, Optional: True, Type: System.Nullable`1[[System.Double, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

Call911 - Resource

GET api/Call911

Using GET with a URI with no ID returns all items in the collection. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - There are no errors. Zero to n items are returned. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.

GET api/Call911/{ID}

Getting a single item is done by using a URI that includes an ID. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - The item is found and there are no errors. 404 - Not Found - The item requested was not found. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • ID The unique ID for an instance
    • Source: FromUri, Optional: False, Type: System.String

GET api/Call911?callID={callID}

Parameters:
  • callID
    • Source: FromUri, Optional: False, Type: System.String

POST api/Call911

Using POST with a URI for a resource and the item data in the request attempts to add a new item to the collection. If the ID of the item exists in the collection, the action returns an error status of found, since this action is only for adding new items. If the action is successful, the response location header contains the location URI of the new item and a status of OK is returned. For possible outcomes, see the HTTP status codes below. HTTP status codes: 200 - OK - The resource is successfully created. 302 - Found - A record with a matching ID already exists in the collection. No changes are made to the system. 400 - Bad Request - The body might have error information; the data might not be valid. 404 - Not Found - Geocoding resulted in zero address candidates. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors. 503 - Service Unavailable - The geocoding service is unavailable.
Parameters:
  • call Call911 Model class
    • Source: FromBody, Optional: False, Type: GeoCommCall911.Call911

PUT api/Call911?callID={callID}

Using PUT with a URI for a resource and the item data in the request attempts to update the item based on its ID. The ID used to identify the item in the collection comes from the URI and not the data in the request. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - The resource is successfully updated. 400 - Bad Request - The body might have error information. 404 - Not Found - Attempts to update item by ID, where the item does not exist. Nothing is updated. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • callID The unique ID for an instance
    • Source: FromUri, Optional: False, Type: System.String
  • Call Call 911 Model class
    • Source: FromBody, Optional: False, Type: GeoCommCall911.Call911

PUT api/Call911/{id}

Sends a mute\privacy\hold on\off message to the MSMQ
Parameters:
  • id The call ID
    • Source: FromUri, Optional: False, Type: System.String
  • mutePrivacyHoldInformation Information to send to MSMQ
    • Source: FromBody, Optional: False, Type: GeoCommCall911.Model.DTOMutePrivacyHold

PUT api/Call911?callID={callID}&callStateToPut={callStateToPut}

Parameters:
  • callID
    • Source: FromUri, Optional: False, Type: System.String
  • callStateToPut
    • Source: FromUri, Optional: False, Type: System.String

GET api/Call911/GetAll

Using GET with a URI with no ID returns all items in the collection. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - There are no errors. Zero to n items are returned. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.

GET api/Call911/GetByID/{ID}

Getting a single item is done by using a URI that includes an ID. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - The item is found and there are no errors. 404 - Not Found - The item requested was not found. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • ID The unique ID for an instance
    • Source: FromUri, Optional: False, Type: System.String

GET api/Call911/GetCallStateById?callID={callID}

Parameters:
  • callID
    • Source: FromUri, Optional: False, Type: System.String

POST api/Call911/PostCall

Using POST with a URI for a resource and the item data in the request attempts to add a new item to the collection. If the ID of the item exists in the collection, the action returns an error status of found, since this action is only for adding new items. If the action is successful, the response location header contains the location URI of the new item and a status of OK is returned. For possible outcomes, see the HTTP status codes below. HTTP status codes: 200 - OK - The resource is successfully created. 302 - Found - A record with a matching ID already exists in the collection. No changes are made to the system. 400 - Bad Request - The body might have error information; the data might not be valid. 404 - Not Found - Geocoding resulted in zero address candidates. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors. 503 - Service Unavailable - The geocoding service is unavailable.
Parameters:
  • call Call911 Model class
    • Source: FromBody, Optional: False, Type: GeoCommCall911.Call911

PUT api/Call911/PutCall911?callID={callID}

Using PUT with a URI for a resource and the item data in the request attempts to update the item based on its ID. The ID used to identify the item in the collection comes from the URI and not the data in the request. For possible outcomes, see the HTTP status codes. HTTP status codes: 200 - OK - The resource is successfully updated. 400 - Bad Request - The body might have error information. 404 - Not Found - Attempts to update item by ID, where the item does not exist. Nothing is updated. 500 - Internal Server Error - The response contains an error message with more detail to the specific issue. Note: These tend to be system errors.
Parameters:
  • callID The unique ID for an instance
    • Source: FromUri, Optional: False, Type: System.String
  • Call Call 911 Model class
    • Source: FromBody, Optional: False, Type: GeoCommCall911.Call911

PUT api/Call911/PutSendMutePrivacyHold/{id}

Sends a mute\privacy\hold on\off message to the MSMQ
Parameters:
  • id The call ID
    • Source: FromUri, Optional: False, Type: System.String
  • mutePrivacyHoldInformation Information to send to MSMQ
    • Source: FromBody, Optional: False, Type: GeoCommCall911.Model.DTOMutePrivacyHold

PUT api/Call911/PutCallState?callID={callID}&callStateToPut={callStateToPut}

Parameters:
  • callID
    • Source: FromUri, Optional: False, Type: System.String
  • callStateToPut
    • Source: FromUri, Optional: False, Type: System.String
All rights reserved Copyright 2013, 2014, 2015 Geo-Comm Inc