If you have a comment on this topic, contact Aptify Documentation. If you want to return to the Aptify Community Site, please click here.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Work On Progress...

Endpoint

SaveData end point allows you to create, update or save a single record in Aptify .The POST action is used for the data modification operations. 

 

Headers

In order to save and receive entity record, the AptifyAuthorization header is required along with <TokenId> genrated after Authentication.

 

Header NameHeader Value
AptifyAuthorization<Authentication Provider> <TokenId>

 

SaveData EndPoint  For Non-Subtype Record

https://<base address>/services/BasicGenericEntity/SaveData/{id}

 

Request Body (POST, as Form Data)

 {
  ID: -1,
  EntityName: "Groups",
  Name: "Data Savers" 
}

Data returned has a valid ID value, indicating that you successfully saved a new group.Note the ID of the group you created.In this case ID is 1038.

Sample Response Body

{  
	 "ID": 1038,
  	 "EntityName": "Groups",
	 "Name": "Data Savers",
	 "Description": "",
  	 "Subtypes": [ ]
} 

 

Save Data Endpoint For Single Subtype Record 

https://<base address>/services/BasicGenericEntity/SaveData/{id}

Request Body (POST, as Form Data)

  {
  	ID: <Group ID>,
	EntityName: "Groups",
	SubTypes: 
	[ {
		ID: -1, 
		EntityName: "GroupMembers", 
		UserID: <User ID>
	} ] 
}

Sample Response Body

{  
	"id": <Group ID>,
	"entityname": "Groups",
	"name": "Data Savers",
	"description": "",
	"subtypes": [{ 
	"id": <ID>,
	"entityname": "GroupMembers",
	"groupid": <Group ID>,
	"sequence": 1,
	"userid": <User ID>,
	"userid_name": <User ID Name>,
	"aptify_record_version": "system.byte[]"
	]}
}



 

Request Body For Multiple Records

 

  {
	  ID: <Group ID>,
	  EntityName: "Groups",
	  SubTypes: [
	{
		ID: -1,
		EntityName: "GroupMembers", 
		UserID: <User ID 1> 
	}, 
	{
		ID: -1,
		EntityName: "GroupMembers",
		UserID: <User ID 2> 
	}
] }

 

Sample Response Body  Multiple Records

{   
	"id": <Group ID>,
	"entityname": "groups",
	"name": "data savers",
	"description": "",
	"subtypes": [{ 
	"id": <ID>,
	"entityname": "GroupMembers",
	"groupid":  <Group ID>,
	"sequence": 1,
	"userid": <User ID 1>,
	"userid_name": <User ID1 Name>,
	"aptify_record_version": "system.byte[]"
},
{   
	"id": <ID>,
	"entityname": "GroupMembers",
	"groupid":  <Group ID>,
	"sequence": 2,
	"userid": <User ID 2>,
	"userid_name": <User ID2 Name>,
	"aptify_record_version": "system.byte[]"	
}]

} 

 

 

  • No labels