PdfOutput
The pdfOutput controller for getting files in the system.
| API | Description |
|---|---|
| GET api/v1/pdfoutput/{fileName} |
Gets the files with the given . |
Suppliers
The suppliers controller.
| API | Description |
|---|---|
| GET api/v1/suppliers/campaigns/{pageSize}/{page} |
Returns a paged list of campaigns that the current user can see. |
| POST api/v1/suppliers/campaigns/{id}/status |
Updates a campaign status. |
Auth
The auth controller used to handle authentication to the back end services.
| API | Description |
|---|---|
| POST token |
The token endpoint supporting either credentials or refresh token flows. |
| POST api/v1/token |
The token endpoint supporting either credentials or refresh token flows. |
Campaigns
The campaigns controller.
| API | Description |
|---|---|
| GET api/v1/campaigns/{startDate}/{endDate}/{pageSize}/{page} |
Returns a paged list of campaigns between the start and end dates. |
| GET api/v1/campaigns/{id}/contactsFile |
Returns the data file used on the campaign with the given id if available. |
DataTransfer
The data transfer controller. For handling the ingest of external data and saving it into the Gem system.
| API | Description |
|---|---|
| POST api/v1/datatransfer/datalist/{dataListId} |
Saves the uploaded file using the given . |
| POST api/v1/datatransfer/datalist/json/{dataListId} |
Saves the given using the given . |
| POST api/v1/datatransfer/campaign/{campaignId} |
Saves the given to the data list used by the campaign with the given . |
| POST api/v1/datatransfer/flush/{dataListId} |
Flushes the data items from the given . |
DataLists
The data lists controller to get and create public data lists.
| API | Description |
|---|---|
| GET api/v1/datalists/{dataListId} |
Gets data list with the given |
| POST api/v1/datalists |
Creates a new data list with the information provided in the . |
Orders
The orders controller.
| API | Description |
|---|---|
| GET api/v1/orders/{startDate}/{endDate}/{pageSize}/{page} |
Returns a paged list of orders between the start and end dates. |
| POST api/v1/orders/consignmentNumber |
Post the consignment number for a pay order. |
| POST api/v1/orders/status |
Post a status change for a pay order. |
Schemas
The schema controller for getting schemas stored in the system.
| API | Description |
|---|---|
| GET api/Schemas/{id} |
Gets the schema with the given . |
| GET api/Schemas?name={name} |
Gets the schema with the given . |