Register   |  Login             

SCP API DETAILS

Application


put : /application/changeStatus/{userId}/{appId}

put

Description

Change status of an application

Response Model
                            {
   errorCode (integer): Error code,
   errorDesc (string): Error description
}
                        
Parameters
Parameter Description Parameter Type Data Type
appId Id of the application path Long
userId User id path Long
status Application Status query Byte
post : /application/createApp/{userId}

post

Description

Create an application

Response Model
                            {
   id (long): Id of application,
   errorCode (integer): Error code,
   errorDesc (string): Error description
}
                        
Parameters
Parameter Description Parameter Type Data Type
userId User id path Long
application Objects applications. Json format. body
                                                {
	name (string): The name of the application,
	apppath (string): The path,
	version (string): This version of the app,
	fileupload (string): File upload,
	userid (long): Id of the account,
	categoryid (long): Id of the type of application,
	appcode (string): The application code,
	status (byte): Status Application (1: indevelopment, 2: waiting for approve, 3: production),
	description (string): Description,
	apptype (byte): Type of Application (1: Hosted, 2: External),
	devices (long): [,,] System deviceIds
}
                                            
delete : /application/deleteApp/{userId}/{appId}

delete

Description

Delete an application by Id

Response Model
                            {
   errorCode (integer): Error code,
   errorDesc (string): Error description
}
                        
Parameters
Parameter Description Parameter Type Data Type
appId Id of the application path Long
userId User id path Long
get : /application/getAppCategoryDetail/{userId}/{appCateId}

get

Description

Get information application and devices

Response Model
                            {
    errorCode (integer): Error code,
	errorDesc (string): Error description,
	id (long): Application id,
	name (string): Application name,
	description (string): Application description
}
                        
Parameters
Parameter Description Parameter Type Data Type
appCateId Application category id path Long
userId User id path Long
get : /application/getAppDetail/{userId}/{appId}

get

Description

Get information of an application

Response Model
                            {
	errorCode (integer): Error code,
	errorDesc (string): Error description,
	id (long): Id applications,
	name (string): The name of the application,
	apppath (string): The path,
	version (string): This version of the app,
	fileupload (string): File upload,
	userid (long): Id of the account,
	categoryid (long): Id of the type of application,
	appcode (string): the application code,
	status (byte): Status application,
	description (string): Description,
	lastmodifydate (string): Date edited,
	apptype (byte): Type of Application (1: Hosted, 2: External),
	devices (long): [,,] System deviceIds,
	apiKey (string): Api key,
	email (string): Email user
}
                        
Parameters
Parameter Description Parameter Type Data Type
appId Id of the application path Long
userId User id path Long
get : /application/getAppDetailByApiKey

get

Description

Get information application by API_KEY

Response Model
                            {
    errorCode (integer): Error code,
	errorDesc (string): Error description,
	id (long): Application id,
	name (string): Application name,
	apppath (string): Application path,
	version (string): Application version,
	fileupload (string): Information file uploaded of application,
	userid (long): User id,
	categoryid (long): Category id,
	appcode (string): Application code,
	status (byte): Status application,
	description (string): Application description,
	lastmodifydate (string): Last modify date,
	apptype (byte): Type of application,
	apiKey (string): API_KEY,
    devicesLastMeasure: [
		{
			deviceId (long): System deviceId,
			deviceIdExternal (string): DeviceId,
			deviceName (string): Device name,
			deviceType (long): Device type
		}
	}
}
                        
Parameters
Parameter Description Parameter Type Data Type
get : /application/getAppList/{userId}

get

Description

Get the application list

Response Model
                            {
    total (integer): Total,
    errorCode (integer): Error code,
	errorDesc (string): Error description,
    appList: [
		{
			id (long): Id of application,
			name (string): The name of application,
			status (byte): Status application,
			category (string): The type of application,
			lastmodifydate (string): Date edited,
			appPath (string): Application Path,
			email (string): Email user,
			appType (byte): Type of application
		}
    ]
}
                        
Parameters
Parameter Description Parameter Type Data Type
userId User id path Long
categoryId Id of the type of application query Long
fromDate From date (dd-MM-yyyy) query String
name The name kind of application query String
start Records began query Integer
status Application Status query Byte
toDate To date (dd-MM-yyyy) query String
total Get the number of records query Integer
get : /application/getCategoryByApp/{userId}

get

Description

Get category by application

Response Model
                            {
    total (integer): Total,
    errorCode (integer): Error code,
	errorDesc (string): Error description,
    appList: [
	{
		id (long): Id type of application,
		name (string): The name of the application type,
		description (string): Describe the type of application
	}
  ]
}
                        
Parameters
Parameter Description Parameter Type Data Type
userId User id path Long
appId Id of the application query Long
get : /application/getCategoryList/{userId}

get

Description

Get category list

Response Model
                            {
    total (integer): Total,
    errorCode (integer): Error code,
	errorDesc (string): Error description,
    appList: [
		{
			id (long): Id type of application,
			name (string): The name of the application type,
			description (string): Describe the type of application
		}
  	]
}
                        
Parameters
Parameter Description Parameter Type Data Type
userId User id path Long
put : /application/reBuildApiKey/{userId}/{appId}

put

Description

Rebuild apiKey

Response Model
                            {
   errorCode (integer): Error code,
   errorDesc (string): Error description
}
                        
Parameters
Parameter Description Parameter Type Data Type
appId Application id path Long
userId User id path Long
put : /application/updateApp/{userId}

put

Description

Update an application

Response Model
                            {
   errorCode (integer): Error code,
   errorDesc (string): Error description
}
                        
Parameters
Parameter Description Parameter Type Data Type
userId User id path Long
application Communication an application object. Json format. body
                                                {
	id (long): Id of application,
	name (string): The name of application,
	apppath (string): The path,
	version (string): This version of application,
	fileupload (string): File upload,
	userid (long): Id of the account,
	categoryid (long): Id of the type of application,
	status (byte): Status application,
	description (string): Description,
	apptype (byte): Type of Application (1: Hosted, 2: External),
	devices (long): [,,] Id system devices
}
                                            
Contact Information

Vietnam Post and Telecommunication Industry Technology (VNPT Technology)

Tel
Fax
Address
(+84) 4 3748 0922
(+84) 4 3748 0925
No. 124 Hoang Quoc Viet Street, Nghia Tan Ward, Cau Giay District, Hanoi
Introduction

•      VNPT Technology Introduction
•      SCP Introduction

Partners

•      Introduction
•      Certification process

Developers

•      SCP Discovery
•      APIs
•      Guideline Documents
•      Libraries

Legal

•      Terms of use
•      Privacy Policy
•      License Agreement

Copyright © 2017 VNPT Technology. All rights reserved.