Common to all calls
- Michael Dominique Aguillon
Authentication (POST)
User must need to generate a token that will be used by every callout for retrieving records. (expires after a while)
URL Format: {salesforce org domain)/services/oauth2/token
e.g. https://al1687300701641.my.salesforce.com/services/oauth2/token
Body
Field | Value |
username | {Salesforce org username} |
password | {Salesforce org password} |
grant_type | password |
client_id | client key from the connected app |
client_secret | client secret from the connected app |
Response
Retrieving Records
The actual callout for retrieving records from Salesforce. Requires a valid token to work. (see Authentication (POST))
URL Format: {salesforce org domain)/services/apexrest/{namespace/}wonde/{school code}/{object}
e.g. https://al1687300701641.my.salesforce.com/services/apexrest/wonde/EDVALALPHASYS/students
URL Parameters
size = maximum number of records (per page)
start_after = Salesforce id of last record used for pagination purposes, based from lastRecord
Response
size - maximum number of records (per page), defaulted to 200 if unspecified on url
numRecords - number of total records expected to be retrieved after pagination
lastRecord - Salesforce id of last record used for pagination purposes