{
"openapi": "3.0.2",
"info": {
"title": "CAMP 365 Connect your organisation API computerCamp/general/v1.0",
"version": "28.1.0.0",
"description": "Generated on 27-05-2026"
},
"servers": [
{
"url": "https://api.businesscentral.dynamics.com/v2.0/sandbox/api/computerCamp/general/v1.0"
},
{
"url": "https://api.businesscentral.dynamics.com/v2.0/production/api/computerCamp/general/v1.0"
}
],
"tags": [
{
"name": "altAddresses"
},
{
"name": "calculatedanniversaries"
},
{
"name": "codes1"
},
{
"name": "codes2"
},
{
"name": "collectionLines"
},
{
"name": "collections"
},
{
"name": "collectionSubscriptions"
},
{
"name": "committeeMembers"
},
{
"name": "committees"
},
{
"name": "committeeTypes"
},
{
"name": "communities"
},
{
"name": "communityMembers"
},
{
"name": "communityTypes"
},
{
"name": "dimensions"
},
{
"name": "educationInstitutes"
},
{
"name": "educations"
},
{
"name": "employmentTypes"
},
{
"name": "flowMembers"
},
{
"name": "functions"
},
{
"name": "jobEmployees"
},
{
"name": "jobQueues"
},
{
"name": "jobs"
},
{
"name": "localUnions"
},
{
"name": "memberCubes"
},
{
"name": "memberEducations"
},
{
"name": "memberGroups"
},
{
"name": "memberPayrollReports"
},
{
"name": "memberPriceGroups"
},
{
"name": "members"
},
{
"name": "onlinePayment"
},
{
"name": "passwords"
},
{
"name": "positions"
},
{
"name": "sentMails"
},
{
"name": "subscriptionMemberCubes"
},
{
"name": "subscriptionMembers"
},
{
"name": "subscriptionPrices"
},
{
"name": "taxonomies"
},
{
"name": "taxonomyCubes"
},
{
"name": "taxonomyMembers"
},
{
"name": "unionPosts"
},
{
"name": "unionPostTypes"
}
],
"security": [
{
"oAuth2ClientCredentials": [
"https://api.businesscentral.dynamics.com/.default"
]
},
{
"bearerAuth": []
}
],
"paths": {
"/altAddresses": {
"get": {
"description": "A list of alternative adresses
Permissions: Read and write
Returns: A list of alternative addresses
Conditions: None
Examples:
GET:
Complete list: {environment}/api/computerCamp/general/v1.0/companies({company})/altAddresses
POST:
To create a new address, call the service with
{
\"code\": \"TEST\",
\"memberNo\": \"MyCustomer\",
\"usage\": \"Collection\"
\"eMail\": \"test@some.where\"
}
PATCH:
To modify an existing address, use PATCH",
"summary": "Get entities from altAddresses",
"tags": [
"altAddresses"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"systemId desc",
"code",
"code desc",
"memberNo",
"memberNo desc",
"usage",
"usage desc",
"name",
"name desc",
"name2",
"name2 desc",
"address",
"address desc",
"address2",
"address2 desc",
"postCode",
"postCode desc",
"city",
"city desc",
"countryRegionCode",
"countryRegionCode desc",
"county",
"county desc",
"contact",
"contact desc",
"eMail",
"eMail desc",
"gln",
"gln desc",
"phoneNo",
"phoneNo desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"code",
"memberNo",
"usage",
"name",
"name2",
"address",
"address2",
"postCode",
"city",
"countryRegionCode",
"county",
"contact",
"eMail",
"gln",
"phoneNo"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"member"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of altAddress",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.altAddress"
}
}
}
}
}
}
}
}
},
"post": {
"summary": "Add new entity to altAddresses",
"tags": [
"altAddresses"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
}
],
"requestBody": {
"description": "New entity",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.altAddress-create"
}
}
}
},
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"201": {
"description": "Created entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.altAddress"
}
}
}
}
}
}
},
"/altAddresses({systemId})": {
"parameters": [
{
"description": "key: systemId",
"in": "path",
"name": "systemId",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
}
},
{
"$ref": "#/components/parameters/company"
}
],
"get": {
"summary": "Get entity from altAddresses by key",
"tags": [
"altAddresses"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"code",
"memberNo",
"usage",
"name",
"name2",
"address",
"address2",
"postCode",
"city",
"countryRegionCode",
"county",
"contact",
"eMail",
"gln",
"phoneNo"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"member"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.altAddress"
}
}
}
}
}
},
"patch": {
"summary": "Update entity in altAddresses",
"tags": [
"altAddresses"
],
"requestBody": {
"description": "New property values",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.altAddress-update"
}
}
}
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/error"
}
}
},
"delete": {
"summary": "Delete entity from altAddresses",
"tags": [
"altAddresses"
],
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/error"
}
}
}
},
"/calculatedanniversaries": {
"get": {
"description": "A list of anniversaries based on a calculation in the system.
Permissions: Read
Returns: A list of anniversaries on a given date
Conditions: None
Examples:
GET:
Complete list: {environment}/api/computerCamp/general/v1.0/companies({company})/calculatedanniversaries
A specific member: {environment}/api/computerCamp/general/v1.0/companies({company})/calculatedanniversaries?$filter = member eq '{memberNo}'
A specific year: {environment}/api/computerCamp/general/v1.0/companies({company})/calculatedanniversaries?$filter = year eq {year}",
"summary": "Get entities from calculatedanniversaries",
"tags": [
"calculatedanniversaries"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"member",
"member desc",
"anniversaryType",
"anniversaryType desc",
"anniversaryDate",
"anniversaryDate desc",
"year",
"year desc",
"education",
"education desc",
"employer",
"employer desc",
"name",
"name desc",
"dateOfCalculation",
"dateOfCalculation desc",
"localUnion",
"localUnion desc",
"educationDescription",
"educationDescription desc",
"employerName",
"employerName desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"member",
"anniversaryType",
"anniversaryDate",
"year",
"education",
"employer",
"name",
"dateOfCalculation",
"localUnion",
"educationDescription",
"employerName"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of calculatedanniversary",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.calculatedanniversary"
}
}
}
}
}
}
}
}
}
},
"/calculatedanniversaries('{member}',{anniversaryType},{anniversaryDate},{year},'{education}','{employer}')": {
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"description": "key: member",
"in": "path",
"name": "member",
"required": true,
"schema": {
"type": "string",
"maxLength": 20
}
},
{
"$ref": "#/components/parameters/company"
},
{
"description": "key: anniversaryType",
"in": "path",
"name": "anniversaryType",
"required": true,
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campAnniversary"
}
]
}
},
{
"$ref": "#/components/parameters/company"
},
{
"description": "key: anniversaryDate",
"in": "path",
"name": "anniversaryDate",
"required": true,
"schema": {
"format": "date",
"example": "2017-04-13",
"type": "string"
}
},
{
"$ref": "#/components/parameters/company"
},
{
"description": "key: year",
"in": "path",
"name": "year",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"$ref": "#/components/parameters/company"
},
{
"description": "key: education",
"in": "path",
"name": "education",
"required": true,
"schema": {
"type": "string",
"maxLength": 20
}
},
{
"$ref": "#/components/parameters/company"
},
{
"description": "key: employer",
"in": "path",
"name": "employer",
"required": true,
"schema": {
"type": "string",
"maxLength": 20
}
}
],
"get": {
"summary": "Get entity from calculatedanniversaries by key",
"tags": [
"calculatedanniversaries"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"member",
"anniversaryType",
"anniversaryDate",
"year",
"education",
"employer",
"name",
"dateOfCalculation",
"localUnion",
"educationDescription",
"employerName"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.calculatedanniversary"
}
}
}
}
}
}
},
"/codes1": {
"get": {
"description": "A list of code 1 entities
Permissions: Read and write
Returns: A list of code 1
Conditions: None
Examples:
GET:
Complete list: {environment}/api/computerCamp/general/v1.0/companies({company})/codes1
POST:
To create a new code, call the service with
{
\"code\": \"Test\",
\"description\": \"Dette er en test\"
}
PATCH:
To modify an existing code, use PATCH",
"summary": "Get entities from codes1",
"tags": [
"codes1"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"systemId desc",
"code",
"code desc",
"description",
"description desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"code",
"description"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of code1",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.code1"
}
}
}
}
}
}
}
}
},
"post": {
"summary": "Add new entity to codes1",
"tags": [
"codes1"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
}
],
"requestBody": {
"description": "New entity",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.code1-create"
}
}
}
},
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"201": {
"description": "Created entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.code1"
}
}
}
}
}
}
},
"/codes1({systemId})": {
"parameters": [
{
"description": "key: systemId",
"in": "path",
"name": "systemId",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
}
},
{
"$ref": "#/components/parameters/company"
}
],
"get": {
"summary": "Get entity from codes1 by key",
"tags": [
"codes1"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"code",
"description"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.code1"
}
}
}
}
}
},
"patch": {
"summary": "Update entity in codes1",
"tags": [
"codes1"
],
"requestBody": {
"description": "New property values",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.code1-update"
}
}
}
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/error"
}
}
},
"delete": {
"summary": "Delete entity from codes1",
"tags": [
"codes1"
],
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/error"
}
}
}
},
"/codes2": {
"get": {
"description": "A list of code 2 entities
Permissions: Read and write
Returns: A list of code 2
Conditions: None
Examples:
GET:
Complete list: {environment}/api/computerCamp/general/v1.0/companies({company})/codes2
POST:
To create a new code, call the service with
{
\"code\": \"Test\",
\"description\": \"Dette er en test\"
}
PATCH:
To modify an existing code, use PATCH",
"summary": "Get entities from codes2",
"tags": [
"codes2"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"systemId desc",
"code",
"code desc",
"description",
"description desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"code",
"description"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of code2",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.code2"
}
}
}
}
}
}
}
}
},
"post": {
"summary": "Add new entity to codes2",
"tags": [
"codes2"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
}
],
"requestBody": {
"description": "New entity",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.code2-create"
}
}
}
},
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"201": {
"description": "Created entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.code2"
}
}
}
}
}
}
},
"/codes2({systemId})": {
"parameters": [
{
"description": "key: systemId",
"in": "path",
"name": "systemId",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
}
},
{
"$ref": "#/components/parameters/company"
}
],
"get": {
"summary": "Get entity from codes2 by key",
"tags": [
"codes2"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"code",
"description"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.code2"
}
}
}
}
}
},
"patch": {
"summary": "Update entity in codes2",
"tags": [
"codes2"
],
"requestBody": {
"description": "New property values",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.code2-update"
}
}
}
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/error"
}
}
},
"delete": {
"summary": "Delete entity from codes2",
"tags": [
"codes2"
],
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/error"
}
}
}
},
"/collectionLines": {
"get": {
"description": "A list of collection line entities
Permissions: Read only
Returns: A list of collection lines
Conditions: None
Examples:
GET:
All collection lines: {environment}/api/computerCamp/general/v1.0/companies({company})/collectionLines
A specific collection line: {environment}/api/computerCamp/general/v1.0/companies({company})/collectionLines?$filter=systemId eq {systemId}
Lines for a collection: {environment}/api/computerCamp/general/v1.0/companies({company})/collectionLines?$filter=collectionNo eq '{collectionNo}'
Lines for a member: {environment}/api/computerCamp/general/v1.0/companies({company})/collectionLines?$filter=memberNo eq '{memberNo}'
Lines for a subscription: {environment}/api/computerCamp/general/v1.0/companies({company})/collectionLines?$filter=membersubscriptionId eq {membersubscriptionId}",
"summary": "Get entities from collectionLines",
"tags": [
"collectionLines"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"systemId desc",
"amountLCYIncludingVAT",
"amountLCYIncludingVAT desc",
"amountLCY",
"amountLCY desc",
"collectionNo",
"collectionNo desc",
"collectionFrequency",
"collectionFrequency desc",
"description",
"description desc",
"endingDate",
"endingDate desc",
"log",
"log desc",
"memberName",
"memberName desc",
"memberNo",
"memberNo desc",
"membersubscriptionId",
"membersubscriptionId desc",
"no",
"no desc",
"postAtPaymentFromSub",
"postAtPaymentFromSub desc",
"quantity",
"quantity desc",
"recalcOf",
"recalcOf desc",
"recalculatedOn",
"recalculatedOn desc",
"refundOf",
"refundOf desc",
"refundedOn",
"refundedOn desc",
"reportingDocumentationGrpNo",
"reportingDocumentationGrpNo desc",
"startingDate",
"startingDate desc",
"subscription",
"subscription desc",
"subscriptionPricegroup",
"subscriptionPricegroup desc",
"vat",
"vat desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"amountLCYIncludingVAT",
"amountLCY",
"collectionNo",
"collectionFrequency",
"description",
"endingDate",
"log",
"memberName",
"memberNo",
"membersubscriptionId",
"no",
"postAtPaymentFromSub",
"quantity",
"recalcOf",
"recalculatedOn",
"refundOf",
"refundedOn",
"reportingDocumentationGrpNo",
"startingDate",
"subscription",
"subscriptionPricegroup",
"vat"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"collection",
"member",
"subscriptionMember",
"collectionSubscription"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of collectionLine",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.collectionLine"
}
}
}
}
}
}
}
}
}
},
"/collectionLines({systemId})": {
"parameters": [
{
"description": "key: systemId",
"in": "path",
"name": "systemId",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
}
},
{
"$ref": "#/components/parameters/company"
}
],
"get": {
"summary": "Get entity from collectionLines by key",
"tags": [
"collectionLines"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"amountLCYIncludingVAT",
"amountLCY",
"collectionNo",
"collectionFrequency",
"description",
"endingDate",
"log",
"memberName",
"memberNo",
"membersubscriptionId",
"no",
"postAtPaymentFromSub",
"quantity",
"recalcOf",
"recalculatedOn",
"refundOf",
"refundedOn",
"reportingDocumentationGrpNo",
"startingDate",
"subscription",
"subscriptionPricegroup",
"vat"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"collection",
"member",
"subscriptionMember",
"collectionSubscription"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.collectionLine"
}
}
}
}
}
}
},
"/collections": {
"get": {
"description": "A list of collection header entities
Permissions: Read and write
Returns: A list of collections
Conditions: None
Examples:
GET:
All collections: {environment}/api/computerCamp/general/v1.0/companies({company})/collections
A specific collection: {environment}/api/computerCamp/general/v1.0/companies({company})/collections?$filter=collectionNo eq '{collectionNo}'
Collections for a member: {environment}/api/computerCamp/general/v1.0/companies({company})/collections?$filter=memberNo eq '{memberNo}'
PATCH:
To modify an existing collection, call the service with the systemId and the fields to update:
{environment}/api/computerCamp/general/v1.0/companies({company})/collections({systemId})
{
\"log\": \"Updated log entry\",
\"recalculate\": true
}",
"summary": "Get entities from collections",
"tags": [
"collections"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"systemId desc",
"amountLCY",
"amountLCY desc",
"amountLCYIncludingVAT",
"amountLCYIncludingVAT desc",
"batchNo",
"batchNo desc",
"collectionNo",
"collectionNo desc",
"collectionPeriod",
"collectionPeriod desc",
"collectionStatus",
"collectionStatus desc",
"documentNo",
"documentNo desc",
"donation",
"donation desc",
"dueDate",
"dueDate desc",
"glnNo",
"glnNo desc",
"invoiceDate",
"invoiceDate desc",
"invoiceMemberNo",
"invoiceMemberNo desc",
"invoiceAccountName",
"invoiceAccountName desc",
"invoiceNo",
"invoiceNo desc",
"log",
"log desc",
"memberNo",
"memberNo desc",
"memberName",
"memberName desc",
"oldBalance",
"oldBalance desc",
"paymentId",
"paymentId desc",
"paymentMethodCode",
"paymentMethodCode desc",
"paymentType",
"paymentType desc",
"postingDescription",
"postingDescription desc",
"recalculate",
"recalculate desc",
"recalcOf",
"recalcOf desc",
"recalculatedOn",
"recalculatedOn desc",
"refundOf",
"refundOf desc",
"refundedOn",
"refundedOn desc",
"typeOfCollection",
"typeOfCollection desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"amountLCY",
"amountLCYIncludingVAT",
"batchNo",
"collectionNo",
"collectionPeriod",
"collectionStatus",
"documentNo",
"donation",
"dueDate",
"glnNo",
"invoiceDate",
"invoiceMemberNo",
"invoiceAccountName",
"invoiceNo",
"log",
"memberNo",
"memberName",
"oldBalance",
"paymentId",
"paymentMethodCode",
"paymentType",
"postingDescription",
"recalculate",
"recalcOf",
"recalculatedOn",
"refundOf",
"refundedOn",
"typeOfCollection"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"collectionSubscription",
"member",
"collectionLines"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of collection",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.collection"
}
}
}
}
}
}
}
}
}
},
"/collections({systemId})": {
"parameters": [
{
"description": "key: systemId",
"in": "path",
"name": "systemId",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
}
},
{
"$ref": "#/components/parameters/company"
}
],
"get": {
"summary": "Get entity from collections by key",
"tags": [
"collections"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"amountLCY",
"amountLCYIncludingVAT",
"batchNo",
"collectionNo",
"collectionPeriod",
"collectionStatus",
"documentNo",
"donation",
"dueDate",
"glnNo",
"invoiceDate",
"invoiceMemberNo",
"invoiceAccountName",
"invoiceNo",
"log",
"memberNo",
"memberName",
"oldBalance",
"paymentId",
"paymentMethodCode",
"paymentType",
"postingDescription",
"recalculate",
"recalcOf",
"recalculatedOn",
"refundOf",
"refundedOn",
"typeOfCollection"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"collectionSubscription",
"member",
"collectionLines"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.collection"
}
}
}
}
}
},
"patch": {
"summary": "Update entity in collections",
"tags": [
"collections"
],
"requestBody": {
"description": "New property values",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.collection-update"
}
}
}
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/error"
}
}
}
},
"/collectionSubscriptions": {
"get": {
"description": "Used to display a list of subscriptions. Filters can be applied to one, several or no fields
Permissions: Read
Returns: A list of subscriptions
Conditions: None
Examples:
GET:
All subscriptions: {environment}/api/computerCamp/general/v1.0/companies({company})/collectionSubscriptions
A specific subscription from code: {environment}/api/computerCamp/general/v1.0/companies({company})/collectionSubscriptions?$filter=code eq '{code}'
All subscription which can be displayed on internet: {environment}/api/computerCamp/general/v1.0/companies({company})/collectionSubscriptions?$filter=displayOnInternet eq true",
"summary": "Get entities from collectionSubscriptions",
"tags": [
"collectionSubscriptions"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"systemId desc",
"code",
"code desc",
"description",
"description desc",
"internetDescription",
"internetDescription desc",
"subscriptionGroup",
"subscriptionGroup desc",
"displayOnInternet",
"displayOnInternet desc",
"welcomeLetter",
"welcomeLetter desc",
"sortingCode",
"sortingCode desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"code",
"description",
"internetDescription",
"subscriptionGroup",
"displayOnInternet",
"welcomeLetter",
"sortingCode"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of collectionSubscription",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.collectionSubscription"
}
}
}
}
}
}
}
}
}
},
"/collectionSubscriptions({systemId})": {
"parameters": [
{
"description": "key: systemId",
"in": "path",
"name": "systemId",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
}
},
{
"$ref": "#/components/parameters/company"
}
],
"get": {
"summary": "Get entity from collectionSubscriptions by key",
"tags": [
"collectionSubscriptions"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"code",
"description",
"internetDescription",
"subscriptionGroup",
"displayOnInternet",
"welcomeLetter",
"sortingCode"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.collectionSubscription"
}
}
}
}
}
}
},
"/committeeMembers": {
"get": {
"description": "Insert, update and delete a committee member. Filters can be applied to one, several or no fields
Permissions: Read and write
Returns: info about a committee member or a list of committee members
Conditions: None
Examples:
GET:
All committee members in a given committee: {environment}/api/computerCamp/general/v1.0/companies({company})/committeeMembers?$filter=committee eq '{committee}'
A specific committee member in a given committee: {environment}/api/computerCamp/general/v1.0/companies({company})/committeeMembers?$filter=committee eq '{committee}' and memberNo eq '{memberNo}'
POST:
create a committee member
{environment}/api/computerCamp/general/v1.0/companies({company})/committeeMembers
{
\"committee\": \"{committee}\",
\"memberNo\": \"{memberNo}\",
\"committeeFunction\": \"{committeeFunction}\",
\"startingDate\": \"2023-01-01\",
\"endingDate\": \"0001-01-01\",
\"priority\": \"\"
}",
"summary": "Get entities from committeeMembers",
"tags": [
"committeeMembers"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"systemId desc",
"committee",
"committee desc",
"memberNo",
"memberNo desc",
"committeeFunctionDescription",
"committeeFunctionDescription desc",
"committeeName",
"committeeName desc",
"memberEmail",
"memberEmail desc",
"note",
"note desc",
"committeeRefersTo",
"committeeRefersTo desc",
"startingDate",
"startingDate desc",
"endingDate",
"endingDate desc",
"committeeFunction",
"committeeFunction desc",
"memberName",
"memberName desc",
"memberPhoneNo",
"memberPhoneNo desc",
"memberMobilePhoneNo",
"memberMobilePhoneNo desc",
"localUnion",
"localUnion desc",
"priority",
"priority desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"committee",
"memberNo",
"committeeFunctionDescription",
"committeeName",
"memberEmail",
"note",
"committeeRefersTo",
"startingDate",
"endingDate",
"committeeFunction",
"memberName",
"memberPhoneNo",
"memberMobilePhoneNo",
"localUnion",
"priority"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"member",
"function"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of committeeMember",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.committeeMember"
}
}
}
}
}
}
}
}
},
"post": {
"summary": "Add new entity to committeeMembers",
"tags": [
"committeeMembers"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
}
],
"requestBody": {
"description": "New entity",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.committeeMember-create"
}
}
}
},
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"201": {
"description": "Created entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.committeeMember"
}
}
}
}
}
}
},
"/committeeMembers({systemId})": {
"parameters": [
{
"description": "key: systemId",
"in": "path",
"name": "systemId",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
}
},
{
"$ref": "#/components/parameters/company"
}
],
"get": {
"summary": "Get entity from committeeMembers by key",
"tags": [
"committeeMembers"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"committee",
"memberNo",
"committeeFunctionDescription",
"committeeName",
"memberEmail",
"note",
"committeeRefersTo",
"startingDate",
"endingDate",
"committeeFunction",
"memberName",
"memberPhoneNo",
"memberMobilePhoneNo",
"localUnion",
"priority"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"member",
"function"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.committeeMember"
}
}
}
}
}
},
"patch": {
"summary": "Update entity in committeeMembers",
"tags": [
"committeeMembers"
],
"requestBody": {
"description": "New property values",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.committeeMember-update"
}
}
}
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/error"
}
}
},
"delete": {
"summary": "Delete entity from committeeMembers",
"tags": [
"committeeMembers"
],
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/error"
}
}
}
},
"/committees": {
"get": {
"description": "Permissions: Read
Returns: Info for the selected committees
Conditions: \"Displayed on internet\" must be checked.
Examples:
GET:
All committees: {environment}/api/computerCamp/general/v1.0/companies({company})/committees
A specific committee: {environment}/api/computerCamp/general/v1.0/companies({company})/committees?$filter=code eq '{committeeCode}'
",
"summary": "Get entities from committees",
"tags": [
"committees"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"code",
"code desc",
"systemId",
"systemId desc",
"caseWorker",
"caseWorker desc",
"closed",
"closed desc",
"committeeType",
"committeeType desc",
"committeeTypeDescription",
"committeeTypeDescription desc",
"displayOnInternet",
"displayOnInternet desc",
"electionDate",
"electionDate desc",
"endingDate",
"endingDate desc",
"fullName",
"fullName desc",
"localUnion",
"localUnion desc",
"localUnionDescription",
"localUnionDescription desc",
"name",
"name desc",
"postingMember",
"postingMember desc",
"referringTo",
"referringTo desc",
"referringToName",
"referringToName desc",
"region",
"region desc",
"regionName",
"regionName desc",
"report",
"report desc",
"secretary",
"secretary desc",
"startingDate",
"startingDate desc",
"hasTaxonomy",
"hasTaxonomy desc",
"taxonomyFilter",
"taxonomyFilter desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"code",
"systemId",
"caseWorker",
"closed",
"committeeType",
"committeeTypeDescription",
"displayOnInternet",
"electionDate",
"endingDate",
"fullName",
"localUnion",
"localUnionDescription",
"name",
"postingMember",
"referringTo",
"referringToName",
"region",
"regionName",
"report",
"secretary",
"startingDate",
"hasTaxonomy",
"taxonomyFilter"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"member",
"taxonomy"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of committee",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.committee"
}
}
}
}
}
}
}
}
}
},
"/committees('{code}')": {
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"description": "key: code",
"in": "path",
"name": "code",
"required": true,
"schema": {
"type": "string",
"maxLength": 10
}
}
],
"get": {
"summary": "Get entity from committees by key",
"tags": [
"committees"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"code",
"systemId",
"caseWorker",
"closed",
"committeeType",
"committeeTypeDescription",
"displayOnInternet",
"electionDate",
"endingDate",
"fullName",
"localUnion",
"localUnionDescription",
"name",
"postingMember",
"referringTo",
"referringToName",
"region",
"regionName",
"report",
"secretary",
"startingDate",
"hasTaxonomy",
"taxonomyFilter"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"member",
"taxonomy"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.committee"
}
}
}
}
}
}
},
"/committeeTypes": {
"get": {
"description": "Used to display a list of committee types. Filters can be applied to one, several or no fields
Permissions: Read
Returns: A list of committee types
Conditions: None
Examples:
GET:
All committee types: {environment}/api/computerCamp/general/v1.0/companies({company})/committeeTypes
A specific committee type from code: {environment}/api/computerCamp/general/v1.0/companies({company})/committeeTypes?$filter=code eq '{code}'",
"summary": "Get entities from committeeTypes",
"tags": [
"committeeTypes"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"code",
"code desc",
"systemId",
"systemId desc",
"description",
"description desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"code",
"systemId",
"description"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of committeeType",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.committeeType"
}
}
}
}
}
}
}
}
}
},
"/committeeTypes('{code}')": {
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"description": "key: code",
"in": "path",
"name": "code",
"required": true,
"schema": {
"type": "string",
"maxLength": 10
}
}
],
"get": {
"summary": "Get entity from committeeTypes by key",
"tags": [
"committeeTypes"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"code",
"systemId",
"description"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.committeeType"
}
}
}
}
}
}
},
"/communities": {
"get": {
"description": "Used to display a list of communities. Filters can be applied to one, several or no fields
Permissions: Read and write
Returns: A list of communities
Conditions: None
Examples:
GET:
All communities: {environment}/api/computerCamp/general/v1.0/companies({company})/communities
A specific community from code: {environment}/api/computerCamp/general/v1.0/companies({company})/communities?$filter=code eq '{code}'
POST:
create a community
{environment}/api/computerCamp/general/v1.0/companies({company})/communities
{
\"code\": \"{communityCode}\",
\"name\": \"{name}\",
\"startingDate\": \"2023-01-01\",
\"endingDate\": \"0001-01-01\"
}",
"summary": "Get entities from communities",
"tags": [
"communities"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"systemId desc",
"code",
"code desc",
"name",
"name desc",
"accessType",
"accessType desc",
"startingDate",
"startingDate desc",
"endingDate",
"endingDate desc",
"type",
"type desc",
"shownOnInternet",
"shownOnInternet desc",
"description",
"description desc",
"teamsURL",
"teamsURL desc",
"createInTeams",
"createInTeams desc",
"teamsActive",
"teamsActive desc",
"teamsTemplate",
"teamsTemplate desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"code",
"name",
"accessType",
"startingDate",
"endingDate",
"type",
"shownOnInternet",
"description",
"teamsURL",
"createInTeams",
"teamsActive",
"teamsTemplate"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"communityType"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of community",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.community"
}
}
}
}
}
}
}
}
},
"post": {
"summary": "Add new entity to communities",
"tags": [
"communities"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
}
],
"requestBody": {
"description": "New entity",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.community-create"
}
}
}
},
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"201": {
"description": "Created entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.community"
}
}
}
}
}
}
},
"/communities({systemId})": {
"parameters": [
{
"description": "key: systemId",
"in": "path",
"name": "systemId",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
}
},
{
"$ref": "#/components/parameters/company"
}
],
"get": {
"summary": "Get entity from communities by key",
"tags": [
"communities"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"code",
"name",
"accessType",
"startingDate",
"endingDate",
"type",
"shownOnInternet",
"description",
"teamsURL",
"createInTeams",
"teamsActive",
"teamsTemplate"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"communityType"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.community"
}
}
}
}
}
},
"patch": {
"summary": "Update entity in communities",
"tags": [
"communities"
],
"requestBody": {
"description": "New property values",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.community-update"
}
}
}
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/error"
}
}
},
"delete": {
"summary": "Delete entity from communities",
"tags": [
"communities"
],
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/error"
}
}
}
},
"/communityMembers": {
"get": {
"description": "Insert, update and delete a community member. Filters can be applied to one, several or no fields
Permissions: Read and write
Returns: info about a community member or a list of community members
Conditions: None
Examples:
GET:
All community members in a given community: {environment}/api/computerCamp/general/v1.0/companies({company})/communityMembers?$filter=communityCode eq '{communityCode}'
A specific community member in a given community: {environment}/api/computerCamp/general/v1.0/companies({company})/communityMembers?$filter=communityCode eq '{communityCode}' and memberNo eq '{memberNo}'
POST:
create a community member
{environment}/api/computerCamp/general/v1.0/companies({company})/communityMembers
{
\"communityCode\": \"{communityCode}\",
\"memberNo\": \"{memberNo}\",
\"startingDate\": \"2023-01-01\",
\"endingDate\": \"0001-01-01\"
}",
"summary": "Get entities from communityMembers",
"tags": [
"communityMembers"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"systemId desc",
"communityCode",
"communityCode desc",
"memberNo",
"memberNo desc",
"startingDate",
"startingDate desc",
"endingDate",
"endingDate desc",
"communityName",
"communityName desc",
"communityAccessType",
"communityAccessType desc",
"teamsEmail",
"teamsEmail desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"communityCode",
"memberNo",
"startingDate",
"endingDate",
"communityName",
"communityAccessType",
"teamsEmail"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"community",
"member"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of communityMember",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.communityMember"
}
}
}
}
}
}
}
}
},
"post": {
"summary": "Add new entity to communityMembers",
"tags": [
"communityMembers"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
}
],
"requestBody": {
"description": "New entity",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.communityMember-create"
}
}
}
},
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"201": {
"description": "Created entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.communityMember"
}
}
}
}
}
}
},
"/communityMembers({systemId})": {
"parameters": [
{
"description": "key: systemId",
"in": "path",
"name": "systemId",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
}
},
{
"$ref": "#/components/parameters/company"
}
],
"get": {
"summary": "Get entity from communityMembers by key",
"tags": [
"communityMembers"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"communityCode",
"memberNo",
"startingDate",
"endingDate",
"communityName",
"communityAccessType",
"teamsEmail"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"community",
"member"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.communityMember"
}
}
}
}
}
},
"patch": {
"summary": "Update entity in communityMembers",
"tags": [
"communityMembers"
],
"requestBody": {
"description": "New property values",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.communityMember-update"
}
}
}
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/error"
}
}
},
"delete": {
"summary": "Delete entity from communityMembers",
"tags": [
"communityMembers"
],
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/error"
}
}
}
},
"/communityTypes": {
"get": {
"description": "Insert, update and delete a community type. Filters can be applied to one, several or no fields
Permissions: Read and write
Returns: A list of community types
Conditions: None
Examples:
GET:
All community types: {environment}/api/computerCamp/general/v1.0/companies({company})/communityTypes
A specific community from code: {environment}/api/computerCamp/general/v1.0/companies({company})/communities?$filter=code eq '{code}'
POST:
{environment}/api/computerCamp/general/v1.0/companies({company})/communityTypes
{
\"code\": \"{myCommunity}\",
\"description\": \"{description of my community}\"
}",
"summary": "Get entities from communityTypes",
"tags": [
"communityTypes"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"systemId desc",
"code",
"code desc",
"description",
"description desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"code",
"description"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of communityType",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.communityType"
}
}
}
}
}
}
}
}
},
"post": {
"summary": "Add new entity to communityTypes",
"tags": [
"communityTypes"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
}
],
"requestBody": {
"description": "New entity",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.communityType-create"
}
}
}
},
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"201": {
"description": "Created entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.communityType"
}
}
}
}
}
}
},
"/communityTypes({systemId})": {
"parameters": [
{
"description": "key: systemId",
"in": "path",
"name": "systemId",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
}
},
{
"$ref": "#/components/parameters/company"
}
],
"get": {
"summary": "Get entity from communityTypes by key",
"tags": [
"communityTypes"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"code",
"description"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.communityType"
}
}
}
}
}
},
"patch": {
"summary": "Update entity in communityTypes",
"tags": [
"communityTypes"
],
"requestBody": {
"description": "New property values",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.communityType-update"
}
}
}
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/error"
}
}
},
"delete": {
"summary": "Delete entity from communityTypes",
"tags": [
"communityTypes"
],
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/error"
}
}
}
},
"/dimensions": {
"get": {
"description": "Used to display a list of dimensions. Filters can be applied to one, several or no fields
DimensionCode is the type of dimension
Permissions: Read
Returns: Info for the selected dimensions
Conditions: None
Examples:
GET:
All dimensions: {environment}/api/computerCamp/general/v1.0/companies({company})/dimensions
A specific dimension: {environment}/api/computerCamp/general/v1.0/companies({company})/dimensions?$filter=code eq '{code}' and dimensionCode eq '{dimensionCode}'
",
"summary": "Get entities from dimensions",
"tags": [
"dimensions"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"dimensionCode",
"dimensionCode desc",
"code",
"code desc",
"blocked",
"blocked desc",
"globalDimensionNo",
"globalDimensionNo desc",
"name",
"name desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"dimensionCode",
"code",
"blocked",
"globalDimensionNo",
"name"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of dimension",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.dimension"
}
}
}
}
}
}
}
}
}
},
"/dimensions('{dimensionCode}','{code}')": {
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"description": "key: dimensionCode",
"in": "path",
"name": "dimensionCode",
"required": true,
"schema": {
"type": "string",
"maxLength": 20
}
},
{
"$ref": "#/components/parameters/company"
},
{
"description": "key: code",
"in": "path",
"name": "code",
"required": true,
"schema": {
"type": "string",
"maxLength": 20
}
}
],
"get": {
"summary": "Get entity from dimensions by key",
"tags": [
"dimensions"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"dimensionCode",
"code",
"blocked",
"globalDimensionNo",
"name"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.dimension"
}
}
}
}
}
}
},
"/educationInstitutes": {
"get": {
"description": "Used to display a list of education institutes. Filters can be applied to one, several or no fields
Permissions: Read
Returns: A list of education institutes
Conditions: None
Examples:
GET:
All education institutes: {environment}/api/computerCamp/general/v1.0/companies({company})/educationInstitutes
A specific education institute from code: {environment}/api/computerCamp/general/v1.0/companies({company})/educationInstitutes?$filter=code eq '{code}'",
"summary": "Get entities from educationInstitutes",
"tags": [
"educationInstitutes"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"code",
"code desc",
"systemId",
"systemId desc",
"description",
"description desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"code",
"systemId",
"description"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of educationInstitute",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.educationInstitute"
}
}
}
}
}
}
}
}
}
},
"/educationInstitutes('{code}')": {
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"description": "key: code",
"in": "path",
"name": "code",
"required": true,
"schema": {
"type": "string",
"maxLength": 20
}
}
],
"get": {
"summary": "Get entity from educationInstitutes by key",
"tags": [
"educationInstitutes"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"code",
"systemId",
"description"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.educationInstitute"
}
}
}
}
}
}
},
"/educations": {
"get": {
"description": "Used to display a list of educations. Filters can be applied to one, several or no fields
Permissions: Read
Returns: A list of educations
Conditions: None
Examples:
GET:
All educations: {environment}/api/computerCamp/general/v1.0/companies({company})/educations
A specific education from code: {environment}/api/computerCamp/general/v1.0/companies({company})/educations?$filter=code eq '{code}'",
"summary": "Get entities from educations",
"tags": [
"educations"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"code",
"code desc",
"systemId",
"systemId desc",
"description",
"description desc",
"semesterCalculation",
"semesterCalculation desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"code",
"systemId",
"description",
"semesterCalculation"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of education",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.education"
}
}
}
}
}
}
}
}
}
},
"/educations('{code}')": {
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"description": "key: code",
"in": "path",
"name": "code",
"required": true,
"schema": {
"type": "string",
"maxLength": 20
}
}
],
"get": {
"summary": "Get entity from educations by key",
"tags": [
"educations"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"code",
"systemId",
"description",
"semesterCalculation"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.education"
}
}
}
}
}
}
},
"/employmentTypes": {
"get": {
"description": "A list of employment type entities
Permissions: Read and write
Returns: A list of employment types
Conditions: None
Examples:
GET:
Complete list: {environment}/api/computerCamp/general/v1.0/companies({company})/employmentTypes
POST:
To create a new employment type, call the service with
{
\"code\": \"Test\",
\"description\": \"Dette er en test\"
}
PATCH:
To modify an existing employment type, use PATCH",
"summary": "Get entities from employmentTypes",
"tags": [
"employmentTypes"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"systemId desc",
"code",
"code desc",
"description",
"description desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"code",
"description"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of employmentType",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.employmentType"
}
}
}
}
}
}
}
}
}
},
"/employmentTypes({systemId})": {
"parameters": [
{
"description": "key: systemId",
"in": "path",
"name": "systemId",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
}
},
{
"$ref": "#/components/parameters/company"
}
],
"get": {
"summary": "Get entity from employmentTypes by key",
"tags": [
"employmentTypes"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"code",
"description"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.employmentType"
}
}
}
}
}
}
},
"/flowMembers": {
"get": {
"description": "A list of mail flow types cross joined with members
Permissions: Read
Returns: A list of mail flow types for each member and the date the flow was run
Conditions: None
Examples:
GET:
Complete list: {environment}/api/computerCamp/general/v1.0/companies({company})/flowMembers
List of members that has never received a specified mail: {environment}/api/computerCamp/general/v1.0/companies({company})/flowMembers?$filter=code eq '{MailCode}' and date eq 0001-01-01",
"summary": "Get entities from flowMembers",
"tags": [
"flowMembers"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"code",
"code desc",
"memberNo",
"memberNo desc",
"name",
"name desc",
"creationDate",
"creationDate desc",
"withdrawalDate",
"withdrawalDate desc",
"eMail",
"eMail desc",
"customerSystemId",
"customerSystemId desc",
"date",
"date desc",
"systemId",
"systemId desc",
"creationDateEqualsDate",
"creationDateEqualsDate desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"code",
"memberNo",
"name",
"creationDate",
"withdrawalDate",
"eMail",
"customerSystemId",
"date",
"systemId",
"creationDateEqualsDate"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of flowMember",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.flowMember"
}
}
}
}
}
}
}
}
}
},
"/flowMembers('{code}','{memberNo}')": {
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"description": "key: code",
"in": "path",
"name": "code",
"required": true,
"schema": {
"type": "string",
"maxLength": 10
}
},
{
"$ref": "#/components/parameters/company"
},
{
"description": "key: memberNo",
"in": "path",
"name": "memberNo",
"required": true,
"schema": {
"type": "string",
"maxLength": 20
}
}
],
"get": {
"summary": "Get entity from flowMembers by key",
"tags": [
"flowMembers"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"code",
"memberNo",
"name",
"creationDate",
"withdrawalDate",
"eMail",
"customerSystemId",
"date",
"systemId",
"creationDateEqualsDate"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.flowMember"
}
}
}
}
}
}
},
"/functions": {
"get": {
"description": "Permissions: Read
Returns: Info for the selected committee functions
Conditions: None
Examples:
GET:
All committeefunctions: {environment}/api/computerCamp/general/v1.0/companies({company})/functions
A specific committeefunction: {environment}/api/computerCamp/general/v1.0/companies({company})/functions?$filter=code eq '{committeeFunctionCode}'
",
"summary": "Get entities from functions",
"tags": [
"functions"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"code",
"code desc",
"systemId",
"systemId desc",
"description",
"description desc",
"chairman",
"chairman desc",
"treasurer",
"treasurer desc",
"unique",
"unique desc",
"eventAdmin",
"eventAdmin desc",
"eventSecretary",
"eventSecretary desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"code",
"systemId",
"description",
"chairman",
"treasurer",
"unique",
"eventAdmin",
"eventSecretary"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of function",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.function"
}
}
}
}
}
}
}
}
}
},
"/functions('{code}')": {
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"description": "key: code",
"in": "path",
"name": "code",
"required": true,
"schema": {
"type": "string",
"maxLength": 10
}
}
],
"get": {
"summary": "Get entity from functions by key",
"tags": [
"functions"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"code",
"systemId",
"description",
"chairman",
"treasurer",
"unique",
"eventAdmin",
"eventSecretary"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.function"
}
}
}
}
}
}
},
"/jobEmployees": {
"get": {
"description": "Read member employees. Filters can be applied to one, several or no fields
Permissions: Read
Returns: info about the members working for the same employer or the employments of a specific member
Conditions: None
Examples:
GET:
All employees for a given employer: {environment}/api/computerCamp/general/v1.0/companies({company})/jobs?$filter=employerMemberNo eq '{employerMemberNo}'
",
"summary": "Get entities from jobEmployees",
"tags": [
"jobEmployees"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"systemId desc",
"employeeMemberNo",
"employeeMemberNo desc",
"employeeName",
"employeeName desc",
"employeeMemberGroup",
"employeeMemberGroup desc",
"employeeMemberGroupDesc",
"employeeMemberGroupDesc desc",
"employeeAddress",
"employeeAddress desc",
"employeePostCode",
"employeePostCode desc",
"employeeCity",
"employeeCity desc",
"employeeCountry",
"employeeCountry desc",
"employerMemberNo",
"employerMemberNo desc",
"employerName",
"employerName desc",
"employerMemberGroup",
"employerMemberGroup desc",
"employerMemberGroupDesc",
"employerMemberGroupDesc desc",
"startingDate",
"startingDate desc",
"endingDate",
"endingDate desc",
"isMainJob",
"isMainJob desc",
"position",
"position desc",
"extentOfEmployment",
"extentOfEmployment desc",
"employmentType",
"employmentType desc",
"eMail",
"eMail desc",
"mobilePhoneNo",
"mobilePhoneNo desc",
"phoneNo",
"phoneNo desc",
"internetResponsible",
"internetResponsible desc",
"jobNo",
"jobNo desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"employeeMemberNo",
"employeeName",
"employeeMemberGroup",
"employeeMemberGroupDesc",
"employeeAddress",
"employeePostCode",
"employeeCity",
"employeeCountry",
"employerMemberNo",
"employerName",
"employerMemberGroup",
"employerMemberGroupDesc",
"startingDate",
"endingDate",
"isMainJob",
"position",
"extentOfEmployment",
"employmentType",
"eMail",
"mobilePhoneNo",
"phoneNo",
"internetResponsible",
"jobNo"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"member",
"memberGroup"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of jobEmployee",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.jobEmployee"
}
}
}
}
}
}
}
}
}
},
"/jobEmployees({systemId})": {
"parameters": [
{
"description": "key: systemId",
"in": "path",
"name": "systemId",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
}
},
{
"$ref": "#/components/parameters/company"
}
],
"get": {
"summary": "Get entity from jobEmployees by key",
"tags": [
"jobEmployees"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"employeeMemberNo",
"employeeName",
"employeeMemberGroup",
"employeeMemberGroupDesc",
"employeeAddress",
"employeePostCode",
"employeeCity",
"employeeCountry",
"employerMemberNo",
"employerName",
"employerMemberGroup",
"employerMemberGroupDesc",
"startingDate",
"endingDate",
"isMainJob",
"position",
"extentOfEmployment",
"employmentType",
"eMail",
"mobilePhoneNo",
"phoneNo",
"internetResponsible",
"jobNo"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"member",
"memberGroup"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.jobEmployee"
}
}
}
}
}
}
},
"/jobQueues": {
"get": {
"description": "A list of job queue entities
Permissions: Read
Returns: A list of job queues
Conditions: None
Examples:
GET:
Complete list: {environment}/api/computerCamp/general/v1.0/companies({company})/jobQueue",
"summary": "Get entities from jobQueues",
"tags": [
"jobQueues"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"systemId desc",
"objectIDtoRun",
"objectIDtoRun desc",
"objectTypetoRun",
"objectTypetoRun desc",
"objectCaptiontoRun",
"objectCaptiontoRun desc",
"description",
"description desc",
"recurringJob",
"recurringJob desc",
"scheduled",
"scheduled desc",
"status",
"status desc",
"earliestStartDateTime",
"earliestStartDateTime desc",
"startingDateTime",
"startingDateTime desc",
"lastReadyState",
"lastReadyState desc",
"userID",
"userID desc",
"userName",
"userName desc",
"userLanguageID",
"userLanguageID desc",
"userEmail",
"userEmail desc",
"errorMessage",
"errorMessage desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"objectIDtoRun",
"objectTypetoRun",
"objectCaptiontoRun",
"description",
"recurringJob",
"scheduled",
"status",
"earliestStartDateTime",
"startingDateTime",
"lastReadyState",
"userID",
"userName",
"userLanguageID",
"userEmail",
"errorMessage"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of jobQueue",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.jobQueue"
}
}
}
}
}
}
}
}
}
},
"/jobQueues({systemId})": {
"parameters": [
{
"description": "key: systemId",
"in": "path",
"name": "systemId",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
}
},
{
"$ref": "#/components/parameters/company"
}
],
"get": {
"summary": "Get entity from jobQueues by key",
"tags": [
"jobQueues"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"objectIDtoRun",
"objectTypetoRun",
"objectCaptiontoRun",
"description",
"recurringJob",
"scheduled",
"status",
"earliestStartDateTime",
"startingDateTime",
"lastReadyState",
"userID",
"userName",
"userLanguageID",
"userEmail",
"errorMessage"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.jobQueue"
}
}
}
}
}
}
},
"/jobs": {
"get": {
"description": "Insert, update and delete member employments. Filters can be applied to one, several or no fields
Permissions: Read and write
Returns: info about the members working for the same employer or the employments of a specific member
Conditions: None
Examples:
GET:
All employees for a given employer: {environment}/api/computerCamp/general/v1.0/companies({company})/jobs?$filter=employerMemberNo eq '{employerMemberNo}'
A specific members employments: {environment}/api/computerCamp/general/v1.0/companies({company})/jobs?$filter=employeeMemberNo eq '{employeeMemberNo}'
POST:
create an employement for a member
{environment}/api/computerCamp/general/v1.0/companies({company})/jobs
{
\"employeeMemberNo\": \"{employeeMemberNo}\",
\"employerMemberNo\": \"{employerMemberNo}\",
\"startingDate\": \"2023-01-01\",
\"endingDate\": \"0001-01-01\",
\"isMainJob\": \"true\",
\"position\": \"{position}\",
\"extentOfEmployment\": 100,
\"employmentType\": \"{employmentType}\",
\"eMail\": \"{eMail}\",
\"mobilePhoneNo\": \"{mobilePhoneNo}\",
\"phoneNo\": \"{phoneNo}\",
\"internetResponsible\": \"false\"
}",
"summary": "Get entities from jobs",
"tags": [
"jobs"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"systemId desc",
"employeeMemberNo",
"employeeMemberNo desc",
"employeeName",
"employeeName desc",
"employeeMemberGroup",
"employeeMemberGroup desc",
"employeeMemberGroupDesc",
"employeeMemberGroupDesc desc",
"employeeAddress",
"employeeAddress desc",
"employeePostCode",
"employeePostCode desc",
"employeeCity",
"employeeCity desc",
"employeeCountry",
"employeeCountry desc",
"employerMemberNo",
"employerMemberNo desc",
"employerName",
"employerName desc",
"employerMemberGroup",
"employerMemberGroup desc",
"employerMemberGroupDesc",
"employerMemberGroupDesc desc",
"startingDate",
"startingDate desc",
"endingDate",
"endingDate desc",
"isMainJob",
"isMainJob desc",
"position",
"position desc",
"extentOfEmployment",
"extentOfEmployment desc",
"employmentType",
"employmentType desc",
"eMail",
"eMail desc",
"mobilePhoneNo",
"mobilePhoneNo desc",
"phoneNo",
"phoneNo desc",
"internetResponsible",
"internetResponsible desc",
"jobNo",
"jobNo desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"employeeMemberNo",
"employeeName",
"employeeMemberGroup",
"employeeMemberGroupDesc",
"employeeAddress",
"employeePostCode",
"employeeCity",
"employeeCountry",
"employerMemberNo",
"employerName",
"employerMemberGroup",
"employerMemberGroupDesc",
"startingDate",
"endingDate",
"isMainJob",
"position",
"extentOfEmployment",
"employmentType",
"eMail",
"mobilePhoneNo",
"phoneNo",
"internetResponsible",
"jobNo"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"member",
"memberGroup"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of job",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.job"
}
}
}
}
}
}
}
}
},
"post": {
"summary": "Add new entity to jobs",
"tags": [
"jobs"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
}
],
"requestBody": {
"description": "New entity",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.job-create"
}
}
}
},
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"201": {
"description": "Created entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.job"
}
}
}
}
}
}
},
"/jobs({systemId})": {
"parameters": [
{
"description": "key: systemId",
"in": "path",
"name": "systemId",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
}
},
{
"$ref": "#/components/parameters/company"
}
],
"get": {
"summary": "Get entity from jobs by key",
"tags": [
"jobs"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"employeeMemberNo",
"employeeName",
"employeeMemberGroup",
"employeeMemberGroupDesc",
"employeeAddress",
"employeePostCode",
"employeeCity",
"employeeCountry",
"employerMemberNo",
"employerName",
"employerMemberGroup",
"employerMemberGroupDesc",
"startingDate",
"endingDate",
"isMainJob",
"position",
"extentOfEmployment",
"employmentType",
"eMail",
"mobilePhoneNo",
"phoneNo",
"internetResponsible",
"jobNo"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"member",
"memberGroup"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.job"
}
}
}
}
}
},
"patch": {
"summary": "Update entity in jobs",
"tags": [
"jobs"
],
"requestBody": {
"description": "New property values",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.job-update"
}
}
}
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/error"
}
}
},
"delete": {
"summary": "Delete entity from jobs",
"tags": [
"jobs"
],
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/error"
}
}
}
},
"/localUnions": {
"get": {
"description": "Used to display a list of local unions. Filters can be applied to one, several or no fields
Permissions: Read
Returns: A list of local unions
Conditions: None
Examples:
GET:
All local unions: {environment}/api/computerCamp/general/v1.0/companies({company})/localUnions
A specific local union from code: {environment}/api/computerCamp/general/v1.0/companies({company})/localUnions?$filter=code eq '{code}'",
"summary": "Get entities from localUnions",
"tags": [
"localUnions"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"systemId desc",
"code",
"code desc",
"description",
"description desc",
"boardCommittee",
"boardCommittee desc",
"subscription",
"subscription desc",
"referringTo",
"referringTo desc",
"postingMember",
"postingMember desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"code",
"description",
"boardCommittee",
"subscription",
"referringTo",
"postingMember"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"committee",
"collectionSubscription",
"member"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of localUnion",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.localUnion"
}
}
}
}
}
}
}
}
}
},
"/localUnions({systemId})": {
"parameters": [
{
"description": "key: systemId",
"in": "path",
"name": "systemId",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
}
},
{
"$ref": "#/components/parameters/company"
}
],
"get": {
"summary": "Get entity from localUnions by key",
"tags": [
"localUnions"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"code",
"description",
"boardCommittee",
"subscription",
"referringTo",
"postingMember"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"committee",
"collectionSubscription",
"member"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.localUnion"
}
}
}
}
}
}
},
"/memberCubes": {
"get": {
"description": "Used to display a list of members combined with other key tables. Filters can be applied to one, several or no fields. The table is updated periodically.
Permissions: Read
Returns: A list of members
Conditions: None
Examples:
GET:
All members: {environment}/api/computerCamp/general/v1.0/companies({company})/memberCubes
members from memberNo: {environment}/api/computerCamp/general/v1.0/companies({company})/memberCubes?$filter=no eq '{memberNo}'",
"summary": "Get entities from memberCubes",
"tags": [
"memberCubes"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"no",
"no desc",
"activeAddress",
"activeAddress desc",
"activeAddress2",
"activeAddress2 desc",
"activeCity",
"activeCity desc",
"activeMainEmployer",
"activeMainEmployer desc",
"activePostCode",
"activePostCode desc",
"address",
"address desc",
"address2",
"address2 desc",
"age",
"age desc",
"birthDate",
"birthDate desc",
"cprNumber",
"cprNumber desc",
"numbertOfActiveEmployees",
"numbertOfActiveEmployees desc",
"code1",
"code1 desc",
"code2",
"code2 desc",
"firstName",
"firstName desc",
"headofficeMemberNo",
"headofficeMemberNo desc",
"invoicePaytype",
"invoicePaytype desc",
"jobTitle",
"jobTitle desc",
"memberGroup",
"memberGroup desc",
"middleName",
"middleName desc",
"opponentCode",
"opponentCode desc",
"opponentDescription",
"opponentDescription desc",
"paragraph12",
"paragraph12 desc",
"paragraph8",
"paragraph8 desc",
"priceGroupDescription",
"priceGroupDescription desc",
"subscriptionPriceGroup",
"subscriptionPriceGroup desc",
"surname",
"surname desc",
"text1",
"text1 desc",
"text2",
"text2 desc",
"text3",
"text3 desc",
"text4",
"text4 desc",
"text5",
"text5 desc",
"unionPostTRName",
"unionPostTRName desc",
"unionSubscription",
"unionSubscription desc",
"city",
"city desc",
"countryRegionCode",
"countryRegionCode desc",
"currentSemester",
"currentSemester desc",
"currentMailEmail",
"currentMailEmail desc",
"eMail",
"eMail desc",
"education",
"education desc",
"educationDescription",
"educationDescription desc",
"employerMail",
"employerMail desc",
"employerMobilePhoneNo",
"employerMobilePhoneNo desc",
"employerName",
"employerName desc",
"employerPhoneNo",
"employerPhoneNo desc",
"employmentType",
"employmentType desc",
"entrySource",
"entrySource desc",
"gender",
"gender desc",
"headOfficeName",
"headOfficeName desc",
"isActive",
"isActive desc",
"jobAddress",
"jobAddress desc",
"jobCity",
"jobCity desc",
"jobPostalcode",
"jobPostalcode desc",
"jobEmail",
"jobEmail desc",
"localUnion",
"localUnion desc",
"localUnionDescription",
"localUnionDescription desc",
"memberGroupStartDate",
"memberGroupStartDate desc",
"membergroupDescription",
"membergroupDescription desc",
"mobilePhoneNo",
"mobilePhoneNo desc",
"municipality",
"municipality desc",
"municipalityName",
"municipalityName desc",
"name",
"name desc",
"name2",
"name2 desc",
"numberOfEmployees",
"numberOfEmployees desc",
"partnerType",
"partnerType desc",
"phoneNo",
"phoneNo desc",
"position",
"position desc",
"positionDescription",
"positionDescription desc",
"postCode",
"postCode desc",
"referringTo",
"referringTo desc",
"region",
"region desc",
"regionName",
"regionName desc",
"createdAt",
"createdAt desc",
"registrationDate",
"registrationDate desc",
"createdBy",
"createdBy desc",
"systemId",
"systemId desc",
"modifiedAt",
"modifiedAt desc",
"modifiedBy",
"modifiedBy desc",
"vatRegistrationNo",
"vatRegistrationNo desc",
"withdrawalDate",
"withdrawalDate desc",
"withdrawalReason",
"withdrawalReason desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"no",
"activeAddress",
"activeAddress2",
"activeCity",
"activeMainEmployer",
"activePostCode",
"address",
"address2",
"age",
"birthDate",
"cprNumber",
"numbertOfActiveEmployees",
"code1",
"code2",
"firstName",
"headofficeMemberNo",
"invoicePaytype",
"jobTitle",
"memberGroup",
"middleName",
"opponentCode",
"opponentDescription",
"paragraph12",
"paragraph8",
"priceGroupDescription",
"subscriptionPriceGroup",
"surname",
"text1",
"text2",
"text3",
"text4",
"text5",
"unionPostTRName",
"unionSubscription",
"city",
"countryRegionCode",
"currentSemester",
"currentMailEmail",
"eMail",
"education",
"educationDescription",
"employerMail",
"employerMobilePhoneNo",
"employerName",
"employerPhoneNo",
"employmentType",
"entrySource",
"gender",
"headOfficeName",
"isActive",
"jobAddress",
"jobCity",
"jobPostalcode",
"jobEmail",
"localUnion",
"localUnionDescription",
"memberGroupStartDate",
"membergroupDescription",
"mobilePhoneNo",
"municipality",
"municipalityName",
"name",
"name2",
"numberOfEmployees",
"partnerType",
"phoneNo",
"position",
"positionDescription",
"postCode",
"referringTo",
"region",
"regionName",
"createdAt",
"registrationDate",
"createdBy",
"systemId",
"modifiedAt",
"modifiedBy",
"vatRegistrationNo",
"withdrawalDate",
"withdrawalReason"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"member"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of memberCube",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.memberCube"
}
}
}
}
}
}
}
}
}
},
"/memberCubes('{no}')": {
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"description": "key: no",
"in": "path",
"name": "no",
"required": true,
"schema": {
"type": "string",
"maxLength": 20
}
}
],
"get": {
"summary": "Get entity from memberCubes by key",
"tags": [
"memberCubes"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"no",
"activeAddress",
"activeAddress2",
"activeCity",
"activeMainEmployer",
"activePostCode",
"address",
"address2",
"age",
"birthDate",
"cprNumber",
"numbertOfActiveEmployees",
"code1",
"code2",
"firstName",
"headofficeMemberNo",
"invoicePaytype",
"jobTitle",
"memberGroup",
"middleName",
"opponentCode",
"opponentDescription",
"paragraph12",
"paragraph8",
"priceGroupDescription",
"subscriptionPriceGroup",
"surname",
"text1",
"text2",
"text3",
"text4",
"text5",
"unionPostTRName",
"unionSubscription",
"city",
"countryRegionCode",
"currentSemester",
"currentMailEmail",
"eMail",
"education",
"educationDescription",
"employerMail",
"employerMobilePhoneNo",
"employerName",
"employerPhoneNo",
"employmentType",
"entrySource",
"gender",
"headOfficeName",
"isActive",
"jobAddress",
"jobCity",
"jobPostalcode",
"jobEmail",
"localUnion",
"localUnionDescription",
"memberGroupStartDate",
"membergroupDescription",
"mobilePhoneNo",
"municipality",
"municipalityName",
"name",
"name2",
"numberOfEmployees",
"partnerType",
"phoneNo",
"position",
"positionDescription",
"postCode",
"referringTo",
"region",
"regionName",
"createdAt",
"registrationDate",
"createdBy",
"systemId",
"modifiedAt",
"modifiedBy",
"vatRegistrationNo",
"withdrawalDate",
"withdrawalReason"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"member"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.memberCube"
}
}
}
}
}
}
},
"/memberEducations": {
"get": {
"description": "Used to display a list of member educations. Filters can be applied to one, several or no fields
Permissions: Read
Returns: A list of member educations
Conditions: None
Examples:
GET:
All member educations: {environment}/api/computerCamp/general/v1.0/companies({company})/memberEducations
All member educations for a member: {environment}/api/computerCamp/general/v1.0/companies({company})/memberEducations?$filter=memberNo eq '{memberNo}'
A specific member education from memberNo and year: {environment}/api/computerCamp/general/v1.0/companies({company})/memberEducations?$filter=memberNo eq '{memberNo}' and year eq {year}",
"summary": "Get entities from memberEducations",
"tags": [
"memberEducations"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"systemId desc",
"duration",
"duration desc",
"education",
"education desc",
"educationInstitute",
"educationInstitute desc",
"memberNo",
"memberNo desc",
"month",
"month desc",
"no",
"no desc",
"year",
"year desc",
"educationDescription",
"educationDescription desc",
"instituteDescription",
"instituteDescription desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"duration",
"education",
"educationInstitute",
"memberNo",
"month",
"no",
"year",
"educationDescription",
"instituteDescription"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"member"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of memberEducation",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.memberEducation"
}
}
}
}
}
}
}
}
}
},
"/memberEducations({systemId})": {
"parameters": [
{
"description": "key: systemId",
"in": "path",
"name": "systemId",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
}
},
{
"$ref": "#/components/parameters/company"
}
],
"get": {
"summary": "Get entity from memberEducations by key",
"tags": [
"memberEducations"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"duration",
"education",
"educationInstitute",
"memberNo",
"month",
"no",
"year",
"educationDescription",
"instituteDescription"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"member"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.memberEducation"
}
}
}
}
}
}
},
"/memberGroups": {
"get": {
"description": "Used to display a list of member groups. Filters can be applied to one, several or no fields
Permissions: Read
Returns: A list of member groups
Conditions: \"Displayed on internet\" must be checked.
Examples:
GET:
All member groups: {environment}/api/computerCamp/general/v1.0/companies({company})/memberGroups
A specific member group from code: {environment}/api/computerCamp/general/v1.0/companies({company})/memberGroups?$filter=code eq '{code}'",
"summary": "Get entities from memberGroups",
"tags": [
"memberGroups"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"code",
"code desc",
"systemId",
"systemId desc",
"description",
"description desc",
"internetDescription",
"internetDescription desc",
"displayOnInternet",
"displayOnInternet desc",
"mayBeSelectedFromInternet",
"mayBeSelectedFromInternet desc",
"partnerType",
"partnerType desc",
"pinRequirement",
"pinRequirement desc",
"customerPostingGroup",
"customerPostingGroup desc",
"subscriptionPriceGroupId",
"subscriptionPriceGroupId desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"code",
"systemId",
"description",
"internetDescription",
"displayOnInternet",
"mayBeSelectedFromInternet",
"partnerType",
"pinRequirement",
"customerPostingGroup",
"subscriptionPriceGroupId"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of memberGroup",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.memberGroup"
}
}
}
}
}
}
}
}
}
},
"/memberGroups('{code}')": {
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"description": "key: code",
"in": "path",
"name": "code",
"required": true,
"schema": {
"type": "string",
"maxLength": 10
}
}
],
"get": {
"summary": "Get entity from memberGroups by key",
"tags": [
"memberGroups"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"code",
"systemId",
"description",
"internetDescription",
"displayOnInternet",
"mayBeSelectedFromInternet",
"partnerType",
"pinRequirement",
"customerPostingGroup",
"subscriptionPriceGroupId"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.memberGroup"
}
}
}
}
}
}
},
"/memberPayrollReports": {
"get": {
"description": "A list of payroll member reports for each member report line
Permissions: Read
Returns: A list of payroll registrations for a given member
Conditions: None
Examples:
GET:
Complete list: {environment}/api/computerCamp/general/v1.0/companies({company})/memberPayrollReports
For a specific member: {environment}/api/computerCamp/general/v1.0/companies({company})/memberPayrollReports?$filter=memberNo eq '{memberNo}'
",
"summary": "Get entities from memberPayrollReports",
"tags": [
"memberPayrollReports"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"no",
"no desc",
"reportNo",
"reportNo desc",
"memberNo",
"memberNo desc",
"year",
"year desc",
"registrationDate",
"registrationDate desc",
"status",
"status desc",
"reportedBy",
"reportedBy desc",
"column",
"column desc",
"measure",
"measure desc",
"description",
"description desc",
"reportedSum",
"reportedSum desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"no",
"reportNo",
"memberNo",
"year",
"registrationDate",
"status",
"reportedBy",
"column",
"measure",
"description",
"reportedSum"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"member"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of memberPayrollReport",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.memberPayrollReport"
}
}
}
}
}
}
}
}
}
},
"/memberPayrollReports({no})": {
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"description": "key: no",
"in": "path",
"name": "no",
"required": true,
"schema": {
"format": "int64",
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"example": "42"
}
}
],
"get": {
"summary": "Get entity from memberPayrollReports by key",
"tags": [
"memberPayrollReports"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"no",
"reportNo",
"memberNo",
"year",
"registrationDate",
"status",
"reportedBy",
"column",
"measure",
"description",
"reportedSum"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"member"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.memberPayrollReport"
}
}
}
}
}
}
},
"/memberPriceGroups": {
"get": {
"description": "TODO IKKE FÆRDIG
Used to display a list of member price groups. Filters can be applied to one, several or no fields
Permissions: Read and update
Returns: A list of member price groups
Conditions: None
Examples:
GET:
All member groups: {environment}/api/computerCamp/general/v1.0/companies({company})/memberPriceGroups
A specific member group from code: {environment}/api/computerCamp/general/v1.0/companies({company})/memberPriceGroups?$filter=priceGroup eq '{priceGroup}'",
"summary": "Get entities from memberPriceGroups",
"tags": [
"memberPriceGroups"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"systemId desc",
"priceGroup",
"priceGroup desc",
"memberNo",
"memberNo desc",
"subscription",
"subscription desc",
"startingDate",
"startingDate desc",
"endingDate",
"endingDate desc",
"priceGroupDescription",
"priceGroupDescription desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"priceGroup",
"memberNo",
"subscription",
"startingDate",
"endingDate",
"priceGroupDescription"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"member",
"collectionSubscription"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of memberPriceGroup",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.memberPriceGroup"
}
}
}
}
}
}
}
}
},
"post": {
"summary": "Add new entity to memberPriceGroups",
"tags": [
"memberPriceGroups"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
}
],
"requestBody": {
"description": "New entity",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.memberPriceGroup-create"
}
}
}
},
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"201": {
"description": "Created entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.memberPriceGroup"
}
}
}
}
}
}
},
"/memberPriceGroups({systemId})": {
"parameters": [
{
"description": "key: systemId",
"in": "path",
"name": "systemId",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
}
},
{
"$ref": "#/components/parameters/company"
}
],
"get": {
"summary": "Get entity from memberPriceGroups by key",
"tags": [
"memberPriceGroups"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"priceGroup",
"memberNo",
"subscription",
"startingDate",
"endingDate",
"priceGroupDescription"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"member",
"collectionSubscription"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.memberPriceGroup"
}
}
}
}
}
},
"patch": {
"summary": "Update entity in memberPriceGroups",
"tags": [
"memberPriceGroups"
],
"requestBody": {
"description": "New property values",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.memberPriceGroup-update"
}
}
}
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/error"
}
}
},
"delete": {
"summary": "Delete entity from memberPriceGroups",
"tags": [
"memberPriceGroups"
],
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/error"
}
}
}
},
"/members": {
"get": {
"description": "Used to display a list of members. Filters can be applied to one, several or no fields
Permissions: Read
Returns: A list of members
Conditions: None
Examples:
GET:
All members: {environment}/api/computerCamp/general/v1.0/companies({company})/members
A member from memberNo: {environment}/api/computerCamp/general/v1.0/companies({company})/members?$filter=memberNo eq '{memberNo}'
A range of members: {environment}/api/computerCamp/general/v1.0/companies({company})/members?$filter=memberNo gt '{memberNo}' and memberNo lt '{memberNo}'
A specific member with all expands: {environment}/api/computerCamp/general/v1.0/companies({company})/members?$filter=memberNo gt '{memberNo}' &$expand=AltAddresses,jobs,taxonomyMembers,memberEducations,subscriptionMembers,memberPayrollReports",
"summary": "Get entities from members",
"tags": [
"members"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"memberNo",
"memberNo desc",
"name",
"name desc",
"name2",
"name2 desc",
"searchName",
"searchName desc",
"memberGroup",
"memberGroup desc",
"subscriptionPricegroup",
"subscriptionPricegroup desc",
"currencyCode",
"currencyCode desc",
"languageCode",
"languageCode desc",
"address",
"address desc",
"address2",
"address2 desc",
"postCode",
"postCode desc",
"city",
"city desc",
"county",
"county desc",
"countryRegionCode",
"countryRegionCode desc",
"gln",
"gln desc",
"eMail",
"eMail desc",
"phoneNo",
"phoneNo desc",
"mobilePhoneNo",
"mobilePhoneNo desc",
"addresscodeMail",
"addresscodeMail desc",
"currentMailAddress",
"currentMailAddress desc",
"addresscodeInvoice",
"addresscodeInvoice desc",
"currentInvoiceAddress",
"currentInvoiceAddress desc",
"shareEmail",
"shareEmail desc",
"hideEmail",
"hideEmail desc",
"shareGeneralData",
"shareGeneralData desc",
"secretAddress",
"secretAddress desc",
"shareMemberList",
"shareMemberList desc",
"hideMemberList",
"hideMemberList desc",
"localUnion",
"localUnion desc",
"localUnionDescription",
"localUnionDescription desc",
"code1",
"code1 desc",
"code2",
"code2 desc",
"text1",
"text1 desc",
"text2",
"text2 desc",
"text3",
"text3 desc",
"text4",
"text4 desc",
"text5",
"text5 desc",
"creationDate",
"creationDate desc",
"withdrawalDate",
"withdrawalDate desc",
"entrySource",
"entrySource desc",
"entrySourceName",
"entrySourceName desc",
"withdrawalReason",
"withdrawalReason desc",
"withdrawalReasonDescription",
"withdrawalReasonDescription desc",
"isInLocalUnion",
"isInLocalUnion desc",
"municipality",
"municipality desc",
"municipalityName",
"municipalityName desc",
"region",
"region desc",
"regionName",
"regionName desc",
"billtoMemberNo",
"billtoMemberNo desc",
"systemId",
"systemId desc",
"partnerType",
"partnerType desc",
"hasCommittee",
"hasCommittee desc",
"hasCommunity",
"hasCommunity desc",
"hasUnionPost",
"hasUnionPost desc",
"hasTaxonomy",
"hasTaxonomy desc",
"hasSubscription",
"hasSubscription desc",
"birthDate",
"birthDate desc",
"cprNo",
"cprNo desc",
"gender",
"gender desc",
"firstName",
"firstName desc",
"middleName",
"middleName desc",
"surname",
"surname desc",
"employerNo",
"employerNo desc",
"employerName",
"employerName desc",
"shareEducation",
"shareEducation desc",
"hideEducation",
"hideEducation desc",
"shareJob",
"shareJob desc",
"hideJob",
"hideJob desc",
"jobTitle",
"jobTitle desc",
"jobPhone",
"jobPhone desc",
"jobMobilePhone",
"jobMobilePhone desc",
"jobEmail",
"jobEmail desc",
"jobPosition",
"jobPosition desc",
"pair",
"pair desc",
"vatBusPostingGroup",
"vatBusPostingGroup desc",
"cvrNo",
"cvrNo desc",
"numberOfEmployees",
"numberOfEmployees desc",
"isEmployer",
"isEmployer desc",
"headOfficeMemberNo",
"headOfficeMemberNo desc",
"headOfficeName",
"headOfficeName desc",
"opponent",
"opponent desc",
"contact",
"contact desc",
"localUnionFilter",
"localUnionFilter desc",
"subcriptionFilter",
"subcriptionFilter desc",
"invoiceMemberFilter",
"invoiceMemberFilter desc",
"committeeFilter",
"committeeFilter desc",
"communityFilter",
"communityFilter desc",
"unionPostTypeFilter",
"unionPostTypeFilter desc",
"taxonomyFilter",
"taxonomyFilter desc",
"startingDateFilter",
"startingDateFilter desc",
"endingDateFilter",
"endingDateFilter desc",
"homePage",
"homePage desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"memberNo",
"name",
"name2",
"searchName",
"memberGroup",
"subscriptionPricegroup",
"currencyCode",
"languageCode",
"address",
"address2",
"postCode",
"city",
"county",
"countryRegionCode",
"gln",
"eMail",
"phoneNo",
"mobilePhoneNo",
"addresscodeMail",
"currentMailAddress",
"addresscodeInvoice",
"currentInvoiceAddress",
"shareEmail",
"hideEmail",
"shareGeneralData",
"secretAddress",
"shareMemberList",
"hideMemberList",
"localUnion",
"localUnionDescription",
"code1",
"code2",
"text1",
"text2",
"text3",
"text4",
"text5",
"creationDate",
"withdrawalDate",
"entrySource",
"entrySourceName",
"withdrawalReason",
"withdrawalReasonDescription",
"isInLocalUnion",
"municipality",
"municipalityName",
"region",
"regionName",
"billtoMemberNo",
"systemId",
"partnerType",
"hasCommittee",
"hasCommunity",
"hasUnionPost",
"hasTaxonomy",
"hasSubscription",
"birthDate",
"cprNo",
"gender",
"firstName",
"middleName",
"surname",
"employerNo",
"employerName",
"shareEducation",
"hideEducation",
"shareJob",
"hideJob",
"jobTitle",
"jobPhone",
"jobMobilePhone",
"jobEmail",
"jobPosition",
"pair",
"vatBusPostingGroup",
"cvrNo",
"numberOfEmployees",
"isEmployer",
"headOfficeMemberNo",
"headOfficeName",
"opponent",
"contact",
"localUnionFilter",
"subcriptionFilter",
"invoiceMemberFilter",
"committeeFilter",
"communityFilter",
"unionPostTypeFilter",
"taxonomyFilter",
"startingDateFilter",
"endingDateFilter",
"homePage"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"memberCube",
"collectionSubscription",
"committee",
"community",
"unionPostType",
"taxonomy",
"altAddresses",
"jobs",
"jobEmployees",
"taxonomyMembers",
"memberEducations",
"subscriptionMembers",
"memberPayrollReports"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of member",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.member"
}
}
}
}
}
}
}
}
}
},
"/members('{memberNo}')": {
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"description": "key: memberNo",
"in": "path",
"name": "memberNo",
"required": true,
"schema": {
"type": "string",
"maxLength": 20
}
}
],
"get": {
"summary": "Get entity from members by key",
"tags": [
"members"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"memberNo",
"name",
"name2",
"searchName",
"memberGroup",
"subscriptionPricegroup",
"currencyCode",
"languageCode",
"address",
"address2",
"postCode",
"city",
"county",
"countryRegionCode",
"gln",
"eMail",
"phoneNo",
"mobilePhoneNo",
"addresscodeMail",
"currentMailAddress",
"addresscodeInvoice",
"currentInvoiceAddress",
"shareEmail",
"hideEmail",
"shareGeneralData",
"secretAddress",
"shareMemberList",
"hideMemberList",
"localUnion",
"localUnionDescription",
"code1",
"code2",
"text1",
"text2",
"text3",
"text4",
"text5",
"creationDate",
"withdrawalDate",
"entrySource",
"entrySourceName",
"withdrawalReason",
"withdrawalReasonDescription",
"isInLocalUnion",
"municipality",
"municipalityName",
"region",
"regionName",
"billtoMemberNo",
"systemId",
"partnerType",
"hasCommittee",
"hasCommunity",
"hasUnionPost",
"hasTaxonomy",
"hasSubscription",
"birthDate",
"cprNo",
"gender",
"firstName",
"middleName",
"surname",
"employerNo",
"employerName",
"shareEducation",
"hideEducation",
"shareJob",
"hideJob",
"jobTitle",
"jobPhone",
"jobMobilePhone",
"jobEmail",
"jobPosition",
"pair",
"vatBusPostingGroup",
"cvrNo",
"numberOfEmployees",
"isEmployer",
"headOfficeMemberNo",
"headOfficeName",
"opponent",
"contact",
"localUnionFilter",
"subcriptionFilter",
"invoiceMemberFilter",
"committeeFilter",
"communityFilter",
"unionPostTypeFilter",
"taxonomyFilter",
"startingDateFilter",
"endingDateFilter",
"homePage"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"memberCube",
"collectionSubscription",
"committee",
"community",
"unionPostType",
"taxonomy",
"altAddresses",
"jobs",
"jobEmployees",
"taxonomyMembers",
"memberEducations",
"subscriptionMembers",
"memberPayrollReports"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.member"
}
}
}
}
}
}
},
"/onlinePayment": {
"get": {
"description": "Infomation about online payments made by a given member for a given service or product bought (eg. a subscription or an event participation).
Note: Online payments are created automatically when an event participant is created with the payment type \"Online Payment\".
Permissions: Read and write
Returns: A list of online payments
Conditions: None
Examples:
GET:
All online payments: {environment}/api/computerCamp/event/v1.0/companies({company})/onlinePayment
An online payment with a specific order id: {environment}/api/computerCamp/event/v1.0/companies({company})/onlinePayment('{Order Id}')
POST:
{environment}/api/computerCamp/event/v1.0/companies({company})/onlinePayment
Content-Type: application/json
{
\"orderId\": \"{MyOrder}\",
\"paymentStatus\": \"None\",
\"transactionId\": \"{MyTransaction}\",
\"cardExpiryMonth\": \"12\",
\"cardExpiryYear\": \"12\",
\"cardType\": \"{MyCard}\",
\"exceptionMessage\": \"{MyException}\",
\"exceptionType\": \"{MyType}\",
\"latestOnlinePaymentFunction\": \"None\",
\"latestOnlinePaymentTime\": \"2023-04-28T12:28:05.04Z\",
\"onlinePaymentErrorCode\": \"{MyError}\",
\"onlinePaymentErrorMessage\": \"{MyMessage}\",
\"collectionNo\": \"\",
\"participantEntryNo\": \"{Participant No.}\",
\"participantMemberNo\": \"{Member No.}\",
\"eventNo\": \"{Event No.}\"
}
PATCH:
{environment}/api/computerCamp/event/v1.0/companies({company})/onlinePayment('{orderId}')
Content-Type: application/json
If-Match: \"{eTag}\"
{
\"orderId\": \"{MyOrder}\",
\"paymentStatus\": \"Captured\",
\"transactionId\": \"{MyTransaction}\",
\"cardExpiryMonth\": \"12\",
\"cardExpiryYear\": \"12\",
\"cardType\": \"{MyCard}\",
\"exceptionMessage\": \"{MyException}\",
\"exceptionType\": \"{MyType}\",
\"latestOnlinePaymentFunction\": \"None\",
\"latestOnlinePaymentTime\": \"2023-04-28T12:28:05.04Z\",
\"onlinePaymentErrorCode\": \"{MyError}\",
\"onlinePaymentErrorMessage\": \"{MyMessage}\",
\"collectionNo\": \"\",
\"participantEntryNo\": \"{Participant No.}\",
\"participantMemberNo\": \"{Member No.}\",
\"eventNo\": \"{Event No.}\"
}",
"summary": "Get entities from onlinePayment",
"tags": [
"onlinePayment"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"orderId",
"orderId desc",
"paymentStatus",
"paymentStatus desc",
"transactionId",
"transactionId desc",
"cardExpiryMonth",
"cardExpiryMonth desc",
"cardExpiryYear",
"cardExpiryYear desc",
"cardType",
"cardType desc",
"exceptionMessage",
"exceptionMessage desc",
"exceptionType",
"exceptionType desc",
"latestOnlinePaymentFunction",
"latestOnlinePaymentFunction desc",
"latestOnlinePaymentTime",
"latestOnlinePaymentTime desc",
"onlinePaymentErrorCode",
"onlinePaymentErrorCode desc",
"onlinePaymentErrorMessage",
"onlinePaymentErrorMessage desc",
"collectionNo",
"collectionNo desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"orderId",
"paymentStatus",
"transactionId",
"cardExpiryMonth",
"cardExpiryYear",
"cardType",
"exceptionMessage",
"exceptionType",
"latestOnlinePaymentFunction",
"latestOnlinePaymentTime",
"onlinePaymentErrorCode",
"onlinePaymentErrorMessage",
"collectionNo"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"collection"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of onlinePayment",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.onlinePayment"
}
}
}
}
}
}
}
}
},
"post": {
"summary": "Add new entity to onlinePayment",
"tags": [
"onlinePayment"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
}
],
"requestBody": {
"description": "New entity",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.onlinePayment-create"
}
}
}
},
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"201": {
"description": "Created entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.onlinePayment"
}
}
}
}
}
}
},
"/onlinePayment('{orderId}')": {
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"description": "key: orderId",
"in": "path",
"name": "orderId",
"required": true,
"schema": {
"type": "string",
"maxLength": 20
}
}
],
"get": {
"summary": "Get entity from onlinePayment by key",
"tags": [
"onlinePayment"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"orderId",
"paymentStatus",
"transactionId",
"cardExpiryMonth",
"cardExpiryYear",
"cardType",
"exceptionMessage",
"exceptionType",
"latestOnlinePaymentFunction",
"latestOnlinePaymentTime",
"onlinePaymentErrorCode",
"onlinePaymentErrorMessage",
"collectionNo"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"collection"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.onlinePayment"
}
}
}
}
}
},
"patch": {
"summary": "Update entity in onlinePayment",
"tags": [
"onlinePayment"
],
"requestBody": {
"description": "New property values",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.onlinePayment-update"
}
}
}
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/error"
}
}
},
"delete": {
"summary": "Delete entity from onlinePayment",
"tags": [
"onlinePayment"
],
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/error"
}
}
}
},
"/passwords": {
"get": {
"description": "Password info in relation to a given member
Permissions: Read and update
Returns: Password information for a given member
Conditions: None
Examples:
GET:
Password information for a member: {environment}/api/computerCamp/general/v1.0/companies({company})/passwords?$filter=memberNo eq '{memberNo}'",
"summary": "Get entities from passwords",
"tags": [
"passwords"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"memberNo",
"memberNo desc",
"eMail",
"eMail desc",
"password",
"password desc",
"campCprNo",
"campCprNo desc",
"name",
"name desc",
"localUnion",
"localUnion desc",
"campMemberGroup",
"campMemberGroup desc",
"campLocalUnionDescription",
"campLocalUnionDescription desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"memberNo",
"eMail",
"password",
"campCprNo",
"name",
"localUnion",
"campMemberGroup",
"campLocalUnionDescription"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"memberGroup"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of password",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.password"
}
}
}
}
}
}
}
}
}
},
"/passwords('{memberNo}')": {
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"description": "key: memberNo",
"in": "path",
"name": "memberNo",
"required": true,
"schema": {
"type": "string",
"maxLength": 20
}
}
],
"get": {
"summary": "Get entity from passwords by key",
"tags": [
"passwords"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"memberNo",
"eMail",
"password",
"campCprNo",
"name",
"localUnion",
"campMemberGroup",
"campLocalUnionDescription"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"memberGroup"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.password"
}
}
}
}
}
},
"patch": {
"summary": "Update entity in passwords",
"tags": [
"passwords"
],
"requestBody": {
"description": "New property values",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.password-update"
}
}
}
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/error"
}
}
}
},
"/positions": {
"get": {
"description": "Used to display a list of positions. Filters can be applied to one, several or no fields
Permissions: Read
Returns: A list of positions
Conditions: None
Examples:
GET:
All positions: {environment}/api/computerCamp/general/v1.0/companies({company})/positions
A specific position from code: {environment}/api/computerCamp/general/v1.0/companies({company})/positions?$filter=code eq '{code}'
All positions which can be displayed on internet: {environment}/api/computerCamp/general/v1.0/companies({company})/positions?$filter=display_on_internet eq true",
"summary": "Get entities from positions",
"tags": [
"positions"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"code",
"code desc",
"systemId",
"systemId desc",
"jobTitle",
"jobTitle desc",
"webText",
"webText desc",
"display_on_internet",
"display_on_internet desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"code",
"systemId",
"jobTitle",
"webText",
"display_on_internet"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of position",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.position"
}
}
}
}
}
}
}
}
}
},
"/positions('{code}')": {
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"description": "key: code",
"in": "path",
"name": "code",
"required": true,
"schema": {
"type": "string",
"maxLength": 10
}
}
],
"get": {
"summary": "Get entity from positions by key",
"tags": [
"positions"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"code",
"systemId",
"jobTitle",
"webText",
"display_on_internet"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.position"
}
}
}
}
}
}
},
"/sentMails": {
"get": {
"description": "Information about emails sent to a given person. Commonly used for workflows.
Permissions: Read and write
Returns: Info about sent emails
Conditions: None
Examples:
GET:
All emails for all members: {environment}/api/computerCamp/general/v1.0/companies({company})/sentMails
A specific email for a specific customer: {environment}/api/computerCamp/general/v1.0/companies({company})/sentMails?$filter=memberNo eq '{Member No}' and code eq '{Code}'
All emails sent to a member: {environment}/api/computerCamp/general/v1.0/companies({company})/sentMails?$filter=memberNo eq '{Member No.}'
POST:
Create an email record.
{environment}/api/computerCamp/general/v1.0/companies({company})/sentMails
{
\"memberNo\": \"{Member No.}\",
\"code\": \"{Code}\",
\"date\": \"0001-01-01\"
}",
"summary": "Get entities from sentMails",
"tags": [
"sentMails"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"systemId desc",
"memberNo",
"memberNo desc",
"code",
"code desc",
"date",
"date desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"memberNo",
"code",
"date"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"member"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of sentMail",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.sentMail"
}
}
}
}
}
}
}
}
},
"post": {
"summary": "Add new entity to sentMails",
"tags": [
"sentMails"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
}
],
"requestBody": {
"description": "New entity",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.sentMail-create"
}
}
}
},
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"201": {
"description": "Created entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.sentMail"
}
}
}
}
}
}
},
"/sentMails({systemId})": {
"parameters": [
{
"description": "key: systemId",
"in": "path",
"name": "systemId",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
}
},
{
"$ref": "#/components/parameters/company"
}
],
"get": {
"summary": "Get entity from sentMails by key",
"tags": [
"sentMails"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"memberNo",
"code",
"date"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"member"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.sentMail"
}
}
}
}
}
},
"patch": {
"summary": "Update entity in sentMails",
"tags": [
"sentMails"
],
"requestBody": {
"description": "New property values",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.sentMail-update"
}
}
}
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/error"
}
}
},
"delete": {
"summary": "Delete entity from sentMails",
"tags": [
"sentMails"
],
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/error"
}
}
}
},
"/subscriptionMemberCubes": {
"get": {
"description": "Used to display a list of subscription members combined with other key tables. Filters can be applied to one, several or no fields. The table is updated periodically.
Permissions: Read
Returns: A list of subscription members
Conditions: None
Examples:
GET:
All subscription members: {environment}/api/computerCamp/general/v1.0/companies({company})/subscriptionMemberCubes
Subscription members from memberNo: {environment}/api/computerCamp/general/v1.0/companies({company})/subscriptionMemberCubes?$filter=memberNo eq '{memberNo}'
Subscription members from subscription: {environment}/api/computerCamp/general/v1.0/companies({company})/subscriptionMemberCubes?$filter=subscription eq '{subscription}'",
"summary": "Get entities from subscriptionMemberCubes",
"tags": [
"subscriptionMemberCubes"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"no",
"no desc",
"activeAddress",
"activeAddress desc",
"activeAddress2",
"activeAddress2 desc",
"activeCity",
"activeCity desc",
"activeEMail",
"activeEMail desc",
"activePostCode",
"activePostCode desc",
"address",
"address desc",
"address2",
"address2 desc",
"addresscodeInvoice",
"addresscodeInvoice desc",
"addresscodeMail",
"addresscodeMail desc",
"age",
"age desc",
"attentionName",
"attentionName desc",
"billToCustomerNo",
"billToCustomerNo desc",
"birthdate",
"birthdate desc",
"cpr",
"cpr desc",
"memberCreateExec",
"memberCreateExec desc",
"memberWithdExec",
"memberWithdExec desc",
"subStartExec",
"subStartExec desc",
"subWithdExec",
"subWithdExec desc",
"city",
"city desc",
"collectedInOldSystemTo",
"collectedInOldSystemTo desc",
"countryRegion",
"countryRegion desc",
"eInvoiceContact",
"eInvoiceContact desc",
"eInvoiceDocumentNo",
"eInvoiceDocumentNo desc",
"eMail",
"eMail desc",
"eanNo",
"eanNo desc",
"employerAccNo",
"employerAccNo desc",
"employerMail",
"employerMail desc",
"employerName",
"employerName desc",
"employerNo",
"employerNo desc",
"endingDate",
"endingDate desc",
"entrySource",
"entrySource desc",
"entrySourceDescription",
"entrySourceDescription desc",
"frequency",
"frequency desc",
"gender",
"gender desc",
"hasBeenInEntryList",
"hasBeenInEntryList desc",
"hasBeenInWithdrawalList",
"hasBeenInWithdrawalList desc",
"invoiceDescription",
"invoiceDescription desc",
"invoiceEndingDate",
"invoiceEndingDate desc",
"invoiceMemberName",
"invoiceMemberName desc",
"invoiceMemberNo",
"invoiceMemberNo desc",
"invoiceMonth",
"invoiceMonth desc",
"invoiceQuantity",
"invoiceQuantity desc",
"invoiceStartingDate",
"invoiceStartingDate desc",
"isBlocked",
"isBlocked desc",
"isCollectedUntil",
"isCollectedUntil desc",
"isWelcomeLetterCreated",
"isWelcomeLetterCreated desc",
"localUnion",
"localUnion desc",
"localUnionDescription",
"localUnionDescription desc",
"manuelInvoicePeriod",
"manuelInvoicePeriod desc",
"memberCreationDate",
"memberCreationDate desc",
"memberGroup",
"memberGroup desc",
"memberName",
"memberName desc",
"memberNo",
"memberNo desc",
"memberWithdrawalDate",
"memberWithdrawalDate desc",
"memberIsActive",
"memberIsActive desc",
"mobile",
"mobile desc",
"name2",
"name2 desc",
"partnerPBS",
"partnerPBS desc",
"phone",
"phone desc",
"postCode",
"postCode desc",
"price",
"price desc",
"priceGroup",
"priceGroup desc",
"publicationQuantity",
"publicationQuantity desc",
"referringTo",
"referringTo desc",
"sendMethod",
"sendMethod desc",
"startingDate",
"startingDate desc",
"subscription",
"subscription desc",
"subscriptionDescription",
"subscriptionDescription desc",
"subscriptionGroup",
"subscriptionGroup desc",
"subscriptionMemberIsActive",
"subscriptionMemberIsActive desc",
"createdAt",
"createdAt desc",
"createdBy",
"createdBy desc",
"systemId",
"systemId desc",
"modifiedAt",
"modifiedAt desc",
"modifiedBy",
"modifiedBy desc",
"vatRegistrationNo",
"vatRegistrationNo desc",
"withdrawalReason",
"withdrawalReason desc",
"withdrawalReasonDescription",
"withdrawalReasonDescription desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"no",
"activeAddress",
"activeAddress2",
"activeCity",
"activeEMail",
"activePostCode",
"address",
"address2",
"addresscodeInvoice",
"addresscodeMail",
"age",
"attentionName",
"billToCustomerNo",
"birthdate",
"cpr",
"memberCreateExec",
"memberWithdExec",
"subStartExec",
"subWithdExec",
"city",
"collectedInOldSystemTo",
"countryRegion",
"eInvoiceContact",
"eInvoiceDocumentNo",
"eMail",
"eanNo",
"employerAccNo",
"employerMail",
"employerName",
"employerNo",
"endingDate",
"entrySource",
"entrySourceDescription",
"frequency",
"gender",
"hasBeenInEntryList",
"hasBeenInWithdrawalList",
"invoiceDescription",
"invoiceEndingDate",
"invoiceMemberName",
"invoiceMemberNo",
"invoiceMonth",
"invoiceQuantity",
"invoiceStartingDate",
"isBlocked",
"isCollectedUntil",
"isWelcomeLetterCreated",
"localUnion",
"localUnionDescription",
"manuelInvoicePeriod",
"memberCreationDate",
"memberGroup",
"memberName",
"memberNo",
"memberWithdrawalDate",
"memberIsActive",
"mobile",
"name2",
"partnerPBS",
"phone",
"postCode",
"price",
"priceGroup",
"publicationQuantity",
"referringTo",
"sendMethod",
"startingDate",
"subscription",
"subscriptionDescription",
"subscriptionGroup",
"subscriptionMemberIsActive",
"createdAt",
"createdBy",
"systemId",
"modifiedAt",
"modifiedBy",
"vatRegistrationNo",
"withdrawalReason",
"withdrawalReasonDescription"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"member",
"collectionSubscription"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of subscriptionMemberCube",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.subscriptionMemberCube"
}
}
}
}
}
}
}
}
}
},
"/subscriptionMemberCubes({no})": {
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"description": "key: no",
"in": "path",
"name": "no",
"required": true,
"schema": {
"format": "int64",
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"example": "42"
}
}
],
"get": {
"summary": "Get entity from subscriptionMemberCubes by key",
"tags": [
"subscriptionMemberCubes"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"no",
"activeAddress",
"activeAddress2",
"activeCity",
"activeEMail",
"activePostCode",
"address",
"address2",
"addresscodeInvoice",
"addresscodeMail",
"age",
"attentionName",
"billToCustomerNo",
"birthdate",
"cpr",
"memberCreateExec",
"memberWithdExec",
"subStartExec",
"subWithdExec",
"city",
"collectedInOldSystemTo",
"countryRegion",
"eInvoiceContact",
"eInvoiceDocumentNo",
"eMail",
"eanNo",
"employerAccNo",
"employerMail",
"employerName",
"employerNo",
"endingDate",
"entrySource",
"entrySourceDescription",
"frequency",
"gender",
"hasBeenInEntryList",
"hasBeenInWithdrawalList",
"invoiceDescription",
"invoiceEndingDate",
"invoiceMemberName",
"invoiceMemberNo",
"invoiceMonth",
"invoiceQuantity",
"invoiceStartingDate",
"isBlocked",
"isCollectedUntil",
"isWelcomeLetterCreated",
"localUnion",
"localUnionDescription",
"manuelInvoicePeriod",
"memberCreationDate",
"memberGroup",
"memberName",
"memberNo",
"memberWithdrawalDate",
"memberIsActive",
"mobile",
"name2",
"partnerPBS",
"phone",
"postCode",
"price",
"priceGroup",
"publicationQuantity",
"referringTo",
"sendMethod",
"startingDate",
"subscription",
"subscriptionDescription",
"subscriptionGroup",
"subscriptionMemberIsActive",
"createdAt",
"createdBy",
"systemId",
"modifiedAt",
"modifiedBy",
"vatRegistrationNo",
"withdrawalReason",
"withdrawalReasonDescription"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"member",
"collectionSubscription"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.subscriptionMemberCube"
}
}
}
}
}
}
},
"/subscriptionMembers": {
"get": {
"description": "Insert, update and delete a subscription member. Filters can be applied to one, several or no fields
Permissions: Read and write
Returns: info about a subscription member or a list of subscription members
Conditions: None
Examples:
GET:
All Subscription members for a given subscription: {environment}/api/computerCamp/general/v1.0/companies({company})/subscriptionMembers?$filter=subscription eq '{subscription}'
A specific subscription member for a given subscription: {environment}/api/computerCamp/general/v1.0/companies({company})/subscriptionMembers?$filter=subscription eq '{subscription}' and memberNo eq '{memberNo}'
POST:
create a subscription member
{environment}/api/computerCamp/general/v1.0/companies({company})/subscriptionMembers
{
\"memberNo\": \"{memberNo}\",
\"subscription\": \"{subscription}\",
\"frequency\": \"{frequency}\",
\"startingDate\": \"{startingDate}\",
\"endingDate\": \"{endingDate}\",
\"addresscodeInvoice\": \"{addresscodeInvoice}\",
\"addresscodeMail\": \"{addresscodeMail}\",
\"invoiceMemberNo\": \"{invoiceMemberNo}\",
\"publicationQuantity\": \"{publicationQuantity}\",
\"sendMethod\": \"{sendMethod}\"
}",
"summary": "Get entities from subscriptionMembers",
"tags": [
"subscriptionMembers"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"systemId desc",
"memberNo",
"memberNo desc",
"subscription",
"subscription desc",
"frequency",
"frequency desc",
"isBlocked",
"isBlocked desc",
"invoiceStartingDate",
"invoiceStartingDate desc",
"invoiceEndingDate",
"invoiceEndingDate desc",
"startingDate",
"startingDate desc",
"endingDate",
"endingDate desc",
"attentionName",
"attentionName desc",
"invoiceMonth",
"invoiceMonth desc",
"eanNo",
"eanNo desc",
"addresscodeInvoice",
"addresscodeInvoice desc",
"addresscodeMail",
"addresscodeMail desc",
"periodPrice",
"periodPrice desc",
"subscriptionGroup",
"subscriptionGroup desc",
"invoiceMemberNo",
"invoiceMemberNo desc",
"subscriptionDescription",
"subscriptionDescription desc",
"associatedToNo",
"associatedToNo desc",
"welcomeLetter",
"welcomeLetter desc",
"isWelcomeLetterCreated",
"isWelcomeLetterCreated desc",
"hasBeenInEntryList",
"hasBeenInEntryList desc",
"hasBeenInWithdrawalList",
"hasBeenInWithdrawalList desc",
"invoiceQuantity",
"invoiceQuantity desc",
"invoiceMemberName",
"invoiceMemberName desc",
"memberName",
"memberName desc",
"no",
"no desc",
"price",
"price desc",
"publicationQuantity",
"publicationQuantity desc",
"invoiceDescription",
"invoiceDescription desc",
"sendMethod",
"sendMethod desc",
"onlinePaymentOrderId",
"onlinePaymentOrderId desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"memberNo",
"subscription",
"frequency",
"isBlocked",
"invoiceStartingDate",
"invoiceEndingDate",
"startingDate",
"endingDate",
"attentionName",
"invoiceMonth",
"eanNo",
"addresscodeInvoice",
"addresscodeMail",
"periodPrice",
"subscriptionGroup",
"invoiceMemberNo",
"subscriptionDescription",
"associatedToNo",
"welcomeLetter",
"isWelcomeLetterCreated",
"hasBeenInEntryList",
"hasBeenInWithdrawalList",
"invoiceQuantity",
"invoiceMemberName",
"memberName",
"no",
"price",
"publicationQuantity",
"invoiceDescription",
"sendMethod",
"onlinePaymentOrderId"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"member",
"collectionSubscription",
"onlinePayment"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of subscriptionMember",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.subscriptionMember"
}
}
}
}
}
}
}
}
},
"post": {
"summary": "Add new entity to subscriptionMembers",
"tags": [
"subscriptionMembers"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
}
],
"requestBody": {
"description": "New entity",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.subscriptionMember-create"
}
}
}
},
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"201": {
"description": "Created entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.subscriptionMember"
}
}
}
}
}
}
},
"/subscriptionMembers({systemId})": {
"parameters": [
{
"description": "key: systemId",
"in": "path",
"name": "systemId",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
}
},
{
"$ref": "#/components/parameters/company"
}
],
"get": {
"summary": "Get entity from subscriptionMembers by key",
"tags": [
"subscriptionMembers"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"memberNo",
"subscription",
"frequency",
"isBlocked",
"invoiceStartingDate",
"invoiceEndingDate",
"startingDate",
"endingDate",
"attentionName",
"invoiceMonth",
"eanNo",
"addresscodeInvoice",
"addresscodeMail",
"periodPrice",
"subscriptionGroup",
"invoiceMemberNo",
"subscriptionDescription",
"associatedToNo",
"welcomeLetter",
"isWelcomeLetterCreated",
"hasBeenInEntryList",
"hasBeenInWithdrawalList",
"invoiceQuantity",
"invoiceMemberName",
"memberName",
"no",
"price",
"publicationQuantity",
"invoiceDescription",
"sendMethod",
"onlinePaymentOrderId"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"member",
"collectionSubscription",
"onlinePayment"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.subscriptionMember"
}
}
}
}
}
},
"patch": {
"summary": "Update entity in subscriptionMembers",
"tags": [
"subscriptionMembers"
],
"requestBody": {
"description": "New property values",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.subscriptionMember-update"
}
}
}
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/error"
}
}
},
"delete": {
"summary": "Delete entity from subscriptionMembers",
"tags": [
"subscriptionMembers"
],
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/error"
}
}
}
},
"/subscriptionPrices": {
"get": {
"description": "Used to display a list of subscription prices. Filters can be applied to one, several or no fields
Permissions: Read
Returns: A list of subscription prices
Conditions: None
Examples:
GET:
All subscription prices: {environment}/api/computerCamp/general/v1.0/companies({company})/subscriptionPrices
Subscription prices for a specific subscription: {environment}/api/computerCamp/general/v1.0/companies({company})/subscriptionPrices?$filter=subscription eq '{subscription}'",
"summary": "Get entities from subscriptionPrices",
"tags": [
"subscriptionPrices"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"systemId desc",
"endingDate",
"endingDate desc",
"frequency",
"frequency desc",
"priceForUnits",
"priceForUnits desc",
"quantity",
"quantity desc",
"ruleCode",
"ruleCode desc",
"ruleType",
"ruleType desc",
"startingDate",
"startingDate desc",
"subscription",
"subscription desc",
"unitsInPrice",
"unitsInPrice desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"endingDate",
"frequency",
"priceForUnits",
"quantity",
"ruleCode",
"ruleType",
"startingDate",
"subscription",
"unitsInPrice"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"collectionSubscription"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of subscriptionPrice",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.subscriptionPrice"
}
}
}
}
}
}
}
}
}
},
"/subscriptionPrices({systemId})": {
"parameters": [
{
"description": "key: systemId",
"in": "path",
"name": "systemId",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
}
},
{
"$ref": "#/components/parameters/company"
}
],
"get": {
"summary": "Get entity from subscriptionPrices by key",
"tags": [
"subscriptionPrices"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"endingDate",
"frequency",
"priceForUnits",
"quantity",
"ruleCode",
"ruleType",
"startingDate",
"subscription",
"unitsInPrice"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"collectionSubscription"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.subscriptionPrice"
}
}
}
}
}
}
},
"/taxonomies": {
"get": {
"description": "Used to display a list of taxonomies. Filters can be applied to one, several or no fields
Permissions: Read
Returns: A list of taxonomies
Conditions: None
Examples:
GET:
All taxonomies: {environment}/api/computerCamp/general/v1.0/companies({company})/taxonomies
A specific taxonomy from number: {environment}/api/computerCamp/general/v1.0/companies({company})/taxonomies?$filter=no eq {no}
All taxonomies which can be displayed on internet: {environment}/api/computerCamp/general/v1.0/companies({company})/taxonomies?$filter=displayOnInternet eq true",
"summary": "Get entities from taxonomies",
"tags": [
"taxonomies"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"no",
"no desc",
"systemId",
"systemId desc",
"description",
"description desc",
"path",
"path desc",
"displayOnInternet",
"displayOnInternet desc",
"parentNo",
"parentNo desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"no",
"systemId",
"description",
"path",
"displayOnInternet",
"parentNo"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of taxonomy",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.taxonomy"
}
}
}
}
}
}
}
}
}
},
"/taxonomies({no})": {
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"description": "key: no",
"in": "path",
"name": "no",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"get": {
"summary": "Get entity from taxonomies by key",
"tags": [
"taxonomies"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"no",
"systemId",
"description",
"path",
"displayOnInternet",
"parentNo"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.taxonomy"
}
}
}
}
}
}
},
"/taxonomyCubes": {
"get": {
"description": "A list of taxonomy cube entities
Permissions: Read only
Returns: A list of taxonomy cube entities
Conditions: None
Examples:
GET:
Complete list: {environment}/api/computerCamp/general/v1.0/companies({company})/taxonomyCubes
A members records: {environment}/api/computerCamp/general/v1.0/companies({company})/taxonomyCubes?$filter=memberNo eq '{memberNo}'",
"summary": "Get entities from taxonomyCubes",
"tags": [
"taxonomyCubes"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"no",
"no desc",
"memberNo",
"memberNo desc",
"name",
"name desc",
"address",
"address desc",
"address2",
"address2 desc",
"city",
"city desc",
"phoneNo",
"phoneNo desc",
"countryRegionCode",
"countryRegionCode desc",
"postCode",
"postCode desc",
"eMail",
"eMail desc",
"chosenEMail",
"chosenEMail desc",
"memberIsActive",
"memberIsActive desc",
"age",
"age desc",
"municipalityName",
"municipalityName desc",
"regionName",
"regionName desc",
"memberGroup",
"memberGroup desc",
"cprNumber",
"cprNumber desc",
"localUnion",
"localUnion desc",
"subscriptionPriceGroup",
"subscriptionPriceGroup desc",
"mobilePhoneNo",
"mobilePhoneNo desc",
"municipality",
"municipality desc",
"localUnionDescription",
"localUnionDescription desc",
"birthDate",
"birthDate desc",
"gender",
"gender desc",
"region",
"region desc",
"activeMainEmployer",
"activeMainEmployer desc",
"employerName",
"employerName desc",
"employerAddress",
"employerAddress desc",
"employerCity",
"employerCity desc",
"employerPostCode",
"employerPostCode desc",
"activeAddress",
"activeAddress desc",
"activeAddress2",
"activeAddress2 desc",
"activePostCode",
"activePostCode desc",
"activeCity",
"activeCity desc",
"campCode1",
"campCode1 desc",
"campCode2",
"campCode2 desc",
"campText1",
"campText1 desc",
"campText2",
"campText2 desc",
"campText3",
"campText3 desc",
"campText4",
"campText4 desc",
"campText5",
"campText5 desc",
"referringTo",
"referringTo desc",
"taxonomyNo",
"taxonomyNo desc",
"taxonomyPath",
"taxonomyPath desc",
"startingDate",
"startingDate desc",
"endingDate",
"endingDate desc",
"comment",
"comment desc",
"taxonomyIsActive",
"taxonomyIsActive desc",
"shownOnInternet",
"shownOnInternet desc",
"description",
"description desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"no",
"memberNo",
"name",
"address",
"address2",
"city",
"phoneNo",
"countryRegionCode",
"postCode",
"eMail",
"chosenEMail",
"memberIsActive",
"age",
"municipalityName",
"regionName",
"memberGroup",
"cprNumber",
"localUnion",
"subscriptionPriceGroup",
"mobilePhoneNo",
"municipality",
"localUnionDescription",
"birthDate",
"gender",
"region",
"activeMainEmployer",
"employerName",
"employerAddress",
"employerCity",
"employerPostCode",
"activeAddress",
"activeAddress2",
"activePostCode",
"activeCity",
"campCode1",
"campCode2",
"campText1",
"campText2",
"campText3",
"campText4",
"campText5",
"referringTo",
"taxonomyNo",
"taxonomyPath",
"startingDate",
"endingDate",
"comment",
"taxonomyIsActive",
"shownOnInternet",
"description"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"member",
"code1",
"code2",
"taxonomy"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of taxonomyCube",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.taxonomyCube"
}
}
}
}
}
}
}
}
}
},
"/taxonomyCubes({no})": {
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"description": "key: no",
"in": "path",
"name": "no",
"required": true,
"schema": {
"format": "int64",
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"example": "42"
}
}
],
"get": {
"summary": "Get entity from taxonomyCubes by key",
"tags": [
"taxonomyCubes"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"no",
"memberNo",
"name",
"address",
"address2",
"city",
"phoneNo",
"countryRegionCode",
"postCode",
"eMail",
"chosenEMail",
"memberIsActive",
"age",
"municipalityName",
"regionName",
"memberGroup",
"cprNumber",
"localUnion",
"subscriptionPriceGroup",
"mobilePhoneNo",
"municipality",
"localUnionDescription",
"birthDate",
"gender",
"region",
"activeMainEmployer",
"employerName",
"employerAddress",
"employerCity",
"employerPostCode",
"activeAddress",
"activeAddress2",
"activePostCode",
"activeCity",
"campCode1",
"campCode2",
"campText1",
"campText2",
"campText3",
"campText4",
"campText5",
"referringTo",
"taxonomyNo",
"taxonomyPath",
"startingDate",
"endingDate",
"comment",
"taxonomyIsActive",
"shownOnInternet",
"description"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"member",
"code1",
"code2",
"taxonomy"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.taxonomyCube"
}
}
}
}
}
}
},
"/taxonomyMembers": {
"get": {
"description": "Insert, update and delete a taxonomy member. Filters can be applied to one, several or no fields
Permissions: Read and write
Returns: info about a taxonomy member or a list of taxonomy members
Conditions: None
Examples:
GET:
All taxonomy members for a given taxonomy: {environment}/api/computerCamp/general/v1.0/companies({company})/taxonomyMembers?$filter=taxonomy eq {taxonomy}
A specific taxonomy member for a given taxonomy: {environment}/api/computerCamp/general/v1.0/companies({company})/taxonomyMembers?$filter=taxonomy eq {taxonomy} and memberNo eq '{memberNo}'
All taxonomies for a specific member: {environment}/api/computerCamp/general/v1.0/companies({company})/taxonomyMembers?$filter=memberNo eq '{memberNo}'
POST:
create a taxonomy member
{environment}/api/computerCamp/general/v1.0/companies({company})/taxonomyMembers
{
\"taxonomy\": \"{taxonomy}\",
\"memberNo\": \"{memberNo}\",
\"startingDate\": \"2023-01-01\",
\"endingDate\": \"0001-01-01\",
\"comment\": \"{comment}\"
}",
"summary": "Get entities from taxonomyMembers",
"tags": [
"taxonomyMembers"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"systemId desc",
"taxonomy",
"taxonomy desc",
"taxonomyDescription",
"taxonomyDescription desc",
"taxonomyPath",
"taxonomyPath desc",
"memberNo",
"memberNo desc",
"startingDate",
"startingDate desc",
"endingDate",
"endingDate desc",
"no",
"no desc",
"comment",
"comment desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"taxonomy",
"taxonomyDescription",
"taxonomyPath",
"memberNo",
"startingDate",
"endingDate",
"no",
"comment"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"member"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of taxonomyMember",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.taxonomyMember"
}
}
}
}
}
}
}
}
},
"post": {
"summary": "Add new entity to taxonomyMembers",
"tags": [
"taxonomyMembers"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
}
],
"requestBody": {
"description": "New entity",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.taxonomyMember-create"
}
}
}
},
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"201": {
"description": "Created entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.taxonomyMember"
}
}
}
}
}
}
},
"/taxonomyMembers({systemId})": {
"parameters": [
{
"description": "key: systemId",
"in": "path",
"name": "systemId",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
}
},
{
"$ref": "#/components/parameters/company"
}
],
"get": {
"summary": "Get entity from taxonomyMembers by key",
"tags": [
"taxonomyMembers"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"taxonomy",
"taxonomyDescription",
"taxonomyPath",
"memberNo",
"startingDate",
"endingDate",
"no",
"comment"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"member"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.taxonomyMember"
}
}
}
}
}
},
"patch": {
"summary": "Update entity in taxonomyMembers",
"tags": [
"taxonomyMembers"
],
"requestBody": {
"description": "New property values",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.taxonomyMember-update"
}
}
}
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/error"
}
}
},
"delete": {
"summary": "Delete entity from taxonomyMembers",
"tags": [
"taxonomyMembers"
],
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/error"
}
}
}
},
"/unionPosts": {
"get": {
"description": "Insert, update and delete a union post. Filters can be applied to one, several or no fields
Permissions: Read and write
Returns: info about a union post or a list of union posts
Conditions: None
Examples:
GET:
All union posts: {environment}/api/computerCamp/general/v1.0/companies({company})/unionPosts
Union posts for a specific employee: {environment}/api/computerCamp/general/v1.0/companies({company})/unionPosts?$filter=employeeMemberNo eq '{employeeMemberNo}'
All union posts for a specific employer: {environment}/api/computerCamp/general/v1.0/companies({company})/unionPosts?$filter=employerMemberNo eq '{employerMemberNo}'
POST:
create a union post
{environment}/api/computerCamp/general/v1.0/companies({company})/unionPosts
{
\"employerMemberNo\": \"{employerMemberNo}\",
\"employeeMemberNo\": \"{employeeMemberNo}\",
\"unionPostType\": \"{unionPostType}\",
\"startingDate\": \"2023-01-01\",
\"endingDate\": \"0001-01-01\",
}",
"summary": "Get entities from unionPosts",
"tags": [
"unionPosts"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"systemId desc",
"employerMemberNo",
"employerMemberNo desc",
"employerName",
"employerName desc",
"employeeMemberNo",
"employeeMemberNo desc",
"employeeName",
"employeeName desc",
"unionPostType",
"unionPostType desc",
"unionPostTypeDescription",
"unionPostTypeDescription desc",
"startingDate",
"startingDate desc",
"endingDate",
"endingDate desc",
"withdrawalDate",
"withdrawalDate desc",
"isJobChanged",
"isJobChanged desc",
"no",
"no desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"employerMemberNo",
"employerName",
"employeeMemberNo",
"employeeName",
"unionPostType",
"unionPostTypeDescription",
"startingDate",
"endingDate",
"withdrawalDate",
"isJobChanged",
"no"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"member"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of unionPost",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.unionPost"
}
}
}
}
}
}
}
}
},
"post": {
"summary": "Add new entity to unionPosts",
"tags": [
"unionPosts"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
}
],
"requestBody": {
"description": "New entity",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.unionPost-create"
}
}
}
},
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"201": {
"description": "Created entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.unionPost"
}
}
}
}
}
}
},
"/unionPosts({systemId})": {
"parameters": [
{
"description": "key: systemId",
"in": "path",
"name": "systemId",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
}
},
{
"$ref": "#/components/parameters/company"
}
],
"get": {
"summary": "Get entity from unionPosts by key",
"tags": [
"unionPosts"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"systemId",
"employerMemberNo",
"employerName",
"employeeMemberNo",
"employeeName",
"unionPostType",
"unionPostTypeDescription",
"startingDate",
"endingDate",
"withdrawalDate",
"isJobChanged",
"no"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"member"
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.unionPost"
}
}
}
}
}
},
"patch": {
"summary": "Update entity in unionPosts",
"tags": [
"unionPosts"
],
"requestBody": {
"description": "New property values",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.unionPost-update"
}
}
}
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/error"
}
}
},
"delete": {
"summary": "Delete entity from unionPosts",
"tags": [
"unionPosts"
],
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/error"
}
}
}
},
"/unionPostTypes": {
"get": {
"description": "Used to display a list of union post types. Filters can be applied to one, several or no fields
Permissions: Read
Returns: A list of union post types
Conditions: None
Examples:
GET:
All union post types: {environment}/api/computerCamp/general/v1.0/companies({company})/unionPostTypes
A specific union post type from code: {environment}/api/computerCamp/general/v1.0/companies({company})/unionPostTypes?$filter=code eq '{code}'",
"summary": "Get entities from unionPostTypes",
"tags": [
"unionPostTypes"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"code",
"code desc",
"description",
"description desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"code",
"description"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of unionPostType",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.unionPostType"
}
}
}
}
}
}
}
}
}
},
"/unionPostTypes('{code}')": {
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"description": "key: code",
"in": "path",
"name": "code",
"required": true,
"schema": {
"type": "string",
"maxLength": 10
}
}
],
"get": {
"summary": "Get entity from unionPostTypes by key",
"tags": [
"unionPostTypes"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"code",
"description"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.unionPostType"
}
}
}
}
}
}
},
"/$batch": {
"post": {
"summary": "Send a group of requests",
"description": "Group multiple requests into a single request payload, see [Batch Requests](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_BatchRequests).\n\n*Please note that \"Try it out\" is not supported for this request.*",
"tags": [
"Batch Requests"
],
"requestBody": {
"required": true,
"description": "Batch request",
"content": {
"multipart/mixed;boundary=request-separator": {
"schema": {
"type": "string"
},
"example": "--request-separator\nContent-Type: application/http\nContent-Transfer-Encoding: binary\n\nGET educations HTTP/1.1\nAccept: application/json\n\n\n--request-separator--"
}
}
},
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Batch response",
"content": {
"multipart/mixed": {
"schema": {
"type": "string"
},
"example": "--response-separator\nContent-Type: application/http\n\nHTTP/1.1 200 OK\nContent-Type: application/json\n\n{...}\n--response-separator--"
}
}
}
}
}
}
},
"components": {
"schemas": {
"Microsoft.NAV.campAddresscodeInvoice": {
"type": "string",
"title": "campAddresscodeInvoice",
"enum": [
"PrimaryAddress",
"Employer",
"EmployerInvoice"
]
},
"Microsoft.NAV.campAddresscodeMail": {
"type": "string",
"title": "campAddresscodeMail",
"enum": [
"PrimaryAddress",
"Employer"
]
},
"Microsoft.NAV.campAddressUsage": {
"type": "string",
"title": "campAddressUsage",
"enum": [
"Selectable",
"Collection",
"Publication"
]
},
"Microsoft.NAV.campAnniversary": {
"type": "string",
"title": "campAnniversary",
"enum": [
"Education",
"Membership",
"Employment",
"Birthday"
]
},
"Microsoft.NAV.campCollectionStatus": {
"type": "string",
"title": "campCollectionStatus",
"enum": [
"Created",
"Approved",
"Posted",
"Paid"
]
},
"Microsoft.NAV.campCollectionType": {
"type": "string",
"title": "campCollectionType",
"enum": [
"Manuel",
"Periodic",
"Newsletter",
"Campaign",
"OnlinePayment",
"UnplacedPayment",
"Integration",
"Recalculation"
]
},
"Microsoft.NAV.campCommunityAccessType": {
"type": "string",
"title": "campCommunityAccessType",
"enum": [
"Open",
"Restricted",
"Closed"
]
},
"Microsoft.NAV.campGender": {
"type": "string",
"title": "campGender",
"enum": [
"Unknown",
"Male",
"Female"
]
},
"Microsoft.NAV.campInvoicePayTypes": {
"type": "string",
"title": "campInvoicePayTypes",
"enum": [
"None",
"Ordinary",
"Payroll"
]
},
"Microsoft.NAV.campMonth": {
"type": "string",
"title": "campMonth",
"enum": [
"None",
"January",
"February",
"March",
"April",
"May",
"June",
"July",
"August",
"September",
"October",
"November",
"December"
]
},
"Microsoft.NAV.campOnlinePaymentFunction": {
"type": "string",
"title": "campOnlinePaymentFunction",
"enum": [
"None",
"Authorize",
"Capture",
"Cancel",
"ReAuthorize",
"Refund",
"Subscribe"
]
},
"Microsoft.NAV.campOnlinePaymentStatus": {
"type": "string",
"title": "campOnlinePaymentStatus",
"enum": [
"None",
"Authorized",
"Captured",
"Cancelled",
"ReAuthorized",
"Refunded",
"Subscribed",
"Declined",
"Pending"
]
},
"Microsoft.NAV.campPayrollReportStatus": {
"type": "string",
"title": "campPayrollReportStatus",
"enum": [
"Created",
"RegStarted",
"SchemeReceived",
"UnsolvedProblem",
"SchemeDenied",
"SchemeAccepted"
]
},
"Microsoft.NAV.campPriceGroupRuleType": {
"type": "string",
"title": "campPriceGroupRuleType",
"enum": [
"All",
"Pricegroup",
"Account"
]
},
"Microsoft.NAV.campPublicationSendMethod": {
"type": "string",
"title": "campPublicationSendMethod",
"enum": [
"Email",
"SMS",
"Post"
]
},
"Microsoft.NAV.partnerType": {
"type": "string",
"title": "partnerType",
"enum": [
"_x0020_",
"Company",
"Person",
"Government"
]
},
"Microsoft.NAV.altAddress": {
"title": "altAddress",
"type": "object",
"properties": {
"systemId": {
"description": "The internal id of the record. Use this as index in the url when updating the record.",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
},
"code": {
"description": "",
"type": "string",
"maxLength": 10
},
"memberNo": {
"description": "The associated customer number",
"type": "string",
"maxLength": 20
},
"usage": {
"description": "The primary purpose for the location",
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campAddressUsage"
}
],
"nullable": true
},
"name": {
"description": "The address name of the location",
"type": "string",
"maxLength": 100,
"nullable": true
},
"name2": {
"description": "the address name 2 of the location",
"type": "string",
"maxLength": 50,
"nullable": true
},
"address": {
"description": "The address of the location",
"type": "string",
"maxLength": 100,
"nullable": true
},
"address2": {
"description": "The address 2 of the location",
"type": "string",
"maxLength": 50,
"nullable": true
},
"postCode": {
"description": "The address postal code of the location",
"type": "string",
"maxLength": 20,
"nullable": true
},
"city": {
"description": "The address city of the location",
"type": "string",
"maxLength": 30,
"nullable": true
},
"countryRegionCode": {
"description": "The address country of the location",
"type": "string",
"maxLength": 10,
"nullable": true
},
"county": {
"description": "The address county of the location",
"type": "string",
"maxLength": 30,
"nullable": true
},
"contact": {
"description": "The address contact of the location",
"type": "string",
"maxLength": 100,
"nullable": true
},
"eMail": {
"description": "The e-mail of the location",
"type": "string",
"maxLength": 80,
"nullable": true
},
"gln": {
"description": "The GLN number of the location",
"type": "string",
"maxLength": 13,
"nullable": true
},
"phoneNo": {
"description": "The phone number of the location",
"type": "string",
"maxLength": 30,
"nullable": true
}
}
},
"Microsoft.NAV.altAddress-create": {
"title": "altAddress (for create)",
"type": "object",
"properties": {
"code": {
"type": "string",
"maxLength": 10
},
"memberNo": {
"type": "string",
"maxLength": 20
},
"usage": {
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campAddressUsage"
}
],
"nullable": true
},
"name": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"name2": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"address": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"address2": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"postCode": {
"type": "string",
"maxLength": 20,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 30,
"nullable": true
},
"countryRegionCode": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 30,
"nullable": true
},
"contact": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"eMail": {
"type": "string",
"maxLength": 80,
"nullable": true
},
"gln": {
"type": "string",
"maxLength": 13,
"nullable": true
},
"phoneNo": {
"type": "string",
"maxLength": 30,
"nullable": true
}
},
"required": [
"code",
"memberNo"
]
},
"Microsoft.NAV.altAddress-update": {
"title": "altAddress (for update)",
"type": "object",
"properties": {
"code": {
"type": "string",
"maxLength": 10
},
"memberNo": {
"type": "string",
"maxLength": 20
},
"usage": {
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campAddressUsage"
}
],
"nullable": true
},
"name": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"name2": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"address": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"address2": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"postCode": {
"type": "string",
"maxLength": 20,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 30,
"nullable": true
},
"countryRegionCode": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 30,
"nullable": true
},
"contact": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"eMail": {
"type": "string",
"maxLength": 80,
"nullable": true
},
"gln": {
"type": "string",
"maxLength": 13,
"nullable": true
},
"phoneNo": {
"type": "string",
"maxLength": 30,
"nullable": true
}
}
},
"Microsoft.NAV.calculatedanniversary": {
"title": "calculatedanniversary",
"type": "object",
"properties": {
"member": {
"description": "Unique id of the member",
"type": "string",
"maxLength": 20
},
"anniversaryType": {
"description": "Type of member anniversary",
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campAnniversary"
}
]
},
"anniversaryDate": {
"description": "Anniversary date",
"type": "string",
"format": "date",
"example": "2017-04-13"
},
"year": {
"description": "Anniversary year",
"type": "integer",
"format": "int32"
},
"education": {
"description": "",
"type": "string",
"maxLength": 20
},
"employer": {
"description": "",
"type": "string",
"maxLength": 20
},
"name": {
"description": "Name of member",
"type": "string",
"maxLength": 100,
"nullable": true
},
"dateOfCalculation": {
"description": "Date og calculation",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"localUnion": {
"description": "The local union of the member ",
"type": "string",
"maxLength": 10,
"nullable": true
},
"educationDescription": {
"description": "Name of the education",
"type": "string",
"maxLength": 60,
"nullable": true
},
"employerName": {
"description": "Name of the employer",
"type": "string",
"maxLength": 100,
"nullable": true
}
}
},
"Microsoft.NAV.code1": {
"title": "code1",
"type": "object",
"properties": {
"systemId": {
"description": "",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
},
"code": {
"description": "",
"type": "string",
"maxLength": 20
},
"description": {
"description": "Description of the code",
"type": "string",
"maxLength": 50,
"nullable": true
}
}
},
"Microsoft.NAV.code1-create": {
"title": "code1 (for create)",
"type": "object",
"properties": {
"code": {
"type": "string",
"maxLength": 20
},
"description": {
"type": "string",
"maxLength": 50,
"nullable": true
}
},
"required": [
"code"
]
},
"Microsoft.NAV.code1-update": {
"title": "code1 (for update)",
"type": "object",
"properties": {
"code": {
"type": "string",
"maxLength": 20
},
"description": {
"type": "string",
"maxLength": 50,
"nullable": true
}
}
},
"Microsoft.NAV.code2": {
"title": "code2",
"type": "object",
"properties": {
"systemId": {
"description": "",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
},
"code": {
"description": "",
"type": "string",
"maxLength": 20
},
"description": {
"description": "Description of the code",
"type": "string",
"maxLength": 50,
"nullable": true
}
}
},
"Microsoft.NAV.code2-create": {
"title": "code2 (for create)",
"type": "object",
"properties": {
"code": {
"type": "string",
"maxLength": 20
},
"description": {
"type": "string",
"maxLength": 50,
"nullable": true
}
},
"required": [
"code"
]
},
"Microsoft.NAV.code2-update": {
"title": "code2 (for update)",
"type": "object",
"properties": {
"code": {
"type": "string",
"maxLength": 20
},
"description": {
"type": "string",
"maxLength": 50,
"nullable": true
}
}
},
"Microsoft.NAV.collectionLine": {
"title": "collectionLine",
"type": "object",
"properties": {
"systemId": {
"description": "The unique system-generated GUID for this collection line record, used as the OData key.",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
},
"amountLCYIncludingVAT": {
"description": "The total amount of the collection line in local currency, including VAT.",
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
],
"format": "decimal",
"example": 0,
"nullable": true
},
"amountLCY": {
"description": "The amount of the collection line in local currency, excluding VAT.",
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
],
"format": "decimal",
"example": 0,
"nullable": true
},
"collectionNo": {
"description": "The document number of the collection this line belongs to.",
"type": "string",
"maxLength": 20,
"nullable": true
},
"collectionFrequency": {
"description": "The frequency at which this collection line is charged, e.g. monthly or yearly.",
"type": "integer",
"format": "int32",
"nullable": true
},
"description": {
"description": "A text description of the collection line, typically the name of the subscription or item being charged.",
"type": "string",
"maxLength": 60,
"nullable": true
},
"endingDate": {
"description": "The date on which the collection period covered by this line ends.",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"log": {
"description": "A log of events or status changes that have occurred on this collection line.",
"type": "string",
"maxLength": 250,
"nullable": true
},
"memberName": {
"description": "The full name of the member being charged on this collection line.",
"type": "string",
"maxLength": 100,
"nullable": true
},
"memberNo": {
"description": "The unique identifier of the member being charged on this collection line.",
"type": "string",
"maxLength": 20,
"nullable": true
},
"membersubscriptionId": {
"description": "The unique identifier of the member subscription that generated this collection line.",
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"format": "int64",
"example": "42",
"nullable": true
},
"no": {
"description": "The line number that uniquely identifies this line within the collection.",
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"format": "int64",
"example": "42",
"nullable": true
},
"postAtPaymentFromSub": {
"description": "Indicates whether this line should be posted when payment is received from the subscription rather than at collection time.",
"type": "boolean",
"nullable": true
},
"quantity": {
"description": "The number of units charged on this collection line.",
"type": "integer",
"format": "int32",
"nullable": true
},
"recalcOf": {
"description": "The line number of the original collection line that this line is a recalculation of. Empty if this is not a recalculation.",
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"format": "int64",
"example": "42",
"nullable": true
},
"recalculatedOn": {
"description": "The date on which this collection line was recalculated.",
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"format": "int64",
"example": "42",
"nullable": true
},
"refundOf": {
"description": "The line number of the original collection line that this line is a refund of. Empty if this is not a refund.",
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"format": "int64",
"example": "42",
"nullable": true
},
"refundedOn": {
"description": "The date on which this collection line was refunded.",
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"format": "int64",
"example": "42",
"nullable": true
},
"reportingDocumentationGrpNo": {
"description": "The reporting documentation group number used to categorise this line for financial reporting purposes.",
"type": "integer",
"format": "int32",
"nullable": true
},
"startingDate": {
"description": "The date on which the collection period covered by this line begins.",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"subscription": {
"description": "The subscription type or code associated with this collection line.",
"type": "string",
"maxLength": 20,
"nullable": true
},
"subscriptionPricegroup": {
"description": "The price group applied to the subscription, which determines the rate used to calculate the amount.",
"type": "string",
"maxLength": 10,
"nullable": true
},
"vat": {
"description": "The VAT percentage applied to this collection line.",
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
],
"format": "decimal",
"example": 0,
"nullable": true
}
}
},
"Microsoft.NAV.collection": {
"title": "collection",
"type": "object",
"properties": {
"systemId": {
"description": "The system-generated unique identifier (GUID) for this collection record.",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
},
"amountLCY": {
"description": "The total collection amount in local currency, excluding VAT.",
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
],
"format": "decimal",
"example": 0,
"nullable": true
},
"amountLCYIncludingVAT": {
"description": "The total collection amount in local currency, including VAT.",
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
],
"format": "decimal",
"example": 0,
"nullable": true
},
"batchNo": {
"description": "The batch number used to group collections that were processed together.",
"type": "string",
"maxLength": 20,
"nullable": true
},
"collectionNo": {
"description": "The unique identifier for this collection.",
"type": "string",
"maxLength": 20
},
"collectionPeriod": {
"description": "The period (e.g. month or quarter) that this collection covers.",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"collectionStatus": {
"description": "The current processing status of the collection, such as Open, Sent, or Closed.",
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campCollectionStatus"
}
],
"nullable": true
},
"documentNo": {
"description": "The document number associated with this collection, typically the posted invoice or credit memo number.",
"type": "string",
"maxLength": 20,
"nullable": true
},
"donation": {
"description": "Indicates whether this collection includes a voluntary donation from the member.",
"type": "string",
"maxLength": 20,
"nullable": true
},
"dueDate": {
"description": "The date by which payment for this collection must be received.",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"glnNo": {
"description": "The Global Location Number (GLN) of the member, used for electronic invoicing (EAN/PEPPOL).",
"type": "string",
"maxLength": 13,
"nullable": true
},
"invoiceDate": {
"description": "The date on which the invoice for this collection was issued.",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"invoiceMemberNo": {
"description": "The member number of the party being invoiced, which may differ from the member if invoiced through a parent or payer account.",
"type": "string",
"maxLength": 20,
"nullable": true
},
"invoiceAccountName": {
"description": "The name of the account that the invoice is addressed to.",
"type": "string",
"maxLength": 100,
"nullable": true
},
"invoiceNo": {
"description": "The invoice number issued to the member for this collection.",
"type": "string",
"maxLength": 20,
"nullable": true
},
"log": {
"description": "A free-text log of events or notes recorded on this collection.",
"type": "string",
"maxLength": 250,
"nullable": true
},
"memberNo": {
"description": "The unique member number identifying the member this collection belongs to.",
"type": "string",
"maxLength": 20,
"nullable": true
},
"memberName": {
"description": "The full name of the member this collection belongs to.",
"type": "string",
"maxLength": 100,
"nullable": true
},
"oldBalance": {
"description": "The outstanding balance on the member''s account prior to this collection being processed.",
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
],
"format": "decimal",
"example": 0,
"nullable": true
},
"paymentId": {
"description": "The payment identifier returned by the payment provider, used to reconcile payments against this collection.",
"type": "string",
"maxLength": 20,
"nullable": true
},
"paymentMethodCode": {
"description": "The code of the payment method used for this collection, such as BANK, PBS, or CARD.",
"type": "string",
"maxLength": 10,
"nullable": true
},
"paymentType": {
"description": "The type of payment arrangement for this collection, such as direct debit or manual payment.",
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campInvoicePayTypes"
}
],
"nullable": true
},
"postingDescription": {
"description": "The description text used when posting the collection to the general ledger.",
"type": "string",
"maxLength": 50,
"nullable": true
},
"recalculate": {
"description": "Indicates whether this collection should be recalculated, for example after a membership change.",
"type": "boolean",
"nullable": true
},
"recalcOf": {
"description": "The collection number of the original collection that this entry is a recalculation of.",
"type": "string",
"maxLength": 20,
"nullable": true
},
"recalculatedOn": {
"description": "The date on which this collection was recalculated.",
"type": "string",
"maxLength": 20,
"nullable": true
},
"refundOf": {
"description": "The collection number of the original collection that this entry is a refund of.",
"type": "string",
"maxLength": 20,
"nullable": true
},
"refundedOn": {
"description": "The date on which this collection was refunded.",
"type": "string",
"maxLength": 20,
"nullable": true
},
"typeOfCollection": {
"description": "The type of collection, such as membership fee, donation, or one-time charge.",
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campCollectionType"
}
],
"nullable": true
}
}
},
"Microsoft.NAV.collection-update": {
"title": "collection (for update)",
"type": "object",
"properties": {
"log": {
"type": "string",
"maxLength": 250,
"nullable": true
},
"recalculate": {
"type": "boolean",
"nullable": true
}
}
},
"Microsoft.NAV.collectionSubscription": {
"title": "collectionSubscription",
"type": "object",
"properties": {
"systemId": {
"description": "",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
},
"code": {
"description": "",
"type": "string",
"maxLength": 20
},
"description": {
"description": "Description of the subscription",
"type": "string",
"maxLength": 30,
"nullable": true
},
"internetDescription": {
"description": "Description used on the internet",
"type": "string",
"maxLength": 250,
"nullable": true
},
"subscriptionGroup": {
"description": "The subscription group in which the subscription belongs",
"type": "string",
"maxLength": 20,
"nullable": true
},
"displayOnInternet": {
"description": "Is the event to be displayed on the internet",
"type": "boolean",
"nullable": true
},
"welcomeLetter": {
"description": "Does the subscription trigger a welcome mail",
"type": "boolean",
"nullable": true
},
"sortingCode": {
"description": "An alternative way of sorting",
"type": "string",
"maxLength": 10,
"nullable": true
}
}
},
"Microsoft.NAV.committeeMember": {
"title": "committeeMember",
"type": "object",
"properties": {
"systemId": {
"description": "",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
},
"committee": {
"description": "Unique id of the committee",
"type": "string",
"maxLength": 10
},
"memberNo": {
"description": "Unique id of member",
"type": "string",
"maxLength": 20
},
"committeeFunctionDescription": {
"description": "Read-Only. Description of the committee function",
"type": "string",
"maxLength": 60,
"nullable": true
},
"committeeName": {
"description": "Read-Only. Description of the committee",
"type": "string",
"maxLength": 30,
"nullable": true
},
"memberEmail": {
"description": "Read-Only. E-mail address of the member",
"type": "string",
"maxLength": 80,
"nullable": true
},
"note": {
"description": "Notes associated with the committee member",
"type": "string",
"maxLength": 2000,
"nullable": true
},
"committeeRefersTo": {
"description": "Read-Only. The committee this committee refres to",
"type": "string",
"maxLength": 10,
"nullable": true
},
"startingDate": {
"description": "The starting date for the committee membership",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"endingDate": {
"description": "The ending date for the committee membership",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"committeeFunction": {
"description": "The committee function for the membership",
"type": "string",
"maxLength": 10
},
"memberName": {
"description": "Read-Only.. The name of the member",
"type": "string",
"maxLength": 100,
"nullable": true
},
"memberPhoneNo": {
"description": "Read-Only. The phone number of the member",
"type": "string",
"maxLength": 30,
"nullable": true
},
"memberMobilePhoneNo": {
"description": "Read-Only. The mobile phone of the member",
"type": "string",
"maxLength": 30,
"nullable": true
},
"localUnion": {
"description": "Read-Only. The local union in which the member belongs",
"type": "string",
"maxLength": 10,
"nullable": true
},
"priority": {
"description": "The priority of the membership",
"type": "string",
"maxLength": 10,
"nullable": true
}
}
},
"Microsoft.NAV.committeeMember-create": {
"title": "committeeMember (for create)",
"type": "object",
"properties": {
"committee": {
"type": "string",
"maxLength": 10
},
"memberNo": {
"type": "string",
"maxLength": 20
},
"note": {
"type": "string",
"maxLength": 2000,
"nullable": true
},
"startingDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"endingDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"committeeFunction": {
"type": "string",
"maxLength": 10
},
"priority": {
"type": "string",
"maxLength": 10,
"nullable": true
}
},
"required": [
"committee",
"memberNo",
"committeeFunction"
]
},
"Microsoft.NAV.committeeMember-update": {
"title": "committeeMember (for update)",
"type": "object",
"properties": {
"committee": {
"type": "string",
"maxLength": 10
},
"memberNo": {
"type": "string",
"maxLength": 20
},
"note": {
"type": "string",
"maxLength": 2000,
"nullable": true
},
"startingDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"endingDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"committeeFunction": {
"type": "string",
"maxLength": 10
},
"priority": {
"type": "string",
"maxLength": 10,
"nullable": true
}
}
},
"Microsoft.NAV.committee": {
"title": "committee",
"type": "object",
"properties": {
"code": {
"description": "",
"type": "string",
"maxLength": 10
},
"systemId": {
"description": "",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef",
"nullable": true
},
"caseWorker": {
"description": "The case worker associated with the committee",
"type": "string",
"maxLength": 30,
"nullable": true
},
"closed": {
"description": "Deprecated from version 23.2.0.0. Use starting and ending dates.
Closed",
"type": "boolean",
"nullable": true
},
"committeeType": {
"description": "Type of committee",
"type": "string",
"maxLength": 10,
"nullable": true
},
"committeeTypeDescription": {
"description": "Description of the committee type",
"type": "string",
"maxLength": 30,
"nullable": true
},
"displayOnInternet": {
"description": "Can the committee be displayed on internet",
"type": "boolean",
"nullable": true
},
"electionDate": {
"description": "Date of election of the board of directors",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"endingDate": {
"description": "Ending date of the committee",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"fullName": {
"description": "Full name of committee",
"type": "string",
"maxLength": 120,
"nullable": true
},
"localUnion": {
"description": "Local union associated with the committee",
"type": "string",
"maxLength": 10,
"nullable": true
},
"localUnionDescription": {
"description": "Read-Only. Name of local union associated with the committee",
"type": "string",
"maxLength": 50,
"nullable": true
},
"name": {
"description": "Committee name",
"type": "string",
"maxLength": 30
},
"postingMember": {
"description": "Posting member associated with the committee",
"type": "string",
"maxLength": 20,
"nullable": true
},
"referringTo": {
"description": "The committee this committee refers to",
"type": "string",
"maxLength": 10,
"nullable": true
},
"referringToName": {
"description": "Name of the committee this committee refers to",
"type": "string",
"maxLength": 30,
"nullable": true
},
"region": {
"description": "Region in which the committee belongs",
"type": "string",
"maxLength": 10,
"nullable": true
},
"regionName": {
"description": "Name of the region in which the committee belongs",
"type": "string",
"maxLength": 30,
"nullable": true
},
"report": {
"description": "",
"type": "boolean",
"nullable": true
},
"secretary": {
"description": "The secretary associated with the committee",
"type": "string",
"maxLength": 30,
"nullable": true
},
"startingDate": {
"description": "Starting date of the committee",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"hasTaxonomy": {
"description": "Indicates if the committee has a taxonomy",
"type": "boolean",
"nullable": true
},
"taxonomyFilter": {
"description": "Used with hastaxonomy to filter records with a specific taxonomy",
"type": "string",
"nullable": true
}
}
},
"Microsoft.NAV.committeeType": {
"title": "committeeType",
"type": "object",
"properties": {
"code": {
"description": "",
"type": "string",
"maxLength": 10
},
"systemId": {
"description": "",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef",
"nullable": true
},
"description": {
"description": "Description of the committee type",
"type": "string",
"maxLength": 30
}
}
},
"Microsoft.NAV.community": {
"title": "community",
"type": "object",
"properties": {
"systemId": {
"description": "",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
},
"code": {
"description": "",
"type": "string",
"maxLength": 20
},
"name": {
"description": "Description of the community",
"type": "string",
"maxLength": 50,
"nullable": true
},
"accessType": {
"description": "Access type to the community",
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campCommunityAccessType"
}
],
"nullable": true
},
"startingDate": {
"description": "Starting date of the community",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"endingDate": {
"description": "Ending date of the community",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"type": {
"description": "Type of community",
"type": "string",
"maxLength": 20,
"nullable": true
},
"shownOnInternet": {
"description": "Shown on Internet",
"type": "boolean",
"nullable": true
},
"description": {
"description": "",
"type": "string",
"maxLength": 2000,
"nullable": true
},
"teamsURL": {
"description": "The url of the team.",
"type": "string",
"maxLength": 300,
"nullable": true
},
"createInTeams": {
"description": "",
"type": "boolean",
"nullable": true
},
"teamsActive": {
"description": "",
"type": "boolean",
"nullable": true
},
"teamsTemplate": {
"description": "",
"type": "string",
"maxLength": 100,
"nullable": true
}
}
},
"Microsoft.NAV.community-create": {
"title": "community (for create)",
"type": "object",
"properties": {
"code": {
"type": "string",
"maxLength": 20
},
"name": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"accessType": {
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campCommunityAccessType"
}
],
"nullable": true
},
"startingDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"endingDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"type": {
"type": "string",
"maxLength": 20,
"nullable": true
},
"shownOnInternet": {
"type": "boolean",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 2000,
"nullable": true
},
"createInTeams": {
"type": "boolean",
"nullable": true
},
"teamsActive": {
"type": "boolean",
"nullable": true
},
"teamsTemplate": {
"type": "string",
"maxLength": 100,
"nullable": true
}
},
"required": [
"code"
]
},
"Microsoft.NAV.community-update": {
"title": "community (for update)",
"type": "object",
"properties": {
"code": {
"type": "string",
"maxLength": 20
},
"name": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"accessType": {
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campCommunityAccessType"
}
],
"nullable": true
},
"startingDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"endingDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"type": {
"type": "string",
"maxLength": 20,
"nullable": true
},
"shownOnInternet": {
"type": "boolean",
"nullable": true
},
"description": {
"type": "string",
"maxLength": 2000,
"nullable": true
},
"createInTeams": {
"type": "boolean",
"nullable": true
},
"teamsActive": {
"type": "boolean",
"nullable": true
},
"teamsTemplate": {
"type": "string",
"maxLength": 100,
"nullable": true
}
}
},
"Microsoft.NAV.communityMember": {
"title": "communityMember",
"type": "object",
"properties": {
"systemId": {
"description": "",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
},
"communityCode": {
"description": "Unique id of the community",
"type": "string",
"maxLength": 20
},
"memberNo": {
"description": "Unique id of member",
"type": "string",
"maxLength": 20
},
"startingDate": {
"description": "The starting date for the community membership",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"endingDate": {
"description": "The ending date for the community membership",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"communityName": {
"description": "Read-Only. Description of the community",
"type": "string",
"maxLength": 50,
"nullable": true
},
"communityAccessType": {
"description": "Read-Only. The type of access to the community. Can be open, restricted or closed",
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campCommunityAccessType"
}
],
"nullable": true
},
"teamsEmail": {
"description": "Read-Only. The E-Mail address used to sign in to Teams. If blank the member has not been invited.",
"type": "string",
"maxLength": 80,
"nullable": true
}
}
},
"Microsoft.NAV.communityMember-create": {
"title": "communityMember (for create)",
"type": "object",
"properties": {
"communityCode": {
"type": "string",
"maxLength": 20
},
"memberNo": {
"type": "string",
"maxLength": 20
},
"startingDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"endingDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
}
},
"required": [
"communityCode",
"memberNo"
]
},
"Microsoft.NAV.communityMember-update": {
"title": "communityMember (for update)",
"type": "object",
"properties": {
"communityCode": {
"type": "string",
"maxLength": 20
},
"memberNo": {
"type": "string",
"maxLength": 20
},
"startingDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"endingDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
}
}
},
"Microsoft.NAV.communityType": {
"title": "communityType",
"type": "object",
"properties": {
"systemId": {
"description": "",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
},
"code": {
"description": "",
"type": "string",
"maxLength": 20
},
"description": {
"description": "Description of the community",
"type": "string",
"maxLength": 100,
"nullable": true
}
}
},
"Microsoft.NAV.communityType-create": {
"title": "communityType (for create)",
"type": "object",
"properties": {
"code": {
"type": "string",
"maxLength": 20
},
"description": {
"type": "string",
"maxLength": 100,
"nullable": true
}
},
"required": [
"code"
]
},
"Microsoft.NAV.communityType-update": {
"title": "communityType (for update)",
"type": "object",
"properties": {
"code": {
"type": "string",
"maxLength": 20
},
"description": {
"type": "string",
"maxLength": 100,
"nullable": true
}
}
},
"Microsoft.NAV.dimension": {
"title": "dimension",
"type": "object",
"properties": {
"dimensionCode": {
"description": "",
"type": "string",
"maxLength": 20
},
"code": {
"description": "",
"type": "string",
"maxLength": 20
},
"blocked": {
"description": "Is the dimension blocked",
"type": "boolean",
"nullable": true
},
"globalDimensionNo": {
"description": "The number af the global dimension in the dimension setup",
"type": "integer",
"format": "int32",
"nullable": true
},
"name": {
"description": "Description of the dimension",
"type": "string",
"maxLength": 50,
"nullable": true
}
}
},
"Microsoft.NAV.educationInstitute": {
"title": "educationInstitute",
"type": "object",
"properties": {
"code": {
"description": "",
"type": "string",
"maxLength": 20
},
"systemId": {
"description": "",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef",
"nullable": true
},
"description": {
"description": "Description of the education institute",
"type": "string",
"maxLength": 60,
"nullable": true
}
}
},
"Microsoft.NAV.education": {
"title": "education",
"type": "object",
"properties": {
"code": {
"description": "",
"type": "string",
"maxLength": 20
},
"systemId": {
"description": "",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef",
"nullable": true
},
"description": {
"description": "Description of the education",
"type": "string",
"maxLength": 60,
"nullable": true
},
"semesterCalculation": {
"description": "Specifies if semester calculation is activated for the education",
"type": "boolean",
"nullable": true
}
}
},
"Microsoft.NAV.employmentType": {
"title": "employmentType",
"type": "object",
"properties": {
"systemId": {
"description": "",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
},
"code": {
"description": "",
"type": "string",
"maxLength": 10
},
"description": {
"description": "Description of the code",
"type": "string",
"maxLength": 30,
"nullable": true
}
}
},
"Microsoft.NAV.flowMember": {
"title": "flowMember",
"type": "object",
"properties": {
"code": {
"description": "",
"type": "string",
"maxLength": 10
},
"memberNo": {
"description": "",
"type": "string",
"maxLength": 20
},
"name": {
"description": "",
"type": "string",
"maxLength": 100,
"nullable": true
},
"creationDate": {
"description": "",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"withdrawalDate": {
"description": "",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"eMail": {
"description": "",
"type": "string",
"maxLength": 80,
"nullable": true
},
"customerSystemId": {
"description": "",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef",
"nullable": true
},
"date": {
"description": "",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"systemId": {
"description": "",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef",
"nullable": true
},
"creationDateEqualsDate": {
"description": "",
"type": "boolean",
"nullable": true
}
}
},
"Microsoft.NAV.function": {
"title": "function",
"type": "object",
"properties": {
"code": {
"description": "",
"type": "string",
"maxLength": 10
},
"systemId": {
"description": "",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef",
"nullable": true
},
"description": {
"description": "Description of the committee function",
"type": "string",
"maxLength": 60
},
"chairman": {
"description": "Indicates if the committee function is chairman",
"type": "boolean",
"nullable": true
},
"treasurer": {
"description": "Indicates if the committee function is treasure",
"type": "boolean",
"nullable": true
},
"unique": {
"description": "Is the committee function unique in the committee",
"type": "boolean",
"nullable": true
},
"eventAdmin": {
"description": "Indicates if committee function is Event Administrator",
"type": "boolean",
"nullable": true
},
"eventSecretary": {
"description": "Indicates if committee function is Event Secretary",
"type": "boolean",
"nullable": true
}
}
},
"Microsoft.NAV.jobEmployee": {
"title": "jobEmployee",
"type": "object",
"properties": {
"systemId": {
"description": "",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
},
"employeeMemberNo": {
"description": "Unique id of member/employee",
"type": "string",
"maxLength": 20
},
"employeeName": {
"description": "Read-Only. Name of the employee from the member card",
"type": "string",
"maxLength": 100,
"nullable": true
},
"employeeMemberGroup": {
"description": "The member group of the employee",
"type": "string",
"maxLength": 10,
"nullable": true
},
"employeeMemberGroupDesc": {
"description": "The description of the member group of the employee",
"type": "string",
"maxLength": 60,
"nullable": true
},
"employeeAddress": {
"description": "Read-Only. Employee address from the member card",
"type": "string",
"maxLength": 100,
"nullable": true
},
"employeePostCode": {
"description": "Read-Only. Employee post code from the member card",
"type": "string",
"maxLength": 100,
"nullable": true
},
"employeeCity": {
"description": "Read-Only. Employee city from the member card",
"type": "string",
"maxLength": 100,
"nullable": true
},
"employeeCountry": {
"description": "Read-Only. Employee country from the member card",
"type": "string",
"maxLength": 100,
"nullable": true
},
"employerMemberNo": {
"description": "Unique id of member/employer",
"type": "string",
"maxLength": 20
},
"employerName": {
"description": "Read-Only. Name of the employer from the member card",
"type": "string",
"maxLength": 100,
"nullable": true
},
"employerMemberGroup": {
"description": "The member group of the employer",
"type": "string",
"maxLength": 10,
"nullable": true
},
"employerMemberGroupDesc": {
"description": "The description of the member group of the employer",
"type": "string",
"maxLength": 60,
"nullable": true
},
"startingDate": {
"description": "Starting date of the employment",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"endingDate": {
"description": "Ending date of the employment",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"isMainJob": {
"description": "Is it the main employment of the member",
"type": "boolean",
"nullable": true
},
"position": {
"description": "The postition of the employee in the current employment",
"type": "string",
"maxLength": 10,
"nullable": true
},
"extentOfEmployment": {
"description": "The extent of the employment",
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
],
"format": "decimal",
"example": 0,
"nullable": true
},
"employmentType": {
"description": "The type of employment",
"type": "string",
"maxLength": 10,
"nullable": true
},
"eMail": {
"description": "The e-mail for the employment",
"type": "string",
"maxLength": 80,
"nullable": true
},
"mobilePhoneNo": {
"description": "The mobile phone number for the employment. Can only contain the characters: \"()+- 0123456789\"",
"type": "string",
"maxLength": 30,
"nullable": true
},
"phoneNo": {
"description": "The phone number for the employment. Can only contain the characters: \"()+- 0123456789\"",
"type": "string",
"maxLength": 30,
"nullable": true
},
"internetResponsible": {
"description": "Is the employee internet responsible",
"type": "boolean",
"nullable": true
},
"jobNo": {
"description": "",
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"format": "int64",
"example": "42",
"nullable": true
}
}
},
"Microsoft.NAV.jobQueue": {
"title": "jobQueue",
"type": "object",
"properties": {
"systemId": {
"description": "",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
},
"objectIDtoRun": {
"description": "Object ID to run",
"type": "integer",
"format": "int32",
"nullable": true
},
"objectTypetoRun": {
"description": "Object Type to run",
"type": "string",
"nullable": true
},
"objectCaptiontoRun": {
"description": "Caption of the object to run",
"type": "string",
"maxLength": 250,
"nullable": true
},
"description": {
"description": "Description of the code",
"type": "string",
"maxLength": 250,
"nullable": true
},
"recurringJob": {
"description": "Recurring Job",
"type": "boolean",
"nullable": true
},
"scheduled": {
"description": "Scheduled",
"type": "boolean",
"nullable": true
},
"status": {
"description": "Status",
"type": "string",
"nullable": true
},
"earliestStartDateTime": {
"description": "Earliest start date/time",
"type": "string",
"format": "date-time",
"nullable": true
},
"startingDateTime": {
"description": "Starting time of the latest execution",
"type": "string",
"format": "date-time",
"nullable": true
},
"lastReadyState": {
"description": "Last ready state",
"type": "string",
"format": "date-time",
"nullable": true
},
"userID": {
"description": "",
"type": "string",
"maxLength": 65,
"nullable": true
},
"userName": {
"description": "User''s name",
"type": "string",
"nullable": true
},
"userLanguageID": {
"description": "User''s language ID",
"type": "integer",
"format": "int32",
"nullable": true
},
"userEmail": {
"description": "User''s email address",
"type": "string",
"nullable": true
},
"errorMessage": {
"description": "Error Message",
"type": "string",
"maxLength": 2048,
"nullable": true
}
}
},
"Microsoft.NAV.job": {
"title": "job",
"type": "object",
"properties": {
"systemId": {
"description": "",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
},
"employeeMemberNo": {
"description": "Unique id of member/employee",
"type": "string",
"maxLength": 20
},
"employeeName": {
"description": "Read-Only. Name of the employee from the member card",
"type": "string",
"maxLength": 100,
"nullable": true
},
"employeeMemberGroup": {
"description": "The member group of the employee",
"type": "string",
"maxLength": 10,
"nullable": true
},
"employeeMemberGroupDesc": {
"description": "The description of the member group of the employee",
"type": "string",
"maxLength": 60,
"nullable": true
},
"employeeAddress": {
"description": "Read-Only. Employee address from the member card",
"type": "string",
"maxLength": 100,
"nullable": true
},
"employeePostCode": {
"description": "Read-Only. Employee post code from the member card",
"type": "string",
"maxLength": 100,
"nullable": true
},
"employeeCity": {
"description": "Read-Only. Employee city from the member card",
"type": "string",
"maxLength": 100,
"nullable": true
},
"employeeCountry": {
"description": "Read-Only. Employee country from the member card",
"type": "string",
"maxLength": 100,
"nullable": true
},
"employerMemberNo": {
"description": "Unique id of member/employer",
"type": "string",
"maxLength": 20
},
"employerName": {
"description": "Read-Only. Name of the employer from the member card",
"type": "string",
"maxLength": 100,
"nullable": true
},
"employerMemberGroup": {
"description": "The member group of the employer",
"type": "string",
"maxLength": 10,
"nullable": true
},
"employerMemberGroupDesc": {
"description": "The description of the member group of the employer",
"type": "string",
"maxLength": 60,
"nullable": true
},
"startingDate": {
"description": "Starting date of the employment",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"endingDate": {
"description": "Ending date of the employment",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"isMainJob": {
"description": "Is it the main employment of the member",
"type": "boolean",
"nullable": true
},
"position": {
"description": "The postition of the employee in the current employment",
"type": "string",
"maxLength": 10,
"nullable": true
},
"extentOfEmployment": {
"description": "The extent of the employment",
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
],
"format": "decimal",
"example": 0,
"nullable": true
},
"employmentType": {
"description": "The type of employment",
"type": "string",
"maxLength": 10,
"nullable": true
},
"eMail": {
"description": "The e-mail for the employment",
"type": "string",
"maxLength": 80,
"nullable": true
},
"mobilePhoneNo": {
"description": "The mobile phone number for the employment. Can only contain the characters: \"()+- 0123456789\"",
"type": "string",
"maxLength": 30,
"nullable": true
},
"phoneNo": {
"description": "The phone number for the employment. Can only contain the characters: \"()+- 0123456789\"",
"type": "string",
"maxLength": 30,
"nullable": true
},
"internetResponsible": {
"description": "Is the employee internet responsible",
"type": "boolean",
"nullable": true
},
"jobNo": {
"description": "",
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"format": "int64",
"example": "42",
"nullable": true
}
}
},
"Microsoft.NAV.job-create": {
"title": "job (for create)",
"type": "object",
"properties": {
"employeeMemberNo": {
"type": "string",
"maxLength": 20
},
"employerMemberNo": {
"type": "string",
"maxLength": 20
},
"startingDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"endingDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"isMainJob": {
"type": "boolean",
"nullable": true
},
"position": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"extentOfEmployment": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
],
"format": "decimal",
"example": 0,
"nullable": true
},
"employmentType": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"eMail": {
"type": "string",
"maxLength": 80,
"nullable": true
},
"mobilePhoneNo": {
"type": "string",
"maxLength": 30,
"nullable": true
},
"phoneNo": {
"type": "string",
"maxLength": 30,
"nullable": true
},
"internetResponsible": {
"type": "boolean",
"nullable": true
}
},
"required": [
"employeeMemberNo",
"employerMemberNo"
]
},
"Microsoft.NAV.job-update": {
"title": "job (for update)",
"type": "object",
"properties": {
"employeeMemberNo": {
"type": "string",
"maxLength": 20
},
"employerMemberNo": {
"type": "string",
"maxLength": 20
},
"startingDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"endingDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"isMainJob": {
"type": "boolean",
"nullable": true
},
"position": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"extentOfEmployment": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
],
"format": "decimal",
"example": 0,
"nullable": true
},
"employmentType": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"eMail": {
"type": "string",
"maxLength": 80,
"nullable": true
},
"mobilePhoneNo": {
"type": "string",
"maxLength": 30,
"nullable": true
},
"phoneNo": {
"type": "string",
"maxLength": 30,
"nullable": true
},
"internetResponsible": {
"type": "boolean",
"nullable": true
}
}
},
"Microsoft.NAV.localUnion": {
"title": "localUnion",
"type": "object",
"properties": {
"systemId": {
"description": "",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
},
"code": {
"description": "",
"type": "string",
"maxLength": 10
},
"description": {
"description": "Description of the local union",
"type": "string",
"maxLength": 50,
"nullable": true
},
"boardCommittee": {
"description": "Indicates if the local union is a board committee",
"type": "string",
"maxLength": 10,
"nullable": true
},
"subscription": {
"description": "Subscription associated to the local union",
"type": "string",
"maxLength": 20,
"nullable": true
},
"referringTo": {
"description": "Local union this local union refers to",
"type": "string",
"maxLength": 10,
"nullable": true
},
"postingMember": {
"description": "Posting member associated with the local union",
"type": "string",
"maxLength": 20,
"nullable": true
}
}
},
"Microsoft.NAV.memberCube": {
"title": "memberCube",
"type": "object",
"properties": {
"no": {
"description": "The member''s number. This is a unique identifier for the member, which can be used to reference the member in the system.",
"type": "string",
"maxLength": 20
},
"activeAddress": {
"description": "The member''s active address. This is the address that is currently active for the member and used for correspondence. It can be either the home address or the job address depending on which one is active.",
"type": "string",
"maxLength": 100,
"nullable": true
},
"activeAddress2": {
"description": "The member''s second active address. This is the address that is currently active for the member and used for correspondence. It can be either the home address or the job address depending on which one is active.",
"type": "string",
"maxLength": 50,
"nullable": true
},
"activeCity": {
"description": "The city of the member''s active address. This is the city of the address that is currently active for the member and used for correspondence. It can be either the home address or the job address depending on which one is active.",
"type": "string",
"maxLength": 30,
"nullable": true
},
"activeMainEmployer": {
"description": "The member''s active main employer. This is the member number of the main employer that is currently active for the member.",
"type": "string",
"maxLength": 20,
"nullable": true
},
"activePostCode": {
"description": "The postal code of the member''s active address. This is the postal code of the address that is currently active for the member and used for correspondence. It can be either the home address or the job address depending on which one is active.",
"type": "string",
"maxLength": 20,
"nullable": true
},
"address": {
"description": "The member''s home address. This is the address that is registered as the home address for the member.",
"type": "string",
"maxLength": 100,
"nullable": true
},
"address2": {
"description": "The member''s second home address. This is the address that is registered as the second home address for the member.",
"type": "string",
"maxLength": 50,
"nullable": true
},
"age": {
"description": "The member''s age. This is calculated based on the member''s birth date and the current date.",
"type": "integer",
"format": "int32",
"nullable": true
},
"birthDate": {
"description": "The member''s birth date. This is the date of birth registered for the member.",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"cprNumber": {
"description": "The member''s CPR number. This is a unique identification number used in Denmark, which is registered for the member.",
"type": "string",
"maxLength": 10,
"nullable": true
},
"numbertOfActiveEmployees": {
"description": "The number of active employees. This is the number of active employees registered for company members.",
"type": "integer",
"format": "int32",
"nullable": true
},
"code1": {
"description": "The member''s code 1. This is a code that can be used for various purposes, such as categorization or segmentation of members.",
"type": "string",
"maxLength": 20,
"nullable": true
},
"code2": {
"description": "The member''s code 2. This is a code that can be used for various purposes, such as categorization or segmentation of members.",
"type": "string",
"maxLength": 20,
"nullable": true
},
"firstName": {
"description": "The member''s first name. This is the first name registered for the member.",
"type": "string",
"maxLength": 30,
"nullable": true
},
"headofficeMemberNo": {
"description": "The member number of the head office. This is the member number of the head office that the member is associated with, if applicable.",
"type": "string",
"maxLength": 20,
"nullable": true
},
"invoicePaytype": {
"description": "The member''s invoice pay type. This is the payment type that is registered for the member''s invoices, such as credit card, bank transfer, etc.",
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campInvoicePayTypes"
}
],
"nullable": true
},
"jobTitle": {
"description": "The member''s job title. This is the job title registered for the member, which can provide information about the member''s role or position within their organization.",
"type": "string",
"maxLength": 50,
"nullable": true
},
"memberGroup": {
"description": "The member''s member group. This is the group that the member is categorized into, which can be used for segmentation or analysis purposes.",
"type": "string",
"maxLength": 10,
"nullable": true
},
"middleName": {
"description": "The member''s middle name. This is the middle name registered for the member, if applicable.",
"type": "string",
"maxLength": 30,
"nullable": true
},
"opponentCode": {
"description": "The member''s opponent code. This represents the nogotiation opponent for company members.",
"type": "string",
"maxLength": 10,
"nullable": true
},
"opponentDescription": {
"description": "The description of the member''s opponent code. This provides a textual description of the nogotiation opponent for company members.",
"type": "string",
"maxLength": 30,
"nullable": true
},
"paragraph12": {
"description": "Specifies if the total amount the member has paid for paragraph 12 subscriptions.",
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
],
"format": "decimal",
"example": 0,
"nullable": true
},
"paragraph8": {
"description": "Specifies if the total amount the member has paid for paragraph 8 subscriptions.",
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
],
"format": "decimal",
"example": 0,
"nullable": true
},
"priceGroupDescription": {
"description": "The description of the member''s price group.",
"type": "string",
"maxLength": 30,
"nullable": true
},
"subscriptionPriceGroup": {
"description": "The subscription price group that the member is categorized into. This also may determine subscription prices.",
"type": "string",
"maxLength": 10,
"nullable": true
},
"surname": {
"description": "The member''s surname. This is the surname registered for the member.",
"type": "string",
"maxLength": 30,
"nullable": true
},
"text1": {
"description": "The member''s text 1. This is a text field that can be used for various purposes, such as additional information or notes about the member.",
"type": "string",
"maxLength": 50,
"nullable": true
},
"text2": {
"description": "The member''s text 2. This is a text field that can be used for various purposes, such as additional information or notes about the member.",
"type": "string",
"maxLength": 50,
"nullable": true
},
"text3": {
"description": "The member''s text 3. This is a text field that can be used for various purposes, such as additional information or notes about the member.",
"type": "string",
"maxLength": 50,
"nullable": true
},
"text4": {
"description": "The member''s text 4. This is a text field that can be used for various purposes, such as additional information or notes about the member.",
"type": "string",
"maxLength": 50,
"nullable": true
},
"text5": {
"description": "The member''s text 5. This is a text field that can be used for various purposes, such as additional information or notes about the member.",
"type": "string",
"maxLength": 50,
"nullable": true
},
"unionPostTRName": {
"description": "The name of union representative for the member. This is the name of the union representative that is registered for the member''s employer.",
"type": "string",
"maxLength": 100,
"nullable": true
},
"unionSubscription": {
"description": "The local union subscription code. This is the subscription that is associated with the member''s local union, if applicable.",
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
],
"format": "decimal",
"example": 0,
"nullable": true
},
"city": {
"description": "The city of the member''s home address. This is the city of the address that is registered as the home address for the member.",
"type": "string",
"maxLength": 30,
"nullable": true
},
"countryRegionCode": {
"description": "The country or region code of the member''s home address. This is the code that represents the country or region of the address that is registered as the home address for the member.",
"type": "string",
"maxLength": 10,
"nullable": true
},
"currentSemester": {
"description": "The member''s current semester. This is the current semester that the member is in, if applicable. It can provide information about the member''s current stage in their education or training.",
"type": "string",
"maxLength": 20,
"nullable": true
},
"currentMailEmail": {
"description": "The member''s current email. This is the email address that is currently active for the member and used for correspondence. It can be either the personal email or the employer email depending on which one is active.",
"type": "string",
"maxLength": 80,
"nullable": true
},
"eMail": {
"description": "The member''s personal email. This is the email address that is registered as the personal email for the member.",
"type": "string",
"maxLength": 80,
"nullable": true
},
"education": {
"description": "The member''s education. This is the code that represents the member''s education or training program, if applicable.",
"type": "string",
"maxLength": 20,
"nullable": true
},
"educationDescription": {
"description": "The description of the member''s education. This provides a textual description of the member''s education or training program, if applicable.",
"type": "string",
"maxLength": 60,
"nullable": true
},
"employerMail": {
"description": "The member''s employer email. This is the email address that is registered as the employer email for the member, if applicable.",
"type": "string",
"maxLength": 80,
"nullable": true
},
"employerMobilePhoneNo": {
"description": "The member''s employer mobile phone number. This is the mobile phone number that is registered as the employer phone number for the member, if applicable.",
"type": "string",
"maxLength": 30,
"nullable": true
},
"employerName": {
"description": "The member''s employer name. This is the name of the member''s employer that is registered for the member, if applicable.",
"type": "string",
"maxLength": 100,
"nullable": true
},
"employerPhoneNo": {
"description": "The member''s employer phone number. This is the phone number that is registered as the employer phone number for the member, if applicable.",
"type": "string",
"maxLength": 30,
"nullable": true
},
"employmentType": {
"description": "The member''s employment type. This is the code that represents the member''s type of employment, such as full-time, part-time, self-employed, etc.",
"type": "string",
"maxLength": 10,
"nullable": true
},
"entrySource": {
"description": "The source of the member''s entry. This is the code that represents how the member entered into the system, such as through a website, a mobile app, a manual entry, etc.",
"type": "string",
"maxLength": 10,
"nullable": true
},
"gender": {
"description": "The member''s gender.",
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campGender"
}
],
"nullable": true
},
"headOfficeName": {
"description": "The name of the head office. This is the name of the head office that the member is associated with, if applicable.",
"type": "string",
"maxLength": 100,
"nullable": true
},
"isActive": {
"description": "Specifies if the member is currently active. An active member is one that is currently engaged with the organization, such as having an active subscription. This field can be used to filter members based on their active status.",
"type": "boolean",
"nullable": true
},
"jobAddress": {
"description": "The member''s job address. This is the address that is registered as the job address for the member, if applicable.",
"type": "string",
"maxLength": 200,
"nullable": true
},
"jobCity": {
"description": "The city of the member''s job address. This is the city of the address that is registered as the job address for the member, if applicable.",
"type": "string",
"maxLength": 30,
"nullable": true
},
"jobPostalcode": {
"description": "The postal code of the member''s job address. This is the postal code of the address that is registered as the job address for the member, if applicable.",
"type": "string",
"maxLength": 20,
"nullable": true
},
"jobEmail": {
"description": "The member''s job email. This is the email address that is registered as the job email for the member, if applicable.",
"type": "string",
"maxLength": 80,
"nullable": true
},
"localUnion": {
"description": "The member''s local union. This is the code that represents the local union that the member is associated with, if applicable.",
"type": "string",
"maxLength": 10,
"nullable": true
},
"localUnionDescription": {
"description": "The description of the member''s local union. This provides a textual description of the local union that the member is associated with, if applicable.",
"type": "string",
"maxLength": 50,
"nullable": true
},
"memberGroupStartDate": {
"description": "The start date of the member''s current member group. This is the date when the member was assigned to their current member group, which can be used to track how long the member has been in that group.",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"membergroupDescription": {
"description": "The description of the member''s member group. This provides a textual description of the member group that the member is categorized into, which can be used for segmentation or analysis purposes.",
"type": "string",
"maxLength": 60,
"nullable": true
},
"mobilePhoneNo": {
"description": "The member''s personal mobile phone number. This is the mobile phone number that is registered as the personal phone number for the member, if applicable.",
"type": "string",
"maxLength": 30,
"nullable": true
},
"municipality": {
"description": "The member''s municipality. This is the code that represents the municipality of the member''s home address, if applicable.",
"type": "string",
"maxLength": 10,
"nullable": true
},
"municipalityName": {
"description": "The name of the member''s municipality. This is the name of the municipality of the member''s home address, if applicable.",
"type": "string",
"maxLength": 30,
"nullable": true
},
"name": {
"description": "The member''s name. This is the full name of the member, which can be a combination of the first name, middle name, and surname, or it can be a company name for company members.",
"type": "string",
"maxLength": 100,
"nullable": true
},
"name2": {
"description": "The member''s second name. This is an additional name field that can be used for various purposes, such as a secondary contact name or a company name for company members.",
"type": "string",
"maxLength": 100,
"nullable": true
},
"numberOfEmployees": {
"description": "The number of employees. This is the number of employees registered for company members, which can provide information about the size of the member''s organization.",
"type": "integer",
"format": "int32",
"nullable": true
},
"partnerType": {
"description": "The member''s partner type. This is the code that represents the type of partner the member is, such as person, company, etc.",
"type": "string",
"nullable": true
},
"phoneNo": {
"description": "The member''s personal phone number. This is the phone number that is registered as the personal phone number for the member, if applicable.",
"type": "string",
"maxLength": 30,
"nullable": true
},
"position": {
"description": "The member''s position. This is the code that represents the member''s position or role within their organization, if applicable.",
"type": "string",
"maxLength": 10,
"nullable": true
},
"positionDescription": {
"description": "The description of the member''s position. This provides a textual description of the member''s position or role within their organization, if applicable.",
"type": "string",
"maxLength": 60,
"nullable": true
},
"postCode": {
"description": "The postal code of the member''s home address. This is the postal code of the address that is registered as the home address for the member.",
"type": "string",
"maxLength": 20,
"nullable": true
},
"referringTo": {
"description": "The local union that the member''s current local union is referring to. This hierarchical parent of the member''s current local union.",
"type": "string",
"maxLength": 10,
"nullable": true
},
"region": {
"description": "The member''s region. This is the code that represents the region of the member''s home address, if applicable.",
"type": "string",
"maxLength": 10,
"nullable": true
},
"regionName": {
"description": "The name of the member''s region. This is the name of the region of the member''s home address, if applicable.",
"type": "string",
"maxLength": 30,
"nullable": true
},
"createdAt": {
"description": "The date and time when the member cube record was created in the system. This field is automatically populated by the system when a new member cube record is inserted, and it can be used to track when the member cube was last updated.",
"type": "string",
"format": "date-time",
"nullable": true
},
"registrationDate": {
"description": "The date when the member registered. This is the date when the member first registered with the organization, which can provide information about how long the member has been associated with the organization.",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"createdBy": {
"description": "The user who created the member cube record in the system. This field is automatically populated by the system when a new member cube record is inserted, and it can be used to track who created the member cube record.",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef",
"nullable": true
},
"systemId": {
"description": "The unique identifier for the member cube record in the system. This field is automatically generated by the system and can be used to reference the member cube record.",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef",
"nullable": true
},
"modifiedAt": {
"description": "The date and time when the member cube record was last modified in the system. This field is automatically updated by the system whenever the member cube record is updated, and it can be used to track when the member cube was last updated.",
"type": "string",
"format": "date-time",
"nullable": true
},
"modifiedBy": {
"description": "The user who last modified the member cube record in the system. This field is automatically updated by the system whenever the member cube record is updated, and it can be used to track who last modified the member cube record.",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef",
"nullable": true
},
"vatRegistrationNo": {
"description": "The member''s VAT registration number. This is the VAT number that is registered for the member, if applicable, which can be used for tax purposes.",
"type": "string",
"maxLength": 20,
"nullable": true
},
"withdrawalDate": {
"description": "The date when the member withdrew. This is the date when the member withdrew from the organization, which can provide information about how long the member was associated with the organization before withdrawing.",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"withdrawalReason": {
"description": "The reason for the member''s withdrawal. This is a code that represents the reason why the member withdrew from the organization, if applicable, which can be used for analysis of member retention and attrition.",
"type": "string",
"maxLength": 10,
"nullable": true
}
}
},
"Microsoft.NAV.memberEducation": {
"title": "memberEducation",
"type": "object",
"properties": {
"systemId": {
"description": "",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
},
"duration": {
"description": "",
"type": "integer",
"format": "int32",
"nullable": true
},
"education": {
"description": "Unique code of the education",
"type": "string",
"maxLength": 20
},
"educationInstitute": {
"description": "The place of education",
"type": "string",
"maxLength": 20,
"nullable": true
},
"memberNo": {
"description": "The unique id of the member the education belongs to",
"type": "string",
"maxLength": 20
},
"month": {
"description": "Month of graduation",
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campMonth"
}
],
"nullable": true
},
"no": {
"description": "",
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"format": "int64",
"example": "42",
"nullable": true
},
"year": {
"description": "Year of graduation",
"type": "integer",
"format": "int32"
},
"educationDescription": {
"description": "Description of the education",
"type": "string",
"maxLength": 60,
"nullable": true
},
"instituteDescription": {
"description": "Description of the place of education",
"type": "string",
"maxLength": 60,
"nullable": true
}
}
},
"Microsoft.NAV.memberGroup": {
"title": "memberGroup",
"type": "object",
"properties": {
"code": {
"description": "",
"type": "string",
"maxLength": 10
},
"systemId": {
"description": "",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef",
"nullable": true
},
"description": {
"description": "Description of the member group",
"type": "string",
"maxLength": 60
},
"internetDescription": {
"description": "Description of the member group to be shown on the frontend web portal",
"type": "string",
"maxLength": 250,
"nullable": true
},
"displayOnInternet": {
"description": "Should members in this member group be searchable from member searches on web",
"type": "boolean",
"nullable": true
},
"mayBeSelectedFromInternet": {
"description": "Can this member group be selected as an option, when enrolling as member from the web",
"type": "boolean",
"nullable": true
},
"partnerType": {
"description": "Type of entity for this member group (eg. person, organization",
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.partnerType"
}
],
"nullable": true
},
"pinRequirement": {
"description": "Is it mandatory to fill in cpr. no. when enrolling as this type on member",
"type": "boolean",
"nullable": true
},
"customerPostingGroup": {
"description": "Customer posting group for members of this member group",
"type": "string",
"maxLength": 20,
"nullable": true
},
"subscriptionPriceGroupId": {
"description": "Unique id of the subscription price group",
"type": "string",
"maxLength": 10,
"nullable": true
}
}
},
"Microsoft.NAV.memberPayrollReport": {
"title": "memberPayrollReport",
"type": "object",
"properties": {
"no": {
"description": "",
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"format": "int64",
"example": "42"
},
"reportNo": {
"description": "Read-Only. The report indentifier",
"type": "string",
"maxLength": 10,
"nullable": true
},
"memberNo": {
"description": "The member/company that has the report",
"type": "string",
"maxLength": 20,
"nullable": true
},
"year": {
"description": "The year in which the report is valid",
"type": "integer",
"format": "int32",
"nullable": true
},
"registrationDate": {
"description": "The registration date of the payroll report",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"status": {
"description": "Specifies the status of the report",
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campPayrollReportStatus"
}
],
"nullable": true
},
"reportedBy": {
"description": "Specifies the person who made the registration",
"type": "string",
"maxLength": 20,
"nullable": true
},
"column": {
"description": "Specifies the column the reported sum belongs to",
"type": "integer",
"format": "int32",
"nullable": true
},
"measure": {
"description": "Specifies the measure af the reported sum",
"type": "string",
"maxLength": 10,
"nullable": true
},
"description": {
"description": "Specifies the description of the measure",
"type": "string",
"maxLength": 60,
"nullable": true
},
"reportedSum": {
"description": "Specifies the reported sum for the chosen column",
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
],
"format": "decimal",
"example": 0,
"nullable": true
}
}
},
"Microsoft.NAV.memberPriceGroup": {
"title": "memberPriceGroup",
"type": "object",
"properties": {
"systemId": {
"description": "",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
},
"priceGroup": {
"description": "Unique id of the subscription price group",
"type": "string",
"maxLength": 10
},
"memberNo": {
"description": "Unique id of the member",
"type": "string",
"maxLength": 20
},
"subscription": {
"description": "Unique id of the subscription associated with the subscription price group",
"type": "string",
"maxLength": 20,
"nullable": true
},
"startingDate": {
"description": "Starting date of the subscription price group",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"endingDate": {
"description": "Ending date of the subscription price group",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"priceGroupDescription": {
"description": "The description of the subscription price group",
"type": "string",
"maxLength": 30,
"nullable": true
}
}
},
"Microsoft.NAV.memberPriceGroup-create": {
"title": "memberPriceGroup (for create)",
"type": "object",
"properties": {
"priceGroup": {
"type": "string",
"maxLength": 10
},
"memberNo": {
"type": "string",
"maxLength": 20
},
"subscription": {
"type": "string",
"maxLength": 20,
"nullable": true
},
"startingDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"endingDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
}
},
"required": [
"priceGroup",
"memberNo"
]
},
"Microsoft.NAV.memberPriceGroup-update": {
"title": "memberPriceGroup (for update)",
"type": "object",
"properties": {
"priceGroup": {
"type": "string",
"maxLength": 10
},
"memberNo": {
"type": "string",
"maxLength": 20
},
"subscription": {
"type": "string",
"maxLength": 20,
"nullable": true
},
"startingDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"endingDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
}
}
},
"Microsoft.NAV.member": {
"title": "member",
"type": "object",
"properties": {
"memberNo": {
"description": "Unique id of member",
"type": "string",
"maxLength": 20
},
"name": {
"description": "Name of member",
"type": "string",
"maxLength": 100,
"nullable": true
},
"name2": {
"description": "Name 2 of member",
"type": "string",
"maxLength": 50,
"nullable": true
},
"searchName": {
"description": "Search name used for queries of members",
"type": "string",
"maxLength": 100,
"nullable": true
},
"memberGroup": {
"description": "The member group that this member belongs to",
"type": "string",
"maxLength": 10
},
"subscriptionPricegroup": {
"description": "The subscription pricegroup for this member",
"type": "string",
"maxLength": 10,
"nullable": true
},
"currencyCode": {
"description": "Currency code to be used for invoicing of the member",
"type": "string",
"maxLength": 10,
"nullable": true
},
"languageCode": {
"description": "Spoken/written language of the member",
"type": "string",
"maxLength": 10,
"nullable": true
},
"address": {
"description": "Main address of member",
"type": "string",
"maxLength": 100,
"nullable": true
},
"address2": {
"description": "Supplement to Address",
"type": "string",
"maxLength": 50,
"nullable": true
},
"postCode": {
"description": "Zipcode for address",
"type": "string",
"maxLength": 20,
"nullable": true
},
"city": {
"description": "City name for address",
"type": "string",
"maxLength": 30,
"nullable": true
},
"county": {
"description": "County for address",
"type": "string",
"maxLength": 30,
"nullable": true
},
"countryRegionCode": {
"description": "Country for address - country of residence for the member",
"type": "string",
"maxLength": 10,
"nullable": true
},
"gln": {
"description": "The GLN code for companies",
"type": "string",
"maxLength": 13,
"nullable": true
},
"eMail": {
"description": "Primary E-mail for the member",
"type": "string",
"maxLength": 80,
"nullable": true
},
"phoneNo": {
"description": "Primary phone no. for the member",
"type": "string",
"maxLength": 30,
"nullable": true
},
"mobilePhoneNo": {
"description": "Primary mobile phone no. for the member",
"type": "string",
"maxLength": 30,
"nullable": true
},
"addresscodeMail": {
"description": "Address choice for receival of postage mail",
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campAddresscodeMail"
}
],
"nullable": true
},
"currentMailAddress": {
"description": "Current complete address of member",
"type": "string",
"nullable": true
},
"addresscodeInvoice": {
"description": "Address choice for receival of invoices",
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campAddresscodeInvoice"
}
],
"nullable": true
},
"currentInvoiceAddress": {
"description": "Current complete invoiceaddress of member ",
"type": "string",
"nullable": true
},
"shareEmail": {
"description": "Deprecated from version 21.7. Erstattet af HideEmail.
Show email address in public member info on the organizations member website",
"type": "boolean",
"nullable": true
},
"hideEmail": {
"description": "Hide email address in public member info on the organizations member website",
"type": "boolean",
"nullable": true
},
"shareGeneralData": {
"description": "Deprecated from version 21.7. Erstattet af SecretAddress.
Show general data in public member info on the organizations member website",
"type": "boolean",
"nullable": true
},
"secretAddress": {
"description": "Hide general data in public member info on the organizations member website",
"type": "boolean",
"nullable": true
},
"shareMemberList": {
"description": "Deprecated from version 21.7. Erstattet af HideMemberList.
Is this member searchable/visible as part of public member info on the organizations member website",
"type": "boolean",
"nullable": true
},
"hideMemberList": {
"description": "Is this member unsearchable/invisible as part of public member info on the organizations member website",
"type": "boolean",
"nullable": true
},
"localUnion": {
"description": "Id of the local union that this member belongs to",
"type": "string",
"maxLength": 10,
"nullable": true
},
"localUnionDescription": {
"description": "Description of the local union of this member",
"type": "string",
"maxLength": 50,
"nullable": true
},
"code1": {
"description": "For future use - organization specific extra info",
"type": "string",
"maxLength": 20,
"nullable": true
},
"code2": {
"description": "For future use - organization specific extra info",
"type": "string",
"maxLength": 20,
"nullable": true
},
"text1": {
"description": "For future use - organization specific extra info",
"type": "string",
"maxLength": 50,
"nullable": true
},
"text2": {
"description": "For future use - organization specific extra info",
"type": "string",
"maxLength": 50,
"nullable": true
},
"text3": {
"description": "For future use - organization specific extra info",
"type": "string",
"maxLength": 50,
"nullable": true
},
"text4": {
"description": "For future use - organization specific extra info",
"type": "string",
"maxLength": 50,
"nullable": true
},
"text5": {
"description": "For future use - organization specific extra info",
"type": "string",
"maxLength": 50,
"nullable": true
},
"creationDate": {
"description": "The date this member enrolled as member in the organization",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"withdrawalDate": {
"description": "The date this member withdrew membership",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"entrySource": {
"description": "The media through which this member enrolled in the organization",
"type": "string",
"maxLength": 10,
"nullable": true
},
"entrySourceName": {
"description": "Description for entry source",
"type": "string",
"nullable": true
},
"withdrawalReason": {
"description": "Reason id as to why this member withdrew membership",
"type": "string",
"maxLength": 10,
"nullable": true
},
"withdrawalReasonDescription": {
"description": "Description of withdrawal reason",
"type": "string",
"maxLength": 100,
"nullable": true
},
"isInLocalUnion": {
"description": "Is this member part of a local union",
"type": "boolean",
"nullable": true
},
"municipality": {
"description": "Municipality id of the address of this member",
"type": "string",
"maxLength": 10,
"nullable": true
},
"municipalityName": {
"description": "Name of the municipality",
"type": "string",
"nullable": true
},
"region": {
"description": "Region id of the address of this member",
"type": "string",
"maxLength": 10,
"nullable": true
},
"regionName": {
"description": "Name of region",
"type": "string",
"nullable": true
},
"billtoMemberNo": {
"description": "Member No. of the member who pays for this member",
"type": "string",
"maxLength": 20,
"nullable": true
},
"systemId": {
"description": "",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef",
"nullable": true
},
"partnerType": {
"description": "Is the member a person or a company/organization",
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.partnerType"
}
],
"nullable": true
},
"hasCommittee": {
"description": "Use this to filter on member''s committees",
"type": "boolean",
"nullable": true
},
"hasCommunity": {
"description": "Use this to filter on member''s communities",
"type": "boolean",
"nullable": true
},
"hasUnionPost": {
"description": "Use this to filter on member''s local union posts",
"type": "boolean",
"nullable": true
},
"hasTaxonomy": {
"description": "Use this to filter on member''s taxonomies",
"type": "boolean",
"nullable": true
},
"hasSubscription": {
"description": "Use this to filter on member''s subscriptions",
"type": "boolean",
"nullable": true
},
"birthDate": {
"description": "Birthdate of the member",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"cprNo": {
"description": "The social security number of the member",
"type": "string",
"maxLength": 10,
"nullable": true
},
"gender": {
"description": "The gender of the member",
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campGender"
}
],
"nullable": true
},
"firstName": {
"description": "The first name of the member",
"type": "string",
"maxLength": 30,
"nullable": true
},
"middleName": {
"description": "The middle name of the member",
"type": "string",
"maxLength": 30,
"nullable": true
},
"surname": {
"description": "The surname of the member",
"type": "string",
"maxLength": 30,
"nullable": true
},
"employerNo": {
"description": "The active main employment of the member",
"type": "string",
"maxLength": 20,
"nullable": true
},
"employerName": {
"description": "The name of the main employer",
"type": "string",
"maxLength": 100,
"nullable": true
},
"shareEducation": {
"description": "Deprecated from version 21.7. Erstattet af HideEducation.
",
"type": "boolean",
"nullable": true
},
"hideEducation": {
"description": "Is the member''s address confidential and not to be displayed on the internet",
"type": "boolean",
"nullable": true
},
"shareJob": {
"description": "Deprecated from version 21.7. Erstattet af HideJob.
",
"type": "boolean",
"nullable": true
},
"hideJob": {
"description": "Is the member''s employment to be displayed on the internet",
"type": "boolean",
"nullable": true
},
"jobTitle": {
"description": "The titel of the member",
"type": "string",
"maxLength": 50,
"nullable": true
},
"jobPhone": {
"description": "The phone number for the main employment",
"type": "string",
"nullable": true
},
"jobMobilePhone": {
"description": "The mobile phone number for the main employment",
"type": "string",
"nullable": true
},
"jobEmail": {
"description": "The e-mail for the main employment",
"type": "string",
"nullable": true
},
"jobPosition": {
"description": "The position for the main employment",
"type": "string",
"nullable": true
},
"pair": {
"description": "Is the member part of a pair",
"type": "string",
"maxLength": 20,
"nullable": true
},
"vatBusPostingGroup": {
"description": "The VAT Bus. posting group on the member",
"type": "string",
"maxLength": 20,
"nullable": true
},
"cvrNo": {
"description": "The VAT registration number on the member",
"type": "string",
"maxLength": 20,
"nullable": true
},
"numberOfEmployees": {
"description": "The number of employees on the member (if the member is a company)",
"type": "integer",
"format": "int32",
"nullable": true
},
"isEmployer": {
"description": "Is the member an employer",
"type": "boolean",
"nullable": true
},
"headOfficeMemberNo": {
"description": "The head office member number the member belogs to (if the member is a company)",
"type": "string",
"maxLength": 20,
"nullable": true
},
"headOfficeName": {
"description": "The name of the head office",
"type": "string",
"maxLength": 100,
"nullable": true
},
"opponent": {
"description": "The negotiating counterpart of the member",
"type": "string",
"maxLength": 10,
"nullable": true
},
"contact": {
"description": "The contact associated with the member",
"type": "string",
"maxLength": 100,
"nullable": true
},
"localUnionFilter": {
"description": "Filter use only",
"type": "string",
"maxLength": 10,
"nullable": true
},
"subcriptionFilter": {
"description": "Filter use only",
"type": "string",
"maxLength": 20,
"nullable": true
},
"invoiceMemberFilter": {
"description": "Filter use only",
"type": "string",
"maxLength": 20,
"nullable": true
},
"committeeFilter": {
"description": "Filter use only",
"type": "string",
"maxLength": 10,
"nullable": true
},
"communityFilter": {
"description": "Filter use only",
"type": "string",
"maxLength": 20,
"nullable": true
},
"unionPostTypeFilter": {
"description": "Filter use only",
"type": "string",
"maxLength": 10,
"nullable": true
},
"taxonomyFilter": {
"description": "Filter use only",
"type": "string",
"nullable": true
},
"startingDateFilter": {
"description": "Filter use only",
"type": "string",
"nullable": true
},
"endingDateFilter": {
"description": "Filter use only",
"type": "string",
"nullable": true
},
"homePage": {
"description": "Homepage address for the member",
"type": "string",
"maxLength": 255,
"nullable": true
}
}
},
"Microsoft.NAV.onlinePayment": {
"title": "onlinePayment",
"type": "object",
"properties": {
"orderId": {
"description": "The unique id of this payment transaction, used to identify this payment at online payment provider",
"type": "string",
"maxLength": 20
},
"paymentStatus": {
"description": "The current status of this payment transaction, eg: A status of \"Authorized\" means the transaction has been sent been sent to payment provider, but no response yet received. A status of \"Captured\" means the transaction has been processed fully at payment provider",
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campOnlinePaymentStatus"
}
],
"nullable": true
},
"transactionId": {
"description": "Online payment providers unique ref. for this payment transaction - received in response to a successful payment",
"type": "string",
"maxLength": 60,
"nullable": true
},
"cardExpiryMonth": {
"description": "Card expire month",
"type": "integer",
"format": "int32",
"nullable": true
},
"cardExpiryYear": {
"description": "Card expire year",
"type": "integer",
"format": "int32",
"nullable": true
},
"cardType": {
"description": "Card type",
"type": "string",
"maxLength": 20,
"nullable": true
},
"exceptionMessage": {
"description": "Error message received from frontend in relation to this payment transaction",
"type": "string",
"maxLength": 200,
"nullable": true
},
"exceptionType": {
"description": "Exception type received from frontend in relation to this payment transaction",
"type": "string",
"maxLength": 60,
"nullable": true
},
"latestOnlinePaymentFunction": {
"description": "The latest attempt made against online payment provider for this transaction",
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campOnlinePaymentFunction"
}
],
"nullable": true
},
"latestOnlinePaymentTime": {
"description": "Timestamp of the latest online payment function",
"type": "string",
"format": "date-time",
"nullable": true
},
"onlinePaymentErrorCode": {
"description": "Error code from online payment provider in relation to this payment transaction",
"type": "string",
"maxLength": 60,
"nullable": true
},
"onlinePaymentErrorMessage": {
"description": "Error message from online payment provider in relation to this payment transaction",
"type": "string",
"maxLength": 200,
"nullable": true
},
"collectionNo": {
"description": "Unique id of the collection that this payment transaction relates to",
"type": "string",
"maxLength": 20,
"nullable": true
}
}
},
"Microsoft.NAV.onlinePayment-create": {
"title": "onlinePayment (for create)",
"type": "object",
"properties": {
"orderId": {
"type": "string",
"maxLength": 20
},
"paymentStatus": {
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campOnlinePaymentStatus"
}
],
"nullable": true
},
"transactionId": {
"type": "string",
"maxLength": 60,
"nullable": true
},
"cardExpiryMonth": {
"type": "integer",
"format": "int32",
"nullable": true
},
"cardExpiryYear": {
"type": "integer",
"format": "int32",
"nullable": true
},
"cardType": {
"type": "string",
"maxLength": 20,
"nullable": true
},
"exceptionMessage": {
"type": "string",
"maxLength": 200,
"nullable": true
},
"exceptionType": {
"type": "string",
"maxLength": 60,
"nullable": true
},
"latestOnlinePaymentFunction": {
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campOnlinePaymentFunction"
}
],
"nullable": true
},
"latestOnlinePaymentTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"onlinePaymentErrorCode": {
"type": "string",
"maxLength": 60,
"nullable": true
},
"onlinePaymentErrorMessage": {
"type": "string",
"maxLength": 200,
"nullable": true
},
"collectionNo": {
"type": "string",
"maxLength": 20,
"nullable": true
}
},
"required": [
"orderId"
]
},
"Microsoft.NAV.onlinePayment-update": {
"title": "onlinePayment (for update)",
"type": "object",
"properties": {
"paymentStatus": {
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campOnlinePaymentStatus"
}
],
"nullable": true
},
"transactionId": {
"type": "string",
"maxLength": 60,
"nullable": true
},
"cardExpiryMonth": {
"type": "integer",
"format": "int32",
"nullable": true
},
"cardExpiryYear": {
"type": "integer",
"format": "int32",
"nullable": true
},
"cardType": {
"type": "string",
"maxLength": 20,
"nullable": true
},
"exceptionMessage": {
"type": "string",
"maxLength": 200,
"nullable": true
},
"exceptionType": {
"type": "string",
"maxLength": 60,
"nullable": true
},
"latestOnlinePaymentFunction": {
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campOnlinePaymentFunction"
}
],
"nullable": true
},
"latestOnlinePaymentTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"onlinePaymentErrorCode": {
"type": "string",
"maxLength": 60,
"nullable": true
},
"onlinePaymentErrorMessage": {
"type": "string",
"maxLength": 200,
"nullable": true
},
"collectionNo": {
"type": "string",
"maxLength": 20,
"nullable": true
}
}
},
"Microsoft.NAV.password": {
"title": "password",
"type": "object",
"properties": {
"memberNo": {
"description": "Unique id of member",
"type": "string",
"maxLength": 20
},
"eMail": {
"description": "The e-mail of the member",
"type": "string",
"maxLength": 80,
"nullable": true
},
"password": {
"description": "Password in encrypted form",
"type": "string",
"maxLength": 100,
"nullable": true
},
"campCprNo": {
"description": "Cpr. no. of the member (citizen unique id)",
"type": "string",
"maxLength": 10,
"nullable": true
},
"name": {
"description": "Name of member",
"type": "string",
"maxLength": 100,
"nullable": true
},
"localUnion": {
"description": "Id of the local union that this member belongs to",
"type": "string",
"maxLength": 10,
"nullable": true
},
"campMemberGroup": {
"description": "The member group that this member belongs to",
"type": "string",
"maxLength": 10
},
"campLocalUnionDescription": {
"description": "Description for the local union",
"type": "string",
"maxLength": 50,
"nullable": true
}
}
},
"Microsoft.NAV.password-update": {
"title": "password (for update)",
"type": "object",
"properties": {
"eMail": {
"type": "string",
"maxLength": 80,
"nullable": true
},
"password": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"campCprNo": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"name": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"localUnion": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"campMemberGroup": {
"type": "string",
"maxLength": 10
}
}
},
"Microsoft.NAV.position": {
"title": "position",
"type": "object",
"properties": {
"code": {
"description": "",
"type": "string",
"maxLength": 10
},
"systemId": {
"description": "",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef",
"nullable": true
},
"jobTitle": {
"description": "Description of the position",
"type": "string",
"maxLength": 60,
"nullable": true
},
"webText": {
"description": "Web-text associated with the position",
"type": "string",
"maxLength": 100,
"nullable": true
},
"display_on_internet": {
"description": "Is the event to be displayed on the internet",
"type": "boolean",
"nullable": true
}
}
},
"Microsoft.NAV.sentMail": {
"title": "sentMail",
"type": "object",
"properties": {
"systemId": {
"description": "",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
},
"memberNo": {
"description": "Identification of the member",
"type": "string",
"maxLength": 20,
"nullable": true
},
"code": {
"description": "",
"type": "string",
"maxLength": 20,
"nullable": true
},
"date": {
"description": "",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
}
}
},
"Microsoft.NAV.sentMail-create": {
"title": "sentMail (for create)",
"type": "object",
"properties": {
"memberNo": {
"type": "string",
"maxLength": 20,
"nullable": true
},
"code": {
"type": "string",
"maxLength": 20,
"nullable": true
},
"date": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
}
},
"required": []
},
"Microsoft.NAV.sentMail-update": {
"title": "sentMail (for update)",
"type": "object",
"properties": {
"memberNo": {
"type": "string",
"maxLength": 20,
"nullable": true
},
"code": {
"type": "string",
"maxLength": 20,
"nullable": true
},
"date": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
}
}
},
"Microsoft.NAV.subscriptionMemberCube": {
"title": "subscriptionMemberCube",
"type": "object",
"properties": {
"no": {
"description": "The unique identifier or number assigned to the member subscription record. This field can be used to store the specific number that is associated with the member subscription, which may be used for identification, billing, and record-keeping purposes related to the member subscription.",
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"format": "int64",
"example": "42"
},
"activeAddress": {
"description": "The member''s active address for this subscription. This is the address that is currently active for the member subscription and used for correspondence. It can be either the home address or the job address depending on which one is active.",
"type": "string",
"maxLength": 100,
"nullable": true
},
"activeAddress2": {
"description": "The member''s active secondary address for this subscription. This field can be used to store an additional address for the member subscription, such as a secondary residence or a different job location. It is not mandatory and may be left blank if not applicable.",
"type": "string",
"maxLength": 50,
"nullable": true
},
"activeCity": {
"description": "The city associated with the member''s active address for this subscription. This field provides the city information for the active address, which can be used for communication and logistical purposes related to the member subscription.",
"type": "string",
"maxLength": 30,
"nullable": true
},
"activeEMail": {
"description": "The member''s active email address for this subscription. This is the email address that is currently active for the member subscription and used for electronic communication. It can be either the home email or the job email depending on which one is active.",
"type": "string",
"maxLength": 80,
"nullable": true
},
"activePostCode": {
"description": "The postal code associated with the member''s active address for this subscription. This field provides the postal code information for the active address, which can be used for communication and logistical purposes related to the member subscription.",
"type": "string",
"maxLength": 20,
"nullable": true
},
"address": {
"description": "The member''s home address for the member. This is the primary residential address of the member and can be used for communication and correspondence related to the member subscription. It may not be active if the member has a different active address, such as a job address.",
"type": "string",
"maxLength": 100,
"nullable": true
},
"address2": {
"description": "The member''s secondary home address for the member. This field can be used to store an additional residential address for the member, such as a secondary residence. It is not mandatory and may be left blank if not applicable.",
"type": "string",
"maxLength": 50,
"nullable": true
},
"addresscodeInvoice": {
"description": "The code representing the member''s invoice address for this subscription. This code is used to identify the specific invoice address associated with the member subscription, which may be different from the home or job address. It is used for billing and invoicing purposes related to the member subscription.",
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campAddresscodeInvoice"
}
],
"nullable": true
},
"addresscodeMail": {
"description": "The code representing the member''s mailing address for this subscription. This code is used to identify the specific mailing address associated with the member subscription, which may be different from the home or job address. It is used for communication and correspondence purposes related to the member subscription.",
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campAddresscodeMail"
}
],
"nullable": true
},
"age": {
"description": "The age of the member for this subscription. This field calculates the member''s age based on their birthdate and the current date. It can be used for demographic analysis and to determine eligibility for certain subscription benefits or offers.",
"type": "integer",
"format": "int32",
"nullable": true
},
"attentionName": {
"description": "The attention name for the member subscription. This field can be used to specify a particular name or contact person to whom correspondence or communication related to the member subscription should be directed. It is useful for ensuring that important information reaches the appropriate individual associated with the member subscription.",
"type": "string",
"maxLength": 60,
"nullable": true
},
"billToCustomerNo": {
"description": "The customer number of the bill-to customer for this member subscription. This field identifies the specific customer account that is responsible for receiving the invoice and making payments for the member subscription. It is used for billing and invoicing purposes related to the member subscription.",
"type": "string",
"maxLength": 20,
"nullable": true
},
"birthdate": {
"description": "The birthdate of the member for this subscription. This field stores the date of birth of the member, which can be used to calculate their age and for demographic analysis related to the member subscription.",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"cpr": {
"description": "The CPR number of the member for this subscription. The CPR number is a unique identifier used in Denmark, similar to a social security number, and is used for various administrative purposes related to the member subscription, such as identification and record-keeping.",
"type": "string",
"maxLength": 10,
"nullable": true
},
"memberCreateExec": {
"description": "The date and time when the member''s was created in the system. This field captures the execution timestamp of the member creation process, which can be used for auditing and tracking purposes related to the member subscription lifecycle.",
"type": "string",
"format": "date-time",
"nullable": true
},
"memberWithdExec": {
"description": "The date and time when the member''s withdrawal was executed in the system. This field captures the execution timestamp of the member withdrawal process, which can be used for auditing and tracking purposes related to the member subscription lifecycle.",
"type": "string",
"format": "date-time",
"nullable": true
},
"subStartExec": {
"description": "The date and time when the subscription start was executed in the system. This field captures the execution timestamp of the subscription start process, which can be used for auditing and tracking purposes related to the member subscription lifecycle.",
"type": "string",
"format": "date-time",
"nullable": true
},
"subWithdExec": {
"description": "The date and time when the subscription withdrawal was executed in the system. This field captures the execution timestamp of the subscription withdrawal process, which can be used for auditing and tracking purposes related to the member subscription lifecycle.",
"type": "string",
"format": "date-time",
"nullable": true
},
"city": {
"description": "The member''s home city for the member. This is the primary residential city of the member and can be used for communication and correspondence related to the member subscription. It may not be active if the member has a different active address, such as a job address.",
"type": "string",
"maxLength": 30,
"nullable": true
},
"collectedInOldSystemTo": {
"description": "The date until which the member subscription was collected in the old system. This field indicates the end date of the period during which the member subscription data was collected and maintained in the previous system before being migrated to the current system. It can be used for historical reference and to understand the timeline of the member subscription data migration.",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"countryRegion": {
"description": "The country or region associated with the member''s active address for this subscription. This field provides the country or region information for the active address, which can be used for communication, logistical purposes, and to comply with regional regulations related to the member subscription.",
"type": "string",
"maxLength": 10,
"nullable": true
},
"eInvoiceContact": {
"description": "The contact person for e-invoicing related to this member subscription. This field can be used to specify the name of the individual who is responsible for handling e-invoices for the member subscription, ensuring that electronic billing communications are directed to the appropriate contact person.",
"type": "string",
"maxLength": 100,
"nullable": true
},
"eInvoiceDocumentNo": {
"description": "The document number associated with the e-invoice for this member subscription. This field is used to store the unique identifier of the e-invoice document, which can be referenced for tracking and record-keeping purposes related to the billing of the member subscription.",
"type": "string",
"maxLength": 35,
"nullable": true
},
"eMail": {
"description": "The member''s home email address for the member. This is the primary residential email address of the member and can be used for communication and correspondence related to the member subscription. It may not be active if the member has a different active email, such as a job email.",
"type": "string",
"maxLength": 80,
"nullable": true
},
"eanNo": {
"description": "The European Article Number (EAN) associated with this member subscription. This field can be used to store the EAN code, which is a unique identifier for products and services in the European market. It may be used for inventory management, billing, or other purposes related to the member subscription.",
"type": "string",
"maxLength": 13,
"nullable": true
},
"employerAccNo": {
"description": "The employer account number associated with this member subscription. This field can be used to store the account number of the employer that is linked to the member subscription, which may be relevant for billing, invoicing, or administrative purposes related to the member subscription.",
"type": "string",
"maxLength": 20,
"nullable": true
},
"employerMail": {
"description": "The email address of the employer associated with this member subscription. This field can be used to store the employer''s email address, which may be relevant for communication and correspondence related to the member subscription, especially if the employer is involved in the billing or administration of the subscription.",
"type": "string",
"maxLength": 80,
"nullable": true
},
"employerName": {
"description": "The name of the employer associated with this member subscription. This field can be used to store the name of the employer that is linked to the member subscription, which may be relevant for billing, invoicing, or administrative purposes related to the member subscription.",
"type": "string",
"maxLength": 100,
"nullable": true
},
"employerNo": {
"description": "The employer number associated with this member subscription. This field can be used to store the unique identifier or number of the employer that is linked to the member subscription, which may be relevant for billing, invoicing, or administrative purposes related to the member subscription.",
"type": "string",
"maxLength": 20,
"nullable": true
},
"endingDate": {
"description": "The ending date of the member subscription. This field indicates the date on which the member subscription is set to expire or has expired. It can be used for managing subscription renewals, cancellations, and for providing information to the member about the status of their subscription.",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"entrySource": {
"description": "The source from which the member subscription entry was created. This field can be used to track the origin of the member subscription data, such as whether it was entered manually, imported from another system, or created through an automated process. It can provide insights into the data entry methods and help with auditing and troubleshooting related to the member subscription records.",
"type": "string",
"maxLength": 10,
"nullable": true
},
"entrySourceDescription": {
"description": "The description of the source from which the member subscription entry was created. This field provides additional details about the entry source, offering a more descriptive explanation of how the member subscription data was entered into the system. It can be used for better understanding and analysis of the data entry methods related to the member subscription records.",
"type": "string",
"maxLength": 30,
"nullable": true
},
"frequency": {
"description": "The frequency of the member subscription. This field indicates how often the member subscription is billed or renewed, such as monthly, quarterly, or annually. It can be used for managing billing cycles, subscription renewals, and for providing information to the member about the schedule of their subscription payments.",
"type": "integer",
"format": "int32",
"nullable": true
},
"gender": {
"description": "The member''s gender.",
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campGender"
}
],
"nullable": true
},
"hasBeenInEntryList": {
"description": "The flag indicating whether the member subscription has been included in the entry list. This field can be used to track whether the member subscription record has been part of the entry list during its lifecycle, which may be relevant for auditing, reporting, or data management purposes related to the member subscription records.",
"type": "boolean",
"nullable": true
},
"hasBeenInWithdrawalList": {
"description": "The flag indicating whether the member subscription has been included in the withdrawal list. This field can be used to track whether the member subscription record has been part of the withdrawal list during its lifecycle, which may be relevant for auditing, reporting, or data management purposes related to the member subscription records.",
"type": "boolean",
"nullable": true
},
"invoiceDescription": {
"description": "The description of the invoice for this member subscription. This field can be used to provide additional details or notes about the invoice associated with the member subscription, which can be helpful for billing, record-keeping, and communication purposes related to the member subscription.",
"type": "string",
"maxLength": 250,
"nullable": true
},
"invoiceEndingDate": {
"description": "The ending date of the invoice for this member subscription. This field indicates the date on which the invoice for the member subscription is set to expire or has expired. It can be used for managing invoice renewals, cancellations, and for providing information to the member about the status of their invoice related to the subscription.",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"invoiceMemberName": {
"description": "The name of the member as it appears on the invoice for this member subscription. This field can be used to store the specific name that is printed on the invoice, which may differ from the member''s actual name or may include additional information for billing purposes related to the member subscription.",
"type": "string",
"maxLength": 100,
"nullable": true
},
"invoiceMemberNo": {
"description": "The member number as it appears on the invoice for this member subscription. This field can be used to store the specific member number that is printed on the invoice, which may differ from the member''s actual member number or may include additional information for billing purposes related to the member subscription.",
"type": "string",
"maxLength": 20,
"nullable": true
},
"invoiceMonth": {
"description": "The month for which the invoice is generated for this member subscription. This field indicates the specific month that the invoice covers, which can be used for billing cycles, financial reporting, and for providing information to the member about the period of their subscription that is being billed.",
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campMonth"
}
],
"nullable": true
},
"invoiceQuantity": {
"description": "The quantity of items or services included in the invoice for this member subscription. This field can be used to specify the number of units, products, or services that are being billed on the invoice related to the member subscription, which can be important for accurate billing and record-keeping purposes.",
"type": "integer",
"format": "int32",
"nullable": true
},
"invoiceStartingDate": {
"description": "The starting date of the invoice for this member subscription. This field indicates the date on which the invoice for the member subscription becomes effective or starts. It can be used for managing invoice periods, renewals, and for providing information to the member about the status of their invoice related to the subscription.",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"isBlocked": {
"description": "The flag indicating whether the member subscription is blocked. This field can be used to indicate if the member subscription is currently blocked from being active or renewed, which may be due to various reasons such as non-payment, violation of terms, or other administrative issues related to the member subscription.",
"type": "boolean",
"nullable": true
},
"isCollectedUntil": {
"description": "The flag indicating whether the member subscription is collected until a certain date. This field can be used to specify if the member subscription is set to be collected until a specific date, which may be relevant for managing subscription periods, renewals, and for providing information to the member about the status of their subscription collection.",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"isWelcomeLetterCreated": {
"description": "The flag indicating whether a welcome letter has been created for this member subscription. This field can be used to track if a welcome letter has been generated and sent to the member upon the creation of their subscription, which can be important for customer engagement and communication purposes related to the member subscription.",
"type": "boolean",
"nullable": true
},
"localUnion": {
"description": "The local union associated with this member subscription. This field can be used to store the name or identifier of the local union that is linked to the member subscription, which may be relevant for administrative, billing, or communication purposes related to the member subscription, especially if the subscription is offered through or in partnership with a local union organization.",
"type": "string",
"maxLength": 10,
"nullable": true
},
"localUnionDescription": {
"description": "The description of the local union associated with this member subscription. This field provides additional details about the local union linked to the member subscription, offering a more descriptive explanation of the local union''s role, characteristics, or any other relevant information that can help with understanding the context of the member subscription''s association with the local union.",
"type": "string",
"maxLength": 50,
"nullable": true
},
"manuelInvoicePeriod": {
"description": "The manually specified invoice period for this member subscription. This field can be used to store a custom invoice period that is manually set for the member subscription, which may differ from the standard billing cycles. It allows for flexibility in managing billing periods based on specific agreements or arrangements related to the member subscription.",
"type": "boolean",
"nullable": true
},
"memberCreationDate": {
"description": "The date on which the member was created for this subscription. This field indicates the date when the member record was created in the system for the associated subscription, which can be used for tracking the duration of the membership, managing renewals, and providing information to the member about their subscription history.",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"memberGroup": {
"description": "The group or category to which the member belongs for this subscription. This field can be used to classify members into different groups based on certain criteria, such as demographics, subscription types, or other relevant factors. It can be helpful for targeted communication, marketing efforts, and for analyzing member data related to the subscription.",
"type": "string",
"maxLength": 20,
"nullable": true
},
"memberName": {
"description": "The name of the member for this subscription. This field stores the full name of the member associated with the subscription, which can be used for communication, billing, and record-keeping purposes related to the member subscription.",
"type": "string",
"maxLength": 100,
"nullable": true
},
"memberNo": {
"description": "The unique identifier or number assigned to the member for this subscription. This field can be used to store the specific member number that is associated with the member subscription, which may be used for identification, billing, and record-keeping purposes related to the member subscription.",
"type": "string",
"maxLength": 20
},
"memberWithdrawalDate": {
"description": "The date on which the member withdrew from this subscription. This field indicates the date when the member officially canceled or withdrew from the subscription, which can be used for tracking membership duration, managing renewals, and providing information to the member about their subscription history and status.",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"memberIsActive": {
"description": "The flag indicating whether the member is currently active for this subscription. This field can be used to indicate if the member is actively subscribed and eligible for benefits, communication, and billing related to the subscription. It can also be used for filtering and reporting purposes to identify active members within the subscription records.",
"type": "boolean",
"nullable": true
},
"mobile": {
"description": "The member''s mobile phone number for the member. This is the primary residential mobile number of the member and can be used for communication and correspondence related to the member subscription. It may not be active if the member has a different active mobile number, such as a job mobile number.",
"type": "string",
"maxLength": 30,
"nullable": true
},
"name2": {
"description": "The member''s secondary name for the member. This field can be used to store an additional name for the member, such as a middle name, maiden name, or any other relevant name information that may be useful for communication, billing, or record-keeping purposes related to the member subscription.",
"type": "string",
"maxLength": 50,
"nullable": true
},
"partnerPBS": {
"description": "The flag indicating whether the member subscription is associated with a partner PBS (Payment Business Service). This field can be used to identify if the member subscription is linked to a partner PBS for payment processing, which may have implications for billing, invoicing, and administrative handling of the subscription.",
"type": "boolean",
"nullable": true
},
"phone": {
"description": "The member''s home phone number for the member. This is the primary residential phone number of the member and can be used for communication and correspondence related to the member subscription. It may not be active if the member has a different active phone number, such as a job phone number.",
"type": "string",
"maxLength": 30,
"nullable": true
},
"postCode": {
"description": "The member''s home postal code for the member. This is the primary residential postal code of the member and can be used for communication and correspondence related to the member subscription. It may not be active if the member has a different active postal code, such as a job postal code.",
"type": "string",
"maxLength": 20,
"nullable": true
},
"price": {
"description": "The price of the member subscription. This field indicates the cost or fee associated with the member subscription, which can be used for billing, invoicing, and financial reporting purposes related to the member subscription.",
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
],
"format": "decimal",
"example": 0,
"nullable": true
},
"priceGroup": {
"description": "The price group associated with this member subscription. This field can be used to classify the member subscription into a specific price group, which may determine the pricing, discounts, or special offers that apply to the subscription. It can be helpful for managing different pricing tiers and for analyzing subscription data based on price groups.",
"type": "string",
"maxLength": 10,
"nullable": true
},
"publicationQuantity": {
"description": "The quantity of publications included in this member subscription. This field can be used to specify the number of publications, such as magazines, newsletters, or other materials, that are included as part of the member subscription, which can be important for billing, record-keeping, and communication purposes related to the member subscription.",
"type": "integer",
"format": "int32",
"nullable": true
},
"referringTo": {
"description": "The local union that the member''s current local union is referring to. This hierarchical parent of the member''s current local union.",
"type": "string",
"maxLength": 10,
"nullable": true
},
"sendMethod": {
"description": "The method by which communications related to this member subscription are sent. This field can be used to specify the preferred communication method for the member subscription, such as email, postal mail, or phone, which can help ensure that important information reaches the member through their preferred channel.",
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campPublicationSendMethod"
}
],
"nullable": true
},
"startingDate": {
"description": "The starting date of the member subscription. This field indicates the date on which the member subscription becomes active or starts. It can be used for managing subscription periods, renewals, and for providing information to the member about the status of their subscription.",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"subscription": {
"description": "The identifier or reference to the specific subscription associated with this member subscription record. This field can be used to link the member subscription to a particular subscription plan, product, or service that the member is subscribed to, which can be important for billing, record-keeping, and communication purposes related to the member subscription.",
"type": "string",
"maxLength": 20
},
"subscriptionDescription": {
"description": "The description of the subscription associated with this member subscription record. This field provides additional details about the subscription plan, product, or service that the member is subscribed to, offering a more descriptive explanation of the subscription''s features, benefits, or any other relevant information that can help with understanding the context of the member subscription''s association with the specific subscription.",
"type": "string",
"maxLength": 30,
"nullable": true
},
"subscriptionGroup": {
"description": "The group or category to which the subscription belongs for this member subscription. This field can be used to classify subscriptions into different groups based on certain criteria, such as subscription types, product categories, or other relevant factors. It can be helpful for targeted communication, marketing efforts, and for analyzing subscription data related to the member subscription records.",
"type": "string",
"maxLength": 20,
"nullable": true
},
"subscriptionMemberIsActive": {
"description": "The flag indicating whether the member subscription is currently active. This field can be used to indicate if the member subscription is actively subscribed and eligible for benefits, communication, and billing related to the subscription. It can also be used for filtering and reporting purposes to identify active member subscriptions within the records.",
"type": "boolean",
"nullable": true
},
"createdAt": {
"description": "The date and time when the member subscription cube record was created in the system. This field captures the timestamp of when the record was initially created, which can be used for auditing, tracking the lifecycle of the member subscription cube, and for providing information about the history of the subscription cube record.",
"type": "string",
"format": "date-time",
"nullable": true
},
"createdBy": {
"description": "The user who created the member subscription cube record in the system. This field captures the identifier of the user who was responsible for creating the record, which can be used for auditing, tracking changes, and for providing information about the origin of the member subscription cube record.",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef",
"nullable": true
},
"systemId": {
"description": "The unique identifier for the member subscription cube record in the system. This field can be used to store a system-generated unique ID that identifies the specific member subscription cube record, which can be important for data management, integration, and reference purposes related to the member subscription cube.",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef",
"nullable": true
},
"modifiedAt": {
"description": "The date and time when the member subscription cube record was last modified in the system. This field captures the timestamp of the most recent modification to the record, which can be used for auditing, tracking changes, and for providing information about the history of updates to the member subscription cube record.",
"type": "string",
"format": "date-time",
"nullable": true
},
"modifiedBy": {
"description": "The user who last modified the member subscription cube record in the system. This field captures the identifier of the user who was responsible for the most recent modification to the record, which can be used for auditing, tracking changes, and for providing information about the history of updates to the member subscription cube record.",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef",
"nullable": true
},
"vatRegistrationNo": {
"description": "The VAT registration number associated with this member subscription. This field can be used to store the VAT registration number of the member or the associated business entity for the member subscription, which may be relevant for billing, invoicing, and tax purposes related to the member subscription.",
"type": "string",
"maxLength": 20,
"nullable": true
},
"withdrawalReason": {
"description": "The reason for the member''s withdrawal from this subscription. This field can be used to capture the specific reason why the member decided to cancel or withdraw from the subscription, which can provide valuable insights for analyzing member behavior, improving retention strategies, and addressing any issues related to the member subscription experience.",
"type": "string",
"maxLength": 10,
"nullable": true
},
"withdrawalReasonDescription": {
"description": "The description of the reason for the member''s withdrawal from this subscription. This field provides additional details about the withdrawal reason, offering a more descriptive explanation of why the member decided to cancel or withdraw from the subscription. It can be used for better understanding and analysis of member behavior related to subscription cancellations.",
"type": "string",
"maxLength": 100,
"nullable": true
}
}
},
"Microsoft.NAV.subscriptionMember": {
"title": "subscriptionMember",
"type": "object",
"properties": {
"systemId": {
"description": "",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
},
"memberNo": {
"description": "Unique id of member",
"type": "string",
"maxLength": 20
},
"subscription": {
"description": "Unique id of subscription",
"type": "string",
"maxLength": 20
},
"frequency": {
"description": "The frequency with which the subscription is paid",
"type": "integer",
"format": "int32",
"nullable": true
},
"isBlocked": {
"description": "Is the member subscription blocked",
"type": "boolean",
"nullable": true
},
"invoiceStartingDate": {
"description": "Starting date of invoicing",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"invoiceEndingDate": {
"description": "Ending date of invoicing",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"startingDate": {
"description": "Starting date of the member subscription",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"endingDate": {
"description": "Ending date of the member subscription",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"attentionName": {
"description": "Attention name on the member subscription",
"type": "string",
"maxLength": 60,
"nullable": true
},
"invoiceMonth": {
"description": "The month in which the subscription is invoiced",
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campMonth"
}
],
"nullable": true
},
"eanNo": {
"description": "The GLN number of the member, if the member is a company",
"type": "string",
"maxLength": 13,
"nullable": true
},
"addresscodeInvoice": {
"description": "Address choice for receival of invoices",
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campAddresscodeInvoice"
}
],
"nullable": true
},
"addresscodeMail": {
"description": "Address choice for receival of postage mail",
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campAddresscodeMail"
}
],
"nullable": true
},
"periodPrice": {
"description": "Read-Only. The price for the period of invoicing",
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
],
"format": "decimal",
"example": 0,
"nullable": true
},
"subscriptionGroup": {
"description": "Read-Only. The subscription group in which the subscription belongs",
"type": "string",
"maxLength": 20,
"nullable": true
},
"invoiceMemberNo": {
"description": "Invoice account of the person paying the subscription",
"type": "string",
"maxLength": 20,
"nullable": true
},
"subscriptionDescription": {
"description": "Read-Only. Description of the subscription",
"type": "string",
"maxLength": 30,
"nullable": true
},
"associatedToNo": {
"description": "The member subscription this member subscription is associated to",
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"format": "int64",
"example": "42",
"nullable": true
},
"welcomeLetter": {
"description": "Read-Only. Does the subscription trigger a welcome letter",
"type": "boolean",
"nullable": true
},
"isWelcomeLetterCreated": {
"description": "Is a welcome letter created",
"type": "boolean",
"nullable": true
},
"hasBeenInEntryList": {
"description": "Has the member subscription been in additions list",
"type": "boolean",
"nullable": true
},
"hasBeenInWithdrawalList": {
"description": "Has the member subscription been in withdrawal list",
"type": "boolean",
"nullable": true
},
"invoiceQuantity": {
"description": "The quantity being invoiced",
"type": "integer",
"format": "int32",
"nullable": true
},
"invoiceMemberName": {
"description": "Read-Only. The name of the invoice member",
"type": "string",
"maxLength": 100,
"nullable": true
},
"memberName": {
"description": "Read-Only. The name of the subscription member",
"type": "string",
"maxLength": 100,
"nullable": true
},
"no": {
"description": "",
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"format": "int64",
"example": "42",
"nullable": true
},
"price": {
"description": "The price of the subscription",
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
],
"format": "decimal",
"example": 0,
"nullable": true
},
"publicationQuantity": {
"description": "The publication quantity for the member subscription",
"type": "integer",
"format": "int32",
"nullable": true
},
"invoiceDescription": {
"description": "Read-Only. Description to be printed on invoices",
"type": "string",
"maxLength": 250,
"nullable": true
},
"sendMethod": {
"description": "The send medthod of the publication belonging to the member subscription",
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campPublicationSendMethod"
}
],
"nullable": true
},
"onlinePaymentOrderId": {
"description": "Online Payment Order Id",
"type": "string",
"maxLength": 20,
"nullable": true
}
}
},
"Microsoft.NAV.subscriptionMember-create": {
"title": "subscriptionMember (for create)",
"type": "object",
"properties": {
"memberNo": {
"type": "string",
"maxLength": 20
},
"subscription": {
"type": "string",
"maxLength": 20
},
"frequency": {
"type": "integer",
"format": "int32",
"nullable": true
},
"isBlocked": {
"type": "boolean",
"nullable": true
},
"invoiceStartingDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"invoiceEndingDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"startingDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"endingDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"attentionName": {
"type": "string",
"maxLength": 60,
"nullable": true
},
"invoiceMonth": {
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campMonth"
}
],
"nullable": true
},
"eanNo": {
"type": "string",
"maxLength": 13,
"nullable": true
},
"addresscodeInvoice": {
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campAddresscodeInvoice"
}
],
"nullable": true
},
"addresscodeMail": {
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campAddresscodeMail"
}
],
"nullable": true
},
"invoiceMemberNo": {
"type": "string",
"maxLength": 20,
"nullable": true
},
"associatedToNo": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"format": "int64",
"example": "42",
"nullable": true
},
"isWelcomeLetterCreated": {
"type": "boolean",
"nullable": true
},
"hasBeenInEntryList": {
"type": "boolean",
"nullable": true
},
"hasBeenInWithdrawalList": {
"type": "boolean",
"nullable": true
},
"invoiceQuantity": {
"type": "integer",
"format": "int32",
"nullable": true
},
"price": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
],
"format": "decimal",
"example": 0,
"nullable": true
},
"publicationQuantity": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sendMethod": {
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campPublicationSendMethod"
}
],
"nullable": true
},
"onlinePaymentOrderId": {
"type": "string",
"maxLength": 20,
"nullable": true
}
},
"required": [
"memberNo",
"subscription"
]
},
"Microsoft.NAV.subscriptionMember-update": {
"title": "subscriptionMember (for update)",
"type": "object",
"properties": {
"memberNo": {
"type": "string",
"maxLength": 20
},
"subscription": {
"type": "string",
"maxLength": 20
},
"frequency": {
"type": "integer",
"format": "int32",
"nullable": true
},
"isBlocked": {
"type": "boolean",
"nullable": true
},
"invoiceStartingDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"invoiceEndingDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"startingDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"endingDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"attentionName": {
"type": "string",
"maxLength": 60,
"nullable": true
},
"invoiceMonth": {
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campMonth"
}
],
"nullable": true
},
"eanNo": {
"type": "string",
"maxLength": 13,
"nullable": true
},
"addresscodeInvoice": {
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campAddresscodeInvoice"
}
],
"nullable": true
},
"addresscodeMail": {
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campAddresscodeMail"
}
],
"nullable": true
},
"invoiceMemberNo": {
"type": "string",
"maxLength": 20,
"nullable": true
},
"associatedToNo": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"format": "int64",
"example": "42",
"nullable": true
},
"isWelcomeLetterCreated": {
"type": "boolean",
"nullable": true
},
"hasBeenInEntryList": {
"type": "boolean",
"nullable": true
},
"hasBeenInWithdrawalList": {
"type": "boolean",
"nullable": true
},
"invoiceQuantity": {
"type": "integer",
"format": "int32",
"nullable": true
},
"price": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
],
"format": "decimal",
"example": 0,
"nullable": true
},
"publicationQuantity": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sendMethod": {
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campPublicationSendMethod"
}
],
"nullable": true
},
"onlinePaymentOrderId": {
"type": "string",
"maxLength": 20,
"nullable": true
}
}
},
"Microsoft.NAV.subscriptionPrice": {
"title": "subscriptionPrice",
"type": "object",
"properties": {
"systemId": {
"description": "",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
},
"endingDate": {
"description": "Ending date for the subscription price",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"frequency": {
"description": "The Frequencey the price belongs to",
"type": "integer",
"format": "int32"
},
"priceForUnits": {
"description": "The unit price",
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
],
"format": "decimal",
"example": 0,
"nullable": true
},
"quantity": {
"description": "The required quantity",
"type": "integer",
"format": "int32",
"nullable": true
},
"ruleCode": {
"description": "Unique code of the associated rule",
"type": "string",
"maxLength": 20,
"nullable": true
},
"ruleType": {
"description": "Description of the rule type",
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campPriceGroupRuleType"
}
],
"nullable": true
},
"startingDate": {
"description": "Starting date of the subscription price",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"subscription": {
"description": "The subscription the price belongs to",
"type": "string",
"maxLength": 20
},
"unitsInPrice": {
"description": "The number of units in the price",
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
],
"format": "decimal",
"example": 0,
"nullable": true
}
}
},
"Microsoft.NAV.taxonomy": {
"title": "taxonomy",
"type": "object",
"properties": {
"no": {
"description": "Unique id of the taxonomy",
"type": "integer",
"format": "int32"
},
"systemId": {
"description": "",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef",
"nullable": true
},
"description": {
"description": "Description of the taxonomy",
"type": "string",
"maxLength": 60,
"nullable": true
},
"path": {
"description": "The taxonomy list",
"type": "string",
"maxLength": 250,
"nullable": true
},
"displayOnInternet": {
"description": "Is the event to be displayed on the internet",
"type": "boolean",
"nullable": true
},
"parentNo": {
"description": "The parent id of the taxonomy",
"type": "integer",
"format": "int32",
"nullable": true
}
}
},
"Microsoft.NAV.taxonomyCube": {
"title": "taxonomyCube",
"type": "object",
"properties": {
"no": {
"description": "Unique identifier for the taxonomy cube entry",
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"format": "int64",
"example": "42"
},
"memberNo": {
"description": "Unique identifier for the member",
"type": "string",
"maxLength": 20,
"nullable": true
},
"name": {
"description": "Full name of the member",
"type": "string",
"maxLength": 100,
"nullable": true
},
"address": {
"description": "Primary address of the member",
"type": "string",
"maxLength": 100,
"nullable": true
},
"address2": {
"description": "Additional address information",
"type": "string",
"maxLength": 50,
"nullable": true
},
"city": {
"description": "City of residence",
"type": "string",
"maxLength": 30,
"nullable": true
},
"phoneNo": {
"description": "Primary phone number",
"type": "string",
"maxLength": 30,
"nullable": true
},
"countryRegionCode": {
"description": "Country or region code",
"type": "string",
"maxLength": 10,
"nullable": true
},
"postCode": {
"description": "Postal code",
"type": "string",
"maxLength": 20,
"nullable": true
},
"eMail": {
"description": "Primary email address",
"type": "string",
"maxLength": 80,
"nullable": true
},
"chosenEMail": {
"description": "Preferred email address",
"type": "string",
"maxLength": 80,
"nullable": true
},
"memberIsActive": {
"description": "Indicates if the member is active",
"type": "boolean",
"nullable": true
},
"age": {
"description": "Age of the member",
"type": "integer",
"format": "int32",
"nullable": true
},
"municipalityName": {
"description": "Name of the municipality",
"type": "string",
"maxLength": 30,
"nullable": true
},
"regionName": {
"description": "Name of the region",
"type": "string",
"maxLength": 30,
"nullable": true
},
"memberGroup": {
"description": "Group to which the member belongs",
"type": "string",
"maxLength": 10,
"nullable": true
},
"cprNumber": {
"description": "CPR number of the member",
"type": "string",
"maxLength": 10,
"nullable": true
},
"localUnion": {
"description": "Local union affiliation",
"type": "string",
"maxLength": 10,
"nullable": true
},
"subscriptionPriceGroup": {
"description": "Subscription price group for the member",
"type": "string",
"maxLength": 10,
"nullable": true
},
"mobilePhoneNo": {
"description": "Mobile phone number",
"type": "string",
"maxLength": 30,
"nullable": true
},
"municipality": {
"description": "Municipality code",
"type": "string",
"maxLength": 10,
"nullable": true
},
"localUnionDescription": {
"description": "Description of the local union",
"type": "string",
"maxLength": 50,
"nullable": true
},
"birthDate": {
"description": "Date of birth",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"gender": {
"description": "Gender of the member",
"allOf": [
{
"$ref": "#/components/schemas/Microsoft.NAV.campGender"
}
],
"nullable": true
},
"region": {
"description": "Region code",
"type": "string",
"maxLength": 10,
"nullable": true
},
"activeMainEmployer": {
"description": "Indicates if the member has an active main employer",
"type": "string",
"maxLength": 20,
"nullable": true
},
"employerName": {
"description": "Name of the employer",
"type": "string",
"maxLength": 100,
"nullable": true
},
"employerAddress": {
"description": "Employer address",
"type": "string",
"maxLength": 200,
"nullable": true
},
"employerCity": {
"description": "Employer city",
"type": "string",
"maxLength": 30,
"nullable": true
},
"employerPostCode": {
"description": "Employer postal code",
"type": "string",
"maxLength": 20,
"nullable": true
},
"activeAddress": {
"description": "Active address of the member",
"type": "string",
"maxLength": 100,
"nullable": true
},
"activeAddress2": {
"description": "Additional active address information",
"type": "string",
"maxLength": 50,
"nullable": true
},
"activePostCode": {
"description": "Active postal code",
"type": "string",
"maxLength": 20,
"nullable": true
},
"activeCity": {
"description": "Active city",
"type": "string",
"maxLength": 30,
"nullable": true
},
"campCode1": {
"description": "First camp code",
"type": "string",
"maxLength": 20,
"nullable": true
},
"campCode2": {
"description": "Second camp code",
"type": "string",
"maxLength": 20,
"nullable": true
},
"campText1": {
"description": "First camp text field",
"type": "string",
"maxLength": 50,
"nullable": true
},
"campText2": {
"description": "Second camp text field",
"type": "string",
"maxLength": 50,
"nullable": true
},
"campText3": {
"description": "Third camp text field",
"type": "string",
"maxLength": 50,
"nullable": true
},
"campText4": {
"description": "Fourth camp text field",
"type": "string",
"maxLength": 50,
"nullable": true
},
"campText5": {
"description": "Fifth camp text field",
"type": "string",
"maxLength": 50,
"nullable": true
},
"referringTo": {
"description": "Reference to another entity",
"type": "string",
"maxLength": 10,
"nullable": true
},
"taxonomyNo": {
"description": "Taxonomy number",
"type": "integer",
"format": "int32"
},
"taxonomyPath": {
"description": "Path in the taxonomy",
"type": "string",
"maxLength": 250,
"nullable": true
},
"startingDate": {
"description": "Start date of the taxonomy entry",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"endingDate": {
"description": "End date of the taxonomy entry",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"comment": {
"description": "Additional comments",
"type": "string",
"maxLength": 250,
"nullable": true
},
"taxonomyIsActive": {
"description": "Indicates if the taxonomy entry is active",
"type": "boolean",
"nullable": true
},
"shownOnInternet": {
"description": "Indicates if shown on the internet",
"type": "boolean",
"nullable": true
},
"description": {
"description": "Description of the taxonomy entry",
"type": "string",
"maxLength": 60,
"nullable": true
}
}
},
"Microsoft.NAV.taxonomyMember": {
"title": "taxonomyMember",
"type": "object",
"properties": {
"systemId": {
"description": "",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
},
"taxonomy": {
"description": "Id of the taxonomy",
"type": "integer",
"format": "int32"
},
"taxonomyDescription": {
"description": "The description of the taxonomy",
"type": "string",
"maxLength": 60,
"nullable": true
},
"taxonomyPath": {
"description": "The taxonomy path",
"type": "string",
"maxLength": 250,
"nullable": true
},
"memberNo": {
"description": "The member number of the taxonomy",
"type": "string",
"maxLength": 20
},
"startingDate": {
"description": "Starting date of the taxonomy",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"endingDate": {
"description": "Ending date of the taxonomy",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"no": {
"description": "",
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"format": "int64",
"example": "42",
"nullable": true
},
"comment": {
"description": "Comments to the taxonomy",
"type": "string",
"maxLength": 250,
"nullable": true
}
}
},
"Microsoft.NAV.taxonomyMember-create": {
"title": "taxonomyMember (for create)",
"type": "object",
"properties": {
"taxonomy": {
"type": "integer",
"format": "int32"
},
"memberNo": {
"type": "string",
"maxLength": 20
},
"startingDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"endingDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"comment": {
"type": "string",
"maxLength": 250,
"nullable": true
}
},
"required": [
"taxonomy",
"memberNo"
]
},
"Microsoft.NAV.taxonomyMember-update": {
"title": "taxonomyMember (for update)",
"type": "object",
"properties": {
"taxonomy": {
"type": "integer",
"format": "int32"
},
"memberNo": {
"type": "string",
"maxLength": 20
},
"startingDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"endingDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"comment": {
"type": "string",
"maxLength": 250,
"nullable": true
}
}
},
"Microsoft.NAV.unionPost": {
"title": "unionPost",
"type": "object",
"properties": {
"systemId": {
"description": "",
"type": "string",
"format": "uuid",
"example": "01234567-89ab-cdef-0123-456789abcdef"
},
"employerMemberNo": {
"description": "Unique id of member/employer",
"type": "string",
"maxLength": 20
},
"employerName": {
"description": "Read-Only. Name of the employer from the member card",
"type": "string",
"maxLength": 100,
"nullable": true
},
"employeeMemberNo": {
"description": "Unique id of member/employee",
"type": "string",
"maxLength": 20
},
"employeeName": {
"description": "Read-Only. Name of the employee from the member card",
"type": "string",
"maxLength": 100,
"nullable": true
},
"unionPostType": {
"description": "Unique id of the union post type",
"type": "string",
"maxLength": 10
},
"unionPostTypeDescription": {
"description": "Read-Only. Description of the union post type",
"type": "string",
"maxLength": 60,
"nullable": true
},
"startingDate": {
"description": "Starting date of the union post",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"endingDate": {
"description": "Ending date of the union post",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"withdrawalDate": {
"description": "Withdrawn",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"isJobChanged": {
"description": "Has the member changed employement",
"type": "boolean",
"nullable": true
},
"no": {
"description": "",
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"format": "int64",
"example": "42",
"nullable": true
}
}
},
"Microsoft.NAV.unionPost-create": {
"title": "unionPost (for create)",
"type": "object",
"properties": {
"employerMemberNo": {
"type": "string",
"maxLength": 20
},
"employeeMemberNo": {
"type": "string",
"maxLength": 20
},
"unionPostType": {
"type": "string",
"maxLength": 10
},
"startingDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"endingDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"withdrawalDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"isJobChanged": {
"type": "boolean",
"nullable": true
}
},
"required": [
"employerMemberNo",
"employeeMemberNo",
"unionPostType"
]
},
"Microsoft.NAV.unionPost-update": {
"title": "unionPost (for update)",
"type": "object",
"properties": {
"employerMemberNo": {
"type": "string",
"maxLength": 20
},
"employeeMemberNo": {
"type": "string",
"maxLength": 20
},
"unionPostType": {
"type": "string",
"maxLength": 10
},
"startingDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"endingDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"withdrawalDate": {
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"isJobChanged": {
"type": "boolean",
"nullable": true
}
}
},
"Microsoft.NAV.unionPostType": {
"title": "unionPostType",
"type": "object",
"properties": {
"code": {
"description": "",
"type": "string",
"maxLength": 10
},
"description": {
"description": "Description of the union post type",
"type": "string",
"maxLength": 60,
"nullable": true
}
}
},
"count": {
"anyOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "string"
}
],
"description": "The number of entities in the collection. Available when using the [$count](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptioncount) query option."
},
"error": {
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"target": {
"type": "string"
},
"details": {
"type": "array",
"items": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"target": {
"type": "string"
}
}
}
},
"innererror": {
"type": "object",
"description": "The structure of this object is service-specific"
}
}
}
}
}
},
"parameters": {
"company": {
"in": "query",
"schema": {
"type": "string"
},
"name": "company",
"description": "Kan findes i Business Central ved at åbne siden regnskabsoversigt, vælg derefter det ønskede regnskab. Åbn inspectoren ved at trykke ctrl+alt+F1. Marker værdien i feltet "id" ved at triple-klikke og kopier værdien.",
"required": true
},
"top": {
"name": "$top",
"in": "query",
"description": "Show only the first n items, see [Paging - Top](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptiontop)",
"schema": {
"type": "integer",
"minimum": 0
},
"example": 50
},
"skip": {
"name": "$skip",
"in": "query",
"description": "Skip the first n items, see [Paging - Skip](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionskip)",
"schema": {
"type": "integer",
"minimum": 0
}
},
"count": {
"name": "$count",
"in": "query",
"description": "Include count of items, see [Count](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptioncount)",
"schema": {
"type": "boolean"
}
},
"search": {
"name": "$search",
"in": "query",
"description": "Search items by search phrases, see [Searching](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionsearch)",
"schema": {
"type": "string"
}
}
},
"responses": {
"error": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
}
}
}
}
},
"securitySchemes": {
"oAuth2ClientCredentials": {
"type": "oauth2",
"flows": {
"clientCredentials": {
"tokenUrl": "https://login.microsoftonline.com/camp1.onmicrosoft.com/oauth2/v2.0/token",
"scopes": {
"https://api.businesscentral.dynamics.com/.default": "Default permissions"
}
}
},
"description": "HUSK at indsætte dit tenant id eller domæne.
"
},
"bearerAuth": {
"bearerFormat": "JwT",
"scheme": "bearer",
"description": "Hvis du vil teste i Swagger UI, skal du anvende denne.
",
"type": "http"
}
}
}
}