Skip to content

Commit

Permalink
TCC-4292 Amended Settlements API corrections
Browse files Browse the repository at this point in the history
  • Loading branch information
@SamHummerstone
SamHummerstone committed Apr 14, 2015
1 parent d4c0268 commit 37bcf00
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions api_v2.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@
"tests": "",
"time": 1412353188206,
"name": "Release a settlement",
"description": "** POST /v2/settlements/{id}/release **\n Move the Settlement to state 'released', meaning it is ready to be processed.\n\n**Required Fields**\n\nid - Settlement ID\n\n**Optional Fields**\n\non\\_behalf\\_of: Contact ID of the client\n\n**Response**\n\nid:Settlement unique ID\n\nshort_reference:Unique human readable identifier\n\nstatus:Status of the Settlement\n\nconversion\\_ids:Array containing IDs of all Conversions in the Settlement\n\nentries:\n\ncreated\\_at:ISO 8601 Date when the Settlement was created\n\nupdated\\_at:ISO 8601 Date when the Settlement was last updated\n\nreleased\\_at:ISO 8601 Date when the Settlement was released\n",
"description": "** POST /v2/settlements/{id}/release **\n Move the Settlement to state 'released', meaning it is ready to be processed.\n\n**Required Fields**\n\nid - Settlement ID\n\n**Optional Fields**\n\non\\_behalf\\_of: Contact ID of the client\n\n**Response**\n\nid:Settlement unique ID\n\nshort_reference:Unique human readable identifier\n\nstatus:Status of the Settlement\n\ntype: settlement type\n\nconversion\\_ids:Array containing IDs of all Conversions in the Settlement\n\nentries:\n\ncreated\\_at:ISO 8601 Date when the Settlement was created\n\nupdated\\_at:ISO 8601 Date when the Settlement was last updated\n\nreleased\\_at:ISO 8601 Date when the Settlement was released\n",
"collectionId": "99992e35-3b43-1645-a3ab-770044a21090",
"responses": [],
"synced": false
Expand Down Expand Up @@ -324,8 +324,8 @@
"version": 2,
"tests": "",
"time": 1412353598561,
"name": "Find a Settlements",
"description": "**GET /v2/settlements/find**\nReturns an array of Settlement objects for the given search criteria\n\n**Required Fields**\n\n--\n\n\n\n**Optional Fields**\n\nshort_reference:Unique human readable identifier\n\nstatus:The current status of the settlement\n\ncreated\\_at\\_from:ISO 8601 Datetime when the settlement was created\n\ncreated\\_at\\_to:ISO 8601 Datetime when the settlement was created\n\nupdated\\_at\\_from:ISO 8601 Datetime when the settlement was updated\n\nupdated\\_at\\_to:ISO 8601 Datetime when the settlement was updated\n\nreleased\\_at\\_from:ISO 8601 Datetime when the settlement was updated\n\nreleased\\_at\\_to:ISO 8601 Datetime when the settlement was updated\n\npage:Which page to show\n\nper\\_page:Maximum number of entries to return\n\norder:The field to order entries by\n\norder\\_asc\\_desc:Whether the order is ascending (asc) or descending (desc)\n\non_behalf\\_of:Contact ID of the client\n\n\n**Response**\n\nsettlements:An array of Settlement objects\n\nid:Settlement unique ID\n\nshort\\_reference:Unique human readable identifier\n\nstatus:Status of the Settlement\n\nconversion\\_ids:Array containing IDs of all Conversions in the Settlement\n\nentries:\n\ncreated\\_at:ISO 8601 Date when the Settlement was created\n\nupdated\\_at:ISO 8601 Date when the Settlement was last updated\n\nreleased\\_at:ISO 8601 Date when the Settlement was released\n\npagination:Pagination details relevant to the search query\n\ntotal\\_entries:Total entries for this search query\n\ntotal\\_pages:Total pages for this search query\n\ncurrent\\_page:The current page of the search query\n\nper\\_page:The amount of search results to return per page\n\nprevious\\_page:\tThe previous page for this search query\n\nnext\\_page:The next page for this search query\n\norder:The order of the search returned for this search query\n\norder\\_asc\\_desc:The order of results returned e.g. 'asc' or 'desc'",
"name": "Find Settlements",
"description": "**GET /v2/settlements/find**\nReturns an array of Settlement objects for the given search criteria\n\n**Required Fields**\n\n--\n\n\n\n**Optional Fields**\n\nshort_reference:Unique human readable identifier\n\nstatus:The current status of the settlement\n\ncreated\\_at\\_from:ISO 8601 Datetime when the settlement was created\n\ncreated\\_at\\_to:ISO 8601 Datetime when the settlement was created\n\nupdated\\_at\\_from:ISO 8601 Datetime when the settlement was updated\n\nupdated\\_at\\_to:ISO 8601 Datetime when the settlement was updated\n\nreleased\\_at\\_from:ISO 8601 Datetime when the settlement was updated\n\nreleased\\_at\\_to:ISO 8601 Datetime when the settlement was updated\n\npage:Which page to show\n\nper\\_page:Maximum number of entries to return\n\norder:The field to order entries by\n\norder\\_asc\\_desc:Whether the order is ascending (asc) or descending (desc)\n\non_behalf\\_of:Contact ID of the client\n\n\n**Response**\n\nsettlements:An array of Settlement objects\n\nid:Settlement unique ID\n\nshort\\_reference:Unique human readable identifier\n\nstatus:Status of the Settlement\n\ntype: settlement type\n\nconversion\\_ids:Array containing IDs of all Conversions in the Settlement\n\nentries:\n\ncreated\\_at:ISO 8601 Date when the Settlement was created\n\nupdated\\_at:ISO 8601 Date when the Settlement was last updated\n\nreleased\\_at:ISO 8601 Date when the Settlement was released\n\npagination:Pagination details relevant to the search query\n\ntotal\\_entries:Total entries for this search query\n\ntotal\\_pages:Total pages for this search query\n\ncurrent\\_page:The current page of the search query\n\nper\\_page:The amount of search results to return per page\n\nprevious\\_page:\tThe previous page for this search query\n\nnext\\_page:The next page for this search query\n\norder:The order of the search returned for this search query\n\norder\\_asc\\_desc:The order of results returned e.g. 'asc' or 'desc'",
"collectionId": "99992e35-3b43-1645-a3ab-770044a21090",
"responses": [],
"synced": false
Expand Down Expand Up @@ -423,7 +423,7 @@
"tests": "",
"time": 1412353807259,
"name": "Remove a Conversion from a Settlement",
"description": "**POST /v2/settlements/{id}/remove_conversion**\nRemove a Conversion from an open Settlement. Returns the updated Settlement object.\n\n**Required Fields**\n\nid:Settlement ID\n\nconversion_id:ID of the conversion\n\n\n**Optional Fields**\n\non\\_behalf\\_of: Contact ID of the client\n\n\n**Response**\n\nid:Settlement unique ID\n\nshort\\_reference:Unique human readable identifier\n\nstatus:Status of the Settlement\n\nconversion\\_ids:Array containing IDs of all Conversions in the Settlement\n\nentries:\t\n\ncreated\\_at:ISO 8601 Date when the Settlement was created\n\nupdated\\_at:ISO 8601 Date when the Settlement was last updated\n\nreleased\\_at:ISO 8601 Date when the Settlement was released\n",
"description": "**POST /v2/settlements/{id}/remove_conversion**\nRemove a Conversion from an open Settlement. Returns the updated Settlement object.\n\n**Required Fields**\n\nid:Settlement ID\n\nconversion_id:ID of the conversion\n\n\n**Optional Fields**\n\non\\_behalf\\_of: Contact ID of the client\n\n\n**Response**\n\nid:Settlement unique ID\n\nshort\\_reference:Unique human readable identifier\n\nstatus:Status of the Settlement\n\ntype: type of settlement\n\nconversion\\_ids:Array containing IDs of all Conversions in the Settlement\n\nentries:\t\n\ncreated\\_at:ISO 8601 Date when the Settlement was created\n\nupdated\\_at:ISO 8601 Date when the Settlement was last updated\n\nreleased\\_at:ISO 8601 Date when the Settlement was released\n",
"collectionId": "99992e35-3b43-1645-a3ab-770044a21090",
"responses": [],
"synced": false
Expand Down Expand Up @@ -531,7 +531,7 @@
"tests": "",
"time": 1412353736556,
"name": "Unrelease a Settlement",
"description": "**POST /v2/settlements/{id}/unrelease**\nMove the Settlement back to state 'open', allowing Conversions to be added or removed\n\n\n**Required Fields**\n\nid:Settlement ID\n\n**Optional Fields**\n\non\\_behalf\\_of: Contact ID of the client\n\nid:Settlement ID\n\n**Response**\n\nid:Settlement unique ID\n\nshort\\_reference:Unique human readable identifier\n\nstatus:Status of the Settlement\n\nconversion\\_ids:Array containing IDs of all Conversions in the Settlement\n\nentries:\t\n\ncreated\\_at:ISO 8601 Date when the Settlement was created\n\nupdated\\_at:ISO 8601 Date when the Settlement was last updated\n\nreleased\\_at:ISO 8601 Date when the Settlement was released\n\n",
"description": "**POST /v2/settlements/{id}/unrelease**\nMove the Settlement back to state 'open', allowing Conversions to be added or removed\n\n\n**Required Fields**\n\nid:Settlement ID\n\n**Optional Fields**\n\non\\_behalf\\_of: Contact ID of the client\n\n**Response**\n\nid:Settlement unique ID\n\nshort\\_reference:Unique human readable identifier\n\nstatus:Status of the Settlement\n\ntype: settlement type\n\nonversion\\_ids:Array containing IDs of all Conversions in the Settlement\n\nentries:\t\n\ncreated\\_at:ISO 8601 Date when the Settlement was created\n\nupdated\\_at:ISO 8601 Date when the Settlement was last updated\n\nreleased\\_at:ISO 8601 Date when the Settlement was released\n\n",
"collectionId": "99992e35-3b43-1645-a3ab-770044a21090",
"responses": [],
"synced": false
Expand Down Expand Up @@ -657,7 +657,7 @@
"tests": "",
"time": 1412353418866,
"name": "Create a Settlement",
"description": "**POST /v2/settlements/create**\nCreates a new settlement and returns the settlement object\n\n**Required Fields**\n\n--\n\n**Optional Fields**\n\non\\_behalf\\_of: Contact ID of the client\n\n\n\n**Response**\n\n\nid:Settlement unique ID\n\nshort\\_reference:Unique human readable identifier\n\nstatus:Status of the Settlement\n\nconversion\\_ids:Array containing IDs of all Conversions in the Settlement\n\nentries:\t\n\ncreated\\_at:ISO 8601 Date when the Settlement was created\n\nupdated\\_at:ISO 8601 Date when the Settlement was last updated\n\nreleased\\_at:ISO 8601 Date when the Settlement was released",
"description": "**POST /v2/settlements/create**\nCreates a new settlement and returns the settlement object\n\n**Required Fields**\n\n--\n\n**Optional Fields**\n\non\\_behalf\\_of: Contact ID of the client\n\n\n\n**Response**\n\n\nid:Settlement unique ID\n\nshort\\_reference:Unique human readable identifier\n\nstatus:Status of the Settlement\n\ntype: conversion type\n\nconversion\\_ids:Array containing IDs of all Conversions in the Settlement\n\nentries:\t\n\ncreated\\_at:ISO 8601 Date when the Settlement was created\n\nupdated\\_at:ISO 8601 Date when the Settlement was last updated\n\nreleased\\_at:ISO 8601 Date when the Settlement was released",
"collectionId": "99992e35-3b43-1645-a3ab-770044a21090",
"responses": [],
"synced": false
Expand Down Expand Up @@ -925,7 +925,7 @@
"tests": "",
"time": 1412353803971,
"name": "Add a Conversion to Settlement",
"description": "**POST /v2/settlements/{id}/add_conversion**\nAdd a Conversion to an open Settlement. Returns the updated Settlement object.\n\n**Required Fields**\n\nid:Settlement ID\n\nconversion_id:ID of the conversion\n\n\n**Optional Fields**\n\non\\_behalf\\_of: Contact ID of the client\n\n\n**Response**\n\nid:Settlement unique ID\n\nshort\\_reference:Unique human readable identifier\n\nstatus:Status of the Settlement\n\nconversion\\_ids:Array containing IDs of all Conversions in the Settlement\n\nentries:\t\n\ncreated\\_at:ISO 8601 Date when the Settlement was created\n\nupdated\\_at:ISO 8601 Date when the Settlement was last updated\n\nreleased\\_at:ISO 8601 Date when the Settlement was released\n\n",
"description": "**POST /v2/settlements/{id}/add_conversion**\nAdd a Conversion to an open Settlement. Returns the updated Settlement object.\n\n**Required Fields**\n\nid:Settlement ID\n\nconversion_id:ID of the conversion\n\n\n**Optional Fields**\n\non\\_behalf\\_of: Contact ID of the client\n\n\n**Response**\n\nid:Settlement unique ID\n\nshort\\_reference:Unique human readable identifier\n\nstatus:Status of the Settlement\n\ntype: type of settlement\n\nconversion\\_ids:Array containing IDs of all Conversions in the Settlement\n\nentries:\t\n\ncreated\\_at:ISO 8601 Date when the Settlement was created\n\nupdated\\_at:ISO 8601 Date when the Settlement was last updated\n\nreleased\\_at:ISO 8601 Date when the Settlement was released\n\n",
"collectionId": "99992e35-3b43-1645-a3ab-770044a21090",
"responses": [],
"synced": false
Expand Down Expand Up @@ -961,7 +961,7 @@
"tests": "",
"time": 1412353858692,
"name": "Delete a Settlement",
"description": "**POST /v2/settlements/{id}/delete**\nDeletes an open Settlement and returns the Settlement object in its final state.\n\n\n**Required Fields**\n\nid:Settlement ID\n\n\n**Optional Fields**\n\non\\_behalf\\_of: Contact ID of the client\n\n\n**Response**\n\nid:Settlement unique ID\n\nshort\\_reference:Unique human readable identifier\n\nstatus:Status of the Settlement\n\nconversion\\_ids:Array containing IDs of all Conversions in the Settlement\n\nentries:\t\n\ncreated\\_at:ISO 8601 Date when the Settlement was created\n\nupdated\\_at:ISO 8601 Date when the Settlement was last updated\n\nreleased\\_at:ISO 8601 Date when the Settlement was released\n",
"description": "**POST /v2/settlements/{id}/delete**\nDeletes an open Settlement and returns the Settlement object in its final state.\n\n\n**Required Fields**\n\nid:Settlement ID\n\n\n**Optional Fields**\n\non\\_behalf\\_of: Contact ID of the client\n\n\n**Response**\n\nid:Settlement unique ID\n\nshort\\_reference:Unique human readable identifier\n\nstatus:Status of the Settlement\n\ntype: settlement type\n\nconversion\\_ids:Array containing IDs of all Conversions in the Settlement\n\nentries:\t\n\ncreated\\_at:ISO 8601 Date when the Settlement was created\n\nupdated\\_at:ISO 8601 Date when the Settlement was last updated\n\nreleased\\_at:ISO 8601 Date when the Settlement was released\n",
"collectionId": "99992e35-3b43-1645-a3ab-770044a21090",
"responses": [],
"synced": false
Expand Down

0 comments on commit 37bcf00

Please sign in to comment.