REST URLs¶
The default server URL for the NaMi is
Authentification¶
-
POST
/nami/auth/manual/sessionStartup
¶ Login
Query Parameters: - username (string) – The DPSG member id
- password (string) – Your password
-
GET
/nami/auth/logout
¶ Logout. Ends the current session.
Search members¶
List all group members though filtering by one value is possible
Parameters: - groupId (int) – A chosen group id (usually your Stammesnummer)
Query Parameters: - filterString (string) – The filter attribute (optional)
- searchString (string) – Search value. If the filter attribute refers to a date the format is
YYYY-mm-dd HH:MM:SS
. - page (int) – The page number of result display
- start (int) – Show search results form this index
- limit (int) – Show only up to this many entries
Response JSON Object: - success (boolean) – If everything was ok
- responseType (string) – NaMi response type: Can be
OK
,INFO
,WARN
,ERROR
,EXCEPTION
ornull
- totalEntries (int) – Number of returned members
- data (list) –
The search results. Each returned member is a list entry in the form of a json array.
See also
SearchMitgliedSchema
- JSON schema of the returned members
Status Codes: - 200 OK – No error
-
GET
/nami/search-multi/result-list
¶ Search members by multiple keys
Query Parameters: - searchedValues (string) – A json formatted string of all search values
- page (int) – The page number of result display
- start (int) – Show search results form this index
- limit (int) – Show only up to this many entries
Response JSON Object: - success (boolean) – If everything was ok
- responseType (string) – NaMi response type: Can be
OK
,INFO
,WARN
,ERROR
,EXCEPTION
ornull
- totalEntries (int) – Number of returned members
- data (list) –
The search results. Each returned member is a list entry in the form of a json array.
See also
SearchMitgliedSchema
- JSON schema of the returned members
Status Codes: - 200 OK – No error
Get a member by its id (not the DPSG Mitgliedsnummer)
Parameters: - groupId (int) – A chosen group id (usually your Stammesnummer)
- mglId (int) – Member id (not the DPSG Mitgliedsnummer)
Response JSON Object: - success (boolean) – If everything was ok
- responseType (string) – NaMi response type: Can be
OK
,INFO
,WARN
,ERROR
,EXCEPTION
ornull
- message (string) – Should be
null
. - title (string) – Should be
null
. - data (json) –
Contains all relevant information about the member
See also
MitgliedSchema
- JSON schema of the returned member
Status Codes: - 200 OK – No error
Update members¶
Update information about a member.
Parameters: - groupId (int) – A chosen group id (usually your Stammesnummer)
- mglId (int) – Member id (not the DPSG Mitgliedsnummer)
JSON Parameters: - beitragsArt (string) – Fee type
- beitragsArtId (id) – Id of the fee type
- eintrittsdatum – Begin of association (Format:
YYYY-mm-dd HH:MM:SS
) - email (string) – Primary email address
- emailVertretungsberechtigter (string) – Email address of an authorized representative.
- ersteTaetigkeit (string) – First activity. Defaults to
null
. - ersteUntergliederung (string) – First tier.
- fixBeitrag (string) – Defaults to
null
. - geburtsDatum (string) – Birth date (Format:
YYYY-mm-dd HH:MM:SS
) - genericField1 (string) – Not sure why these even exist.
- genericField1 – Not sure why these even exist.
- geschlecht (string) – Gender
- geschlechtId (int) – Corresponding id to the gender
- gruppierung (string) – Group name including its id
- gruppierungId (string) – Group id as a string
- id (int) – Member id
- jungpfadfinder (string) –
- konfession (string) – Confession
- confessionId (int) – Id corresopnding to the confession
- kontoverbindung (string) – JSON formatted string of the payment details
- land (string) – Country the member lives in
- landId (int) – Id corresponding to the address country
- mglType (string) – Member type
- nachname (string) – Surname
- nameZusatz (string) – Additional name
- ort (string) – Address city
- pfadfinder (string) –
- plz (string) – Postal code
- region (string) – Name of the address state
- regionId (int) – Id of the address state
- rover (string) –
- sonst01 (boolean) – Defaults to
false
. - sonst02 (boolean) – Defaults to
false
. - spitzname (string) – Nickname
- staatsangehoerigkeit (string) – Citizenship
- staatsangehoerigkeitId (string) – Id of the citizenship
- status (string) – If the member is active or inactive
- strasse (string) – Address street
- stufe (string) – Current tier of the member
- telefax (string) – Fax number
- telefon1 (string) – First telephone number
- telefon2 (string) – Second telephone number
- telefon3 (string) – Third telephone number
- version (int) – History version number
- vorname (string) – First name
- wiederverwendenFlag (boolean) – If the member data may be used after the membership ends
- woelfing (string) –
- zeitschriftenversand (boolean) – If the member gets the DPSG newspaper.
Response JSON Object: - success (boolean) – If everything was ok
- responseType (string) – NaMi response type: Can be
OK
,INFO
,WARN
,ERROR
,EXCEPTION
ornull
- message (string) – Should be
Update successful
. - title (string) – Should be
null
. - data (json) –
Contains all information about the updated member
See also
MitgliedSchema
- JSON schema of the returned member
Status Codes: - 200 OK – No error
Activities¶
Retrieve all activities of a member. There is also an option for filtering the results.
Parameters: - mglId (int) – Member id (not the DPSG Mitgliedsnummer)
Query Parameters: - page (int) – The page number of result display
- start (int) – Show search results form this index
- limit (int) – Show only up to this many entries
- filterString (string) – The filter attribute (optional)
- searchString (string) – Search value. If the filter attribute refers to a date the format is
YYYY-mm-dd HH:MM:SS
.
Response JSON Object: - success (boolean) – If everything was ok
- responseType (string) – NaMi response type: Can be
OK
,INFO
,WARN
,ERROR
,EXCEPTION
ornull
- totalEntries (int) – Number of returned members
- data (list) –
The search results. Each returned activity is a list entry in the form of a json array.
See also
SearchActivitySchema
- JSON schema of the returned activity
- metaData (json) – Additional information about the data fields but not on the activities themselves.
Status Codes: - 200 OK – No error
Get a single activity by its id.
Parameters: - mglId (int) – Member id (not the DPSG Mitgliedsnummer)
- actId (int) – Id of the desired activity
Response JSON Object: - success (boolean) – If everything was ok
- responseType (string) – NaMi response type: Can be
OK
,INFO
,WARN
,ERROR
,EXCEPTION
ornull
- message (string) – Should be
null
. - title (string) – Should be
null
. - data (json) –
Contains all relevant information about the activity.
See also
ActivitySchema
- JSON schema of the returned activity
Status Codes: - 200 OK – No error
Update an activity
Parameters: - mglId (int) – Member id (not the DPSG Mitgliedsnummer)
- actId (int) – Id of the desired activity
JSON Parameters: - aktivBis (string) – End date of the activity (Format:
YYYY-mm-dd HH:MM:SS
) - aktivVon (string) – Start date of the activity (Format:
YYYY-mm-dd HH:MM:SS
) - beitragsArtId (int) – Id of the fee type (default:
null
). It has not been observed to be anything else thannull
. - caeaGroup (string) – Access rights for the group.
- caeaGroupForGf (string) – Access rights for the sub group.
- caeaGroupId (int) – Corresponsing id for
caeaGroup
. - caeaGroupForGfId (int) – Corresponsing id for
caeaGroupForGf
. - gruppierung (string) – Group Name including its id.
- id (int) – Id of the activity.
- taetigkeit (string) – Type of the activity.
- untergliederung (string) – Department or tier the activity is assciated with.
Response JSON Object: - success (boolean) – If everything was ok
- responseType (string) – NaMi response type: Can be
OK
,INFO
,WARN
,ERROR
,EXCEPTION
ornull
- message (string) – Should be
Update successful
. - title (string) – Should be
null
. - data (json) –
Contains all information about the updated activity.
See also
ActivitySchema
- JSON schema of the returned activity
Status Codes: - 200 OK – No error
Default values¶
-
GET
/baseadmin/{key}/
¶ Get default values and their ids from the baseadmin database.
Parameters: - key (string) – Which type of values you want to get. Possible values are
geschlecht
,staatsangehoerigkeit
,konfession
,region
,land
andzahlungskondition
.
Query Parameters: - gruppierung (string) – Group id
- mitglied (string) – Member id (not the DPSG Mitgliedsnummer)
- page (int) – The page number of result display
- start (int) – Show search results form this index
- limit (int) – Show only up to this many entries
Response JSON Object: - success (boolean) – If everything was ok
- responseType (string) – NaMi response type: Can be
OK
,INFO
,WARN
,ERROR
,EXCEPTION
ornull
- totalEntries (int) – Number of returned members
- data (list) –
The search results. Each returned activity is a list entry in the form of a json array.
See also
BaseadminSchema
- JSON schema of the returned data
- metaData (json) – Additional information about the data fields but not on the data itself.
Status Codes: - 200 OK – No error
- key (string) – Which type of values you want to get. Possible values are
Dashboard¶
-
GET
/dashboard/notification-entries/flist
¶ Retrieve all recent notifications.
Query Parameters: - page (int) – The page number of result display
- start (int) – Show search results form this index
- limit (int) – Show only up to this many entries
- filterString (string) – The filter attribute (optional). So far only the value
interval
has been observed. - searchString (string) – Search value. If the filter attribute refers to a date the format is
YYYY-mm-dd HH:MM:SS
. For the filterStringinterval
use an integer to view the notifications of the specified number of weeks.
Response JSON Object: - success (boolean) – If everything was ok
- responseType (string) – NaMi response type: Can be
OK
,INFO
,WARN
,ERROR
,EXCEPTION
ornull
- totalEntries (int) – Number of returned members
- data (list) –
The search results. Each returned notification is a list entry in the form of a json array.
See also
NotificationSchema
- JSON schema of the returned notification
- metaData (json) – Additional information about the data fields but not on the activities themselves.
Status Codes: - 200 OK – No error
-
GET
/dashboard/history-entries/flist
¶ Retrieve all recent history entries.
Query Parameters: - page (int) – The page number of result display
- start (int) – Show search results form this index
- limit (int) – Show only up to this many entries
- filterString (string) – The filter attribute (optional). So far only the value
interval
has been observed. - searchString (string) – Search value. If the filter attribute refers to a date the format is
YYYY-mm-dd HH:MM:SS
. For the filterStringinterval
use an integer to view the history entries of the specified number of weeks.
Response JSON Object: - success (boolean) – If everything was ok
- responseType (string) – NaMi response type: Can be
OK
,INFO
,WARN
,ERROR
,EXCEPTION
ornull
- totalEntries (int) – Number of returned members
- data (list) –
The search results. Each returned history entry is a list entry in the form of a json array.
See also
HistoryEntrySchema
- JSON schema of the returned history entry
- metaData (json) – Additional information about the data fields but not on the activities themselves.
Status Codes: - 200 OK – No error
-
GET
/dashboard/stats/stats
¶ Get basic statistics about your group
Response JSON Object: - success (boolean) – If everything was ok
- responseType (string) – NaMi response type: Can be
OK
,INFO
,WARN
,ERROR
,EXCEPTION
ornull
- message (string) – Should be
null
. - title (string) – Should be
null
. - data (json) –
Contains the statistical data about your group
See also
StatsSchema
- JSON schema of the statistical data
Status Codes: - 200 OK – No error