POST api/OGA/Amend
Request Information
URI Parameters
None.
Body Parameters
OGAAmendDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| ReferenceNo | string |
Required |
|
| OfficeLetterNo | 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:
{
"ReferenceNo": "sample string 1",
"OfficeLetterNo": "sample string 2",
"ValidDateFrom": "2026-06-13T05:16:11.83972+06:30",
"ValidDateTo": "2026-06-13T05:16:11.83972+06:30",
"Allowance": "sample string 3",
"UsedOnce": true,
"RecommendationPdfUrl": "sample string 5",
"Terminate": true,
"CreatedDate": "2026-06-13T05:16:11.83972+06:30"
}
application/xml, text/xml
Sample:
<OGAAmendDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.DTO"> <Allowance>sample string 3</Allowance> <CreatedDate>2026-06-13T05:16:11.83972+06:30</CreatedDate> <OfficeLetterNo>sample string 2</OfficeLetterNo> <RecommendationPdfUrl>sample string 5</RecommendationPdfUrl> <ReferenceNo>sample string 1</ReferenceNo> <Terminate>true</Terminate> <UsedOnce>true</UsedOnce> <ValidDateFrom>2026-06-13T05:16:11.83972+06:30</ValidDateFrom> <ValidDateTo>2026-06-13T05:16:11.83972+06:30</ValidDateTo> </OGAAmendDTO>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
ResponseMessage| Name | Description | 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>