No match found

Introduction

This documentation contains information about how to authenticate with, and use the open API's provided by Byndle


BASE URL
Production:
https://api.byndle.no/
Sandbox:
https://apidev.byndle.no/

Authentication

needs to be used with all our api endpoints.


Create token

Send a GET request to the create token endpoint to receive a token that should be used on all other API endpoints. 

Use your credentials in the format of username:password in a header named Auth


TitleRequired?TypeDescription
TokenyesJSON ObjectThe response object will contain a property named token. This should be used in all subsequent requests to the API
Response attributes
Token REQUIRED / JSON Object
The response object will contain a property named token. This should be used in all subsequent requests to the API

The returned token should be added as a header to other API requests.


Header Value
AuthorizationBearer token

HEADER PARAMETERS

Content-Typestring

Responses

200
Object

Response attributes

tokenstring
userPermissionsarray
userobject
expiresstring
issuedstring
customerobject
anonymousAccessTokenstring
successfulLoginboolean
requires2FAboolean
maskedEmailobject
maskedPhoneobject
hasActiveSubcriptionboolean
GET
|
1
Response
{ "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMCIsImN1c3RvbWVySWQiOiIyMzYiLCJpc3N1ZWQiOiIwMy8wOS8yMDIyIDEyOjM5OjA3IiwiZXhwIjoxNjQ3NDMwNzQ3LCJpc3MiOiJwb3J0YWwuYnluZGxlLm5vIiwiYXVkIjoicG9ydGFsLmJ5bmRsZS5ubyIsInJvbGUiOiJTeXN0ZW1BZG1pbmlzdHJhdG9yIiwidWlkIjoxMH0.6ho1GDY-pZojVHId7wsEE2WL2qP0R4PxHTBRtKq-kSg", "userPermissions": "", "user": "", "expires": "2022-03-16T12:39:07.999437+01:00", "issued": "2022-03-09T12:39:08.0627748+01:00", "customer": "", "anonymousAccessToken": "-xRITCvCeaGo", "successfulLogin": "true", "requires2FA": "false", "maskedEmail": "", "maskedPhone": "", "hasActiveSubcription": "true" }

Lookup

The lookup feature enables you to do a 1-1 lookup of entries in our databases. The lookup feature contains information about persons and their relations, norwegian propertie3s, business information and vehicle information.


Person

Will return enriched person data based on matching of provided data


Request parameters


TitleRequired?TypeDescriptionMin LengthMax Length
firstnamenostringFirst and / or middle name(s)  
lastnamenostringLast name  
fullnamenostringFull name, can be used instead of first and last name  
addressyesstringStreetname plus number and letter (if available)  
birthdatenodateBirthdate in format yyyy-mm-dd  
postcodenostring   
Response attributes
firstname string
First and / or middle name(s)
lastname string
Last name
fullname string
Full name, can be used instead of first and last name
address REQUIRED / string
Streetname plus number and letter (if available)
birthdate date
Birthdate in format yyyy-mm-dd
postcode string
 

HEADER PARAMETERS

Content-Typestring

BODY PARAMETERS

Firstnamestring
Lastnamestring
Fullnamestring
Addressstring
Birthdatestring
Postcodestring

Responses

200
Object

Response attributes

idnumber
personMatchLevelnumber
first_namestring
last_namestring
full_namestring
person_numberobject
birth_datestring
genderstring
statusnumber
street_namestring
street_numbernumber
street_letterobject
dwelling_unitstring
post_codestring
post_placestring
agenumber
moved_datestring
reserved_contact_phoneboolean
reserved_contact_mailboolean
reserved_contact_hum_orgboolean
municipalitynumber
countynumber
ownership_statusnumber
externalIdobject
citizenshipCountryCodeobject
bornMuniOrCountryCodeobject
bornMuniOrCountryobject
bornPlaceobject
phonenumbernumber
reservationFilteredPhonesarray
child attributes
idnumber
phone_numbernumber
person_idnumber
business_idobject
is_reserved_catalogboolean
phonesobject
commentsobject
propertyobject
POST
|
1
Response
{ "id": "3809194", "personMatchLevel": "2", "first_name": "Ola", "last_name": "Nordmann", "full_name": "Ola Nordmann", "person_number": "", "birth_date": "1988-02-16T00:00:00", "gender": "M", "status": "1", "street_name": "Falkenborgvegen", "street_number": "17", "street_letter": "", "dwelling_unit": "H0407", "post_code": "7044", "post_place": "TRONDHEIM", "age": "34", "moved_date": "2020-02-01T00:00:00", "reserved_contact_phone": "true", "reserved_contact_mail": "true", "reserved_contact_hum_org": "true", "municipality": "5001", "county": "50", "ownership_status": "0", "externalId": "", "citizenshipCountryCode": "", "bornMuniOrCountryCode": "", "bornMuniOrCountry": "", "bornPlace": "", "phonenumber": "90183133", "reservationFilteredPhones": [ { "id": "61267761", "phone_number": "90183133", "person_id": "3809194", "business_id": "", "is_reserved_catalog": "false" } ], "phones": "", "comments": "", "property": "" }
HTTP status code summary

