Add File to Attachment Person Attribute (PUT)

Allows a file to be attached to an Attachment attribute for a person in the Organization module.

URL

{RMUrl}/api/Organization/people/<PersonID>/attributes/<AttributeVariableName>/files/<NewAttachmentGUID>

REQUEST METHOD

PUT

URL PARAMETERS

PersonID: This parameter is provided in the URL and does not need to be sent through PUT.

AttributeVarName: This parameter is provided in the URL and does not need to be sent through PUT.

NewAttachGuid: This parameter is provided in the URL and does not need to be sent through PUT. The user is responsible for creating a new GUID.

FORM CONTENT

FileName (Required): Name used to identify the file in the attribute.

Data (Required): The file to be attached to the person. Maximum file size is 10 MB. The file bytes must be converted to a base64 string before sending.

Description (Optional): Optional comment for the attachment.

REQUEST EXAMPLE

{RMUrl}/api/Organization/people/4104a112-dff9-42de-bc7c-a7046170d762/attributes/attachmentattribute/files

FORM CONTENT EXAMPLE

{

"FileName":"Receipt.pdf",

"Data": "TWFuIGlzIGR...WQsIG5vdCBvbm",

"Description":"Proof of payment sent."

}

SUCCESS RESPONSE

The ID of the file attached. Returns a Guid. The response for the PUT method should be HTTP/1.1 201 Created.

SUCCESS RESPONSE EXAMPLE

"443de4ae-2360-4b66-bf69-8c9e4ca09001"