Get Position

Returns a single position, including its assigned groups and users in WebEOC Nexus using the positionName endpoint. The response includes an ETag header whose value can be supplied in a later Patch position request via the If-Match header to guard against concurrent modification.

positionName endpoint description
Description Returns a single position.
URL

  • /positions/{positionName}

  • /positions/query/position?positionName={positionName}
Method GET
Parameter

positionName
Return Type WebEOCPosition
Sample JSON Response
Copy Code 
{
    "name": "CMD EOC Director",
    "color": "#3366CC",
    "pac": "",
    "comments": "Command staff director",
    "assignedGroups": ["Administrators", "Command"],
    "assignedUsers": ["jsmith", "adoe"]
}

Review the parameter definitions and examples of how to use the positionNameendpoint in a JQuery and C# call.

Parameter

positionName endpoint parameter
Variable Name Type Description Required
positionName String Name of the WebEOC Nexus position to retrieve True (URL)

Examples

JQuery Call

Copy Code 
$.ajax({
    url: baseUrl + '/positions/CMD EOC Director',
    contentType: 'application/json',
    type: 'GET'
});

C# Call

Copy Code 
public WebEOCPosition GetPosition(Cookie cookie)
{
    HttpWebRequest request = (HttpWebRequest)WebRequest.Create(baseUrl + "/positions/CMD EOC Director");
    CookieContainer cookieJar = new CookieContainer();
    cookieJar.Add(cookie);
    request.CookieContainer = cookieJar;
    WebResponse getResponse = request.GetResponse();
    using (Stream responseStream = getResponse.GetResponseStream())
    {
        StreamReader reader = new StreamReader(responseStream, Encoding.UTF8);
        return new JavaScriptSerializer().Deserialize<WebEOCPosition>(reader.ReadToEnd());
    }
}

Errors

401, 400 (blank or unknown position), 500.