200 - OK

Everything worked as expected.

400 - Bad request

The request was unacceptable, often due to missing a required parameter.

401 - Unauthorized

The request was unacceptable, often due to missing a required parameter.

403 - Forbidden

The API key doesnt have permissions to perform the request.

404 - Not Found

The requested resource does not exist.

Person extended

Will return extended person data based on matching of provided input.
The provided endpoint will contain data from multiple registers


Request parameters


HEADER PARAMETERS

Content-Typestring

Responses

200
Object

Response attributes

idnumber
firstNamestring
lastNamestring
addressStreetNamestring
addressStreetNrnumber
addressStreetLetterobject
dwellingUnitstring
postCodestring
genderstring
ownesThisPropertyboolean
birthDatestring
reservedTMboolean
reservedDMboolean
reservedHumOrgboolean
propertiesarray
child attributes
idnumber
addressStreetNamestring
addressStreetNrnumber
addressStreetLetterstring
postCodestring
dwellingUnitstring
livesOnThisPropertyboolean
electricVehiclesarray
child attributes
idnumber
registrationPlatestring
makestring
modelstring
modelYearnumber
nextPKKstring
relationsarray
child attributes
idnumber
firstNamestring
lastNamestring
addressStreetNamestring
addressStreetNrnumber
addressStreetLetterobject
dwellingUnitstring
postCodestring
genderstring
ownesThisPropertyboolean
birthDatestring
reservedTMboolean
reservedDMboolean
reservedHumOrgboolean
propertiesarray
child attributes
idnumber
addressStreetNamestring
addressStreetNrnumber
addressStreetLetterstring
postCodestring
dwellingUnitstring
livesOnThisPropertyboolean
electricVehiclesarray
relationsarray
phonesarray
property_idnumber
phonesarray
child attributes
idnumber
phoneNumbernumber
property_idobject
POST
|
1
Response
{ "id": "4164063", "firstName": "Ola", "lastName": "Nordmann", "addressStreetName": "Einervegen", "addressStreetNr": "8", "addressStreetLetter": "", "dwellingUnit": "H0101", "postCode": "7059", "gender": "M", "ownesThisProperty": "true", "birthDate": "1983-11-16T00:00:00", "reservedTM": "true", "reservedDM": "true", "reservedHumOrg": "false", "properties": [ { "id": "91784362", "addressStreetName": "EINERVEGEN", "addressStreetNr": "8", "addressStreetLetter": "", "postCode": "7059", "dwellingUnit": "H0101", "livesOnThisProperty": "true" } ], "electricVehicles": [ { "id": "8456443", "registrationPlate": "EK12345", "make": "NISSAN", "model": "NISSAN LEAF 30kWh", "modelYear": "2017", "nextPKK": "2023-03-18T00:00:00" } ], "relations": [ { "id": "1757983", "firstName": "Kari", "lastName": "Nordmann", "addressStreetName": "Einervegen", "addressStreetNr": "8", "addressStreetLetter": "", "dwellingUnit": "H0101", "postCode": "7059", "gender": "F", "ownesThisProperty": "true", "birthDate": "1982-03-21T00:00:00", "reservedTM": "true", "reservedDM": "true", "reservedHumOrg": "false", "properties": [ { "id": "91784362", "addressStreetName": "EINERVEGEN", "addressStreetNr": "8", "addressStreetLetter": "", "postCode": "7059", "dwellingUnit": "H0101", "livesOnThisProperty": "true" } ], "electricVehicles": "", "relations": "", "phones": "", "property_id": "91784362" } ], "phones": [ { "id": "61267919", "phoneNumber": "99119911" } ], "property_id": "" }
HTTP status code summary

