diff --git a/api-docs/apiLive.htm b/api-docs/apiLive.htm index e927d44fb..a1a7f4dc7 100644 --- a/api-docs/apiLive.htm +++ b/api-docs/apiLive.htm @@ -3336,11 +3336,17 @@ GET https://DomainName/api/v1/datatables POST https://DomainName/api/v1/datatables/register/{datatable}/{apptable} -POST datatables/register/NewTable/m_client -Content-Type: application/json Request Body: { } +POST datatables/register/userDefinedTableName/m_client + +Content-Type: application/json +Request Body: +{} -{ "resourceId": null } +{ + "resourceId": null +} + @@ -3357,9 +3363,18 @@ Content-Type: application/json Request Body: { } POST https://DomainName/api/v1/datatables/deregister/{datatable} - POST datatables/register/New - Table Content-Type: application/json Request Body: { } - { "resourceId": null } + +POST datatables/deregister/userDefinedTableName + +Content-Type: application/json +Request Body: +{} + + +{ + "resourceId": null +} + @@ -3380,13 +3395,28 @@ POST https://DomainName/api/v1/datatables/deregister/{datatable} POST https://DomainName/api/v1/datatables/{datatable}/{apptableId} - POST datatables/Additional - Client Fields Data/1 Content-Type: application/json Request Body: - { "Business Description": "Livestock sales", Comment: "First - comment\nmade", Education_cv: "Trade", Gender_cd: "21", "Highest - Rate Paid": "8.5", "Next Visit": "01 October 2012", "Years in - Business": "5", dateFormat: "dd MMMM yyyy", locale: "en" } - { "resourceId": 1 } + +POST datatables/Additional Client Fields Data/1 + +Content-Type: application/json +Request Body: +{ + "Business Description": "Livestock sales", + Comment: "First comment\nmade", + Education_cv: "Trade", + Gender_cd: "21", + "Highest Rate Paid": "8.5", + "Next Visit": "01 October 2012", + "Years in Business": "5", + dateFormat: "dd MMMM yyyy", + locale: "en" +} + + +{ + "resourceId": 1 +} + @@ -3435,11 +3465,20 @@ POST https://DomainName/api/v1/datatables/{datatable}/{apptableId} GET https://DomainName/api/v1/datatables/{datatable}/{apptableId} - [ {"client_id": 1, "Business - Description": "Livestock sales", "Years in Business": 5, - "Gender_cd": "21", "Education_cv": "Trade", "Next Visit": [2012, - 10, 1], "Highest Rate Paid": 8.500000, "Comment": "First comment - made"} ] + +[ +{ + "client_id": 1, + "Business Description": "Livestock sales", + "Years in Business": 5, + "Gender_cd": "21", + "Education_cv": "Trade", + "Next Visit": [2012, 10, 1], + "Highest Rate Paid": 8.500000, + "Comment": "First comment made" +} +] + @@ -3455,13 +3494,23 @@ GET https://DomainName/api/v1/datatables/{datatable}/{apptableId} PUT https://DomainName/api/v1/datatables/{datatable}/{apptableId} - PUT datatables/Additional - Client Fields Data/1 Content-Type: application/json Request Body: - { "Business Description": "Livestock sales updated", Comment: - "First comment\nmade", Education_cv: "Trade", Gender_cd: "21", - "Highest Rate Paid": "8.5", "Next Visit": "01 October 2012", - "Years in Business": "5", dateFormat: "dd MMMM yyyy", locale: "en" - } + +PUT datatables/Additional Client Fields Data/1 + +Content-Type: application/json +Request Body: +{ + "Business Description": "Livestock sales updated", + Comment: "First comment\nmade", + Education_cv: "Trade", + Gender_cd: "21", + "Highest Rate Paid": "8.5", + "Next Visit": "01 October 2012", + "Years in Business": "5", + dateFormat: "dd MMMM yyyy", + locale: "en" +} + { "resourceId": 1 } @@ -3477,11 +3526,21 @@ PUT https://DomainName/api/v1/datatables/{datatable}/{apptableId} PUT https://DomainName/api/v1/datatables/{datatable}/{apptableId}/{datatableId} - PUT datatables/Extra Family - Details Data/1/2 Content-Type: application/json Request Body: { - "Date of Birth": "01 June 1982", Education_cdHighest: "5", Name: - "June", "Other Notes": "More\nnotes", "Points Score": "20", - dateFormat: "dd MMMM yyyy", locale: "en" } + +PUT datatables/Extra Family Details Data/1/2 + +Content-Type: application/json +Request Body: +{ + "Date of Birth": "01 June 1982", + Education_cdHighest: "5", + Name: "June", + "Other Notes": "More\nnotes", + "Points Score": "20", + dateFormat: "dd MMMM yyyy", + locale: "en" +} + { "resourceId": 1 } @@ -3502,9 +3561,14 @@ PUT https://DomainName/api/v1/datatables/{datatable}/{apptableId}/{datatableId} DELETE https://DomainName/api/v1/datatables/{datatable}/{apptableId} - DELETE datatables/Additional - Client Fields Data/1 Content-Type: application/json Request Body: - { } + +DELETE datatables/Additional Client Fields Data/1 + +Content-Type: application/json + +Request Body: +{} + { "resourceId": 1 } @@ -3521,8 +3585,12 @@ DELETE https://DomainName/api/v1/datatables/{datatable}/{apptableId} DELETE https://DomainName/api/v1/datatables/{datatable}/{apptableId}/{datatableId} - DELETE datatables/Extra Family - Details Data/1/2 Content-Type: application/json Request Body: { } + +DELETE datatables/Extra Family Details Data/1/2 + +Content-Type: application/json +Request Body: +{} { "resourceId": 1 }