API to Place an order for internal and external vendors to NCC

post

https://gateway-nonprod.optuminsightplatform.com/odxcloudapigatewaypreprod/ncc/om/v1/client-orders

To place a new order to NCC, please use /v1/client-orders API. This API would need to have the pre-defined order components from the pre-requisite set up and the uploaded roster file to the defined ECG location.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

ClientOrderRequest: Request object for the client-orders api, please see schema for details

vendorType

string

required

Type of the vendor for which the order is placed. It can be either external or internal and should not have any other value.

tenantId

int64

required

NCC tenant ID for which the order is to be placed.

clientOrgId

int64

required

NCC Client org ID for which the order is to be placed.

campaignId

int64

required

Campaign ID to place order. Either one of campaignId or campaignName is required. If both are present, then preference will be given to campaign ID.

campaignName

string

Campaign name to place order. Either one of campaignId or campaignName is required. If both are present, then preference will be given to campaign ID.

requestingPartyId

int64

required

Requesting party ID to place order. Either one of requestingPartyId or requestingPartyName is required. If both are present, then preference will be given to requestingPartyId.

requestingPartyName

string

Requesting party name to place order. Either one of requestingPartyId or requestingPartyName is required. If both are present, then preference will be given to requestingPartyId.

rosterFilePath

string

required

The file path of ABS where the roster file is present. Roster file should be available at this location before placing the request.

clientOrderName

string

required

Unique name of the client order to be created.

serviceStartDate

date

required

Service start date.

serviceEndDate

date

required

Service end date.

vendors

array of objects

required

vendors*

Responses

200Place Client Order Success Response

400Bad Request. Some issue in the properties supplied to the API. For example Invalid vendor details, special chars in client order name, invalid vendor type, roster file not present in ABS etc.

401User is unauthorized to access Place client order API

500Application failed to place order in NCC, internal server error occurred