PATCH api/employer/recordId/{recordId}

Update 101/Employer Report document record by record Id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
recordId

integer

Required

Body Parameters

EmployerDocumentRecord
NameDescriptionTypeAdditional information
DocumentID

DocumentID assigned to the EmployerReport/101 document

string

None.

FirstName

First Name assigned to the EmployerReport/101 document

string

None.

LastName

LastName assigned to the EmployerReport/101 document

string

None.

DOB

The DOB assigned to the EmployerReport/101 document

date

None.

DOI

The DOI assigned to the EmployerReport/101 document

date

None.

VCTableId

The ViewCenter record table ID that represents the table the document is in

integer

None.

VCRecordId

The ViewCenter record ID that represents a document

integer

None.

VCParentRecordID

The ViewCenter parent record ID that this document record belongs too.

integer

None.

VCStorageID

The storage ID of the storage folder where the attachment is stored (internal use).

integer

None.

VCFileRelativeLocation

The folder within the storage folder the attachment is stored (internal use).

string

None.

VCFileName

The filename within the storage folder the attachment is named (internal use).

string

None.

VCFileExtension

The file extension of the attachment.

string

None.

VCFileOriginalName

The original filename of the attachment as sent to ViewCenter.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "DocumentID": "sample string 1",
  "FirstName": "sample string 2",
  "LastName": "sample string 3",
  "DOB": "2024-12-28T01:18:42.3560747-07:00",
  "DOI": "2024-12-28T01:18:42.3560747-07:00",
  "VCTableId": 4,
  "VCRecordId": 5,
  "VCParentRecordID": 1,
  "VCStorageID": 1,
  "VCFileRelativeLocation": "sample string 6",
  "VCFileName": "sample string 7",
  "VCFileExtension": "sample string 8",
  "VCFileOriginalName": "sample string 9"
}

application/xml, text/xml

Sample:
<EmployerDocumentRecord xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClaimsVCRestApi.Models">
  <DOB>2024-12-28T01:18:42.3560747-07:00</DOB>
  <DOI>2024-12-28T01:18:42.3560747-07:00</DOI>
  <DocumentID>sample string 1</DocumentID>
  <FirstName>sample string 2</FirstName>
  <LastName>sample string 3</LastName>
  <VCFileExtension>sample string 8</VCFileExtension>
  <VCFileName>sample string 7</VCFileName>
  <VCFileOriginalName>sample string 9</VCFileOriginalName>
  <VCFileRelativeLocation>sample string 6</VCFileRelativeLocation>
  <VCParentRecordID>1</VCParentRecordID>
  <VCRecordId>5</VCRecordId>
  <VCStorageID>1</VCStorageID>
  <VCTableId>4</VCTableId>
</EmployerDocumentRecord>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

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.