-
Notifications
You must be signed in to change notification settings - Fork 96
Common
nanda-kshr edited this page Jan 4, 2026
·
1 revision
Base path: /api/common/
- Brief: Retrieval/list endpoint.
- Request body example (JSON):
{
"field1": "value1",
"field2": "value2"
}- Response example (success):
{
"hasError": false,
"statusCode": 200,
"message": {
"general": [
"Success"
]
},
"response": {
"data": "..."
}
}- Brief: Resource-specific endpoint (path param).
- Path params:
str:circle_id
- Request body example (JSON):
{
"circle_id": "<str:circle_id>",
"field1": "value1",
"field2": "value2"
}- Response example (success):
{
"hasError": false,
"statusCode": 200,
"message": {
"general": [
"Success"
]
},
"response": {
"data": "..."
}
}- Brief: Collection endpoint.
- Request body example (JSON):
{
"field1": "value1",
"field2": "value2"
}- Response example (success):
{
"hasError": false,
"statusCode": 200,
"message": {
"general": [
"Success"
]
},
"response": {
"data": "..."
}
}- Brief: Collection endpoint.
- Request body example (JSON):
{
"field1": "value1",
"field2": "value2"
}- Response example (success):
{
"hasError": false,
"statusCode": 200,
"message": {
"general": [
"Success"
]
},
"response": {
"data": "..."
}
}- Brief: Collection endpoint.
- Request body example (JSON):
{
"field1": "value1",
"field2": "value2"
}- Response example (success):
{
"hasError": false,
"statusCode": 200,
"message": {
"general": [
"Success"
]
},
"response": {
"data": "..."
}
}- Brief: Collection endpoint.
- Request body example (JSON):
{
"field1": "value1",
"field2": "value2"
}- Response example (success):
{
"hasError": false,
"statusCode": 200,
"message": {
"general": [
"Success"
]
},
"response": {
"data": "..."
}
}- Brief: Collection endpoint.
- Request body example (JSON):
{
"field1": "value1",
"field2": "value2"
}- Response example (success):
{
"hasError": false,
"statusCode": 200,
"message": {
"general": [
"Success"
]
},
"response": {
"data": "..."
}
}- Brief: Collection endpoint.
- Request body example (JSON):
{
"field1": "value1",
"field2": "value2"
}- Response example (success):
{
"hasError": false,
"statusCode": 200,
"message": {
"general": [
"Success"
]
},
"response": {
"data": "..."
}
}- Brief: Collection endpoint.
- Request body example (JSON):
{
"field1": "value1",
"field2": "value2"
}- Response example (success):
{
"hasError": false,
"statusCode": 200,
"message": {
"general": [
"Success"
]
},
"response": {
"data": "..."
}
}- Brief: Collection endpoint.
- Request body example (JSON):
{
"field1": "value1",
"field2": "value2"
}- Response example (success):
{
"hasError": false,
"statusCode": 200,
"message": {
"general": [
"Success"
]
},
"response": {
"data": "..."
}
}- Brief: Collection endpoint.
- Request body example (JSON):
{
"field1": "value1",
"field2": "value2"
}- Response example (success):
{
"hasError": false,
"statusCode": 200,
"message": {
"general": [
"Success"
]
},
"response": {
"data": "..."
}
}- Brief: Resource-specific endpoint (path param).
- Path params:
str:muid
- Request body example (JSON):
{
"muid": "<str:muid>",
"field1": "value1",
"field2": "value2"
}- Response example (success):
{
"hasError": false,
"statusCode": 200,
"message": {
"general": [
"Success"
]
},
"response": {
"data": "..."
}
}- Brief: Retrieval/list endpoint.
- Request body example (JSON):
{
"field1": "value1",
"field2": "value2"
}- Response example (success):
{
"hasError": false,
"statusCode": 200,
"message": {
"general": [
"Success"
]
},
"response": {
"data": "..."
}
}- Brief: Retrieval/list endpoint.
- Request body example (JSON):
{
"field1": "value1",
"field2": "value2"
}- Response example (success):
{
"hasError": false,
"statusCode": 200,
"message": {
"general": [
"Success"
]
},
"response": {
"data": "..."
}
}- Brief: Retrieval/list endpoint.
- Request body example (JSON):
{
"field1": "value1",
"field2": "value2"
}- Response example (success):
{
"hasError": false,
"statusCode": 200,
"message": {
"general": [
"Success"
]
},
"response": {
"data": "..."
}
}- Brief: Collection endpoint.
- Request body example (JSON):
{
"field1": "value1",
"field2": "value2"
}- Response example (success):
{
"hasError": false,
"statusCode": 200,
"message": {
"general": [
"Success"
]
},
"response": {
"data": "..."
}
}- Brief: Retrieval/list endpoint.
- Request body example (JSON):
{
"field1": "value1",
"field2": "value2"
}- Response example (success):
{
"hasError": false,
"statusCode": 200,
"message": {
"general": [
"Success"
]
},
"response": {
"data": "..."
}
}- Brief: Retrieval/list endpoint.
- Request body example (JSON):
{
"field1": "value1",
"field2": "value2"
}- Response example (success):
{
"hasError": false,
"statusCode": 200,
"message": {
"general": [
"Success"
]
},
"response": {
"data": "..."
}
}- Brief: Retrieval/list endpoint.
- Request body example (JSON):
{
"field1": "value1",
"field2": "value2"
}- Response example (success):
{
"hasError": false,
"statusCode": 200,
"message": {
"general": [
"Success"
]
},
"response": {
"data": "..."
}
}- Brief: Retrieval/list endpoint.
- Request body example (JSON):
{
"field1": "value1",
"field2": "value2"
}- Response example (success):
{
"hasError": false,
"statusCode": 200,
"message": {
"general": [
"Success"
]
},
"response": {
"data": "..."
}
}