POST v1/company

Creates a company based on a MaaS Org Model and returns the created company structure.

Request Information

URI Parameters

None.

Body Parameters

Initial data used to create the company, and associate the newly created company to a MaaS Org.

MaaSOrg
NameDescriptionTypeAdditional information
orgId

Required parameter, the org id is required in order to create a new company.

 integer

None.
environment

Environment is an optional parameter upon company creation, this parameter will default to the word "Production" if not supplied, is empty or spaces only.

 string

None.
name

Name of the organization.

 string

None.
bucket

Optional Amazon S3 Bucket Name. This is very important for App Framework Applications.

 string

None.
filePrefix

Optional Proffered filename prefix.

 string

None.
accessKey

Optional Amazon bucket Access Key.

 string

None.
secretKey

Optional Amazon bucket Secret Key.

 string

None.
address1

Optional organization address line one.

 string

None.
address2

Optional organization address line 2

 string

None.
country

Optional organization address country.

 string

None.
city

Optional organization address city.

 string

None.
zip

Optional organization address zip code.

 string

None.
website

Optional organization website. (Will be used by future MDU Implementations)

 string

None.
supportNumber

Optional organization phone support number. This is used in emails, mass communications and other customer engagements.

 string

None.
supportEmail

Optional organization support email. This is used in emails and other customer engagements.

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "orgId": 1,
  "environment": "sample string 2",
  "name": "sample string 3",
  "bucket": "sample string 4",
  "filePrefix": "sample string 5",
  "accessKey": "sample string 6",
  "secretKey": "sample string 7",
  "address1": "sample string 8",
  "address2": "sample string 9",
  "country": "sample string 10",
  "city": "sample string 11",
  "zip": "sample string 12",
  "website": "sample string 13",
  "supportNumber": "sample string 14",
  "supportEmail": "sample string 15"
}

Response Information

Resource Description

Returns a company model that represents the newly created company. If an exception is thrown, the a message and its corresponding error HTTP status code will be returned.

CompanyModel
NameDescriptionTypeAdditional information
name

Company (Org) Name.

 string

None.
address

Company / Org Address (Line 1)

 string

None.
addressLine2

Company / Org Address (Line 2)

 string

None.
city

Company City

 string

None.
state

Company State

 string

None.
country

Company Country

 string

None.
zip

Company Zip Code

 string

None.
url

Company Website

 string

None.
phone

Company Phone number used for support purposes.

 string

None.
email

Company email address used for support purposes.

 string

None.
id

Entity unique identifier.

 UUID

None.
type

Type of entity this abstract class represents.

 EntityLinkType

None.
parent

Parent entity, i.e. if this was a property (Venue), the company that the property belongs to.

 Entity

None.

Response Formats

application/json, text/json

Sample: 
{
  "name": "sample string 1",
  "address": "sample string 3",
  "addressLine2": "sample string 4",
  "city": "sample string 5",
  "state": "sample string 6",
  "country": "sample string 7",
  "zip": "sample string 8",
  "url": "sample string 9",
  "phone": "sample string 10",
  "email": "sample string 11",
  "type": 1,
  "parent": {
    "type": 1
  }
}