GET v2/Offices/{officeId}

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

Permissions required to make this request: FieldworkOffice.Read

Retrieve details of a specific fieldwork office.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
officeId

The id of the fieldwork office

 string

Required

Body Parameters

None.

Response Information

Resource Description

The details of the office

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>