Skip to main content
Version: V4.0

Register Service API


Register Family Admin

Request URL

POST /api/v1.0/invoke/open-ability/method/general-commands

Request Parameter

Parameter NameTypeLocationRequiredDescription
Content-TypeStringHeaderYesContent type, the value is application/json
AcceptStringHeaderYesAccept, the value is application/json
AuthorizationStringHeaderYesBearer authorization, access token
commandStringBodyYesCommand name
idStringBodyYesCommand ID
paramObject<param>BodyYesCommand parameter

param description

Parameter NameTypeLocationRequiredDescription
first_nameStringBodyYesFirst name
last_nameStringBodyYesLast name
emailStringBodyYesEmail
passwordStringBodyYesPassword
residence_idStringBodyYesResidence ID

Return Parameter

Parameter NameTypeLocationDescription
Content-TypeStringHeaderContent type, the value is application/json
successBooleanBodyWhether the request is successful or not?
true: success
false: failure
timestampIntegerBodyTimestamp
resultObjectBodyReturn result

Request Example

POST /api/v1.0/invoke/open-ability/method/general-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "register_family_admin",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"last_name": "tom",
"password": "12345678Aaa",
"residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
"first_name": "fly",
"email": "demo@akubela.com"
}
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
"success": true,
"timestamp": 1540869200562,
"result": {}
}

Failure Return Example

See Failure Return Example