POST api/returncodes

Insert a return code Code Name, CreatedBy and description are required

Request Information

URI Parameters

None.

Body Parameters

ReturnCodeViewModel

Name	Description	Type	Additional information
Id	Id	integer	Required
Name	Name	string	Required String length: inclusive between 1 and 10
Description	Description	string	Required String length: inclusive between 1 and 250
Details	Details	string	String length: inclusive between 0 and 1100
CreatedOn	CreatedOn	date	Required
CreatedBy	CreatedBy	integer	Required Range: inclusive between 1 and 2147483647
ModifiedOn	ModifiedOn	date	None.
ModifiedBy	ModifiedBy	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "id": 1,
  "name": "sample string 2",
  "description": "sample string 3",
  "details": "sample string 4",
  "createdOn": "2024-10-14T08:21:06.9179868-04:00",
  "createdBy": 6,
  "modifiedOn": "2024-10-14T08:21:06.9179868-04:00",
  "modifiedBy": 1
}

application/xml, text/xml

Sample:

<ReturnCodeViewModel 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:21:06.9179868-04:00</CreatedOn>
  <Description>sample string 3</Description>
  <Details>sample string 4</Details>
  <Id>1</Id>
  <ModifiedBy>1</ModifiedBy>
  <ModifiedOn>2024-10-14T08:21:06.9179868-04:00</ModifiedOn>
  <Name>sample string 2</Name>
</ReturnCodeViewModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ReturnCodeViewModel'.

Response Information

Resource Description

ReturnCodeViewModel

Name	Description	Type	Additional information
Id	Id	integer	Required
Name	Name	string	Required String length: inclusive between 1 and 10
Description	Description	string	Required String length: inclusive between 1 and 250
Details	Details	string	String length: inclusive between 0 and 1100
CreatedOn	CreatedOn	date	Required
CreatedBy	CreatedBy	integer	Required Range: inclusive between 1 and 2147483647
ModifiedOn	ModifiedOn	date	None.
ModifiedBy	ModifiedBy	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "name": "sample string 2",
  "description": "sample string 3",
  "details": "sample string 4",
  "createdOn": "2024-10-14T08:21:06.9179868-04:00",
  "createdBy": 6,
  "modifiedOn": "2024-10-14T08:21:06.9179868-04:00",
  "modifiedBy": 1
}

application/xml, text/xml

Sample:

<ReturnCodeViewModel 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:21:06.9179868-04:00</CreatedOn>
  <Description>sample string 3</Description>
  <Details>sample string 4</Details>
  <Id>1</Id>
  <ModifiedBy>1</ModifiedBy>
  <ModifiedOn>2024-10-14T08:21:06.9179868-04:00</ModifiedOn>
  <Name>sample string 2</Name>
</ReturnCodeViewModel>