GET v2/Offices

User roles allowed to make this request: DomainAdministrator PowerUser RegularUser Supervisor LimitedUser LocalDomainManager SampleManager DemoUser

Permissions required to make this request: FieldworkOffice.Read

Retrieve a list of Fieldwork Offices. This list can be filtered and sorted using standard OData syntax.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

A (filtered) list of fieldwork offices

Response Message

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.
Content

HttpContent

None.
StatusCode

HttpStatusCode

None.
ReasonPhrase

string

None.
Headers

Collection of Object

None.
RequestMessage

HttpRequestMessage

None.
IsSuccessStatusCode

boolean

None.

Response Formats

application/json, text/json

Sample: 
{
  "Id": "sample string 1",
  "IsHeadquarters": true,
  "Name": "sample string 3",
  "Description": "sample string 4"
}

application/xml, text/xml

Sample: 
<OfficesResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models.Offices">
  <Description>sample string 4</Description>
  <Name>sample string 3</Name>
  <Id>sample string 1</Id>
  <IsHeadquarters>true</IsHeadquarters>
</OfficesResponseModel>