Get Organizations By Id
GET/organizations/:id
This operation allows to get an Organization by id
Request
Path Parameters
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
Responses
- 200
- 401
- 403
- 404
- 500
ok
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
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
organization name
customer id
customer address
organization type
installedOfferList
object[]
list of installed offer associated to an organization
Possible values: Value must match regular expression \S
installed offer code
Possible values: Value must match regular expression \S
installed offer name
sales contact name
sales contact email
tan id
contract id
sales channel
list of ban ids associated to an organization
list of linked customer ids associated to an organization
{
"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"
]
}
unauthorized access
- application/json
- Schema
- Example (from schema)
Schema
error code
error message
error description
{
"code": 0,
"message": "string",
"description": "string"
}
forbidden access
- application/json
- Schema
- Example (from schema)
Schema
error code
error message
error description
{
"code": 0,
"message": "string",
"description": "string"
}
not found
- application/json
- Schema
- Example (from schema)
Schema
error code
error message
error description
{
"code": 0,
"message": "string",
"description": "string"
}
internal error
- application/json
- Schema
- Example (from schema)
Schema
error code
error message
error description
{
"code": 0,
"message": "string",
"description": "string"
}