PATCH api/groups/{groupid}/facilitybranches/{facilitybranchid}/facilityARTypes/{id}

Patches an existing facility AR Type resource

Request Information

URI Parameters

NameDescriptionTypeAdditional information
groupid

Group identifier

integer

Required

facilitybranchid

Facility Branch identifier

integer

Required

id

FacilityARType identifier to patch

integer

Required

Body Parameters

The json formatted patch document (https://tools.ietf.org/html/rfc6902) containing operations to apply to the target rule

JsonPatchDocument
NameDescriptionTypeAdditional information
Operations

Collection of Operation

None.

Request Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/json-patch+json

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A patched facility AR Type resource

FacilityARTypeModel
NameDescriptionTypeAdditional information
FacilityBranchSeqNo

The facility branch associated with an AR Type

integer

None.

ExternalID

The external identifier for an AR Type

string

None.

Description

The description for a AR Type

string

None.

ARShortCode

The AR short code for a AR Type

string

None.

ARClassCode

The class code associated with an AR Type

string

None.

EffectiveStartDate

The effective start date associated with an AR Type

date

None.

EffectiveEndDate

The effective end date associated with an AR Type

date

None.

Url

Gets or sets the link representing a link back to the resource

string

None.

ID

Gets or sets the identifier for the resource

integer

None.

Response Formats

application/json, text/json, application/json-patch+json

Sample:
{
  "url": "sample string 7",
  "id": 8,
  "facilityBranchSeqNo": 1,
  "externalID": "sample string 3",
  "description": "sample string 4",
  "arShortCode": "sample string 5",
  "arClassCode": "sample string 6",
  "effectiveStartDate": "2025-07-16T16:05:58.3211888-05:00",
  "effectiveEndDate": "2025-07-16T16:05:58.3211888-05:00"
}