| Action: | GET | |||||||||||||||
| Method: | GET | |||||||||||||||
| URL: | /api/v1/static/listgroup/get | |||||||||||||||
| Description: | Fetch a Static List Group record based on Identifier | |||||||||||||||
| 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 of the Static List Group record. { "ListGroupID": 33000, "Name": "Country", "Description": "Country", "ScreeningID": 1, "ListDisplayMode": 0 } |
|
||||||||||||||
| Action: | GET ALL | |||||||||||||||
| Method: | GET | |||||||||||||||
| URL: | /api/v1/static/listgroup/getall | |||||||||||||||
| Description: | Fetch all Static List Group records | |||||||||||||||
| Type | Key | DataType | Notes | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Headers | api-key | String | Your Api-Key | |||||||||||||
| Params | ReturnFormat | String | Json or Xml | |||||||||||||
| Return Data: |
Json or XML collection of Static List Group records. [{ "ListGroupID": 33000, "Name": "Country", "Description": "Country", "ScreeningID": 1, "ListDisplayMode": 0 }] |
|
||||||||||||||
| Action: | ADD | |||||||||||||||
| Method: | POST | |||||||||||||||
| URL: | /api/v1/static/listgroup/add | |||||||||||||||
| Description: | Add a Static List Group record | |||||||||||||||
| Type | Key | DataType | Notes | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Headers | api-key | String | Your Api-Key | |||||||||||||
| Headers | Content-Type | String | Enter value: application/x-www-form-urlencoded | |||||||||||||
| Body | Name | String | Name | |||||||||||||
| Body | Description | String | Reference | |||||||||||||
| Body | ScreeningID | Byte | Screening Identifier | |||||||||||||
| Body | ListDisplayMode | Byte | 0 = Name, 1 = Ref, 2 = Ref-Name | |||||||||||||
| Body | ActionUserID | Int16 | Identifier of the User performing action. | |||||||||||||
| Body | ReturnFormat | String | Json or Xml | |||||||||||||
| Return Data: |
Json or XML of the Static List Group record added. { "ListGroupID": 33000, "Name": "Country", "Description": "Country", "ScreeningID": 1, "ListDisplayMode": 0 } |
|
||||||||||||||
| Action: | UPDATE | |||||||||||||||
| Method: | PUT | |||||||||||||||
| URL: | /api/v1/static/listgroup/update | |||||||||||||||
| Description: | Update an existing 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 | Name | String | Name | |||||||||||||
| Body | Description | String | Reference | |||||||||||||
| Body | ScreeningID | Byte | Screening Identifier | |||||||||||||
| Body | ListDisplayMode | Byte | 0 = Name, 1 = Ref, 2 = Ref-Name | |||||||||||||
| Body | ActionUserID | Int16 | Identifier of the User performing action. | |||||||||||||
| Body | ReturnFormat | String | Json or Xml | |||||||||||||
| Return Data: |
Json or XML of the Static List Group record updated. { "ListGroupID": 33000, "Name": "Country", "Description": "Country", "ScreeningID": 1, "ListDisplayMode": 0 } |
|
||||||||||||||
| Action: | DELETE | |||||||||||||||
| Method: | DELETE | |||||||||||||||
| URL: | /api/v1/static/listgroup/delete | |||||||||||||||
| Description: | Delete an existing Static List Group record | |||||||||||||||
| Type | Key | DataType | Notes | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Headers | api-key | String | Your Api-Key | |||||||||||||
| Params | ListGroupID | Int32 | List Group 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 Group record deleted. { "ListGroupID": 33000, "Name": "Country", "Description": "Country", "ScreeningID": 1, "ListDisplayMode": 0 } |
|
||||||||||||||