POST api/OGA/New

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
OGADepartmentCode	string	Required
OGASectionCode	string	Required
ReferenceNo	string	None.
OfficeLetterNo	string	Required
OfficeLetterDate	date	Required
CompanyRegistrationNo	string	Required
ValidDateFrom	date	None.
ValidDateTo	date	None.
Allowance	string	Required
UsedOnce	boolean	Required
RecommendationPdfUrl	string	Required
Terminate	boolean	Required
CreatedDate	date	None.

Request Formats

application/json, text/json

Sample:

{
  "OGADepartmentCode": "sample string 1",
  "OGASectionCode": "sample string 2",
  "ReferenceNo": "sample string 3",
  "OfficeLetterNo": "sample string 4",
  "OfficeLetterDate": "2026-06-13T05:15:33.0383088+06:30",
  "CompanyRegistrationNo": "sample string 6",
  "ValidDateFrom": "2026-06-13T05:15:33.0383088+06:30",
  "ValidDateTo": "2026-06-13T05:15:33.0383088+06:30",
  "Allowance": "sample string 7",
  "UsedOnce": true,
  "RecommendationPdfUrl": "sample string 9",
  "Terminate": true,
  "CreatedDate": "2026-06-13T05:15:33.0383088+06:30"
}

application/xml, text/xml

Sample:

<OGARecommendationDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.DTO">
  <Allowance>sample string 7</Allowance>
  <CompanyRegistrationNo>sample string 6</CompanyRegistrationNo>
  <CreatedDate>2026-06-13T05:15:33.0383088+06:30</CreatedDate>
  <OGADepartmentCode>sample string 1</OGADepartmentCode>
  <OGASectionCode>sample string 2</OGASectionCode>
  <OfficeLetterDate>2026-06-13T05:15:33.0383088+06:30</OfficeLetterDate>
  <OfficeLetterNo>sample string 4</OfficeLetterNo>
  <RecommendationPdfUrl>sample string 9</RecommendationPdfUrl>
  <ReferenceNo>sample string 3</ReferenceNo>
  <Terminate>true</Terminate>
  <UsedOnce>true</UsedOnce>
  <ValidDateFrom>2026-06-13T05:15:33.0383088+06:30</ValidDateFrom>
  <ValidDateTo>2026-06-13T05:15:33.0383088+06:30</ValidDateTo>
</OGARecommendationDTO>

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 'OGARecommendationDTO'.

Response Information

Resource Description

ResponseMessage

Name	Type	Additional information
Id	string	None.
ReferenceNo	string	None.
WholeSaleRegistrationId	string	None.
MessageType	integer	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": "sample string 1",
  "ReferenceNo": "sample string 2",
  "WholeSaleRegistrationId": "sample string 3",
  "MessageType": 4,
  "Message": "sample string 5"
}

application/xml, text/xml

Sample:

<ResponseMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
  <Id>sample string 1</Id>
  <Message>sample string 5</Message>
  <MessageType>4</MessageType>
  <ReferenceNo>sample string 2</ReferenceNo>
  <WholeSaleRegistrationId>sample string 3</WholeSaleRegistrationId>
</ResponseMessage>