×

Party

Party related eamples are available in this section.
 
Load all parties
Load all available parties.
 
Example Code in this section
    
       [TestMethod]
        public void REST_Parties_load()
        {
            state = new ErrorState { passed = false };
            var parties = GET.parties(manager);

            if (parties.Count > 0)
            {
                state.passed = true;
            }
            Assert.AreEqual(true, state.passed, state.message);
    }

    class GET
    {
        public static List<Party> parties(Manager manager)
        {
            var currentClient = manager.getCurrentClient();
            List parties = null;

            string request = "clients/{0}/parties";
            var response = manager.httpClient.GetAsync(string.Format(request, currentClient.id)).Result;

            if (response.StatusCode == HttpStatusCode.OK) {
                parties = JsonConvert.DeserializeObject<List<Party>>(response.Content.ReadAsStringAsync().Result);
            }
            return parties;
        }
    }
    
  
Load Parties
    
    #region party

    @staticmethod
    def parties(manager):
        """
        Method docstring
        """

        _currentclient = manager.getcurrentclient()

        url = '{0}clients/{1}/parties'.format(manager.base_url(), _currentclient['id'])
        response = requests.get(url, headers=manager.headers())

        if response.status_code == 200:
            return_value = response.json()
        else:
            return_value = None

        return return_value
    @staticmethod
    def party_by_id(manager, _id):
        """
        read a party object by it's id

        para:    manager - management object
                 id      - party id
        return:  party   - object

        """
        _currentclient = manager.getcurrentclient()

        url = '{0}clients/{1}/parties/{2}'.format(manager.base_url(), _currentclient['id'], _id)
        response = requests.get(url, headers=manager.headers())

        if response.status_code == 200:
            return_value = response.json()
        else:
            return_value = None

        return return_value

    @staticmethod
    def party_by_name(manager, name):
        """
        read a party by it's name

        para:    manager - management object
                 name    - party name
        return:  party   - object
        """

        _currentclient = manager.getcurrentclient()

        url = '{0}clients/{1}/parties'.format(manager.base_url(), _currentclient['id'])
        response = requests.get(url, headers=manager.headers())
        json_response = response.json()

        _idx = None

        # for i in enumerate(json_response, start = 0):
        for i in range(len(json_response)):

            if name == json_response[i]['name']:
                _idx = i
                break

        if response.status_code == 200:
            return_value = json_response[_idx]
        else:
            return_value = None

        return return_value
    #endregion party
        
    
  
Load Parties
    
      UNDER CONSTRUCTION
    
  
JSON representation of a party
    
{
	"id": 12,
	"countryFID": 110,
	"languageFID": 1,
	"shortName": "SwaBie",
	"name": "THE SWATCH GROUP SA",
	"line1": "",
	"line2": "",
	"city": "Biel/Bienne",
	"address1": "Faubourg du Lac 6",
	"address2": "",
	"addressBlock": "",
	"email": "",
	"remarks": "",
	"telefax": "",
	"telephone": "",
	"web": "",
	"isPrivate": false,
	"partyNum": 1030,
	"freePartyNum": "",
	"isHaveDebtor": false,
	"isHaveCreditor": true,
	"countryCode": "CH",
	"languageCode": "DE",
	"zip": "2502",
	"person": {
		"partyFID": 12,
		"personRoleFID": 1,
		"firstName": "",
		"middleName": "",
		"lastName": "",
		"email": "",
		"jobTitle": "",
		"mobile": "",
		"salutation": "",
		"telephone": "",
		"title": "",
		"titleSuffix": "",
		"isMale": false
	},
	"debtor": {
		"partyFID": 12,
		"accountFID": -1,
		"payMethodFID": -1,
		"payTermFID": -1,
		"freeCode": "",
		"isInactiv": false,
		"noReminders": false,
		"noRemindersFee": false,
		"creditLine": 0.0,
		"maxReminderLevel": 0,
		"person": {
			"partyFID": 12,
			"personRoleFID": -1,
			"firstName": "",
			"middleName": "",
			"lastName": "",
			"email": "",
			"jobTitle": "",
			"mobile": "",
			"salutation": "",
			"telephone": "",
			"title": "",
			"titleSuffix": "",
			"isMale": false
		},
		"payMethods": []
	},
	"creditor": {
		"partyFID": 12,
		"accountFID": 102,
		"payMethodFID": 13,
		"payTermFID": 9,
		"freeCode": "",
		"ourCustomerNum": "",
		"isInactiv": false,
		"creditLine": 0.0,
		"person": {
			"partyFID": 12,
			"personRoleFID": 3,
			"firstName": "",
			"middleName": "",
			"lastName": "",
			"email": "",
			"jobTitle": "",
			"mobile": "",
			"salutation": "",
			"telephone": "",
			"title": "",
			"titleSuffix": "",
			"isMale": false
		},
		"payMethods": [
			{
				"id": 13,
				"partyFID": 12,
				"accountFID": 46,
				"bankAccountFID": 1,
				"bankFID": -1,
				"payTypeFID": 1,
				"accountNum": "010465708",
				"name": "ESR-CHF",
				"payslipCode": "010465708200085",
				"personRoleFID": 3
			}
		]
	}
}
    
  
 
