Action: | GET | |||||||||||
Method: | GET | |||||||||||
URL: | /api/v1/static/prospectrelationship/get | |||||||||||
Description: | Fetch a Static Prospect Relationship record based on Identifier | |||||||||||
Type | Key | DataType | Notes | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Headers | api-key | String | Your Api-Key | |||||||||
Params | ProspectRelationshipID | Int16 | ProspectRelationship Identifier | |||||||||
Params | ReturnFormat | String | Json or Xml | |||||||||
Return Data: | Json or XML of the Static Prospect Relationship record. { "ProspectRelationshipID": 1, "Name": "Director", "Description": "Director", } |
|
Action: | GET ALL | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Method: | GET | |||||||||||||||||||||||||||||||||||||||||||||||||||||
URL: | /api/v1/static/prospectrelationship/getall | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Description: | Fetch all Static Prospect Relationship 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 Prospect Relationship records. [{ "ProspectRelationshipID": 1, "Name": "Director", "Description": "Director", "Value1Name": "", "Value2Name": "", "Value3Name": "", "Value4Name": "", "Value5Name": "", "Value6Name": "", "Value7Name": "", "Value1Decimals": 0, "Value2Decimals": 0, "Value3Decimals": 0, "Value4Decimals": 0, "Value5Decimals": 0, "Value6Decimals": 0, "Value7Decimals": 0, "Value1Enabled": false, "Value2Enabled": false, "Value3Enabled": false, "Value4Enabled": false, "Value5Enabled": false, "Value6Enabled": false, "Value7Enabled": false, }] |
|
Action: | ADD | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Method: | POST | |||||||||||||||||||||||||||||||||||||||||||||||||||||
URL: | /api/v1/static/prospectrelationship/add | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Description: | Add a Static Prospect Relationship and link to Client | |||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value1Name | String | Value 1 Name (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value2Name | String | Value 2 Name (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value3Name | String | Value 3 Name (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value4Name | String | Value 4 Name (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value5Name | String | Value 5 Name (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value6Name | String | Value 6 Name (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value7Name | String | Value 7 Name (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value1Decimals | Byte | Value 1 Decimals (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value2Decimals | Byte | Value 2 Decimals (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value3Decimals | Byte | Value 3 Decimals (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value4Decimals | Byte | Value 4 Decimals (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value5Decimals | Byte | Value 5 Decimals (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value6Decimals | Byte | Value 6 Decimals (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value7Decimals | Byte | Value 7 Decimals (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value1Enabled | Boolean | Value 1 Enabled (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value2Enabled | Boolean | Value 2 Enabled (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value3Enabled | Boolean | Value 3 Enabled (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value4Enabled | Boolean | Value 4 Enabled (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value5Enabled | Boolean | Value 5 Enabled (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value6Enabled | Boolean | Value 6 Enabled (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value7Enabled | Boolean | Value 7 Enabled (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ActionUserID | Int16 | Identifier of the User performing action. | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||||||||||||||||||||||||||||||
Return Data: |
Json or XML of the Static Prospect Relationship record added. { "ProspectRelationshipID": 1, "Name": "Director", "Description": "Director", "Value1Name": "", "Value2Name": "", "Value3Name": "", "Value4Name": "", "Value5Name": "", "Value6Name": "", "Value7Name": "", "Value1Decimals": 0, "Value2Decimals": 0, "Value3Decimals": 0, "Value4Decimals": 0, "Value5Decimals": 0, "Value6Decimals": 0, "Value7Decimals": 0, "Value1Enabled": false, "Value2Enabled": false, "Value3Enabled": false, "Value4Enabled": false, "Value5Enabled": false, "Value6Enabled": false, "Value7Enabled": false, } |
|
Action: | UPDATE | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Method: | PUT | |||||||||||||||||||||||||||||||||||||||||||||||||||||
URL: | /api/v1/static/prospectrelationship/update | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Description: | Update an existing Static Prospect Relationship | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Key | DataType | Notes | |||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Headers | api-key | String | Your Api-Key | |||||||||||||||||||||||||||||||||||||||||||||||||||
Headers | Content-Type | String | Enter value: application/x-www-form-urlencoded | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ProspectRelationshipID | Int16 | Identifier of the Static Prospect Relationship to update | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Name | String | Name | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Description | String | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value1Name | String | Value 1 Name (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value2Name | String | Value 2 Name (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value3Name | String | Value 3 Name (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value4Name | String | Value 4 Name (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value5Name | String | Value 5 Name (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value6Name | String | Value 6 Name (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value7Name | String | Value 7 Name (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value1Decimals | Byte | Value 1 Decimals (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value2Decimals | Byte | Value 2 Decimals (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value3Decimals | Byte | Value 3 Decimals (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value4Decimals | Byte | Value 4 Decimals (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value5Decimals | Byte | Value 5 Decimals (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value6Decimals | Byte | Value 6 Decimals (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value7Decimals | Byte | Value 7 Decimals (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value1Enabled | Boolean | Value 1 Enabled (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value2Enabled | Boolean | Value 2 Enabled (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value3Enabled | Boolean | Value 3 Enabled (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value4Enabled | Boolean | Value 4 Enabled (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value5Enabled | Boolean | Value 5 Enabled (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value6Enabled | Boolean | Value 6 Enabled (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | Value7Enabled | Boolean | Value 7 Enabled (optional) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ActionUserID | Int16 | Identifier of the User performing action. | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||||||||||||||||||||||||||||||
Return Data: |
Json or XML of the Static Prospect Relationship record updated. { "ProspectRelationshipID": 1, "Name": "Director", "Description": "Director", "Value1Name": "", "Value2Name": "", "Value3Name": "", "Value4Name": "", "Value5Name": "", "Value6Name": "", "Value7Name": "", "Value1Decimals": 0, "Value2Decimals": 0, "Value3Decimals": 0, "Value4Decimals": 0, "Value5Decimals": 0, "Value6Decimals": 0, "Value7Decimals": 0, "Value1Enabled": false, "Value2Enabled": false, "Value3Enabled": false, "Value4Enabled": false, "Value5Enabled": false, "Value6Enabled": false, "Value7Enabled": false, } |
|
Action: | DELETE | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Method: | DELETE | |||||||||||||||||||||||||||||||||||||||||||||||||||||
URL: | /api/v1/static/prospectrelationship/delete | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Description: | Delete an existing Static Prospect Relationship link with Client and also the Static Prospect Relationship if not linked to any other clients | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Type | Key | DataType | Notes | |||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Headers | api-key | String | Your Api-Key | |||||||||||||||||||||||||||||||||||||||||||||||||||
Headers | Content-Type | String | Enter value: application/x-www-form-urlencoded | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ProspectRelationshipID | Int16 | Identifier of the Static Prospect Relationship to delete | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ActionUserID | Int16 | Identifier of the User performing action. | |||||||||||||||||||||||||||||||||||||||||||||||||||
Body | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||||||||||||||||||||||||||||||
Return Data: |
Json or XML of the Static Prospect Relationship record deleted. { "ProspectRelationshipID": 1, "Name": "Director", "Description": "Director", "Value1Name": "", "Value2Name": "", "Value3Name": "", "Value4Name": "", "Value5Name": "", "Value6Name": "", "Value7Name": "", "Value1Decimals": 0, "Value2Decimals": 0, "Value3Decimals": 0, "Value4Decimals": 0, "Value5Decimals": 0, "Value6Decimals": 0, "Value7Decimals": 0, "Value1Enabled": false, "Value2Enabled": false, "Value3Enabled": false, "Value4Enabled": false, "Value5Enabled": false, "Value6Enabled": false, "Value7Enabled": false, } |
|