Organizations
GET Organizations#
Get all user organization.
| GET ALL | |
|---|---|
| Method | GET ALL |
| URL or EndPoint | /api/v{version}/organizations |
| Headers | Authorization |
| Parameters | organizations, version |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| Version | Yes | string($uuid) | v1 | Shows the version of API |
Request Body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "string" } ], "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}
| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | ||
| id | string | "string" | |
| name | string | "string" | |
| resultInfo | array [object] | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
POST Organization#
Add new organization to the store.
| POST | |
|---|---|
| Method | POST |
| URL or EndPoint | /api/v{version}/organizations |
| Headers | Authorization |
| Parameters | projectId, distributionId, version |
| Body | { name, addressLine1, addressLine2, country, state, city, vatNumber } |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| Version | Yes | string($uuid) | v1 | Shows the version of API |
Request body#
{ "name": "string", "addressLine1": "string", "addressLine2": "string", "country": "string", "state": "string", "city": "string", "vatNumber": "string", "voucher": "string"}The description of the parameters is as follows:
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| name | Yes | string | "string" | |
| addressLine1 | Yes | string | "string" | |
| addressLine2 | Yes | string | "string" | |
| country | No | string | "string" | |
| state | Yes | string | "string" | |
| city | Yes | string | "string" | |
| vatNumber | Yes | string | "string" | |
| voucher | Yes | string | "string" |
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "string", "addressLine1": "string", "addressLine2": "string", "country": "string", "state": "string", "city": "string", "vatNumber": "string" }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | ||
| id | string | "string" | |
| name | string | "string" | |
| addressLine1 | string | "string" | |
| addressLine2 | string | "string" | |
| country | string | "string" | |
| state | string | "string" | |
| city | string | "string" | |
| vatNumber | string | "string" | |
| resultInfo | array [object] | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
GET Organization#
Get a specific organization by id
| GET | |
|---|---|
| Method | GET By Id |
| URL or EndPoint | /api/v{version}/organizations/{organizationId} |
| Headers | Authorization |
| Parameters | organizationId, organizations, version |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {organizationId} | Yes | string | v1 | The identifier for the organization |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| Version | Yes | string | v1 | Shows the version of API |
| organizationId | Yes | string($uuid) | 1 | The identifier for the organization |
Request Body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "string", "addressLine1": "string", "addressLine2": "string", "country": "string", "state": "string", "city": "string", "vatNumber": "string" }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}
| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | ||
| id | string | "string" | |
| name | string | "string" | |
| addressLine1 | string | "string" | |
| addressLine2 | string | "string" | |
| country | string | "string" | |
| state | string | "string" | |
| city | string | "string" | |
| vatNumber | string | "string" | |
| resultInfo | array [object] | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
PUT Organization#
Updates an organization in the store with form data.
| PUT | |
|---|---|
| Method | PUT |
| URL or EndPoint | /api/v{version}/organizations/{organizationId} |
| Headers | Authorization |
| Parameters | organizationId, organizations, version |
| Body | { name, addressLine1, addressLine2, country, state, city, vatNumber } |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {organizationId} | Yes | string | v1 | The identifier for the organization |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| Version | Yes | string | v1 | Shows the version of API |
| organizationId | Yes | string($uuid) | 1 | The identifier for the organization |
Request body#
{ "name": "string", "addressLine1": "string", "addressLine2": "string", "country": "string", "state": "string", "city": "string", "vatNumber": "string", "voucher": "string"}The description of the parameters is as follows:
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| name | Yes | string | "string" | |
| addressLine1 | Yes | string | "string" | |
| addressLine2 | Yes | string | "string" | |
| country | No | string | "string" | |
| state | Yes | string | "string" | |
| city | Yes | string | "string" | |
| vatNumber | Yes | string | "string" | |
| voucher | Yes | string | "string" |
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "string", "addressLine1": "string", "addressLine2": "string", "country": "string", "state": "string", "city": "string", "vatNumber": "string" }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | ||
| id | string | "string" | |
| name | string | "string" | |
| addressLine1 | string | "string" | |
| addressLine2 | string | "string" | |
| country | string | "string" | |
| state | string | "string" | |
| city | string | "string" | |
| vatNumber | string | "string" | |
| resultInfo | array [object] | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
DELETE Organization#
Deletes an organization.
| DELETE | |
|---|---|
| Method | DELETE |
| URL or EndPoint | /api/v{version}/organizations/{organizationId} |
| Headers | Authorization |
| Parameters | organizationId, organizations, version |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {organizationId} | Yes | string | v1 | The identifier for the organization |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| Version | Yes | string | v1 | Shows the version of API |
| organizationId | Yes | string($uuid) | 1 | The identifier for the organization |
Request Body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "string", "addressLine1": "string", "addressLine2": "string", "country": "string", "state": "string", "city": "string", "vatNumber": "string" }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | ||
| id | string | "string" | |
| name | string | "string" | |
| addressLine1 | string | "string" | |
| addressLine2 | string | "string" | |
| country | string | "string" | |
| state | string | "string" | |
| city | string | "string" | |
| vatNumber | string | "string" | |
| resultInfo | array [object] | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found