POST api/globalDocuments

Inserts a new global document

Request Information

URI Parameters

None.

Body Parameters

GlobalDocumentsViewModel>ViewModel

Name	Type	Additional information
GlobalDocumentId	integer	None.
Name	string	None.
Description	string	None.
IsAvailableForRSM	boolean	None.
CreatedOn	date	None.
CreatedBy	integer	None.
ModifiedOn	date	None.
ModifiedBy	integer	None.
GlobalDocumentFiles	Collection of GlobalDocumentFileModel	None.
AllGlobalDocuments	Collection of GlobalDocumentModel	None.

Response Information

Resource Description

GlobalDocumentsViewModel>ViewModel

GlobalDocumentsViewModel

Name	Description	Type	Additional information
GlobalDocumentId		integer	None.
Name		string	None.
Description		string	None.
IsAvailableForRSM		boolean	None.
CreatedOn	Creation Date	date	None.
CreatedBy	Created by user's ID	integer	Required
ModifiedOn	Edited on	date	None.
ModifiedBy	Edited By	integer	None.
GlobalDocumentsFiles		Collection of GlobalDocumentsFileViewModel	None.

Response Formats

application/json, text/json

Sample:

{
  "globalDocumentId": 1,
  "name": "sample string 2",
  "description": "sample string 3",
  "isAvailableForRSM": true,
  "createdOn": "2024-10-14T08:23:47.9436847-04:00",
  "createdBy": 6,
  "modifiedOn": "2024-10-14T08:23:47.9436847-04:00",
  "modifiedBy": 1,
  "globalDocumentsFiles": [
    {
      "globalDocumentFileId": 1,
      "globalDocumentId": 2,
      "name": "sample string 3",
      "description": "sample string 4",
      "fileName": "sample string 5",
      "path": "sample string 6",
      "effectiveDate": "2024-10-14T08:23:47.9436847-04:00",
      "expirationDate": "2024-10-14T08:23:47.9436847-04:00",
      "createdBy": 9,
      "createdOn": "2024-10-14T08:23:47.9436847-04:00",
      "modifiedBy": 1,
      "modifiedOn": "2024-10-14T08:23:47.9436847-04:00"
    },
    {
      "globalDocumentFileId": 1,
      "globalDocumentId": 2,
      "name": "sample string 3",
      "description": "sample string 4",
      "fileName": "sample string 5",
      "path": "sample string 6",
      "effectiveDate": "2024-10-14T08:23:47.9436847-04:00",
      "expirationDate": "2024-10-14T08:23:47.9436847-04:00",
      "createdBy": 9,
      "createdOn": "2024-10-14T08:23:47.9436847-04:00",
      "modifiedBy": 1,
      "modifiedOn": "2024-10-14T08:23:47.9436847-04:00"
    }
  ]
}

application/xml, text/xml

Sample:

<GlobalDocumentsViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <CreatedBy>6</CreatedBy>
  <CreatedOn>2024-10-14T08:23:47.9436847-04:00</CreatedOn>
  <Description>sample string 3</Description>
  <GlobalDocumentId>1</GlobalDocumentId>
  <GlobalDocumentsFiles>
    <GlobalDocumentsFileViewModel>
      <CreatedBy>9</CreatedBy>
      <CreatedOn>2024-10-14T08:23:47.9436847-04:00</CreatedOn>
      <Description>sample string 4</Description>
      <EffectiveDate>2024-10-14T08:23:47.9436847-04:00</EffectiveDate>
      <ExpirationDate>2024-10-14T08:23:47.9436847-04:00</ExpirationDate>
      <FileName>sample string 5</FileName>
      <GlobalDocumentFileId>1</GlobalDocumentFileId>
      <GlobalDocumentId>2</GlobalDocumentId>
      <ModifiedBy>1</ModifiedBy>
      <ModifiedOn>2024-10-14T08:23:47.9436847-04:00</ModifiedOn>
      <Name>sample string 3</Name>
      <Path>sample string 6</Path>
    </GlobalDocumentsFileViewModel>
    <GlobalDocumentsFileViewModel>
      <CreatedBy>9</CreatedBy>
      <CreatedOn>2024-10-14T08:23:47.9436847-04:00</CreatedOn>
      <Description>sample string 4</Description>
      <EffectiveDate>2024-10-14T08:23:47.9436847-04:00</EffectiveDate>
      <ExpirationDate>2024-10-14T08:23:47.9436847-04:00</ExpirationDate>
      <FileName>sample string 5</FileName>
      <GlobalDocumentFileId>1</GlobalDocumentFileId>
      <GlobalDocumentId>2</GlobalDocumentId>
      <ModifiedBy>1</ModifiedBy>
      <ModifiedOn>2024-10-14T08:23:47.9436847-04:00</ModifiedOn>
      <Name>sample string 3</Name>
      <Path>sample string 6</Path>
    </GlobalDocumentsFileViewModel>
  </GlobalDocumentsFiles>
  <IsAvailableForRSM>true</IsAvailableForRSM>
  <ModifiedBy>1</ModifiedBy>
  <ModifiedOn>2024-10-14T08:23:47.9436847-04:00</ModifiedOn>
  <Name>sample string 2</Name>
</GlobalDocumentsViewModel>