POST api/business/create?trackingId={trackingId}

Create Business

Request Information

URI Parameters

NameDescriptionTypeAdditional information
trackingId

An ID supplied by the client to track or name this request

string

Required

Body Parameters

Required Business Details

Business
NameDescriptionTypeAdditional information
BuildingKey

BuildingKey for Business

integer

None.

Address

Address of Business

Address

None.

BusinessName

Name of Business

string

None.

Phone

Phone number for business

string

None.

Request Formats

application/json, text/json

Sample:
{
  "buildingKey": 1,
  "address": {
    "addressLine1": "sample string 1",
    "aptSuiteOther": "sample string 2",
    "city": "sample string 3",
    "state": "Item",
    "zipCode": "sample string 4"
  },
  "businessName": "sample string 2",
  "phone": "sample string 3"
}

application/xml, text/xml

Sample:
<Business xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Twc.Models">
  <Address>
    <AddressLine1>sample string 1</AddressLine1>
    <AptSuiteOther>sample string 2</AptSuiteOther>
    <City>sample string 3</City>
    <State>Item</State>
    <ZipCode>sample string 4</ZipCode>
  </Address>
  <BuildingKey>1</BuildingKey>
  <BusinessName>sample string 2</BusinessName>
  <Phone>sample string 3</Phone>
</Business>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

New Midas Business Key

CreateBusinessResponse
NameDescriptionTypeAdditional information
TrackingID

string

None.

BusinessKey

integer

None.

ServiceReturnStatus

ServiceReturnStatus

None.

Response Formats

application/json, text/json

Sample:
{
  "trackingID": "sample string 1",
  "businessKey": 2,
  "serviceReturnStatus": {
    "returnCode": 1,
    "returnMessage": "sample string 2",
    "responseTypeCode": 3,
    "responseTypeCodeSpecified": true,
    "responseTypeMessage": "sample string 5",
    "currentPeriodRequestsUsed": 6,
    "currentPeriodRequestsAvailable": 7
  }
}

application/xml, text/xml

Sample:
<CreateBusinessResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Twc.MidasWebServices">
  <BusinessKey>2</BusinessKey>
  <ServiceReturnStatus>
    <currentPeriodRequestsAvailableField>7</currentPeriodRequestsAvailableField>
    <currentPeriodRequestsUsedField>6</currentPeriodRequestsUsedField>
    <responseTypeCodeField>3</responseTypeCodeField>
    <responseTypeCodeFieldSpecified>true</responseTypeCodeFieldSpecified>
    <responseTypeMessageField>sample string 5</responseTypeMessageField>
    <returnCodeField>1</returnCodeField>
    <returnMessageField>sample string 2</returnMessageField>
  </ServiceReturnStatus>
  <TrackingID>sample string 1</TrackingID>
</CreateBusinessResponse>