PATCH v2/Offices/{officeId}

User roles allowed to make this request: DomainAdministrator LocalDomainManager

Permissions required to make this request: FieldworkOffice.Write FieldworkOffice.Read

Update a fieldwork office.

Request Information

URI Parameters

Name	Description	Type	Additional information
officeId	The id of the fieldwork office to update	string	Required

Body Parameters

Office name and description

OfficesRequestModel

Name	Description	Type	Additional information
Name	Name of the fieldwork office	string	None.
Description	Description of the fieldwork office	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "Description": "sample string 2"
}

application/xml, text/xml

Sample:

<OfficesRequestModel 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 2</Description>
  <Name>sample string 1</Name>
</OfficesRequestModel>

application/x-www-form-urlencoded

Sample:

Name=sample&Description=sample

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

The updated office

Response Message

HttpResponseMessage

Name	Type	Additional 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>