POST v1/Engage/createCompany

Creates a code

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
CompanyName	Name of Company	string	Required Max length: 50 Min length: 1
CompanyCode	CompanyCode	string	Max length: 50 Min length: 1
ExternalAddress	External Address	string	Max length: 128 Min length: 1
Email	Email	string	Required Max length: 256 Min length: 1
PosConfiguration	POS Configuration	SitePOSConfiguration	None.
NepOrganizationId	NEP Organization Id	string	Max length: 256 Min length: 1
EngageAppId	EngageAppId	string	Required

Request Formats

application/json, text/json

Sample:

{
  "CompanyName": "sample string 1",
  "CompanyCode": "sample string 2",
  "ExternalAddress": "sample string 3",
  "Email": "sample string 4",
  "PosConfiguration": 0,
  "NepOrganizationId": "sample string 5",
  "EngageAppId": "sample string 6"
}

application/xml, text/xml

Sample:

<InEngageEnrollment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Admin.Inbound">
  <CompanyCode>sample string 2</CompanyCode>
  <CompanyName>sample string 1</CompanyName>
  <Email>sample string 4</Email>
  <EngageAppId>sample string 6</EngageAppId>
  <ExternalAddress>sample string 3</ExternalAddress>
  <NepOrganizationId>sample string 5</NepOrganizationId>
  <PosConfiguration>Unknown</PosConfiguration>
</InEngageEnrollment>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AdminEngageCreateCompanyResponse

Name	Type	Additional information
CompanyCode	string	None.
Message	string	None.
IsSuccessful	boolean	None.
ErrorCode	integer	None.
WarningMessage	string	None.

Response Formats

application/json, text/json

Sample:

{
  "CompanyCode": "sample string 1",
  "Message": "sample string 2",
  "IsSuccessful": true,
  "ErrorCode": 4,
  "WarningMessage": "sample string 5"
}

application/xml, text/xml

Sample:

<AdminEngageCreateCompanyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Radiant.Order.Shared.Contracts.ServiceEntities">
  <ErrorCode>4</ErrorCode>
  <IsSuccessful>true</IsSuccessful>
  <Message>sample string 2</Message>
  <WarningMessage>sample string 5</WarningMessage>
  <CompanyCode>sample string 1</CompanyCode>
</AdminEngageCreateCompanyResponse>