200 - OK

Everything worked as expected.

400 - Bad request

The request was unacceptable, often due to missing a required parameter.

401 - Unauthorized

The request was unacceptable, often due to missing a required parameter.

403 - Forbidden

The API key doesnt have permissions to perform the request.

404 - Not Found

The requested resource does not exist.

Person phones

Will return phone numbers of identified person based on provided data


Request parameters


HEADER PARAMETERS

Content-Typestring

Responses

200
Object

Response attributes

phoneNumbernumber
reservedTelemarketingboolean
reservedHumOrgboolean
reservedDMboolean
personMatchLevelnumber
POST
|
1
Response
[ { "phoneNumber": "99221122", "reservedTelemarketing": "true", "reservedHumOrg": "true", "reservedDM": "true", "personMatchLevel": "2" } ]
HTTP status code summary

200 - OK

Everything worked as expected.

400 - Bad request

The request was unacceptable, often due to missing a required parameter.

401 - Unauthorized

The request was unacceptable, often due to missing a required parameter.

403 - Forbidden

The API key doesnt have permissions to perform the request.

404 - Not Found

The requested resource does not exist.

Phone number

Will return person information based on owner of phone number


Request parameters


HEADER PARAMETERS

Content-Typestring

Responses

200
Object

Response attributes

Idnumber
First_namestring
Last_namestring
Agenumber
Birth_datestring
Street_namestring
Street_numbernumber
Street_letterstring
Dwelling_unitstring
Post_codenumber
Post_placestring
Genderstring
Reserved_contact_hum_orgboolean
Reserved_contact_mailboolean
Reserved_contact_phoneboolean
Deceasedboolean
GET
|
1
Response
{ "Id": "1", "First_name": "Ola", "Last_name": "Nordmann", "Age": "36", "Birth_date": "1982-05-17", "Street_name": "Olas gate", "Street_number": "3", "Street_letter": "B", "Dwelling_unit": "H0101", "Post_code": "7052", "Post_place": "Trondheim", "Gender": "M", "Reserved_contact_hum_org": "true", "Reserved_contact_mail": "false", "Reserved_contact_phone": "true", "Deceased": "false" }
HTTP status code summary

200 - OK

Everything worked as expected.

400 - Bad request

The request was unacceptable, often due to missing a required parameter.

401 - Unauthorized

The request was unacceptable, often due to missing a required parameter.

403 - Forbidden

The API key doesnt have permissions to perform the request.

404 - Not Found

The requested resource does not exist.

Phone number reservation

Will return reservation statuses of the person that is the owner of the phone number


Request parameters


HEADER PARAMETERS

Content-Typestring

Responses

200
Object

Response attributes

idnumber
reservedTMboolean
reservedDMboolean
reservedHMboolean
deceasedboolean
GET
|
1
Response
{ "id": "1", "reservedTM": "true", "reservedDM": "false", "reservedHM": "true", "deceased": "false" }
HTTP status code summary

200 - OK

Everything worked as expected.

400 - Bad request

The request was unacceptable, often due to missing a required parameter.

401 - Unauthorized

The request was unacceptable, often due to missing a required parameter.

403 - Forbidden

The API key doesnt have permissions to perform the request.

404 - Not Found

The requested resource does not exist.

Business

Will return enriched business data based on given organization number


Request parameters


Possible roles to include:


 
Bestyrende reder
Bobestyrer
Daglig leder/administrerende direktør
Deltaker med proratisk ansvar (delt ansvar)
Deltaker med solidarisk ansvar (fullt ansvarlig)
Forretningsfører
Innehaver
Komplementar
Kontaktperson
Nestleder
Norsk representant for utenlandsk enhet
Observatør
Regnskapsfører
Revisor
Styremedlem
Styrets leder
Varamedlem

HEADER PARAMETERS

Content-Typestring

Responses

200
Object

Response attributes