Load party by id
Load a party by id.
 
Example Code in this section
    
       [TestMethod]
        public void REST_Parties_load()
        {
            state = new ErrorState { passed = false };
            var parties = GET.parties(manager);

            if (parties.Count > 0)
            {
                state.passed = true;
            }
            Assert.AreEqual(true, state.passed, state.message);
    }

    class GET
    {
        public static Party party_by_id(int id, Manager manager)
        {
            var currentClient = manager.getCurrentClient();
            Party party = null;

            string request = "clients/{0}/parties/{1}";
            var response = manager.httpClient.GetAsync(string.Format(request, currentClient.id, id)).Result;

            if (response.StatusCode == HttpStatusCode.OK) {
                party = JsonConvert.DeserializeObject<Party>(response.Content.ReadAsStringAsync().Result);
            }
            return party;
        }
    }
    
  
Load Parties
    
    #region party

    @staticmethod
    def parties(manager):
        """
        Method docstring
        """

        _currentclient = manager.getcurrentclient()

        url = '{0}clients/{1}/parties'.format(manager.base_url(), _currentclient['id'])
        response = requests.get(url, headers=manager.headers())

        if response.status_code == 200:
            return_value = response.json()
        else:
            return_value = None

        return return_value
    @staticmethod
    def party_by_id(manager, _id):
        """
        read a party object by it's id

        para:    manager - management object
                 id      - party id
        return:  party   - object

        """
        _currentclient = manager.getcurrentclient()

        url = '{0}clients/{1}/parties/{2}'.format(manager.base_url(), _currentclient['id'], _id)
        response = requests.get(url, headers=manager.headers())

        if response.status_code == 200:
            return_value = response.json()
        else:
            return_value = None

        return return_value

    @staticmethod
    def party_by_name(manager, name):
        """
        read a party by it's name

        para:    manager - management object
                 name    - party name
        return:  party   - object
        """

        _currentclient = manager.getcurrentclient()

        url = '{0}clients/{1}/parties'.format(manager.base_url(), _currentclient['id'])
        response = requests.get(url, headers=manager.headers())
        json_response = response.json()

        _idx = None

        # for i in enumerate(json_response, start = 0):
        for i in range(len(json_response)):

            if name == json_response[i]['name']:
                _idx = i
                break

        if response.status_code == 200:
            return_value = json_response[_idx]
        else:
            return_value = None

        return return_value
    #endregion party
        
    
  
JSON representation of a party
    
