POST api/V3/Outlet/BlockUnblockOutlets

Api to block Outlet from the GUID

Request Information

URI Parameters

None.

Body Parameters

The outlet to be blocked/Unblocked

Collection of V3.GuidBlockModel
NameDescriptionTypeAdditional information
OutletGuid

Guid of the outlet to activated/Deactivated

 string

None.
IsBlocked

Should it be blocked?

 boolean

None.

Request Formats

application/json, text/json

Sample: 
[
  {
    "OutletGuid": "sample string 1",
    "IsBlocked": true
  },
  {
    "OutletGuid": "sample string 1",
    "IsBlocked": true
  }
]

application/xml, text/xml

Sample: 
<ArrayOfGuidBlockModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.V3.Models">
  <GuidBlockModel>
    <IsBlocked>true</IsBlocked>
    <OutletGuid>sample string 1</OutletGuid>
  </GuidBlockModel>
  <GuidBlockModel>
    <IsBlocked>true</IsBlocked>
    <OutletGuid>sample string 1</OutletGuid>
  </GuidBlockModel>
</ArrayOfGuidBlockModel>

Response Information

Resource Description

ApiResponseMessage
NameDescriptionTypeAdditional information
ERPId

ERPID of the Requested insertion/updation

 string

None.
Message

Error Message for the indicated ERPID

 string

None.
ResponseStatus

Status of the action requested from Api

 ResponseStatus

None.
GUID

GUID of the database Entry with respect to the ERP Id Provided

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "ERPId": "sample string 1",
  "Message": "sample string 2",
  "ResponseStatus": "Failure",
  "GUID": "sample string 3"
}

application/xml, text/xml

Sample: 
<ApiResponseMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.Models.Common">
  <ERPId>sample string 1</ERPId>
  <GUID>sample string 3</GUID>
  <Message>sample string 2</Message>
  <ResponseStatus>Failure</ResponseStatus>
</ApiResponseMessage>