PATCH v1/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

OfficesRequestV1Model

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

Request Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<OfficesRequestV1Model 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>
  <OfficeName>sample string 1</OfficeName>
</OfficesRequestV1Model>

application/x-www-form-urlencoded

Sample:

OfficeName=sample&Description=sample

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

The updated office

Response Message

OfficesResponseV1Model

Name	Description	Type	Additional information
OfficeId	Fieldwork office unique identifier.	string	None.
IsHeadquarters	Gets or sets the property that says whether the fieldwork office is a headquarter.	boolean	None.
OfficeName	Name of the fieldwork office	string	None.
Description	Description of the fieldwork office	string	None.

Response Formats

application/json, text/json

Sample:

{
  "OfficeId": "sample string 1",
  "IsHeadquarters": true,
  "OfficeName": "sample string 3",
  "Description": "sample string 4"
}

application/xml, text/xml

Sample:

<OfficesResponseV1Model 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>
  <OfficeName>sample string 3</OfficeName>
  <IsHeadquarters>true</IsHeadquarters>
  <OfficeId>sample string 1</OfficeId>
</OfficesResponseV1Model>