{
	"id": 12,
	"countryFID": 110,
	"languageFID": 1,
	"shortName": "SwaBie",
	"name": "THE SWATCH GROUP SA",
	"line1": "",
	"line2": "",
	"city": "Biel/Bienne",
	"address1": "Faubourg du Lac 6",
	"address2": "",
	"addressBlock": "",
	"email": "",
	"remarks": "",
	"telefax": "",
	"telephone": "",
	"web": "",
	"isPrivate": false,
	"partyNum": 1030,
	"freePartyNum": "",
	"isHaveDebtor": false,
	"isHaveCreditor": true,
	"countryCode": "CH",
	"languageCode": "DE",
	"zip": "2502",
	"person": {
		"partyFID": 12,
		"personRoleFID": 1,
		"firstName": "",
		"middleName": "",
		"lastName": "",
		"email": "",
		"jobTitle": "",
		"mobile": "",
		"salutation": "",
		"telephone": "",
		"title": "",
		"titleSuffix": "",
		"isMale": false
	},
	"debtor": {
		"partyFID": 12,
		"accountFID": -1,
		"payMethodFID": -1,
		"payTermFID": -1,
		"freeCode": "",
		"isInactiv": false,
		"noReminders": false,
		"noRemindersFee": false,
		"creditLine": 0.0,
		"maxReminderLevel": 0,
		"person": {
			"partyFID": 12,
			"personRoleFID": -1,
			"firstName": "",
			"middleName": "",
			"lastName": "",
			"email": "",
			"jobTitle": "",
			"mobile": "",
			"salutation": "",
			"telephone": "",
			"title": "",
			"titleSuffix": "",
			"isMale": false
		},
		"payMethods": []
	},
	"creditor": {
		"partyFID": 12,
		"accountFID": 102,
		"payMethodFID": 13,
		"payTermFID": 9,
		"freeCode": "",
		"ourCustomerNum": "",
		"isInactiv": false,
		"creditLine": 0.0,
		"person": {
			"partyFID": 12,
			"personRoleFID": 3,
			"firstName": "",
			"middleName": "",
			"lastName": "",
			"email": "",
			"jobTitle": "",
			"mobile": "",
			"salutation": "",
			"telephone": "",
			"title": "",
			"titleSuffix": "",
			"isMale": false
		},
		"payMethods": [
			{
				"id": 13,
				"partyFID": 12,
				"accountFID": 46,
				"bankAccountFID": 1,
				"bankFID": -1,
				"payTypeFID": 1,
				"accountNum": "010465708",
				"name": "ESR-CHF",
				"payslipCode": "010465708200085",
				"personRoleFID": 3
			}
		]
	}
}
    
  
 
Load party by number
Load a party by party number.
 
Example Code in this section

    
    [TestMethod]
    public void REST_Parties_load_by_number()
    {
        state = new ErrorState { passed = false };
        int no = REST_Helper.getRandomPartyNumber(manager);
        var party = GET.party_by_number(no, manager);

        if (party != null) {
            state.passed = true;
        }
        Assert.AreEqual(true, state.passed, state.message);
    }

    class GET
    {
        public static Party party_by_number(int no, Manager manager)
        {
            var currentClient = manager.getCurrentClient();           
            Party party = null;

            //select parties
            string request = "clients/{0}/parties/bynumber/{1}";
            var response = manager.httpClient.GetAsync(string.Format(request, currentClient.id, no)).Result;

            if (response.StatusCode == HttpStatusCode.OK)
            {
                party = JsonConvert.DeserializeObject<Party>(response.Content.ReadAsStringAsync().Result);
            }
            return party;
        }
    }
    
  
Load Parties
    
    #region party

    @staticmethod
    def parties(manager):
        """
        Method docstring
        """

        _currentclient = manager.getcurrentclient()

        url = '{0}clients/{1}/parties'.format(manager.base_url(), _currentclient['id'])
        response = requests.get(url, headers=manager.headers())

        if response.status_code == 200:
            return_value = response.json()
        else:
            return_value = None

        return return_value
    @staticmethod
    def party_by_id(manager, _id):
        """
        read a party object by it's id

        para:    manager - management object
                 id      - party id
        return:  party   - object

        """
        _currentclient = manager.getcurrentclient()

        url = '{0}clients/{1}/parties/{2}'.format(manager.base_url(), _currentclient['id'], _id)
        response = requests.get(url, headers=manager.headers())

        if response.status_code == 200:
            return_value = response.json()
        else:
            return_value = None

        return return_value

    @staticmethod
    def party_by_name(manager, name):
        """
        read a party by it's name

        para:    manager - management object
                 name    - party name
        return:  party   - object
        """

        _currentclient = manager.getcurrentclient()

        url = '{0}clients/{1}/parties'.format(manager.base_url(), _currentclient['id'])
        response = requests.get(url, headers=manager.headers())
        json_response = response.json()

        _idx = None

        # for i in enumerate(json_response, start = 0):
        for i in range(len(json_response)):

            if name == json_response[i]['name']:
                _idx = i
                break

        if response.status_code == 200:
            return_value = json_response[_idx]
        else:
            return_value = None

        return return_value
    #endregion party
        
    
  
