Action: | GET | |||||||||||||||
Method: | GET | |||||||||||||||
URL: | /api/v1/static/listdata/get | |||||||||||||||
Description: | Fetch a Static List Data record based on Identifier | |||||||||||||||
Type | Key | DataType | Notes | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Headers | api-key | String | Your Api-Key | |||||||||||||
Params | ListGroupID | Int32 | List Group Identifier | |||||||||||||
Params | ListDataID | Int32 | List Data Identifier | |||||||||||||
Params | ReturnFormat | String | Json or Xml | |||||||||||||
Return Data: |
Json or XML of the Static List Data record. { "ListGroupID": 33011, "ListDataID": 34292, "Name": "Asset Management", "Reference": "AM", "ScreeningDataID": 0 } |
|
Action: | GET ALL | |||||||||||||||
Method: | GET | |||||||||||||||
URL: | /api/v1/static/listdata/getall | |||||||||||||||
Description: | Fetch all Static List Data records | |||||||||||||||
Type | Key | DataType | Notes | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Headers | api-key | String | Your Api-Key | |||||||||||||
Params | ListGroupID | Int32 | List Group Identifier | |||||||||||||
Params | ReturnFormat | String | Json or Xml | |||||||||||||
Return Data: |
Json or XML collection of Static List Data records. [{ "ListGroupID": 33011, "ListDataID": 34292, "Name": "Asset Management", "Reference": "AM", "ScreeningDataID": 0 }] |
|
Action: | ADD | |||||||||||||||
Method: | POST | |||||||||||||||
URL: | /api/v1/static/listdata/add | |||||||||||||||
Description: | Add a Static List Data and link it to Static List Group | |||||||||||||||
Type | Key | DataType | Notes | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Headers | api-key | String | Your Api-Key | |||||||||||||
Headers | Content-Type | String | Enter value: application/x-www-form-urlencoded | |||||||||||||
Body | ListGroupID | Int32 | List Group Identifier | |||||||||||||
Body | ListDataID | Int32 | List Data Identifier | |||||||||||||
Body | Name | String | Name | |||||||||||||
Body | Reference | String | Reference | |||||||||||||
Body | ScreeningDataID | Int32 | Screening Data Identifier | |||||||||||||
Body | ActionUserID | Int16 | Identifier of the User performing action. | |||||||||||||
Body | ReturnFormat | String | Json or Xml | |||||||||||||
Return Data: |
Json or XML of the Static List Data record added. { "ListGroupID": 33002, "ListDataID": 34307, "Name": "Black", "Reference": "Black", "ScreeningDataID": 0 } |
|
Action: | UPDATE | |||||||||||||||
Method: | PUT | |||||||||||||||
URL: | /api/v1/static/listdata/update | |||||||||||||||
Description: | Update an existing Static List Data | |||||||||||||||
Type | Key | DataType | Notes | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Headers | api-key | String | Your Api-Key | |||||||||||||
Headers | Content-Type | String | Enter value: application/x-www-form-urlencoded | |||||||||||||
Body | ListGroupID | Int32 | List Group Identifier | |||||||||||||
Body | ListDataID | Int32 | List Data Identifier | |||||||||||||
Body | Name | String | Name | |||||||||||||
Body | Reference | String | Reference | |||||||||||||
Body | ScreeningDataID | Int32 | Screening Data Identifier | |||||||||||||
Body | ActionUserID | Int16 | Identifier of the User performing action. | |||||||||||||
Body | ReturnFormat | String | Json or Xml | |||||||||||||
Return Data: |
Json or XML of the Static List Data record updated. { "ListGroupID": 33002, "ListDataID": 34307, "Name": "Black", "Reference": "Black", "ScreeningDataID": 0 } |
|
Action: | DELETE | |||||||||||||||
Method: | DELETE | |||||||||||||||
URL: | /api/v1/static/listdata/delete | |||||||||||||||
Description: | Delete an existing Static List Data record | |||||||||||||||
Type | Key | DataType | Notes | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Headers | api-key | String | Your Api-Key | |||||||||||||
Params | ListGroupID | Int32 | List Group Identifier | |||||||||||||
Params | ListDataID | Int32 | List Data Identifier | |||||||||||||
Params | ActionUserID | Int16 | Identifier of the User performing action. | |||||||||||||
Params | ReturnFormat | String | Json or Xml | |||||||||||||
Return Data: |
Json or XML of the Static List Data record deleted. { "ListGroupID": 33002, "ListDataID": 34307, "Name": "Black", "Reference": "Black", "ScreeningDataID": 0 } |
|