The following REST Account API methods are available:
Access to the API is made to "<serverURL>/REST/api/Customer/<method name>
Method |
Method Name |
Description |
|---|---|---|
POST /AccountSignUp |
The AccountSignUp method allows you to create an account with the same result as when a user signs up using the built-in sign-up app. This may be used in conjunction with the ability to use a custom sign-up page. |
|
POST /CreateUser |
The CreateUser method allows you to create users. |
|
POST /DeleteAppInstance |
The DeleteAppInstance method allows you to delete an app instance. |
|
POST /GetAsset |
The GetAsset method allows you to retrieve attached files. It will return the asset's contents. |
|
POST /GetAppData |
The GetAppData method exports the app instance data in CSV/XML. |
|
POST /GetAppInstanceData |
The GetAppInstanceData method returns a single app instance’s content in XML format. |
|
POST /GetAppInstanceMetaData |
The GetAppInstanceMetaData method returns an app instance's meta data. |
|
POST /GetAppInstanceMetaData2 |
The GetAppInstanceMetaData method returns an app instance's meta data and GUID |
|
POST /GetAppInstancePDF |
The GetAppInstancePDF method retrieves an app’s instance PDF in a Base64binary format, ready to be written to file. |
|
POST /GetListOfAppInstances |
The GetListOfAppInstances method retrieves a list of an app’s instances. |
|
POST /GetListOfUsers |
The GetListOfUsers method allows you to retrieve the list of users. |
|
POST /GetUserDetails |
The GetUserDetails method allows you to retrieve the details about a user. |
|
POST /Login |
The Login method logs the API into the system using a security token. |
|
POST /Notify |
The Notify method allows you to send notifications. |
|
POST /PutAsset |
The PutAsset method allows you to attach files. It will return the attachment ID of the file and populates the Asset ID property of a File Attachment object on an app. |
|
POST /SetStage |
The SetStage method allows you to set the stage of a specific instance. |
|
POST /UpdateUserDetails |
The UpdateUserDetails method allows you to modify the details of a user. |
Return to: PerfectApps API, Integration
