Party SDK

`Party` API and SDK Documentation ⍟ v1.0.0

The Party archetype represents an identifiable, addressable entity that may have a legal status and that normally has autonomous control over (at least some of) its actions.

Standards compliance
Resources
Business archetypes defined
Explore other business archetype patterns
Organizations API
- getOrganizationByPartyIdentifier
- getOrganizations
Parties API
- getParties
- getPartyByPartyIdentifier
People API
- getPeople
- getPersonByPartyIdentifier
Preferences API
- getPreferenceByUniqueIdentifier
- getPreferences

Standards compliance

Standard	Contents
OMG Party Management Facility Specification	A standard that supports party management.
ISO 3166	Two- and three-letter country codes and country names.
ISO/IEC 5218:2004	Codes for the representation of human sexes.
ITU-T Recommendations	Telecommunication numbering plan.

Resources

Proposal	Contents
63 Genders	A proposal for describing Gender as a combination of Physical, Personality and Preferential groups.

Business archetypes defined

"A business archetype is a primordial thing that occurs consistently and universally in business domains and business software systems." (Arlow & Neustadt, Enterprise patterns and MDA: building better software with archetype patterns and UML, 2006, p. 5)

Explore other business archetype patterns

Open a Swagger-UI instance, then copy and paste the following Swagger specification URLs into the "Explore" text field and select the "Explore" button for additional APIs.

`Organizations` API

Organization

`getOrganizationByPartyIdentifier`

Retrieve a specific Organization by its unique identifier.

GET /organizations/{party-identifier}

Usage and SDK Samples

Curl

curl -X GET "http://api.swindle.net/archetypes/v1/parties/organizations/{party-identifier}"

Java

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OrganizationsApi;

import java.io.File;
import java.util.*;

public class OrganizationsApiExample {

    public static void main(String[] args) {

        OrganizationsApi apiInstance = new OrganizationsApi();
        String partyIdentifier = partyIdentifier_example; // String | The unique identifier associated with an Organization.
        try {
            Organization_1 result = apiInstance.getOrganizationByPartyIdentifier(partyIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganizationsApi#getOrganizationByPartyIdentifier");
            e.printStackTrace();
        }
    }
}

Android

import io.swagger.client.api.OrganizationsApi;

public class OrganizationsApiExample {

