Create Organization

POST 
/organizations

This operation allows to create an Organization

Request

application/json

Body

organization to create

name stringrequired

Possible values: Value must match regular expression \S

organization name

customerId stringrequired

Possible values: Value must match regular expression \S

customer id

customerAddress stringrequired

Possible values: Value must match regular expression \S

customer address

type stringrequired

Possible values: Value must match regular expression \S

organization type

installedOfferList

object[]

required

Possible values: >= 1, <= 1

list of installed offer associated to an organization

Array [

code stringrequired

Possible values: Value must match regular expression \S

installed offer code

name stringrequired

Possible values: Value must match regular expression \S

installed offer name

]

salesContactName stringrequired

Possible values: Value must match regular expression \S

sales contact name

salesContactEmail stringrequired

Possible values: Value must match regular expression \S

sales contact email

tanid int32

tan id

contractid int32required

contract id

saleschannel stringrequired

Possible values: Value must match regular expression \S

sales channel

banIds int32[]

Possible values: >= 1

list of ban ids associated to an organization

linkedCustomerIds string[]

list of linked customer ids associated to an organization

Responses

201

created

application/json

Schema

Schema

id uuid

Possible values: Value must match regular expression [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

organization id

name string

organization name

customerId string

customer id

customerAddress string

customer address

type string

organization type

installedOfferList

object[]

list of installed offer associated to an organization

Array [

code stringrequired

Possible values: Value must match regular expression \S

installed offer code

name stringrequired

Possible values: Value must match regular expression \S

installed offer name

]

salesContactName string

sales contact name

salesContactEmail string

sales contact email

tanid int32

tan id

contractid int32

contract id

saleschannel string

sales channel

banIds int32[]

list of ban ids associated to an organization

linkedCustomerIds string[]

list of linked customer ids associated to an organization

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "customerId": "string",
  "customerAddress": "string",
  "type": "string",
  "installedOfferList": [
    {
      "code": "string",
      "name": "string"
    }
  ],
  "salesContactName": "string",
  "salesContactEmail": "string",
  "tanid": 0,
  "contractid": 0,
  "saleschannel": "string",
  "banIds": [
    0
  ],
  "linkedCustomerIds": [
    "string"
  ]
}

400

bad request

application/json

Schema

Schema

code int32

bad request code

message string

bad request message

status int32

bad request status

title string

bad request title

violations

object[]

bad request violations

Array [

field string

violated field name

message string

error message

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "status": 0,
  "title": "string",
  "violations": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

401

unauthorized access

application/json

Schema

Schema

code int32

error code

message string

error message

description string

error description

Example (from schema)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

403

forbidden access

application/json

Schema

Schema

code int32

error code

message string

error message

description string

error description

Example (from schema)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

500

internal error

application/json

Schema

Schema

code int32

error code

message string

error message

description string

error description

Example (from schema)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

Loading...