idnumber
namestring
org_numbernumber
umbrella_business_idobject
employee_countnumber
business_typestring
business_codestring
street_namestring
street_numbernumber
street_letterstring
post_codestring
post_placeobject
address_idnumber
established_datestring
registered_datestring
business_sector_codestring
postal_post_codestring
chief_executive_officerstring
chairmanstring
phone_numbernumber
mobile_numbernumber
urlstring
postal_addressstring
regimvastring
regifrstring
regiaastring
bankruptboolean
liquidationboolean
compulsaryLiquidationboolean
bankruptDateobject
businessPersonsarray
child attributes
idnumber
person_idnumber
business_idnumber
business_role_idnumber
business_role_namestring
person_id_match_levelnumber
personobject
child attributes
idnumber
personMatchLevelobject
first_namestring
last_namestring
full_namestring
person_numberobject
birth_datestring
genderstring
statusnumber
street_namestring
street_numbernumber
street_letterobject
dwelling_unitstring
post_codestring
post_placeobject
agenumber
moved_datestring
reserved_contact_phoneboolean
reserved_contact_mailboolean
reserved_contact_hum_orgboolean
municipalitynumber
countynumber
ownership_statusnumber
externalIdobject
citizenshipCountryCodeobject
bornMuniOrCountryCodeobject
bornMuniOrCountryobject
bornPlaceobject
phonenumbernumber
reservationFilteredPhonesarray
phonesobject
commentsobject
propertyobject
businessRolesBusinessesobject
shareOwnersobject
vehiclesobject
accountingobject
commentsobject
sysStartTimestring
sysEndTimestring
POST
|
1
Response
{ "id": "12330416", "name": "FJELLTOPP MEDIA AS", "org_number": "913074548", "umbrella_business_id": "", "employee_count": "3", "business_type": "AS", "business_code": "73.110", "street_name": "Beddingen", "street_number": "16", "street_letter": "", "post_code": "7042", "post_place": "", "address_id": "2367068", "established_date": "2014-01-01T00:00:00", "registered_date": "2014-01-14T00:00:00", "business_sector_code": "Private aksjeselskaper mv.", "postal_post_code": "7436", "chief_executive_officer": "Daniel Lauvli Storløs", "chairman": "Fredrik Bøe", "phone_number": "0", "mobile_number": "0", "url": "www.enevokontakt.no", "postal_address": "c/o Enevo AS Postboks 4267 Torgarden", "regimva": "J", "regifr": "J", "regiaa": "J", "bankrupt": "false", "liquidation": "false", "compulsaryLiquidation": "false", "bankruptDate": "", "businessPersons": [ { "id": "1431010006", "person_id": "952278", "business_id": "12330416", "business_role_id": "3", "business_role_name": "Daglig leder/administrerende direktør", "person_id_match_level": "2", "person": { "id": "952278", "personMatchLevel": "", "first_name": "Daniel Lauvli", "last_name": "Storløs", "full_name": "Daniel Lauvli Storløs", "person_number": "", "birth_date": "1986-12-30T00:00:00", "gender": "M", "status": "1", "street_name": "Skyåsvegen", "street_number": "84", "street_letter": "", "dwelling_unit": "H0101", "post_code": "7045", "post_place": "", "age": "35", "moved_date": "2018-12-02T00:00:00", "reserved_contact_phone": "true", "reserved_contact_mail": "true", "reserved_contact_hum_org": "true", "municipality": "5001", "county": "50", "ownership_status": "1", "externalId": "", "citizenshipCountryCode": "", "bornMuniOrCountryCode": "", "bornMuniOrCountry": "", "bornPlace": "", "phonenumber": "0", "reservationFilteredPhones": "", "phones": "", "comments": "", "property": "" } } ], "businessRolesBusinesses": "", "shareOwners": "", "vehicles": "", "accounting": "", "comments": "", "sysStartTime": "2022-03-17T02:03:33", "sysEndTime": "9999-12-31T23:59:59" }
HTTP status code summary

200 - OK

Everything worked as expected.

400 - Bad request

The request was unacceptable, often due to missing a required parameter.

401 - Unauthorized

The request was unacceptable, often due to missing a required parameter.

403 - Forbidden

The API key doesnt have permissions to perform the request.

404 - Not Found

The requested resource does not exist.

Vehicle

Will return vehicle and owner information based on search input


Request parameters


HEADER PARAMETERS

Content-Typestring

Responses

200
Object

Response attributes