Load Parties
    
      UNDER CONSTRUCTION
    
  
JSON representation of a party
    
{
	"id": 12,
	"countryFID": 110,
	"languageFID": 1,
	"shortName": "SwaBie",
	"name": "THE SWATCH GROUP SA",
	"line1": "",
	"line2": "",
	"city": "Biel/Bienne",
	"address1": "Faubourg du Lac 6",
	"address2": "",
	"addressBlock": "",
	"email": "",
	"remarks": "",
	"telefax": "",
	"telephone": "",
	"web": "",
	"isPrivate": false,
	"partyNum": 1030,
	"freePartyNum": "",
	"isHaveDebtor": false,
	"isHaveCreditor": true,
	"countryCode": "CH",
	"languageCode": "DE",
	"zip": "2502",
	"person": {
		"partyFID": 12,
		"personRoleFID": 1,
		"firstName": "",
		"middleName": "",
		"lastName": "",
		"email": "",
		"jobTitle": "",
		"mobile": "",
		"salutation": "",
		"telephone": "",
		"title": "",
		"titleSuffix": "",
		"isMale": false
	},
	"debtor": {
		"partyFID": 12,
		"accountFID": -1,
		"payMethodFID": -1,
		"payTermFID": -1,
		"freeCode": "",
		"isInactiv": false,
		"noReminders": false,
		"noRemindersFee": false,
		"creditLine": 0.0,
		"maxReminderLevel": 0,
		"person": {
			"partyFID": 12,
			"personRoleFID": -1,
			"firstName": "",
			"middleName": "",
			"lastName": "",
			"email": "",
			"jobTitle": "",
			"mobile": "",
			"salutation": "",
			"telephone": "",
			"title": "",
			"titleSuffix": "",
			"isMale": false
		},
		"payMethods": []
	},
	"creditor": {
		"partyFID": 12,
		"accountFID": 102,
		"payMethodFID": 13,
		"payTermFID": 9,
		"freeCode": "",
		"ourCustomerNum": "",
		"isInactiv": false,
		"creditLine": 0.0,
		"person": {
			"partyFID": 12,
			"personRoleFID": 3,
			"firstName": "",
			"middleName": "",
			"lastName": "",
			"email": "",
			"jobTitle": "",
			"mobile": "",
			"salutation": "",
			"telephone": "",
			"title": "",
			"titleSuffix": "",
			"isMale": false
		},
		"payMethods": [
			{
				"id": 13,
				"partyFID": 12,
				"accountFID": 46,
				"bankAccountFID": 1,
				"bankFID": -1,
				"payTypeFID": 1,
				"accountNum": "010465708",
				"name": "ESR-CHF",
				"payslipCode": "010465708200085",
				"personRoleFID": 3
			}
		]
	}
}
    
  
 
Load party by name
Load a party by party name.
 