    public static void main(String[] args) {
        OrganizationsApi apiInstance = new OrganizationsApi();
        String partyIdentifier = partyIdentifier_example; // String | The unique identifier associated with an Organization.
        try {
            Organization_1 result = apiInstance.getOrganizationByPartyIdentifier(partyIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganizationsApi#getOrganizationByPartyIdentifier");
            e.printStackTrace();
        }
    }
}

ObjectiveC

String *partyIdentifier = partyIdentifier_example; // The unique identifier associated with an Organization.

OrganizationsApi *apiInstance = [[OrganizationsApi alloc] init];

// Retrieve a specific Organization.
[apiInstance getOrganizationByPartyIdentifierWith:partyIdentifier
              completionHandler: ^(Organization_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

Node.js

var Party = require('party');

var api = new Party.OrganizationsApi()

var partyIdentifier = partyIdentifier_example; // {String} The unique identifier associated with an Organization.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrganizationByPartyIdentifier(partyIdentifier, callback);

CSharp

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getOrganizationByPartyIdentifierExample
    {
        public void main()
        {

            var apiInstance = new OrganizationsApi();
            var partyIdentifier = partyIdentifier_example;  // String | The unique identifier associated with an Organization.

            try
            {
                // Retrieve a specific Organization.
                Organization_1 result = apiInstance.getOrganizationByPartyIdentifier(partyIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganizationsApi.getOrganizationByPartyIdentifier: " + e.Message );
            }
        }
    }
}

PHP

getOrganizationByPartyIdentifier($partyIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrganizationsApi->getOrganizationByPartyIdentifier: ', $e->getMessage(), PHP_EOL;
}

Perl

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OrganizationsApi;

my $api_instance = WWW::SwaggerClient::OrganizationsApi->new();
my $partyIdentifier = partyIdentifier_example; # String | The unique identifier associated with an Organization.

eval {
    my $result = $api_instance->getOrganizationByPartyIdentifier(partyIdentifier => $partyIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrganizationsApi->getOrganizationByPartyIdentifier: $@\n";
}

Python

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.OrganizationsApi()
partyIdentifier = partyIdentifier_example # String | The unique identifier associated with an Organization.

try:
    # Retrieve a specific Organization.
    api_response = api_instance.get_organization_by_party_identifier(partyIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrganizationsApi->getOrganizationByPartyIdentifier: %s\n" % e)

Parameters

Path parameters

Name	Description
`party-identifier`*	String The unique identifier associated with an `Organization`. Required

Responses

Status: 200 OK.
Status: 400 Bad Request.
Status: 401 Unauthorized.
Status: 403 Forbidden.
Status: 404 Not Found.
Status: 405 Method Not Allowed.

Organization

`getOrganizations`

Retrieve all Organizations.

GET /organizations/

Usage and SDK Samples

Curl

curl -X GET "http://api.swindle.net/archetypes/v1/parties/organizations/"

Java

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OrganizationsApi;

import java.io.File;
import java.util.*;

public class OrganizationsApiExample {

    public static void main(String[] args) {

        OrganizationsApi apiInstance = new OrganizationsApi();
        try {
            array[Organization_1] result = apiInstance.getOrganizations();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganizationsApi#getOrganizations");
            e.printStackTrace();
        }
    }
}

Android

import io.swagger.client.api.OrganizationsApi;

public class OrganizationsApiExample {

    public static void main(String[] args) {
        OrganizationsApi apiInstance = new OrganizationsApi();
        try {
            array[Organization_1] result = apiInstance.getOrganizations();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganizationsApi#getOrganizations");
            e.printStackTrace();
        }
    }
}

ObjectiveC

OrganizationsApi *apiInstance = [[OrganizationsApi alloc] init];

// Retrieve all Organizations.
[apiInstance getOrganizationsWithCompletionHandler:
              ^(array[Organization_1] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

Node.js

var Party = require('party');

var api = new Party.OrganizationsApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrganizations(callback);

CSharp

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getOrganizationsExample
    {
        public void main()
        {

            var apiInstance = new OrganizationsApi();

            try
            {
                // Retrieve all Organizations.
                array[Organization_1] result = apiInstance.getOrganizations();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganizationsApi.getOrganizations: " + e.Message );
            }
        }
    }
}

PHP

getOrganizations();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrganizationsApi->getOrganizations: ', $e->getMessage(), PHP_EOL;
}

Perl

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OrganizationsApi;

my $api_instance = WWW::SwaggerClient::OrganizationsApi->new();

eval {
    my $result = $api_instance->getOrganizations();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrganizationsApi->getOrganizations: $@\n";
}

Python

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.OrganizationsApi()

try:
    # Retrieve all Organizations.
    api_response = api_instance.get_organizations()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrganizationsApi->getOrganizations: %s\n" % e)

Parameters

None.

Responses

Status: 200 OK.
Status: 400 Bad Request.
Status: 401 Unauthorized.
Status: 403 Forbidden.
Status: 404 Not Found.
Status: 405 Method Not Allowed.

`Parties` API

Party

`getParties`

Retrieve all Parties.

GET /

Usage and SDK Samples

Curl

curl -X GET "http://api.swindle.net/archetypes/v1/parties/"

Java

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PartiesApi;

import java.io.File;
import java.util.*;

public class PartiesApiExample {

    public static void main(String[] args) {

        PartiesApi apiInstance = new PartiesApi();
        try {
            array[inline_response_200] result = apiInstance.getParties();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PartiesApi#getParties");
            e.printStackTrace();
        }
    }
}

Android

import io.swagger.client.api.PartiesApi;

public class PartiesApiExample {

    public static void main(String[] args) {
        PartiesApi apiInstance = new PartiesApi();
        try {
            array[inline_response_200] result = apiInstance.getParties();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PartiesApi#getParties");
            e.printStackTrace();
        }
    }
}

ObjectiveC

PartiesApi *apiInstance = [[PartiesApi alloc] init];

// Retrieve all Parties.
[apiInstance getPartiesWithCompletionHandler:
              ^(array[inline_response_200] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

Node.js

var Party = require('party');

var api = new Party.PartiesApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getParties(callback);

CSharp

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPartiesExample
    {
        public void main()
        {

            var apiInstance = new PartiesApi();

            try
            {
                // Retrieve all Parties.
                array[inline_response_200] result = apiInstance.getParties();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PartiesApi.getParties: " + e.Message );
            }
        }
    }
}

PHP

getParties();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PartiesApi->getParties: ', $e->getMessage(), PHP_EOL;
}

Perl

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PartiesApi;

my $api_instance = WWW::SwaggerClient::PartiesApi->new();

eval {
    my $result = $api_instance->getParties();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PartiesApi->getParties: $@\n";
}

Python

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PartiesApi()

try:
    # Retrieve all Parties.
    api_response = api_instance.get_parties()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PartiesApi->getParties: %s\n" % e)

Parameters

None.

Responses

Status: 200 OK.
Status: 400 Bad Request.
Status: 401 Unauthorized.
Status: 403 Forbidden.
Status: 404 Not Found.
Status: 405 Method Not Allowed.

Party

`getPartyByPartyIdentifier`

Retrieve a Party by its unique identifier.

GET /{party-identifier}

Usage and SDK Samples

Curl

curl -X GET "http://api.swindle.net/archetypes/v1/parties/{party-identifier}"

Java

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PartiesApi;

import java.io.File;
import java.util.*;

public class PartiesApiExample {

    public static void main(String[] args) {

        PartiesApi apiInstance = new PartiesApi();
        String partyIdentifier = partyIdentifier_example; // String | The unique identifier of the Party.
        try {
            inline_response_200 result = apiInstance.getPartyByPartyIdentifier(partyIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PartiesApi#getPartyByPartyIdentifier");
            e.printStackTrace();
        }
    }
}

Android

import io.swagger.client.api.PartiesApi;

public class PartiesApiExample {

    public static void main(String[] args) {
        PartiesApi apiInstance = new PartiesApi();
        String partyIdentifier = partyIdentifier_example; // String | The unique identifier of the Party.
        try {
            inline_response_200 result = apiInstance.getPartyByPartyIdentifier(partyIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PartiesApi#getPartyByPartyIdentifier");
            e.printStackTrace();
        }
    }
}

ObjectiveC

String *partyIdentifier = partyIdentifier_example; // The unique identifier of the Party.

PartiesApi *apiInstance = [[PartiesApi alloc] init];

// Retrieve a specific Party entity.
[apiInstance getPartyByPartyIdentifierWith:partyIdentifier
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

Node.js

var Party = require('party');

var api = new Party.PartiesApi()

var partyIdentifier = partyIdentifier_example; // {String} The unique identifier of the Party.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPartyByPartyIdentifier(partyIdentifier, callback);

CSharp

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPartyByPartyIdentifierExample
    {
        public void main()
        {

            var apiInstance = new PartiesApi();
            var partyIdentifier = partyIdentifier_example;  // String | The unique identifier of the Party.

            try
            {
                // Retrieve a specific Party entity.
                inline_response_200 result = apiInstance.getPartyByPartyIdentifier(partyIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PartiesApi.getPartyByPartyIdentifier: " + e.Message );
            }
        }
    }
}

PHP

getPartyByPartyIdentifier($partyIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PartiesApi->getPartyByPartyIdentifier: ', $e->getMessage(), PHP_EOL;
}

Perl

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PartiesApi;

my $api_instance = WWW::SwaggerClient::PartiesApi->new();
my $partyIdentifier = partyIdentifier_example; # String | The unique identifier of the Party.

eval {
    my $result = $api_instance->getPartyByPartyIdentifier(partyIdentifier => $partyIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PartiesApi->getPartyByPartyIdentifier: $@\n";
}

Python

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PartiesApi()
partyIdentifier = partyIdentifier_example # String | The unique identifier of the Party.

try:
    # Retrieve a specific Party entity.
    api_response = api_instance.get_party_by_party_identifier(partyIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PartiesApi->getPartyByPartyIdentifier: %s\n" % e)

Parameters

Path parameters

Name	Description
`party-identifier`*	String The unique identifier of the `Party`. Required

Responses

Status: 200 OK.
Status: 400 Bad Request.
Status: 401 Unauthorized.
Status: 403 Forbidden.
Status: 404 Not Found.
Status: 405 Method Not Allowed.

`People` API

Person

`getPeople`

Retrieve all People.

GET /people/

Usage and SDK Samples

Curl

curl -X GET "http://api.swindle.net/archetypes/v1/parties/people/"

Java

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PeopleApi;

import java.io.File;
import java.util.*;

public class PeopleApiExample {

    public static void main(String[] args) {

        PeopleApi apiInstance = new PeopleApi();
        try {
            array[Person_1] result = apiInstance.getPeople();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PeopleApi#getPeople");
            e.printStackTrace();
        }
    }
}

Android

import io.swagger.client.api.PeopleApi;

public class PeopleApiExample {

    public static void main(String[] args) {
        PeopleApi apiInstance = new PeopleApi();
        try {
            array[Person_1] result = apiInstance.getPeople();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PeopleApi#getPeople");
            e.printStackTrace();
        }
    }
}

ObjectiveC

PeopleApi *apiInstance = [[PeopleApi alloc] init];

// Retrieve all People.
[apiInstance getPeopleWithCompletionHandler:
              ^(array[Person_1] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

Node.js

var Party = require('party');

var api = new Party.PeopleApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPeople(callback);

CSharp

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPeopleExample
    {
        public void main()
        {

            var apiInstance = new PeopleApi();

            try
            {
                // Retrieve all People.
                array[Person_1] result = apiInstance.getPeople();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PeopleApi.getPeople: " + e.Message );
            }
        }
    }
}

PHP

getPeople();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PeopleApi->getPeople: ', $e->getMessage(), PHP_EOL;
}

Perl

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PeopleApi;

my $api_instance = WWW::SwaggerClient::PeopleApi->new();

eval {
    my $result = $api_instance->getPeople();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PeopleApi->getPeople: $@\n";
}

Python

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PeopleApi()

try:
    # Retrieve all People.
    api_response = api_instance.get_people()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PeopleApi->getPeople: %s\n" % e)

Parameters

None.

Responses

Status: 200 OK.
Status: 400 Bad Request.
Status: 401 Unauthorized.
Status: 403 Forbidden.
Status: 404 Not Found.
Status: 405 Method Not Allowed.

Person

`getPersonByPartyIdentifier`

Retrieve a Person by their unique identifier.

GET /people/{party-identifier}

Usage and SDK Samples

Curl

curl -X GET "http://api.swindle.net/archetypes/v1/parties/people/{party-identifier}"

Java

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PeopleApi;

import java.io.File;
import java.util.*;

public class PeopleApiExample {

    public static void main(String[] args) {

        PeopleApi apiInstance = new PeopleApi();
        String partyIdentifier = partyIdentifier_example; // String | The unique identifier associated with a Person.
        try {
            Person_1 result = apiInstance.getPersonByPartyIdentifier(partyIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PeopleApi#getPersonByPartyIdentifier");
            e.printStackTrace();
        }
    }
}

Android

import io.swagger.client.api.PeopleApi;

public class PeopleApiExample {

    public static void main(String[] args) {
        PeopleApi apiInstance = new PeopleApi();
        String partyIdentifier = partyIdentifier_example; // String | The unique identifier associated with a Person.
        try {
            Person_1 result = apiInstance.getPersonByPartyIdentifier(partyIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PeopleApi#getPersonByPartyIdentifier");
            e.printStackTrace();
        }
    }
}

ObjectiveC

String *partyIdentifier = partyIdentifier_example; // The unique identifier associated with a Person.

PeopleApi *apiInstance = [[PeopleApi alloc] init];

// Retrieve a specific Person entity.
[apiInstance getPersonByPartyIdentifierWith:partyIdentifier
              completionHandler: ^(Person_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

Node.js

var Party = require('party');

var api = new Party.PeopleApi()

var partyIdentifier = partyIdentifier_example; // {String} The unique identifier associated with a Person.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPersonByPartyIdentifier(partyIdentifier, callback);

CSharp

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPersonByPartyIdentifierExample
    {
        public void main()
        {

            var apiInstance = new PeopleApi();
            var partyIdentifier = partyIdentifier_example;  // String | The unique identifier associated with a Person.

            try
            {
                // Retrieve a specific Person entity.
                Person_1 result = apiInstance.getPersonByPartyIdentifier(partyIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PeopleApi.getPersonByPartyIdentifier: " + e.Message );
            }
        }
    }
}

PHP

getPersonByPartyIdentifier($partyIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PeopleApi->getPersonByPartyIdentifier: ', $e->getMessage(), PHP_EOL;
}

Perl

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PeopleApi;

my $api_instance = WWW::SwaggerClient::PeopleApi->new();
my $partyIdentifier = partyIdentifier_example; # String | The unique identifier associated with a Person.

eval {
    my $result = $api_instance->getPersonByPartyIdentifier(partyIdentifier => $partyIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PeopleApi->getPersonByPartyIdentifier: $@\n";
}

Python

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PeopleApi()
partyIdentifier = partyIdentifier_example # String | The unique identifier associated with a Person.

try:
    # Retrieve a specific Person entity.
    api_response = api_instance.get_person_by_party_identifier(partyIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PeopleApi->getPersonByPartyIdentifier: %s\n" % e)

Parameters

None.

Path parameters

Name	Description
`party-identifier`*	String The unique identifier associated with a Person. Required

Responses

Status: 200 OK.
Status: 400 Bad Request.
Status: 401 Unauthorized.
Status: 403 Forbidden.
Status: 404 Not Found.
Status: 405 Method Not Allowed.

`Preferences` API

Preference

`getPreferenceByUniqueIdentifier`

Retrieve a Preference by its unique identifier.

GET /preferences/{unique-identifier}

Usage and SDK Samples

Curl

curl -X GET "http://api.swindle.net/archetypes/v1/parties/preferences/{unique-identifier}"

Java

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PreferencesApi;

import java.io.File;
import java.util.*;

public class PreferencesApiExample {

    public static void main(String[] args) {

        PreferencesApi apiInstance = new PreferencesApi();
        String uniqueIdentifier = uniqueIdentifier_example; // String | The unique identifier associated with a Preference.
        try {
            _preferences result = apiInstance.getPreferenceByUniqueIdentifier(uniqueIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PreferencesApi#getPreferenceByUniqueIdentifier");
            e.printStackTrace();
        }
    }
}

Android

import io.swagger.client.api.PreferencesApi;

public class PreferencesApiExample {

    public static void main(String[] args) {
        PreferencesApi apiInstance = new PreferencesApi();
        String uniqueIdentifier = uniqueIdentifier_example; // String | The unique identifier associated with a Preference.
        try {
            _preferences result = apiInstance.getPreferenceByUniqueIdentifier(uniqueIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PreferencesApi#getPreferenceByUniqueIdentifier");
            e.printStackTrace();
        }
    }
}

ObjectiveC

String *uniqueIdentifier = uniqueIdentifier_example; // The unique identifier associated with a Preference.

PreferencesApi *apiInstance = [[PreferencesApi alloc] init];

// Retrieve a specific Preference.
[apiInstance getPreferenceByUniqueIdentifierWith:uniqueIdentifier
              completionHandler: ^(_preferences output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

Node.js

var Party = require('party');

var api = new Party.PreferencesApi()

var uniqueIdentifier = uniqueIdentifier_example; // {String} The unique identifier associated with a Preference.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPreferenceByUniqueIdentifier(uniqueIdentifier, callback);

CSharp

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPreferenceByUniqueIdentifierExample
    {
        public void main()
        {

            var apiInstance = new PreferencesApi();
            var uniqueIdentifier = uniqueIdentifier_example;  // String | The unique identifier associated with a Preference.

            try
            {
                // Retrieve a specific Preference.
                _preferences result = apiInstance.getPreferenceByUniqueIdentifier(uniqueIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PreferencesApi.getPreferenceByUniqueIdentifier: " + e.Message );
            }
        }
    }
}

PHP

getPreferenceByUniqueIdentifier($uniqueIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PreferencesApi->getPreferenceByUniqueIdentifier: ', $e->getMessage(), PHP_EOL;
}

Perl

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PreferencesApi;

my $api_instance = WWW::SwaggerClient::PreferencesApi->new();
my $uniqueIdentifier = uniqueIdentifier_example; # String | The unique identifier associated with a Preference.

eval {
    my $result = $api_instance->getPreferenceByUniqueIdentifier(uniqueIdentifier => $uniqueIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PreferencesApi->getPreferenceByUniqueIdentifier: $@\n";
}

Python

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PreferencesApi()
uniqueIdentifier = uniqueIdentifier_example # String | The unique identifier associated with a Preference.

try:
    # Retrieve a specific Preference.
    api_response = api_instance.get_preference_by_unique_identifier(uniqueIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PreferencesApi->getPreferenceByUniqueIdentifier: %s\n" % e)

Parameters

Path parameters

Name	Description
`unique-identifier`*	String The unique identifier associated with a `Preference`. Required

Responses

Status: 200 OK.
Status: 400 Bad Request.
Status: 401 Unauthorized.
Status: 403 Forbidden.
Status: 404 Not Found.
Status: 405 Method Not Allowed.

Preference

`getPreferences`

Retrieve all Preferences.

GET /preferences/

Usage and SDK Samples

Curl

curl -X GET "http://api.swindle.net/archetypes/v1/parties/preferences/"

Java

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PreferencesApi;

import java.io.File;
import java.util.*;

public class PreferencesApiExample {

    public static void main(String[] args) {

        PreferencesApi apiInstance = new PreferencesApi();
        try {
            array[_preferences] result = apiInstance.getPreferences();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PreferencesApi#getPreferences");
            e.printStackTrace();
        }
    }
}

Android

import io.swagger.client.api.PreferencesApi;

public class PreferencesApiExample {

    public static void main(String[] args) {
        PreferencesApi apiInstance = new PreferencesApi();
        try {
            array[_preferences] result = apiInstance.getPreferences();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PreferencesApi#getPreferences");
            e.printStackTrace();
        }
    }
}

ObjectiveC

PreferencesApi *apiInstance = [[PreferencesApi alloc] init];

// Retrieve all Preferences.
[apiInstance getPreferencesWithCompletionHandler:
              ^(array[_preferences] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

Node.js

var Party = require('party');

var api = new Party.PreferencesApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPreferences(callback);

CSharp

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPreferencesExample
    {
        public void main()
        {

            var apiInstance = new PreferencesApi();

            try
            {
                // Retrieve all Preferences.
                array[_preferences] result = apiInstance.getPreferences();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PreferencesApi.getPreferences: " + e.Message );
            }
        }
    }
}

PHP

getPreferences();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PreferencesApi->getPreferences: ', $e->getMessage(), PHP_EOL;
}

Perl

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PreferencesApi;

my $api_instance = WWW::SwaggerClient::PreferencesApi->new();

eval {
    my $result = $api_instance->getPreferences();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PreferencesApi->getPreferences: $@\n";
}

Python

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PreferencesApi()

try:
    # Retrieve all Preferences.
    api_response = api_instance.get_preferences()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PreferencesApi->getPreferences: %s\n" % e)

Parameters

None.

Responses

Status: 200 OK.
Status: 400 Bad Request.
Status: 401 Unauthorized.
Status: 403 Forbidden.
Status: 404 Not Found.
Status: 405 Method Not Allowed.

Report an issue.

Apache License 2.0

Generated 2017-08-29T02:23:40.011Z

This work is licensed under a Creative Commons Attribution 4.0 International License.

Graphic art by icons8.

Wiki Home

APIs and SDKs `(v1.0.0)`

Party: an identifiable, addressable entity that may have a legal status and that normally has autonomous control over (at least some of) its actions.
Money: represents an amount of a specific Currency.

Party SDK

Party API and SDK Documentation ⍟ v1.0.0

Table of contents

Standards compliance

Resources

Business archetypes defined

Explore other business archetype patterns

Organizations API

getOrganizationByPartyIdentifier

Usage and SDK Samples

Parameters

Responses

getOrganizations

Usage and SDK Samples

Parameters

Responses

Parties API

getParties

Usage and SDK Samples

Parameters

Responses

getPartyByPartyIdentifier

Usage and SDK Samples

Parameters

Responses

People API

getPeople

Usage and SDK Samples

Parameters

Responses

getPersonByPartyIdentifier

Usage and SDK Samples

Parameters

Responses

Preferences API

getPreferenceByUniqueIdentifier

Usage and SDK Samples

Parameters

Responses

getPreferences

Usage and SDK Samples

Parameters

Responses

Wiki Home

APIs and SDKs (v1.0.0)

Tools

References

Product delivery roadmap

Clone this wiki locally

`Party` API and SDK Documentation ⍟ v1.0.0

`Organizations` API

`getOrganizationByPartyIdentifier`

`getOrganizations`

`Parties` API

`getParties`

`getPartyByPartyIdentifier`

`People` API

`getPeople`

`getPersonByPartyIdentifier`

`Preferences` API

`getPreferenceByUniqueIdentifier`

`getPreferences`

APIs and SDKs `(v1.0.0)`