registrationPlatestring
brandNamestring
brandModelstring
modelYearnumber
electricboolean
hybridCapabilitiesnumber
totalAllowedWeightnumber
carWeightnumber
firstRegisteringDatestring
firstRegistryInNorwaystring
ownerRegisteringDatestring
lastEUControlstring
nextEUControlstring
consumentPersonIdnumber
personFullNamestring
GET
|
1
Response
{ "registrationPlate": "EK29945", "brandName": "NISSAN", "brandModel": "NISSAN LEAF 30kWh", "modelYear": "2017", "electric": "true", "hybridCapabilities": "0", "totalAllowedWeight": "1970", "carWeight": "1450", "firstRegisteringDate": "2017-02-08", "firstRegistryInNorway": "2017-02-08", "ownerRegisteringDate": "2017-02-08", "lastEUControl": "2021-03-18", "nextEUControl": "2023-03-18", "consumentPersonId": "4164063", "personFullName": "Robin Johansen Holum" }
HTTP status code summary

200 - OK

Everything worked as expected.

400 - Bad request

The request was unacceptable, often due to missing a required parameter.

401 - Unauthorized

The request was unacceptable, often due to missing a required parameter.

403 - Forbidden

The API key doesnt have permissions to perform the request.

404 - Not Found

The requested resource does not exist.

Ajourhold

s are for maintaining your existing data. With ajourhold from Byndle you will always have correct and updated data on your customers.
The following documentation is ment for program integrations to add new entries, delete entries and to receive changes from our services.

An account and ajourhold needs to be configured for your account before you can start using these endpoints.

Byndle also provides ajourhold services with file deliveries over SFTP instead of API. Contact us for further information about this. 


Our data is updated every night, and changes will be notified via webhooks immediately after the updates are done.


Match levels

Byndle will match the data you provide us with our internal registers. Our matching follows 11 steps that are described below.
Any match level between 2 and 9 will result in us maintaining and updating data about the person. 


You can also use this match level to determine if you concider the match to be good enough to update your own registers.


Our matching routines uses SOUNDEX to allow some variations or misspelling in certain variables 


Match levelFirst nameLast nameStreetHouse numberPostal codeBirth date
Level 2RequiredRequiredFirst three letters must matchRequiredFirst 2 digits must matchRequired
Level 3RequiredRequiredFirst three letters must matchNot requiredFirst 2 digits must matchRequired
Level 4RequiredRequiredFirst three letters must matchRequiredAll 4 digits must matchNot required
Level 5RequiredRequiredFirst three letters must matchRequiredFirst 2 digits must matchNot required
Level 6RequiredRequiredNot requiredNot requiredFirst 2 digits mustt matchRequired
Level 7RequiredRequiredNot requiredNot requiredFirst 1 digit must matchRequired
Level 8RequiredRequiredNot requiredNot requiredNot requiredRequired
Level 9RequiredRequiredFirst three letters must matchNot requiredAll 4 digits must matchNot required
Level 10RequiredRequiredFirst three letters must matchNot requiredFirst 2 digits must matchNot required
Level 11RequiredRequiredNot requiredNot requiredFirst 2 digits must matchNot required
Level 12RequiredRequiredNot requiredNot requiredNot requiredRequired

Person statuses

idDescription
1Bosatt / Aktiv
2Utflyttet
3Utvandret
4Forsvunnet
5død
6Utgått fødselsnummer korrigret til nytt
7Fødselsregistrert
8Annulert tilgang
9Uregistrert person

Webhooks

With webhooks configured, Byndle will notify your system when changed occurs to any matched row in the ajourhold. 


can only be sent to SSL secured endpoints and accepts Basic Auth Credentials to be configured.


The different types of events that might be triggered on an ajourhold are:


EventNameDescription
reservedDm.changedChange in reservation against direct mail
reservedPhoneSale.changedChange in reservation against phone sales
reservedHumOrg.changedChange in reservation against humanitary organizations
buildingType.changedChange in the registered building type which the person lives or owns
mobNr.changedChange in cellphone number
telNr.changedChange in landline number
name.last.changedChange of last name
name.first.changedChange of first name
address.postNr.changedChange in registered postal code
address.dwellingNr.changedChange in registered dwlling unit
address.streetNr.changedChange in registered street nr
address.streetName.changedChange in registered street name
address.full.changedContains the full address when any address data is changed
sourceMatchLevel.changedChange in our match level
status.changedChange in person status. See description above
entry.removed 
entry.added 