Example Code in this section

    
        [TestMethod]
        public void REST_Parties_load_by_name()
        {
            state = new ErrorState { passed = false };
            var party = GET.party_by_name("Hunkeler", manager);

            if (party != null) {
                state.passed = true;
            }
            Assert.AreEqual(true, state.passed, state.message);

    class GET
    {
        public static Party party_by_name(string name, Manager manager)
        {
            Party party = null;
            List parties = null;

            string request = "clients/{0}/parties";
            var response = manager.httpClient.GetAsync(string.Format(request, manager.getCurrentClient().id)).Result;

            if (response.StatusCode == HttpStatusCode.OK)
            {
                parties = JsonConvert.DeserializeObject>(response.Content.ReadAsStringAsync().Result);
                party = parties.SingleOrDefault(p => p.name.Equals(name));
            }
            return party;
        }
    }
    
  
Load Parties
    
    #region party

    @staticmethod
    def parties(manager):
        """
        Method docstring
        """

        _currentclient = manager.getcurrentclient()

        url = '{0}clients/{1}/parties'.format(manager.base_url(), _currentclient['id'])
        response = requests.get(url, headers=manager.headers())

        if response.status_code == 200:
            return_value = response.json()
        else:
            return_value = None

        return return_value
    @staticmethod
    def party_by_id(manager, _id):
        """
        read a party object by it's id

        para:    manager - management object
                 id      - party id
        return:  party   - object

        """
        _currentclient = manager.getcurrentclient()

        url = '{0}clients/{1}/parties/{2}'.format(manager.base_url(), _currentclient['id'], _id)
        response = requests.get(url, headers=manager.headers())

        if response.status_code == 200:
            return_value = response.json()
        else:
            return_value = None

        return return_value

    @staticmethod
    def party_by_name(manager, name):
        """
        read a party by it's name

        para:    manager - management object
                 name    - party name
        return:  party   - object
        """

        _currentclient = manager.getcurrentclient()

        url = '{0}clients/{1}/parties'.format(manager.base_url(), _currentclient['id'])
        response = requests.get(url, headers=manager.headers())
        json_response = response.json()

        _idx = None

        # for i in enumerate(json_response, start = 0):
        for i in range(len(json_response)):

            if name == json_response[i]['name']:
                _idx = i
                break

        if response.status_code == 200:
            return_value = json_response[_idx]
        else:
            return_value = None

        return return_value
    #endregion party
        
    
  
JSON representation of a party
    
{
	"id": 12,
	"countryFID": 110,
	"languageFID": 1,
	"shortName": "SwaBie",
	"name": "THE SWATCH GROUP SA",
	"line1": "",
	"line2": "",
	"city": "Biel/Bienne",
	"address1": "Faubourg du Lac 6",
	"address2": "",
	"addressBlock": "",
	"email": "",
	"remarks": "",
	"telefax": "",
	"telephone": "",
	"web": "",
	"isPrivate": false,
	"partyNum": 1030,
	"freePartyNum": "",
	"isHaveDebtor": false,
	"isHaveCreditor": true,
	"countryCode": "CH",
	"languageCode": "DE",
	"zip": "2502",
	"person": {
		"partyFID": 12,
		"personRoleFID": 1,
		"firstName": "",
		"middleName": "",
		"lastName": "",
		"email": "",
		"jobTitle": "",
		"mobile": "",
		"salutation": "",
		"telephone": "",
		"title": "",
		"titleSuffix": "",
		"isMale": false
	},
	"debtor": {
		"partyFID": 12,
		"accountFID": -1,
		"payMethodFID": -1,
		"payTermFID": -1,
		"freeCode": "",
		"isInactiv": false,
		"noReminders": false,
		"noRemindersFee": false,
		"creditLine": 0.0,
		"maxReminderLevel": 0,
		"person": {
			"partyFID": 12,
			"personRoleFID": -1,
			"firstName": "",
			"middleName": "",
			"lastName": "",
			"email": "",
			"jobTitle": "",
			"mobile": "",
			"salutation": "",
			"telephone": "",
			"title": "",
			"titleSuffix": "",
			"isMale": false
		},
		"payMethods": []
	},
	"creditor": {
		"partyFID": 12,
		"accountFID": 102,
		"payMethodFID": 13,
		"payTermFID": 9,
		"freeCode": "",
		"ourCustomerNum": "",
		"isInactiv": false,
		"creditLine": 0.0,
		"person": {
			"partyFID": 12,
			"personRoleFID": 3,
			"firstName": "",
			"middleName": "",
			"lastName": "",
			"email": "",
			"jobTitle": "",
			"mobile": "",
			"salutation": "",
			"telephone": "",
			"title": "",
			"titleSuffix": "",
			"isMale": false
		},
		"payMethods": [
			{
				"id": 13,
				"partyFID": 12,
				"accountFID": 46,
				"bankAccountFID": 1,
				"bankFID": -1,
				"payTypeFID": 1,
				"accountNum": "010465708",
				"name": "ESR-CHF",
				"payslipCode": "010465708200085",
				"personRoleFID": 3
			}
		]
	}
}