Responses

200
Object

Response attributes

Eventstring
updatingServiceIdnumber
entryobject
child attributes
Idnumber
ConsumentPersonIdnumber
ExternalIdnumber
FirstNamestring
LastNamestring
PostNrstring
AddressStreetNamestring
AddressStreetNrnumber
AddressHouseLetterstring
DwellingNrstring
changeCountnumber
changesarray
child attributes
Eventstring
PreviousValuestring
NewValuestring
Response
{ "Event": "entry.changed", "updatingServiceId": "18", "entry": { "Id": "8165936", "ConsumentPersonId": "1977475", "ExternalId": "112443", "FirstName": "Petra", "LastName": "Petresen", "PostNr": "3550", "AddressStreetName": "NESVEGEN", "AddressStreetNr": "2", "AddressHouseLetter": "", "DwellingNr": "H0101" }, "changeCount": "11", "changes": [ { "Event": "sourceMatchLevel.changed", "PreviousValue": "2", "NewValue": "8" }, { "Event": "address.full.changed", "PreviousValue": "NESVEGEN 882", "NewValue": "SENTRUMSVEGEN 48 H0101" }, { "Event": "address.streetName.changed", "PreviousValue": "NESVEGEN", "NewValue": "SENTRUMSVEGEN" }, { "Event": "address.streetNr.changed", "PreviousValue": "882", "NewValue": "48" }, { "Event": "address.dwellingNr.changed", "PreviousValue": "", "NewValue": "H0101" }, { "Event": "address.postNr.changed", "PreviousValue": "5567", "NewValue": "3550" }, { "Event": "name.first.changed", "PreviousValue": "TestyMcTestFace", "NewValue": "Ingeborg Maria" }, { "Event": "name.last.changed", "PreviousValue": "Hillestad", "NewValue": "Thorkildsen" }, { "Event": "mobNr.changed", "PreviousValue": "1", "NewValue": "92689912" }, { "Event": "buildingType.changed", "PreviousValue": "", "NewValue": "Våningshus" }, { "Event": "reservedDm.changed", "PreviousValue": "True", "NewValue": "False" } ] }

Add person

For adding single new entries to an existing ajourhold. 


The person will be added regardless of matching in our database, since the record might yield a match later. 


The returned object will be the record with any changes performed by our data. 


Request parameters


HEADER PARAMETERS

Content-Typestring

Responses

200
Object

Response attributes

addedstring
addressStreetNamestring
agenumber
cellphonenumber
changedstring
consumentPersonIdnumber
countystring
dwellingNrstring
externalIdnumber
firstNamestring
genderstring
houseLetterstring
houseNumbernumber
idnumber
isReservedDMstring
isReservedHumOrgstring
isReservedTMstring
lastNamestring
municipalitystring
phonenumbernumber
phonesarray
child attributes
postNrstring
postalAreastring
sourceMatchLevelnumber
POST
|
1
Response
{ "added": "2022-03-01 14:43:29", "addressStreetName": "Nissevegen", "age": "27", "cellphone": "99991234", "changed": "2022-03-01 14:43:29", "consumentPersonId": "889330", "county": "Trøndelag", "dwellingNr": "H0101", "externalId": "48883", "firstName": "Ola", "gender": "M", "houseLetter": "", "houseNumber": "22", "id": "953093480", "isReservedDM": "Nei", "isReservedHumOrg": "Nei", "isReservedTM": "Nei", "lastName": "Nordmann", "municipality": "Trondheim", "phonenumber": "72221234", "phones": [ "99991234", "72221234" ], "postNr": "1337", "postalArea": "Solsiden", "sourceMatchLevel": "2" }
HTTP status code summary

200 - OK

Everything worked as expected.

400 - Bad request

The request was unacceptable, often due to missing a required parameter.

401 - Unauthorized

The request was unacceptable, often due to missing a required parameter.

403 - Forbidden

The API key doesnt have permissions to perform the request.

Remove person

Removing persons from ajourholds are done with DELETE requests to two different endpoints. 


To delete a person based on your own customer identifier (configured as externalId when adding the person):


DELETE https://api.byndle.no/v1/ajourhold/{ajourholdId}/entries/externalId/{externalId}


To delete a person based don the Byndle ID:


DELETE https://api.byndle.no/v1/ajourhold/{ajourholdId}/entries/byndleId/{externalId}


HEADER PARAMETERS

Content-Typestring
DELETE
|
1
HTTP status code summary

200 - OK

Everything worked as expected.

400 - Bad request

The request was unacceptable, often due to missing a required parameter.

401 - Unauthorized

The request was unacceptable, often due to missing a required parameter.

403 - Forbidden

The API key doesnt have permissions to perform the request.

404 - Not Found

The requested resource does not exist.

Get entries

Returns a paginated reply of all entries in the ajourhold 


Request parameters


HEADER PARAMETERS

Content-Typestring

Responses

200
Object

Response attributes

pagenumber
resultPerPagenumber
totalNumberOfPagesnumber
totalNumberOfResultsnumber
dataarray
child attributes
idnumber
addedstring
changedstring
externalIdnumber
consumentPersonIdnumber
sourceMatchLevelnumber
firstNamestring
lastNamestring
genderstring
agenumber
cellphonenumber
phonenumbernumber
phonesarray
child attributes
postNrstring
postalAreastring
municipalitystring
countystring
addressStreetNamestring
houseNumbernumber
houseLetterstring
dwellingNrstring
isReservedDMstring
isReservedHumOrgstring
isReservedTMstring
GET
|
1
Response
{ "page": "0", "resultPerPage": "1000", "totalNumberOfPages": "4", "totalNumberOfResults": "4236", "data": [ { "id": "953093480", "added": "2022-03-01 14:43:29", "changed": "2022-03-01 14:43:29", "externalId": "48883", "consumentPersonId": "889330", "sourceMatchLevel": "2", "firstName": "Ola", "lastName": "Nordmann", "gender": "M", "age": "27", "cellphone": "99991234", "phonenumber": "72221234", "phones": [ "99991234", "72221234" ], "postNr": "1337", "postalArea": "Solsiden", "municipality": "Trondheim", "county": "Trøndelag", "addressStreetName": "Nissevegen", "houseNumber": "22", "houseLetter": "", "dwellingNr": "H0101", "isReservedDM": "Nei", "isReservedHumOrg": "Nei", "isReservedTM": "Nei" } ] }
HTTP status code summary

200 - OK

Everything worked as expected.

400 - Bad request

The request was unacceptable, often due to missing a required parameter.

401 - Unauthorized

The request was unacceptable, often due to missing a required parameter.

Get changes

Returns paginated reply of all entries that has been changed since the input date parameter.


Request parameters


HEADER PARAMETERS

Content-Typestring

Responses

200
Object

Response attributes

pagenumber
resultPerPagenumber
totalNumberOfPagesnumber
totalNumberOfResultsnumber
dataarray
child attributes
idnumber
addedstring
changedstring
externalIdnumber
consumentPersonIdnumber
sourceMatchLevelnumber
firstNamestring
lastNamestring
genderstring
agenumber
cellphonenumber
phonenumbernumber
phonesarray
child attributes
postNrstring
postalAreastring
municipalitystring
countystring
addressStreetNamestring
houseNumbernumber
houseLetterstring
dwellingNrstring
isReservedDMstring
isReservedHumOrgstring
isReservedTMstring
GET
|
1
Response
{ "page": "0", "resultPerPage": "1000", "totalNumberOfPages": "4", "totalNumberOfResults": "4236", "data": [ { "id": "953093480", "added": "2022-03-01 14:43:29", "changed": "2022-03-01 14:43:29", "externalId": "48883", "consumentPersonId": "889330", "sourceMatchLevel": "2", "firstName": "Ola", "lastName": "Nordmann", "gender": "M", "age": "27", "cellphone": "99991234", "phonenumber": "72221234", "phones": [ "99991234", "72221234" ], "postNr": "1337", "postalArea": "Solsiden", "municipality": "Trondheim", "county": "Trøndelag", "addressStreetName": "Nissevegen", "houseNumber": "22", "houseLetter": "", "dwellingNr": "H0101", "isReservedDM": "Nei", "isReservedHumOrg": "Nei", "isReservedTM": "Nei" } ] }
HTTP status code summary

200 - OK

Everything worked as expected.

400 - Bad request

The request was unacceptable, often due to missing a required parameter.

401 - Unauthorized

The request was unacceptable, often due to missing a required parameter.