{ "openapi": "3.1.0", "info": { "title": "Foundational Data", "version": "2023-02-28", "description": "Synchronize your foundational data between your Beeline and your ERP systems in order to drive your financial and procurement processes in Beeline.\n" }, "servers": [ { "url": "https://client.beeline.com/api" }, { "url": "https://client-eu.beeline.com/api" } ], "tags": [ { "name": "Business Area" }, { "name": "Identity and Access Management" }, { "name": "Location", "description": "The Location API is comprised of endpoints you can use to manage location data. You can create, update, and delete a specific location. You can also retrieve data points, such as the location ID, description, and much more, for a specific location." }, { "name": "Organization", "description": "The Organization API is comprised of endpoints you can use to manage organization data. You can create, update, and delete organization related information such as organization unit type and cost center. You can also retrieve data points, such as the cost center ID, organization code, and much more." }, { "name": "Spend Authority" }, { "name": "User" } ], "paths": { "/sites/{clientSiteId}/countries": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-location-countries", "summary": "Country List", "description": "- Field values that use terminology keys in the VMS will return the default language for the VMS instance\n", "tags": [ "Location" ], "security": [ { "client_auth": [ "read:location", "write:location" ] } ], "parameters": [ { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } } ], "responses": { "200": { "description": "List of Countries defined in the VMS instance", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "description": "A set of Countries", "type": "object", "properties": { "maxItems": { "type": "integer", "description": "The total number of items" }, "value": { "type": "array", "description": "The set of items. If there are no items, this will be an empty array.", "items": { "type": "object", "description": "Information", "required": [ "countryCode", "displayName" ], "properties": { "countryCode": { "type": "string", "description": "An identifier for a country", "maxLength": 255 }, "displayName": { "type": "string", "description": "The name of the country", "maxLength": 255 }, "description": { "type": "string", "description": "The long description of the country", "maxLength": 255 } } } } } }, "examples": { "simple": { "value": { "maxItems": 5, "value": [ { "countryCode": "AE", "displayName": "The United Arab Emirates", "description": "Country of UAE" }, { "countryCode": "GB", "displayName": "The United Kingdom of Great Britain and Northern Ireland", "description": "Country of England" }, { "countryCode": "UM", "displayName": "United States Minor Outlying Islands", "description": "Country of USA MOI" }, { "countryCode": "US", "displayName": "The United States of America", "description": "Country of USA" }, { "countryCode": "UZ", "displayName": "The Republic of Uzbekistan", "description": "Country of Uzbekistan" } ] } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/countries/{countryCode}": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "countryCode", "description": "An identifier for a country", "required": true, "schema": { "type": "string", "maxLength": 255 } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-location-country", "summary": "Country", "description": "- Field values that use terminology keys in the VMS will return the default language for the VMS instance\n", "tags": [ "Location" ], "security": [ { "client_auth": [ "read:location", "write:location" ] } ], "responses": { "200": { "description": "Information about a single country", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "Information", "required": [ "displayName" ], "properties": { "displayName": { "type": "string", "description": "The name of the country", "maxLength": 255 }, "description": { "type": "string", "description": "The long description of the country", "maxLength": 255 } } }, "examples": { "simple": { "value": { "displayName": "The United States of America", "description": "Country of USA" } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } }, "put": { "operationId": "put-location-country", "summary": "Country", "tags": [ "Location" ], "security": [ { "client_auth": [ "write:location" ] } ], "requestBody": { "description": "Update or create a country -- this will replace the existing object with the specified object", "content": { "application/json": { "schema": { "type": "object", "description": "Information", "required": [ "displayName" ], "properties": { "displayName": { "type": "string", "description": "The name of the country", "maxLength": 255 }, "description": { "type": "string", "description": "The long description of the country", "maxLength": 255 } } }, "examples": { "simple": { "value": { "displayName": "The United States of America", "description": "Country of USA" } } } } } }, "responses": { "200": { "description": "Country was updated", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "201": { "description": "Country was created", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/countries/{countryCode}/states": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "countryCode", "description": "An identifier for a country", "required": true, "schema": { "type": "string", "maxLength": 255 } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-location-states", "summary": "State List", "description": "- Field values that use terminology keys in the VMS will return the default language for the VMS instance\n", "tags": [ "Location" ], "security": [ { "client_auth": [ "read:location", "write:location" ] } ], "parameters": [ { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } } ], "responses": { "200": { "description": "List of States defined in the VMS instance", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "description": "A set of States", "type": "object", "properties": { "maxItems": { "type": "integer", "description": "The total number of items" }, "value": { "type": "array", "description": "The set of items. If there are no items, this will be an empty array.", "items": { "type": "object", "description": "Information", "required": [ "displayName", "stateCode" ], "properties": { "stateCode": { "type": "string", "description": "An identifier for a state", "maxLength": 5 }, "displayName": { "type": "string", "description": "The name of the state", "maxLength": 255 }, "description": { "type": "string", "description": "The description of the state", "maxLength": 255 } } } } } }, "examples": { "simple": { "value": { "maxItems": 5, "value": [ { "stateCode": "AL", "displayName": "Alabama", "description": "Alabama State" }, { "stateCode": "AK", "displayName": "Alaska", "description": "Alaska State" }, { "stateCode": "AZ", "displayName": "Arizona", "description": "Arizona State" }, { "stateCode": "AR", "displayName": "Arkansas", "description": "Arkansas State" }, { "stateCode": "CA", "displayName": "California", "description": "California State" } ] } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/countries/{countryCode}/states/{stateCode}": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "countryCode", "description": "An identifier for a country", "required": true, "schema": { "type": "string", "maxLength": 255 } }, { "in": "path", "name": "stateCode", "description": "An identifier for a state", "required": true, "schema": { "type": "string", "maxLength": 5 } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-location-state", "summary": "State", "description": "- Field values that use terminology keys in the VMS will return the default language for the VMS instance\n", "tags": [ "Location" ], "security": [ { "client_auth": [ "read:location", "write:location" ] } ], "responses": { "200": { "description": "Information about a single state", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "Information", "required": [ "displayName" ], "properties": { "displayName": { "type": "string", "description": "The name of the state", "maxLength": 255 }, "description": { "type": "string", "description": "The description of the state", "maxLength": 255 } } }, "examples": { "simple": { "value": { "displayName": "California", "description": "California State" } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } }, "put": { "operationId": "put-location-state", "summary": "State", "tags": [ "Location" ], "security": [ { "client_auth": [ "write:location" ] } ], "requestBody": { "description": "Update or create a state -- this will replace the existing object with the specified object", "content": { "application/json": { "schema": { "type": "object", "description": "Information", "required": [ "displayName" ], "properties": { "displayName": { "type": "string", "description": "The name of the state", "maxLength": 255 }, "description": { "type": "string", "description": "The description of the state", "maxLength": 255 } } }, "examples": { "simple": { "value": { "displayName": "California", "description": "California State" } } } } } }, "responses": { "200": { "description": "State was updated", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "201": { "description": "State was created", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/countries/{countryCode}/states/{stateCode}/counties": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "countryCode", "description": "An identifier for a country", "required": true, "schema": { "type": "string", "maxLength": 255 } }, { "in": "path", "name": "stateCode", "description": "An identifier for a state", "required": true, "schema": { "type": "string", "maxLength": 5 } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-location-counties", "summary": "County List", "description": "- Field values that use terminology keys in the VMS will return the default language for the VMS instance\n", "tags": [ "Location" ], "security": [ { "client_auth": [ "read:location", "write:location" ] } ], "parameters": [ { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } } ], "responses": { "200": { "description": "List of Counties defined in the VMS instance", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "description": "A set of Counties", "type": "object", "properties": { "maxItems": { "type": "integer", "description": "The total number of items" }, "value": { "type": "array", "description": "The set of items. If there are no items, this will be an empty array.", "items": { "type": "object", "description": "Information", "required": [ "countyCode", "displayName" ], "properties": { "countyCode": { "type": "string", "description": "An identifier for a county", "maxLength": 255 }, "displayName": { "type": "string", "description": "The name of the county", "maxLength": 255 }, "description": { "type": "string", "description": "The long name of the county", "maxLength": 255 } } } } } }, "examples": { "simple": { "value": { "maxItems": 5, "value": [ { "countyCode": "001", "displayName": "Alameda", "description": "Alameda County" }, { "countyCode": "002", "displayName": "Alpine", "description": "Alpine County" }, { "countyCode": "005", "displayName": "Amador", "description": "Amador County" }, { "countyCode": "007", "displayName": "Butte", "description": "Butte County" }, { "countyCode": "009", "displayName": "Calaveras", "description": "Calaveras County" } ] } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/countries/{countryCode}/states/{stateCode}/counties/{countyCode}": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "countryCode", "description": "An identifier for a country", "required": true, "schema": { "type": "string", "maxLength": 255 } }, { "in": "path", "name": "stateCode", "description": "An identifier for a state", "required": true, "schema": { "type": "string", "maxLength": 5 } }, { "in": "path", "name": "countyCode", "description": "An identifier for a county", "required": true, "schema": { "type": "string", "maxLength": 255 } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-location-county", "summary": "County", "description": "- Field values that use terminology keys in the VMS will return the default language for the VMS instance\n", "tags": [ "Location" ], "security": [ { "client_auth": [ "read:location", "write:location" ] } ], "responses": { "200": { "description": "Information about a single county", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "Information", "required": [ "displayName" ], "properties": { "displayName": { "type": "string", "description": "The name of the county", "maxLength": 255 }, "description": { "type": "string", "description": "The long name of the county", "maxLength": 255 } } }, "examples": { "simple": { "value": { "displayName": "Alameda", "description": "Alameda County" } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } }, "put": { "operationId": "put-location-county", "summary": "County", "tags": [ "Location" ], "security": [ { "client_auth": [ "write:location" ] } ], "requestBody": { "description": "Update or create a county -- this will replace the existing object with the specified object", "content": { "application/json": { "schema": { "type": "object", "description": "Information", "required": [ "displayName" ], "properties": { "displayName": { "type": "string", "description": "The name of the county", "maxLength": 255 }, "description": { "type": "string", "description": "The long name of the county", "maxLength": 255 } } }, "examples": { "simple": { "value": { "displayName": "Alameda", "description": "Alameda County" } } } } } }, "responses": { "200": { "description": "County was updated", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "201": { "description": "County was created", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/locations": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-location-locations", "summary": "Location List", "deprecated": true, "description": "- Field values that use terminology keys in the VMS will return the default language for the VMS instance\n\nThis API is deprecated. Please use new version [here](/api-products/foundational_2023-07-01#tag/Location/operation/get-location-locations).\n", "tags": [ "Location" ], "security": [ { "client_auth": [ "read:location", "write:location" ] } ], "parameters": [ { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } } ], "responses": { "200": { "description": "List of Locations defined in the VMS instance", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of locations", "properties": { "maxItems": { "type": "integer", "description": "The total number of locations" }, "value": { "type": "array", "description": "An array of locations. If there are no locations this will be an empty array.", "items": { "type": "object", "description": "A business location", "required": [ "displayName", "street1", "city", "countryCode", "stateCode", "postalCode", "locationCode" ], "properties": { "locationCode": { "type": "string", "description": "A code uniquely identifying the location", "maxLength": 255 }, "displayName": { "type": "string", "description": "The name of the location", "maxLength": 255 }, "description": { "type": "string", "description": "A description of the location", "maxLength": 255 }, "street1": { "type": "string", "description": "The primary street for this location", "maxLength": 150 }, "street2": { "type": "string", "description": "The secondary street for this location", "maxLength": 150 }, "city": { "type": "string", "description": "A string for storing the city of this location", "maxLength": 50 }, "countryCode": { "type": "string", "description": "A code uniquely identifying the country", "maxLength": 255 }, "stateCode": { "type": "string", "description": "A code uniquely identifying the state within a country", "maxLength": 5 }, "countyCode": { "type": "string", "description": "A code uniquely identifying the county", "maxLength": 255 }, "postalCode": { "type": "string", "description": "The postal code for this location", "maxLength": 10 }, "region": { "type": "string", "description": "The internal region of this location", "maxLength": 255 }, "phoneNumber": { "type": "string", "description": "A phone number for this location", "maxLength": 30 } } } } } }, "examples": { "simple": { "value": { "maxItems": 2, "value": [ { "locationCode": "Alameda", "displayName": "Main Office", "description": "Main Office Location", "street1": "123 Example Dr", "street2": "Building 3A", "city": "Alameda", "countryCode": "US", "stateCode": "CA", "countyCode": "001", "postalCode": "94501", "region": "Pacific", "phoneNumber": "619-555-1212" }, { "locationCode": "Houston", "displayName": "Houston Branch Office", "description": "Houston Branch Office Location", "street1": "456 Example Ave", "street2": "Box 1234", "city": "Houston", "countryCode": "US", "stateCode": "TX", "countyCode": "201", "postalCode": "77080", "region": "South", "phoneNumber": "281-555-1212" } ] } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/locations/{locationCode}": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "locationCode", "description": "A code uniquely identifying the location", "required": true, "schema": { "type": "string", "maxLength": 255 } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-location-location", "summary": "Location", "deprecated": true, "description": "- Field values that use terminology keys in the VMS will return the default language for the VMS instance\n\nThis API is deprecated. Please use new version [here](/api-products/foundational_2023-07-01#tag/Location/operation/get-location-location).\n", "tags": [ "Location" ], "security": [ { "client_auth": [ "read:location", "write:location" ] } ], "responses": { "200": { "description": "Get a location", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A business location", "required": [ "displayName", "street1", "city", "countryCode", "stateCode", "postalCode" ], "properties": { "displayName": { "type": "string", "description": "The name of the location", "maxLength": 255 }, "description": { "type": "string", "description": "A description of the location", "maxLength": 255 }, "street1": { "type": "string", "description": "The primary street for this location", "maxLength": 150 }, "street2": { "type": "string", "description": "The secondary street for this location", "maxLength": 150 }, "city": { "type": "string", "description": "A string for storing the city of this location", "maxLength": 50 }, "countryCode": { "type": "string", "description": "A code uniquely identifying the country", "maxLength": 255 }, "stateCode": { "type": "string", "description": "A code uniquely identifying the state within a country", "maxLength": 5 }, "countyCode": { "type": "string", "description": "A code uniquely identifying the county", "maxLength": 255 }, "postalCode": { "type": "string", "description": "The postal code for this location", "maxLength": 10 }, "region": { "type": "string", "description": "The internal region of this location", "maxLength": 255 }, "phoneNumber": { "type": "string", "description": "A phone number for this location", "maxLength": 30 } } }, "examples": { "simple": { "value": { "displayName": "Main Office", "description": "Main Office Location", "street1": "123 Example Dr", "street2": "Building 3A", "city": "Alameda", "countryCode": "US", "stateCode": "CA", "countyCode": "001", "postalCode": "94501", "region": "Pacific", "phoneNumber": "619-555-1212" } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } }, "put": { "operationId": "put-location-location", "summary": "Location", "deprecated": true, "description": "This API is deprecated. Please use new version [here](/api-products/foundational_2023-07-01#tag/Location/operation/put-location-location).\n", "tags": [ "Location" ], "security": [ { "client_auth": [ "write:location" ] } ], "requestBody": { "description": "Update or create a location -- this will replace the existing object with the specified object", "content": { "application/json": { "schema": { "type": "object", "description": "A business location", "required": [ "displayName", "street1", "city", "countryCode", "stateCode", "postalCode" ], "properties": { "displayName": { "type": "string", "description": "The name of the location", "maxLength": 255 }, "description": { "type": "string", "description": "A description of the location", "maxLength": 255 }, "street1": { "type": "string", "description": "The primary street for this location", "maxLength": 150 }, "street2": { "type": "string", "description": "The secondary street for this location", "maxLength": 150 }, "city": { "type": "string", "description": "A string for storing the city of this location", "maxLength": 50 }, "countryCode": { "type": "string", "description": "A code uniquely identifying the country", "maxLength": 255 }, "stateCode": { "type": "string", "description": "A code uniquely identifying the state within a country", "maxLength": 5 }, "countyCode": { "type": "string", "description": "A code uniquely identifying the county", "maxLength": 255 }, "postalCode": { "type": "string", "description": "The postal code for this location", "maxLength": 10 }, "region": { "type": "string", "description": "The internal region of this location", "maxLength": 255 }, "phoneNumber": { "type": "string", "description": "A phone number for this location", "maxLength": 30 } } }, "examples": { "simple": { "value": { "displayName": "Main Office", "description": "Main Office Location", "street1": "123 Example Dr", "street2": "Building 3A", "city": "Alameda", "countryCode": "US", "stateCode": "CA", "countyCode": "001", "postalCode": "94501", "region": "Pacific", "phoneNumber": "619-555-1212" } } } } } }, "responses": { "200": { "description": "Location was updated", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "201": { "description": "Location was created", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } }, "delete": { "operationId": "delete-location-location", "summary": "Location", "tags": [ "Location" ], "security": [ { "client_auth": [ "write:location" ] } ], "responses": { "200": { "description": "Location was removed", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/ou-types": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-org-ou-types", "summary": "OU Type List", "tags": [ "Organization" ], "security": [ { "client_auth": [ "read:org", "write:org" ] } ], "parameters": [ { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } }, { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "responses": { "200": { "description": "List of Organization Unit Types.", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer" }, "value": { "type": "array", "items": { "required": [ "ouTypeDisplayName" ], "properties": { "ouTypeDisplayName": { "type": "string", "maxLength": 255 } }, "type": "object" } } } }, "examples": { "simple": { "value": { "maxItems": 4, "value": [ { "ouTypeDisplayName": "outype1", "description": "Description of OU Type1" }, { "ouTypeDisplayName": "outype2", "description": "Description of OU Type2" }, { "ouTypeDisplayName": "outype3", "description": "Description of OU Type3" }, { "ouTypeDisplayName": "outype4", "description": "Description of OU Type4" } ] } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/ou-types/{ouTypeDisplayName}": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "ouTypeDisplayName", "description": "A name uniquely identifying an OU Type", "required": true, "schema": { "type": "string", "maxLength": 255 } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-org-ou-type", "summary": "OU Type", "tags": [ "Organization" ], "security": [ { "client_auth": [ "read:org", "write:org" ] } ], "responses": { "200": { "description": "Get an Organization Unit Type", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "maxLength": 255 } } }, "examples": { "simple": { "value": { "description": "Description of OU Type1" } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } }, "put": { "operationId": "put-org-ou-type", "summary": "OU Type", "tags": [ "Organization" ], "security": [ { "client_auth": [ "write:org" ] } ], "requestBody": { "description": "Update or create an Organization Unit Type -- this will replace the existing object with the specified object", "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "maxLength": 255 } } }, "examples": { "simple": { "value": { "description": "Description of OU Type1" } } } } } }, "responses": { "200": { "description": "Organization Unit Type was updated", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "201": { "description": "Organization Unit Type was created", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } }, "delete": { "operationId": "delete-org-ou-type", "summary": "OU Type", "tags": [ "Organization" ], "security": [ { "client_auth": [ "write:org" ] } ], "responses": { "200": { "description": "Organization Unit Type was removed", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/organizations": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-org-organizations", "summary": "Organization List", "parameters": [ { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } }, { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "security": [ { "client_auth": [ "read:org", "write:org" ] } ], "tags": [ "Organization" ], "responses": { "200": { "description": "List of Organizations with the \"Client\" Organization Type.", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of Organizations", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of Organizations" }, "value": { "type": "array", "description": "An array of Organizations. If there are no Organizations this will be an empty array.", "items": { "required": [ "organizationCode", "displayName" ], "properties": { "organizationCode": { "type": "string", "description": "A code uniquely identifying the Organization", "maxLength": 50 }, "displayName": { "type": "string", "maxLength": 255, "description": "Organization Name" }, "description": { "type": "string", "maxLength": 255, "description": "Description of Organization Display Name" } }, "type": "object" } } } }, "examples": { "simple": { "value": { "maxItems": 2, "value": [ { "organizationCode": "acc", "displayName": "Accounting", "description": "Accounting Organization" }, { "organizationCode": "fin", "displayName": "Finance", "description": "Finance Organization" } ] } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/organizations/{organizationCode}": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "organizationCode", "description": "A code uniquely identifying the Organization", "required": true, "schema": { "type": "string", "maxLength": 50 } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-org-organization", "summary": "Organization", "tags": [ "Organization" ], "security": [ { "client_auth": [ "read:org", "write:org" ] } ], "responses": { "200": { "description": "Get an Organization", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "displayName" ], "properties": { "displayName": { "type": "string", "maxLength": 255, "description": "Organization Name" }, "description": { "type": "string", "maxLength": 255, "description": "Description of Organization Display Name" } } }, "examples": { "simple": { "value": { "displayName": "Accounting", "description": "Accounting Organization" } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } }, "put": { "operationId": "put-org-organization", "summary": "Organization", "tags": [ "Organization" ], "security": [ { "client_auth": [ "write:org" ] } ], "requestBody": { "description": "Update or create an Organization -- this will replace the existing object with the specified object", "content": { "application/json": { "schema": { "type": "object", "required": [ "displayName" ], "properties": { "displayName": { "type": "string", "maxLength": 255, "description": "Organization Name" }, "description": { "type": "string", "maxLength": 255, "description": "Description of Organization Display Name" } } }, "examples": { "simple": { "value": { "displayName": "Accounting", "description": "Accounting Organization" } } } } } }, "responses": { "200": { "description": "Organization was updated", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "201": { "description": "Organization was created", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } }, "delete": { "operationId": "delete-org-organization", "summary": "Organization", "tags": [ "Organization" ], "security": [ { "client_auth": [ "write:org" ] } ], "responses": { "200": { "description": "Organization was removed", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/organizations/{organizationCode}/ous": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "organizationCode", "description": "A code uniquely identifying the Organization", "required": true, "schema": { "type": "string", "maxLength": 50 } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-org-ous", "summary": "OU List", "tags": [ "Organization" ], "security": [ { "client_auth": [ "read:org", "write:org" ] } ], "parameters": [ { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } }, { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "responses": { "200": { "description": "List of Organization Units", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer" }, "value": { "type": "array", "items": { "type": "object", "required": [ "ouCode" ], "properties": { "ouCode": { "type": "string", "maxLength": 50, "description": "The organization unit code." } } } } } }, "examples": { "simple": { "value": { "maxItems": 5, "value": [ { "ouCode": "ou1" }, { "ouCode": "ou2" }, { "ouCode": "ou3" }, { "ouCode": "ou4" }, { "ouCode": "ou5" } ] } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/organizations/{organizationCode}/ous/{ouCode}": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "organizationCode", "description": "A code uniquely identifying the Organization", "required": true, "schema": { "type": "string", "maxLength": 50 } }, { "in": "path", "name": "ouCode", "description": "A code uniquely identifying an OU", "required": true, "schema": { "type": "string", "maxLength": 50 } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-org-ou", "summary": "OU", "tags": [ "Organization" ], "security": [ { "client_auth": [ "read:org", "write:org" ] } ], "responses": { "200": { "description": "Get an Organization Unit", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "displayName", "ouTypeDisplayName" ], "properties": { "displayName": { "type": "string", "maxLength": 255 }, "description": { "type": "string", "maxLength": 255 }, "parentOuCode": { "type": "string", "maxLength": 50 }, "ouTypeDisplayName": { "type": "string", "maxLength": 255 }, "externalId": { "type": "string", "maxLength": 255, "description": "Used to store WorkDay specific identifiers" } } }, "examples": { "simple": { "value": { "displayName": "OU", "description": "Description of OU Display Name", "parentOuCode": "parentOU", "ouTypeDisplayName": "outype1", "externalId": "WRD-001" } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } }, "put": { "operationId": "put-org-ou", "summary": "OU", "tags": [ "Organization" ], "security": [ { "client_auth": [ "write:org" ] } ], "requestBody": { "description": "Update or create an Organization Unit -- this will replace the existing object with the specified object", "content": { "application/json": { "schema": { "type": "object", "required": [ "displayName", "ouTypeDisplayName" ], "properties": { "displayName": { "type": "string", "maxLength": 255 }, "description": { "type": "string", "maxLength": 255 }, "parentOuCode": { "type": "string", "maxLength": 50 }, "ouTypeDisplayName": { "type": "string", "maxLength": 255 }, "externalId": { "type": "string", "maxLength": 255, "description": "Used to store WorkDay specific identifiers" } } }, "examples": { "simple": { "value": { "displayName": "OU", "description": "Description of OU Display Name", "parentOuCode": "parentOU", "ouTypeDisplayName": "outype1", "externalId": "WRD-001" } } } } } }, "responses": { "200": { "description": "Organization Unit was updated", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "201": { "description": "Organization Unit was created", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } }, "delete": { "operationId": "delete-org-ou", "summary": "OU", "tags": [ "Organization" ], "security": [ { "client_auth": [ "write:org" ] } ], "responses": { "200": { "description": "Organization Unit was removed", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/organizations/{organizationCode}/ous/{ouCode}/cost-centers": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "organizationCode", "description": "A code uniquely identifying the Organization", "required": true, "schema": { "type": "string", "maxLength": 50 } }, { "in": "path", "name": "ouCode", "description": "A code uniquely identifying an OU", "required": true, "schema": { "type": "string", "maxLength": 50 } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-cost-centers", "summary": "Cost Center List", "description": "Gets a list of cost centers\n", "tags": [ "Organization" ], "security": [ { "client_auth": [ "read:org", "write:org" ] } ], "parameters": [ { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "responses": { "200": { "description": "List of Cost Centers", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of Cost Centers", "properties": { "maxItems": { "type": "integer", "description": "The total number of Cost Centers" }, "value": { "type": "array", "description": "An array of Cost Centers. If there are no Cost Centers this will be an empty array.", "items": { "properties": { "costCenterNumber": { "type": "string", "description": "A code uniquely identifying the Cost Center", "maxLength": 100 } }, "type": "object" } } } }, "examples": { "simple": { "value": { "maxItems": 5, "value": [ { "costCenterNumber": "abcd", "displayName": "Main Cost Center", "description": "Main Cost Center for abcd", "billable": true, "externalId": "external-system-identifier" }, { "costCenterNumber": "efgh", "displayName": "Cost Center 2", "description": "Cost Center 2 for efgh" }, { "costCenterNumber": "ijkl", "displayName": "Cost Center 3", "description": "Cost Center 3 for ijkl", "billable": false }, { "costCenterNumber": "mnop", "displayName": "Cost Center 4", "description": "Cost Center 5 for mnop", "billable": true }, { "costCenterNumber": "qrst", "displayName": "Cost Center 5", "description": "Cost Center 5 for qrst", "billable": true } ] } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/cost-centers": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "query", "name": "costCenterNumber", "description": "A number identifying the cost center", "required": true, "schema": { "type": "string", "maxLength": 100 } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-cost-centers-by-number", "summary": "Cost Center List by Number", "description": "Retrieve a list of your active cost centers\n", "tags": [ "Organization" ], "security": [ { "client_auth": [ "read:org", "write:org" ] } ], "responses": { "200": { "description": "List of Cost Centers", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of detailed cost centers", "properties": { "maxItems": { "type": "integer", "description": "The total number of detailed cost centers" }, "value": { "type": "array", "description": "An array of detailed cost centers. If there are no cost centers this will be an empty array.", "items": { "type": "object", "description": "A detailed cost center", "required": [ "costCenterId", "costCenterNumber", "organizationCode", "ouCode", "billable" ], "properties": { "costCenterId": { "type": "string", "format": "uuid", "description": "The id of the cost center" }, "costCenterNumber": { "type": "string", "description": "The number of the cost center", "maxLength": 100 }, "displayName": { "type": "string", "description": "The name of the cost center", "maxLength": 255 }, "description": { "type": "string", "description": "A description of the cost center", "maxLength": 255 }, "organizationCode": { "type": "string", "description": "The code of the organization for this cost center", "maxLength": 50 }, "ouCode": { "type": "string", "description": "The code of the organization unit for this cost center", "maxLength": 50 }, "billable": { "type": "boolean", "description": "Billable flag of this cost center" }, "externalId": { "type": "string", "description": "The external ID of the cost center", "maxLength": 255 } } } } } }, "examples": { "simple": { "value": { "maxItems": 2, "value": [ { "costCenterId": "12576b49-e5d8-48ef-9ec8-9e7c6d13ec56", "costCenterNumber": "abcd", "displayName": "Main Cost Center", "description": "Main Cost Center for abcd", "organizationCode": "acc", "ouCode": "ou1", "billable": true, "externalId": "external-system-identifier" }, { "costCenterId": "40bfc100-83fa-4aee-9006-b51b47869f5a", "costCenterNumber": "qrst", "displayName": "Cost Center 5", "description": "Cost Center 5 for qrst", "organizationCode": "acc", "ouCode": "ou1", "billable": true } ] } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/organizations/{organizationCode}/ous/{ouCode}/cost-centers/{costCenterNumber}": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "organizationCode", "description": "A code uniquely identifying the Organization", "required": true, "schema": { "type": "string", "maxLength": 50 } }, { "in": "path", "name": "ouCode", "description": "A code uniquely identifying an OU", "required": true, "schema": { "type": "string", "maxLength": 50 } }, { "in": "path", "name": "costCenterNumber", "description": "A code uniquely identifying the cost center", "required": true, "schema": { "type": "string", "maxLength": 100 } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-org-cost-center", "summary": "Cost Center", "description": "Get the details of an individual cost center\n", "tags": [ "Organization" ], "security": [ { "client_auth": [ "read:org", "write:org" ] } ], "responses": { "200": { "description": "Get a Cost Center", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "displayName": { "type": "string", "description": "The Name of the Cost Center", "maxLength": 255 }, "description": { "type": "string", "description": "A description of the Cost Center", "maxLength": 255 }, "billable": { "type": "boolean", "description": "A flag indicating whether the Cost Center is billable. If no value is supplied, then this will default to \"false\"." }, "externalId": { "type": "string", "description": "A unique identifier a client can provide that can be managed externally from Beeline's VMS.", "maxLength": 255 } } }, "examples": { "simple": { "value": { "displayName": "Main Cost Center", "description": "Main Cost Center for abcd", "billable": true, "externalId": "external-system-identifier" } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } }, "put": { "operationId": "put-org-cost-center", "summary": "Cost Center", "tags": [ "Organization" ], "security": [ { "client_auth": [ "write:org" ] } ], "requestBody": { "description": "Update or create a Cost Center -- this will replace the existing object with the specified object", "content": { "application/json": { "schema": { "type": "object", "properties": { "displayName": { "type": "string", "description": "The Name of the Cost Center", "maxLength": 255 }, "description": { "type": "string", "description": "A description of the Cost Center", "maxLength": 255 }, "billable": { "type": "boolean", "description": "A flag indicating whether the Cost Center is billable. If no value is supplied, then this will default to \"false\"." }, "externalId": { "type": "string", "description": "A unique identifier a client can provide that can be managed externally from Beeline's VMS.", "maxLength": 255 } } }, "examples": { "simple": { "value": { "displayName": "Main Cost Center", "description": "Main Cost Center for abcd", "billable": true, "externalId": "external-system-identifier" } } } } } }, "responses": { "200": { "description": "Cost Center was updated", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "201": { "description": "Cost Center was created", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } }, "delete": { "operationId": "delete-org-cost-center", "summary": "Cost Center", "tags": [ "Organization" ], "security": [ { "client_auth": [ "write:org" ] } ], "responses": { "200": { "description": "Cost Center was removed", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/organizations/{organizationCode}/ous/{ouCode}/{domainType}/users/add": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "organizationCode", "description": "A code uniquely identifying the Organization", "required": true, "schema": { "type": "string", "maxLength": 50 } }, { "in": "path", "name": "ouCode", "description": "A code uniquely identifying an OU", "required": true, "schema": { "type": "string", "maxLength": 50 } }, { "in": "path", "name": "domainType", "description": "An unique identifier for ou domain type", "required": true, "schema": { "type": "string", "enum": [ "owner", "assistant", "controller", "mspRepresentative" ] } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "post": { "operationId": "post-org-add-user-ou", "summary": "Add User to OU Domain Type", "tags": [ "Organization" ], "security": [ { "client_auth": [ "write:org" ] } ], "requestBody": { "description": "Add user(s) to OU Domain Type", "content": { "application/json": { "schema": { "type": "object", "description": "A list of users to role", "required": [ "value" ], "properties": { "value": { "type": "array", "description": "An array of userIds. Must provide at least one userId.", "items": { "type": "string", "format": "uuid" } } } }, "examples": { "multiple": { "summary": "List of userIds", "value": [ "d9d2a502-eb16-43a3-a9b7-40880b27c6f1", "0fef347c-6415-4c7d-b120-1d29163bab05", "ca7adf26-c9d5-4966-bf8a-997eb307f3c0" ] }, "single": { "summary": "Single userId", "value": [ "98500cf5-40bb-4209-bf44-fb76e52f55eb" ] } } } } }, "responses": { "200": { "description": "Add user(s) to OU Domain Type as defined in the VMS instance", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/organizations/{organizationCode}/ous/{ouCode}/{domainType}/users/remove": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "organizationCode", "description": "A code uniquely identifying the Organization", "required": true, "schema": { "type": "string", "maxLength": 50 } }, { "in": "path", "name": "ouCode", "description": "A code uniquely identifying an OU", "required": true, "schema": { "type": "string", "maxLength": 50 } }, { "in": "path", "name": "domainType", "description": "An unique identifier for ou domain type", "required": true, "schema": { "type": "string", "enum": [ "owner", "assistant", "controller", "mspRepresentative" ] } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "post": { "operationId": "post-org-remove-user-ou", "summary": "Remove User from OU Domain Type", "tags": [ "Organization" ], "security": [ { "client_auth": [ "write:org" ] } ], "requestBody": { "description": "Remove user(s) from OU Domain Type", "content": { "application/json": { "schema": { "type": "object", "description": "A list of users to role", "required": [ "value" ], "properties": { "value": { "type": "array", "description": "An array of userIds. Must provide at least one userId.", "items": { "type": "string", "format": "uuid" } } } }, "examples": { "multiple": { "summary": "List of userIds", "value": [ "d9d2a502-eb16-43a3-a9b7-40880b27c6f1", "0fef347c-6415-4c7d-b120-1d29163bab05", "ca7adf26-c9d5-4966-bf8a-997eb307f3c0" ] }, "single": { "summary": "Single userId", "value": [ "98500cf5-40bb-4209-bf44-fb76e52f55eb" ] } } } } }, "responses": { "200": { "description": "Domain Type removed from user(s) as defined in the VMS instance", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/users/{userId}/ous": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "userId", "description": "An identifier uniquely identifying the user", "required": true, "example": "d63ff17f-95dd-44ff-b1df-b64fe705c9c9", "schema": { "type": "string", "format": "uuid" } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-org-ou-domain-type-by-user", "summary": "OU and Domain Type List by UserId", "tags": [ "Organization" ], "security": [ { "client_auth": [ "read:org", "write:org" ] } ], "parameters": [ { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "responses": { "200": { "description": "List of OU user types assigned to user as defined in the VMS instance", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of ou domain types for a user", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of ou domain types" }, "value": { "type": "array", "description": "An array of client ou domain types. If there are no ou domain types this will be an empty array.", "items": { "required": [ "ouCode", "domainType" ], "properties": { "ouCode": { "type": "string", "description": "Organizational Unit unique identifier", "maxLength": 50 }, "domainType": { "type": "string", "description": "Domain type a user can be assigned (owner, assistant, controller, mspRepresentative)" } } } } } }, "examples": { "simple": { "value": { "maxItems": 3, "value": [ { "ouCode": "ou1", "domainType": "owner" }, { "ouCode": "ou2", "domainType": "owner" }, { "ouCode": "ou3", "domainType": "controller" } ] } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/organizations/{organizationCode}/ous/{ouCode}/users": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "organizationCode", "description": "A code uniquely identifying the Organization", "required": true, "schema": { "type": "string", "maxLength": 50 } }, { "in": "path", "name": "ouCode", "description": "A code uniquely identifying an OU", "required": true, "schema": { "type": "string", "maxLength": 50 } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-org-ou-users-list", "summary": "UserID and Domain Type List by OU", "tags": [ "Organization" ], "security": [ { "client_auth": [ "read:org", "write:org" ] } ], "parameters": [ { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "responses": { "200": { "description": "List of OU domain types assigned to an OU as defined in the VMS instance", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of ou users", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of ou users" }, "value": { "type": "array", "description": "An array of ou users. If there are no ou users this will be an empty array.", "items": { "type": "object", "required": [ "userId", "domainType" ], "properties": { "userId": { "type": "string", "description": "An identifier uniquely identifying the user", "example": "d63ff17f-95dd-44ff-b1df-b64fe705c9c9", "format": "uuid" }, "domainType": { "type": "string", "description": "Domain type a user can be assigned (owner, assistant, controller, msp-representative)" } } } } } }, "examples": { "simple": { "value": { "maxItems": 3, "value": [ { "userId": "07164c59-2a8d-4034-8283-6440c24e58ff", "domainType": "owner" }, { "userId": "b6024aa6-84cf-45eb-a3e9-7c7e86a66b58", "domainType": "controller" }, { "userId": "486d2399-52d3-4757-b523-ed6e0529c867", "domainType": "mspRepresentative" } ] } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/organizations/{organizationCode}/ous/{ouCode}/cost-centers/{costCenterNumber}/users": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "organizationCode", "description": "A code uniquely identifying the Organization", "required": true, "schema": { "type": "string", "maxLength": 50 } }, { "in": "path", "name": "ouCode", "description": "A code uniquely identifying an OU", "required": true, "schema": { "type": "string", "maxLength": 50 } }, { "in": "path", "name": "costCenterNumber", "description": "A code uniquely identifying the cost center", "required": true, "schema": { "type": "string", "maxLength": 100 } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-org-cc-users", "summary": "CC Domain Users", "tags": [ "Organization" ], "security": [ { "client_auth": [ "read:org", "write:org" ] } ], "responses": { "200": { "description": "List of cost center domain users by specific column domain type as defined in the VMS instance", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ownerUserId": { "type": [ "string", "null" ], "description": "An identifier uniquely identifying the user", "example": "ce6fd7c5-61c9-4f05-969b-5266a2a884a8", "format": "uuid" }, "assistantUserId": { "type": [ "string", "null" ], "description": "An identifier uniquely identifying the user", "example": "281ba412-9193-4a53-a87a-a445abe7d2ca", "format": "uuid" }, "controllerUserId": { "type": [ "string", "null" ], "description": "An identifier uniquely identifying the user", "example": "150efd42-611f-4e61-acbe-44614631fee5", "format": "uuid" } } }, "examples": { "simple": { "summary": "Complete example", "value": { "ownerUserId": "0ce6fd7c5-61c9-4f05-969b-5266a2a884a8", "assistantUserId": "281ba412-9193-4a53-a87a-a445abe7d2ca", "controllerUserId": "150efd42-611f-4e61-acbe-44614631fee5" } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } }, "put": { "operationId": "put-org-cc-user", "summary": "CC Domain Users", "tags": [ "Organization" ], "security": [ { "client_auth": [ "write:org" ] } ], "requestBody": { "description": "Update a cost center domain user by specific column domain type\n- To remove a domain user send an empty tag.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "ownerUserId": { "type": [ "string", "null" ], "description": "An identifier uniquely identifying the user", "example": "ce6fd7c5-61c9-4f05-969b-5266a2a884a8", "format": "uuid" }, "assistantUserId": { "type": [ "string", "null" ], "description": "An identifier uniquely identifying the user", "example": "281ba412-9193-4a53-a87a-a445abe7d2ca", "format": "uuid" }, "controllerUserId": { "type": [ "string", "null" ], "description": "An identifier uniquely identifying the user", "example": "150efd42-611f-4e61-acbe-44614631fee5", "format": "uuid" } } }, "examples": { "partial": { "summary": "Partial example", "value": { "ownerUserId": null, "assistantUserId": "281ba412-9193-4a53-a87a-a445abe7d2ca", "controllerUserId": null } }, "full": { "summary": "Complete example", "value": { "ownerUserId": "0ce6fd7c5-61c9-4f05-969b-5266a2a884a8", "assistantUserId": "281ba412-9193-4a53-a87a-a445abe7d2ca", "controllerUserId": "150efd42-611f-4e61-acbe-44614631fee5" } } } } } }, "responses": { "200": { "description": "Cost center domain users was updated", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/business-areas": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-business-areas", "summary": "Business Area List", "tags": [ "Business Area" ], "security": [ { "client_auth": [ "read:business_area", "write:business_area" ] } ], "parameters": [ { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } } ], "responses": { "200": { "description": "List of Business Areas defined in the VMS instance", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of business areas", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of business areas" }, "value": { "type": "array", "description": "An array of business areas. If there are no business areas this will be an empty array.", "items": { "type": "object", "description": "An area of business, category of business within a client organization which is used for grouping Functional Partitions.", "required": [ "businessAreaCode", "displayName" ], "properties": { "businessAreaCode": { "type": "string", "description": "A code uniquely identifying the business area", "maxLength": 255 }, "displayName": { "type": "string", "description": "The name of the business area", "maxLength": 255 }, "description": { "type": "string", "description": "A description of the business area", "maxLength": 255 } } } } } }, "examples": { "simple": { "value": { "maxItems": 2, "value": [ { "businessAreaCode": "ADM", "displayName": "Administration", "description": "Administration Business Unit" }, { "businessAreaCode": "IT", "displayName": "Information Technology", "description": "Information Technology and Services Business Unit" } ] } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/business-areas/{businessAreaCode}": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "businessAreaCode", "description": "An unique identifier for a business area", "required": true, "schema": { "type": "string", "maxLength": 255 } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-business-area", "summary": "Business Area", "tags": [ "Business Area" ], "security": [ { "client_auth": [ "read:business_area", "write:business_area" ] } ], "responses": { "200": { "description": "Get a business area", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "An area of business, category of business within a client organization which is used for grouping Functional Partitions.", "required": [ "displayName" ], "properties": { "displayName": { "type": "string", "description": "The name of the business area", "maxLength": 255 }, "description": { "type": "string", "description": "A description of the business area", "maxLength": 255 } } }, "examples": { "simple": { "value": { "displayName": "Administration", "description": "Administration Business Unit" } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } }, "put": { "operationId": "put-business-area", "summary": "Business Area", "tags": [ "Business Area" ], "security": [ { "client_auth": [ "write:business_area" ] } ], "requestBody": { "description": "Update or create a business area -- this will replace the existing object with the specified object", "content": { "application/json": { "schema": { "type": "object", "description": "An area of business, category of business within a client organization which is used for grouping Functional Partitions.", "required": [ "displayName" ], "properties": { "displayName": { "type": "string", "description": "The name of the business area", "maxLength": 255 }, "description": { "type": "string", "description": "A description of the business area", "maxLength": 255 } } }, "examples": { "simple": { "value": { "displayName": "Administration", "description": "Administration Business Unit" } } } } } }, "responses": { "200": { "description": "Business Area was updated", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "201": { "description": "Business Area was created", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } }, "delete": { "operationId": "delete-business-area", "summary": "Business Area", "tags": [ "Business Area" ], "security": [ { "client_auth": [ "write:business_area" ] } ], "responses": { "200": { "description": "Business Area was removed", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/business-areas/{businessAreaCode}/functional-partitions": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "businessAreaCode", "description": "An unique identifier for a business area", "required": true, "schema": { "type": "string", "maxLength": 255 } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-functional-partitions", "summary": "Functional Partition List", "tags": [ "Business Area" ], "security": [ { "client_auth": [ "read:business_area", "write:business_area" ] } ], "parameters": [ { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } } ], "responses": { "200": { "description": "List of Functional Partitions for a specified Business Area defined in the VMS instance", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of functional partitions", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of functional partitions" }, "value": { "type": "array", "description": "An array of functional partitions. If there are no functional partitions this will be an empty array.", "items": { "type": "object", "description": "A sub-organization, sub-component, sub-function, or business partition within a client organization which are associated to one Business Area.", "required": [ "displayName", "functionalPartitionCode" ], "properties": { "functionalPartitionCode": { "type": "string", "description": "A code uniquely identifying the functional partition", "maxLength": 255 }, "displayName": { "type": "string", "description": "The name of the functional partition", "maxLength": 255 }, "description": { "type": "string", "description": "A description of the functional partition", "maxLength": 255 } } } } } }, "examples": { "simple": { "value": { "maxItems": 2, "value": [ { "functionalPartitionCode": "AC", "displayName": "Audit and Compliance", "description": "Audit and Compliance Segment" }, { "functionalPartitionCode": "ISC", "displayName": "InfoSec", "description": "Information Security and Compliance Segment" } ] } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/business-areas/{businessAreaCode}/functional-partitions/{functionalPartitionCode}": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "businessAreaCode", "description": "An unique identifier for a business area", "required": true, "schema": { "type": "string", "maxLength": 255 } }, { "in": "path", "name": "functionalPartitionCode", "description": "An unique identifier for a functional partition", "required": true, "schema": { "type": "string", "maxLength": 255 } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-functional-partition", "summary": "Functional Partition", "tags": [ "Business Area" ], "security": [ { "client_auth": [ "read:business_area", "write:business_area" ] } ], "responses": { "200": { "description": "Get a functional partition within a specific business area", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A sub-organization, sub-component, sub-function, or business partition within a client organization which are associated to one Business Area.", "required": [ "displayName" ], "properties": { "displayName": { "type": "string", "description": "The name of the functional partition", "maxLength": 255 }, "description": { "type": "string", "description": "A description of the functional partition", "maxLength": 255 } } }, "examples": { "simple": { "value": { "displayName": "Audit and Compliance", "description": "Audit and Compliance Segment" } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } }, "put": { "operationId": "put-functional-partition", "summary": "Functional Partition", "tags": [ "Business Area" ], "security": [ { "client_auth": [ "write:business_area" ] } ], "requestBody": { "description": "Update or create a functional partition within a specific business area -- this will replace the existing object with the specified object", "content": { "application/json": { "schema": { "type": "object", "description": "A sub-organization, sub-component, sub-function, or business partition within a client organization which are associated to one Business Area.", "required": [ "displayName" ], "properties": { "displayName": { "type": "string", "description": "The name of the functional partition", "maxLength": 255 }, "description": { "type": "string", "description": "A description of the functional partition", "maxLength": 255 } } }, "examples": { "simple": { "value": { "displayName": "Audit and Compliance", "description": "Audit and Compliance Segment" } } } } } }, "responses": { "200": { "description": "Functional Partition was updated", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "201": { "description": "Functional Partition was created", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } }, "delete": { "operationId": "delete-functional-partition", "summary": "Functional Partition", "tags": [ "Business Area" ], "security": [ { "client_auth": [ "write:business_area" ] } ], "responses": { "200": { "description": "Functional Partition was removed", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/language-codes": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-language-codes", "summary": "Language Code List", "description": "Provides list of language code(s) available", "security": [ { "client_auth": [ "read:user" ] } ], "tags": [ "User" ], "parameters": [ { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } } ], "responses": { "200": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "List of Language Codes defined in the VMS instance", "content": { "application/json": { "schema": { "type": "object", "description": "A list of language codes", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of language codes" }, "value": { "type": "array", "description": "An array of language codes. If there are no language codes this will be an empty array.", "items": { "required": [ "languageCode" ], "type": "object", "description": "Retrieve a list of Culture Name (Language Codes)", "properties": { "languageCode": { "type": "string", "description": "A uniquely identifying language code, like en-US", "maxLength": 50 } } } } } }, "examples": { "simple": { "value": { "maxItems": 2, "value": [ { "languageCode": "en-GB" }, { "languageCode": "en-US" } ] } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/users": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-users-list", "summary": "User List", "description": "Provides list of users within VMS", "security": [ { "client_auth": [ "read:user" ] } ], "tags": [ "User" ], "parameters": [ { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } } ], "responses": { "200": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "List of Users by organization defined in the VMS instance", "content": { "application/json": { "schema": { "type": "object", "description": "A list of users", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of users" }, "value": { "type": "array", "description": "An array of users. If there are no users this will be an empty array.", "items": { "type": "object", "description": "A user", "required": [ "userId", "userName", "firstName", "lastName", "organizationCode", "ouCode", "costCenterNumber", "languageCode", "locationCode" ], "properties": { "userId": { "type": "string", "format": "uuid", "description": "Uniquely identifies a user" }, "userName": { "type": "string", "description": "The unique user name of the user", "maxLength": 50 }, "firstName": { "type": "string", "description": "First name of the user", "maxLength": 100 }, "middleName": { "type": "string", "description": "Middle name of the user", "maxLength": 100 }, "lastName": { "type": "string", "description": "Last name of the user", "maxLength": 100 }, "localizedFirstName": { "type": "string", "description": "Localized first name of the user in local culture and language", "maxLength": 100 }, "localizedMiddleName": { "type": "string", "description": "Localized middle name of the user in local culture and language", "maxLength": 100 }, "localizedLastName": { "type": "string", "description": "Localized last name of the user in local culture and language", "maxLength": 100 }, "secondaryLastName": { "type": "string", "description": "Secondary last name of the user", "maxLength": 100 }, "email": { "type": "string", "description": "The work email address of the user", "maxLength": 255 }, "title": { "type": "string", "description": "The assigned title of the user", "maxLength": 255 }, "managerUserName": { "type": "string", "description": "The reporting manager of the user", "maxLength": 50 }, "organizationCode": { "type": "string", "description": "The parent organization to which the user belongs", "maxLength": 50 }, "ouCode": { "type": "string", "description": "The organizational unit within organization to which the user belongs", "maxLength": 50 }, "costCenterNumber": { "type": "string", "description": "The default bill to cost center for the user", "maxLength": 100 }, "locationCode": { "type": "string", "description": "A code uniquely identifying the location", "maxLength": 255 }, "languageCode": { "type": "string", "description": "A uniquely identifying language code, like en-US", "maxLength": 20 } } } } } }, "examples": { "simple": { "value": { "maxItems": 2, "value": [ { "userId": "a53cdeee-fa3a-44af-be6b-7f5b37816982", "userName": "X987123", "firstName": "Molly", "middleName": "Beverly", "lastName": "Howe", "localizedFirstName": "Polly", "localizedMiddleName": "Bev", "localizedLastName": "Red", "secondaryLastName": "van Zijl", "email": "pred@domain.com", "title": "VP of Procurement", "managerUserName": "32109121116", "organizationCode": "Company A", "ouCode": "Division B", "costCenterNumber": "9097", "locationCode": "Alameda", "languageCode": "en-GB" }, { "userId": "53ceeefa-cb73-464d-ba62-90954fb14e58", "userName": "X2771321", "firstName": "Patrick", "middleName": "Stanley", "lastName": "Roy", "localizedFirstName": "Pat", "localizedMiddleName": "Stan", "localizedLastName": "Wha", "secondaryLastName": "van der Meer", "email": "proy@domain.com", "title": "VP of Automation Services", "managerUserName": "32109121116", "organizationalCode": "Company Z", "ouCode": "Division A", "costCenterNumber": "7173", "locationCode": "Houston", "languageCode": "en-US" } ] } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } }, "post": { "operationId": "post-users", "summary": "User Create", "description": "Add a new user to the VMS", "security": [ { "client_auth": [ "write:user" ] } ], "tags": [ "User" ], "requestBody": { "description": "Adds a new user in the VMS\n - This will create the initial specified object only\n - This will NOT update a user\n - To update an existing user requires calling the PUT User Update API\n - For returning user who may have left the organization and returned need to use PUT User Update API\n", "content": { "application/json": { "schema": { "type": "object", "description": "A user", "required": [ "userName", "firstName", "lastName", "organizationCode", "ouCode", "costCenterNumber", "languageCode", "locationCode" ], "properties": { "userName": { "type": "string", "description": "The unique user name of the user", "maxLength": 50 }, "firstName": { "type": "string", "description": "First name of the user", "maxLength": 100 }, "middleName": { "type": "string", "description": "Middle name of the user", "maxLength": 100 }, "lastName": { "type": "string", "description": "Last name of the user", "maxLength": 100 }, "localizedFirstName": { "type": "string", "description": "Localized first name of the user in local culture and language", "maxLength": 100 }, "localizedMiddleName": { "type": "string", "description": "Localized middle name of the user in local culture and language", "maxLength": 100 }, "localizedLastName": { "type": "string", "description": "Localized last name of the user in local culture and language", "maxLength": 100 }, "secondaryLastName": { "type": "string", "description": "Secondary last name of the user", "maxLength": 100 }, "email": { "type": "string", "description": "The work email address of the user", "maxLength": 255 }, "title": { "type": "string", "description": "The assigned title of the user", "maxLength": 255 }, "managerUserName": { "type": "string", "description": "The reporting manager of the user", "maxLength": 50 }, "organizationCode": { "type": "string", "description": "The parent organization to which the user belongs", "maxLength": 50 }, "ouCode": { "type": "string", "description": "The organizational unit within organization to which the user belongs", "maxLength": 50 }, "costCenterNumber": { "type": "string", "description": "The default bill to cost center for the user", "maxLength": 100 }, "locationCode": { "type": "string", "description": "A code uniquely identifying the location", "maxLength": 255 }, "languageCode": { "type": "string", "description": "A uniquely identifying language code, like en-US", "maxLength": 20 } } }, "examples": { "simple": { "value": { "userName": "X987123", "firstName": "Molly", "middleName": "Beverly", "lastName": "Howe", "localizedFirstName": "Polly", "localizedMiddleName": "Bev", "localizedLastName": "Red", "secondaryLastName": "van Zijl", "email": "pred@domain.com", "title": "VP of Procurement", "managerUserName": "32109121116", "organizationCode": "Company A", "ouCode": "Division B", "costCenterNumber": "9097", "locationCode": "Alameda", "languageCode": "en-GB" } } } } } }, "responses": { "201": { "description": "New user has been created", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } }, "Location": { "schema": { "type": "string", "format": "url" }, "example": "https://client.beeline.com/api/sites/b893aeca-889c-4bf6-99a4-79527b4a830e/users/3ccfff94-e20c-444b-b6b4-dc194c2acd08" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "format": "uuid" } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "409": { "description": "Conflict", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/users/{userName}": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "userName", "description": "An identifier uniquely identifying the user", "required": true, "schema": { "type": "string", "maxLength": 50 } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-user-by-userName", "summary": "User by User Name", "description": "Retrieve user information by the user's user name", "security": [ { "client_auth": [ "read:user" ] } ], "tags": [ "User" ], "responses": { "200": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "Get a Client User by User Name", "content": { "application/json": { "schema": { "type": "object", "description": "A user", "required": [ "userId", "userName", "firstName", "lastName", "organizationCode", "ouCode", "costCenterNumber", "languageCode", "locationCode" ], "properties": { "userId": { "type": "string", "format": "uuid", "description": "Uniquely identifies a user" }, "userName": { "type": "string", "description": "The unique user name of the user", "maxLength": 50 }, "firstName": { "type": "string", "description": "First name of the user", "maxLength": 100 }, "middleName": { "type": "string", "description": "Middle name of the user", "maxLength": 100 }, "lastName": { "type": "string", "description": "Last name of the user", "maxLength": 100 }, "localizedFirstName": { "type": "string", "description": "Localized first name of the user in local culture and language", "maxLength": 100 }, "localizedMiddleName": { "type": "string", "description": "Localized middle name of the user in local culture and language", "maxLength": 100 }, "localizedLastName": { "type": "string", "description": "Localized last name of the user in local culture and language", "maxLength": 100 }, "secondaryLastName": { "type": "string", "description": "Secondary last name of the user", "maxLength": 100 }, "email": { "type": "string", "description": "The work email address of the user", "maxLength": 255 }, "title": { "type": "string", "description": "The assigned title of the user", "maxLength": 255 }, "managerUserName": { "type": "string", "description": "The reporting manager of the user", "maxLength": 50 }, "organizationCode": { "type": "string", "description": "The parent organization to which the user belongs", "maxLength": 50 }, "ouCode": { "type": "string", "description": "The organizational unit within organization to which the user belongs", "maxLength": 50 }, "costCenterNumber": { "type": "string", "description": "The default bill to cost center for the user", "maxLength": 100 }, "locationCode": { "type": "string", "description": "A code uniquely identifying the location", "maxLength": 255 }, "languageCode": { "type": "string", "description": "A uniquely identifying language code, like en-US", "maxLength": 20 } } }, "examples": { "simple": { "value": { "userId": "a53cdeee-fa3a-44af-be6b-7f5b37816982", "userName": "X987123", "firstName": "Molly", "middleName": "Beverly", "lastName": "Howe", "localizedFirstName": "Polly", "localizedMiddleName": "Bev", "localizedLastName": "Red", "secondaryLastName": "van Zijl", "email": "pred@domain.com", "title": "VP of Procurement", "managerUserName": "32109121116", "organizationCode": "Company A", "ouCode": "Division B", "costCenterNumber": "9097", "locationCode": "Alameda", "languageCode": "en-GB" } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/users/{userId}": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "userId", "description": "An identifier uniquely identifying the user", "required": true, "example": "d63ff17f-95dd-44ff-b1df-b64fe705c9c9", "schema": { "type": "string", "format": "uuid" } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-user", "summary": "User by UserID", "description": "Retrieve user information by the user's userId", "security": [ { "client_auth": [ "read:user" ] } ], "tags": [ "User" ], "responses": { "200": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "Get a Client User by UserID", "content": { "application/json": { "schema": { "type": "object", "description": "A user", "required": [ "userId", "userName", "firstName", "lastName", "organizationCode", "ouCode", "costCenterNumber", "languageCode", "locationCode" ], "properties": { "userId": { "type": "string", "format": "uuid", "description": "Uniquely identifies a user" }, "userName": { "type": "string", "description": "The unique user name of the user", "maxLength": 50 }, "firstName": { "type": "string", "description": "First name of the user", "maxLength": 100 }, "middleName": { "type": "string", "description": "Middle name of the user", "maxLength": 100 }, "lastName": { "type": "string", "description": "Last name of the user", "maxLength": 100 }, "localizedFirstName": { "type": "string", "description": "Localized first name of the user in local culture and language", "maxLength": 100 }, "localizedMiddleName": { "type": "string", "description": "Localized middle name of the user in local culture and language", "maxLength": 100 }, "localizedLastName": { "type": "string", "description": "Localized last name of the user in local culture and language", "maxLength": 100 }, "secondaryLastName": { "type": "string", "description": "Secondary last name of the user", "maxLength": 100 }, "email": { "type": "string", "description": "The work email address of the user", "maxLength": 255 }, "title": { "type": "string", "description": "The assigned title of the user", "maxLength": 255 }, "managerUserName": { "type": "string", "description": "The reporting manager of the user", "maxLength": 50 }, "organizationCode": { "type": "string", "description": "The parent organization to which the user belongs", "maxLength": 50 }, "ouCode": { "type": "string", "description": "The organizational unit within organization to which the user belongs", "maxLength": 50 }, "costCenterNumber": { "type": "string", "description": "The default bill to cost center for the user", "maxLength": 100 }, "locationCode": { "type": "string", "description": "A code uniquely identifying the location", "maxLength": 255 }, "languageCode": { "type": "string", "description": "A uniquely identifying language code, like en-US", "maxLength": 20 } } }, "examples": { "simple": { "value": { "userId": "a53cdeee-fa3a-44af-be6b-7f5b37816982", "userName": "X987123", "firstName": "Molly", "middleName": "Beverly", "lastName": "Howe", "localizedFirstName": "Polly", "localizedMiddleName": "Bev", "localizedLastName": "Red", "secondaryLastName": "van Zijl", "email": "pred@domain.com", "title": "VP of Procurement", "managerUserName": "32109121116", "organizationCode": "Company A", "ouCode": "Division B", "costCenterNumber": "9097", "locationCode": "Alameda", "languageCode": "en-GB" } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } }, "put": { "operationId": "update-user", "summary": "User Update", "security": [ { "client_auth": [ "write:user" ] } ], "tags": [ "User" ], "requestBody": { "description": "Update an existing user in the VMS\n- This will replace the existing object with the specified object (including User Name)\n- This will allow for returning user whom is inactive to be re-activated\n- This will NOT allow for user whom was erased with \"Right to Erasure\", to be re-activated; will need to use POST Create User\n", "content": { "application/json": { "schema": { "type": "object", "description": "A user", "required": [ "userName", "firstName", "lastName", "organizationCode", "ouCode", "costCenterNumber", "languageCode", "locationCode" ], "properties": { "userName": { "type": "string", "description": "The unique user name of the user", "maxLength": 50 }, "firstName": { "type": "string", "description": "First name of the user", "maxLength": 100 }, "middleName": { "type": "string", "description": "Middle name of the user", "maxLength": 100 }, "lastName": { "type": "string", "description": "Last name of the user", "maxLength": 100 }, "localizedFirstName": { "type": "string", "description": "Localized first name of the user in local culture and language", "maxLength": 100 }, "localizedMiddleName": { "type": "string", "description": "Localized middle name of the user in local culture and language", "maxLength": 100 }, "localizedLastName": { "type": "string", "description": "Localized last name of the user in local culture and language", "maxLength": 100 }, "secondaryLastName": { "type": "string", "description": "Secondary last name of the user", "maxLength": 100 }, "email": { "type": "string", "description": "The work email address of the user", "maxLength": 255 }, "title": { "type": "string", "description": "The assigned title of the user", "maxLength": 255 }, "managerUserName": { "type": "string", "description": "The reporting manager of the user", "maxLength": 50 }, "organizationCode": { "type": "string", "description": "The parent organization to which the user belongs", "maxLength": 50 }, "ouCode": { "type": "string", "description": "The organizational unit within organization to which the user belongs", "maxLength": 50 }, "costCenterNumber": { "type": "string", "description": "The default bill to cost center for the user", "maxLength": 100 }, "locationCode": { "type": "string", "description": "A code uniquely identifying the location", "maxLength": 255 }, "languageCode": { "type": "string", "description": "A uniquely identifying language code, like en-US", "maxLength": 20 } } }, "examples": { "simple": { "value": { "userName": "X987123", "firstName": "Molly", "middleName": "Beverly", "lastName": "Howe", "localizedFirstName": "Polly", "localizedMiddleName": "Bev", "localizedLastName": "Red", "secondaryLastName": "van Zijl", "email": "pred@domain.com", "title": "VP of Procurement", "managerUserName": "32109121116", "organizationCode": "Company A", "ouCode": "Division B", "costCenterNumber": "9097", "locationCode": "Alameda", "languageCode": "en-GB" } } } } } }, "responses": { "200": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "User was updated" }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "409": { "description": "Conflict", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } }, "delete": { "operationId": "delete-user", "summary": "User Delete", "description": "Delete user from VMS", "security": [ { "client_auth": [ "write:user" ] } ], "tags": [ "User" ], "responses": { "200": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "User was removed" }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/users/{userId}/phones": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "userId", "description": "An identifier uniquely identifying the user", "required": true, "example": "d63ff17f-95dd-44ff-b1df-b64fe705c9c9", "schema": { "type": "string", "format": "uuid" } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-user-phone-list", "summary": "User Phone List", "description": "Provides a list of phone numbers by user", "security": [ { "client_auth": [ "read:user" ] } ], "parameters": [ { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } } ], "tags": [ "User" ], "responses": { "200": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "List of phone numbers by user", "content": { "application/json": { "schema": { "type": "array", "description": "Retrieve a list of client user Phone Numbers by Phone Type", "items": { "type": "object", "description": "Retrieve a list of client user Phone Numbers by Phone Type", "required": [ "phoneType", "phoneNumber" ], "properties": { "phoneType": { "type": "string", "description": "Phone type for the phone number", "enum": [ "business", "fax", "home", "mobile" ], "maxLength": 10 }, "phoneNumber": { "type": "string", "description": "Phone number for phone type for a user", "example": "555-555-1212", "maxLength": 30 } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/users/{userId}/phones/{phoneType}": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "userId", "description": "An identifier uniquely identifying the user", "required": true, "example": "d63ff17f-95dd-44ff-b1df-b64fe705c9c9", "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "phoneType", "description": "An unique identifier for phone type", "required": true, "schema": { "type": "string", "enum": [ "business", "fax", "home", "mobile" ] } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-user-phone-by-phone-type", "summary": "User Phone by Type", "description": "Retrieves specific phone number by user and phone type", "tags": [ "User" ], "security": [ { "client_auth": [ "read:user" ] } ], "responses": { "200": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "Phone number by user and phone type", "content": { "application/json": { "schema": { "type": "object", "description": "Retrieve a list of client user Phone Numbers by Phone Type", "required": [ "phoneType", "phoneNumber" ], "properties": { "phoneType": { "type": "string", "description": "Phone type for the phone number", "enum": [ "business", "fax", "home", "mobile" ], "maxLength": 10 }, "phoneNumber": { "type": "string", "description": "Phone number for phone type for a user", "example": "555-555-1212", "maxLength": 30 } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } }, "put": { "operationId": "put-user-phone", "summary": "User Phone by Type", "description": "Adds or updates user phone by phone type", "security": [ { "client_auth": [ "write:user" ] } ], "tags": [ "User" ], "requestBody": { "description": "Adds or updates user phone by phone type", "content": { "application/json": { "schema": { "type": "object", "description": "Retrieve a list of client user Phone Numbers by Phone Type", "required": [ "phoneType", "phoneNumber" ], "properties": { "phoneType": { "type": "string", "description": "Phone type for the phone number", "enum": [ "business", "fax", "home", "mobile" ], "maxLength": 10 }, "phoneNumber": { "type": "string", "description": "Phone number for phone type for a user", "example": "555-555-1212", "maxLength": 30 } } } } } }, "responses": { "200": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "User phone is added or updated" }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } }, "delete": { "operationId": "delete-user-phone-by-phone-type", "summary": "User Phone by Type", "description": "Delete user phone by phone type", "tags": [ "User" ], "security": [ { "client_auth": [ "write:user" ] } ], "responses": { "200": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "User phone was removed" }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/roles": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-iam-roles", "summary": "Role List", "description": "- Provides a list of active roles available in the VMS instance\n- Field values that use terminology keys in the VMS will return the default language for the VMS instance\n", "tags": [ "Identity and Access Management" ], "security": [ { "client_auth": [ "read:iam", "write:iam" ] } ], "parameters": [ { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } } ], "responses": { "200": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "List of roles defined in the VMS instance", "content": { "application/json": { "schema": { "type": "object", "description": "A list of roles", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of roles" }, "value": { "type": "array", "description": "An array of roles. If there are no roles this will be an empty array.", "items": { "type": "object", "description": "A specific client role in Beeline", "required": [ "roleCode", "displayName" ], "properties": { "roleCode": { "type": "string", "description": "The code for the role" }, "displayName": { "type": "string", "description": "The name of the role" }, "description": { "type": "string", "description": "A description that explains purpose of the role" } } } } } }, "examples": { "simple": { "value": { "maxItems": 3, "value": [ { "roleCode": "HM-1", "displayName": "Hiring Manager", "description": "Client Hiring Manager" }, { "roleCode": "RPT", "displayName": "Reporting", "description": "Advanced Reporting" }, { "roleCode": "FIN-APV", "displayName": "Financial Approver", "description": "Approver that has proper fiduciary responsibility" } ] } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/roles/{roleCode}": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "roleCode", "description": "An unique identifier for Role", "required": true, "example": "HM-1", "schema": { "type": "string", "maxLength": 255 } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-iam-single-role", "summary": "Role", "description": "- Provides details of a specific active role available in the VMS instance\n- Field values that use terminology keys in the VMS will return the default language for the VMS instance\n", "tags": [ "Identity and Access Management" ], "security": [ { "client_auth": [ "read:iam", "write:iam" ] } ], "responses": { "200": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "Specific role data as defined in the VMS instance", "content": { "application/json": { "schema": { "type": "object", "description": "A specific client role in Beeline", "required": [ "displayName" ], "properties": { "displayName": { "type": "string", "description": "The name of the role", "maxLength": 255 }, "description": { "type": "string", "description": "A description that explains purpose of the role", "maxLength": 255 } } }, "examples": { "simple": { "value": { "displayName": "Hiring Manager", "description": "Client Hiring Manager" } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/roles/{roleCode}/users/add": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "roleCode", "description": "An unique identifier for Role", "required": true, "example": "HM-1", "schema": { "type": "string", "maxLength": 255 } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "post": { "operationId": "post-iam-add-user", "summary": "Add Role to User", "description": "- An ability to assign a defined role to one to many active user(s)\n", "tags": [ "Identity and Access Management" ], "security": [ { "client_auth": [ "write:iam" ] } ], "requestBody": { "description": "Add role to user(s)", "content": { "application/json": { "schema": { "type": "object", "description": "A list of users to role", "required": [ "value" ], "properties": { "value": { "type": "array", "description": "An array of userIds. Must provide at least one userId.", "items": { "type": "string", "format": "uuid" } } } }, "examples": { "multiple": { "summary": "List of userIds", "value": [ "d9d2a502-eb16-43a3-a9b7-40880b27c6f1", "0fef347c-6415-4c7d-b120-1d29163bab05", "ca7adf26-c9d5-4966-bf8a-997eb307f3c0" ] }, "single": { "summary": "Single userId", "value": [ "98500cf5-40bb-4209-bf44-fb76e52f55eb" ] } } } } }, "responses": { "200": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "Role added to user(s) as defined in the VMS instance" }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/roles/{roleCode}/users/remove": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "roleCode", "description": "An unique identifier for Role", "required": true, "example": "HM-1", "schema": { "type": "string", "maxLength": 255 } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "post": { "operationId": "post-iam-remove-user", "summary": "Remove Role from User", "description": "- An ability to remove a defined role from one to many active user(s)\n", "security": [ { "client_auth": [ "write:iam" ] } ], "tags": [ "Identity and Access Management" ], "requestBody": { "description": "Remove role from user(s)", "content": { "application/json": { "schema": { "type": "object", "description": "A list of users to role", "required": [ "value" ], "properties": { "value": { "type": "array", "description": "An array of userIds. Must provide at least one userId.", "items": { "type": "string", "format": "uuid" } } } }, "examples": { "multiple": { "summary": "List of userIds", "value": [ "d9d2a502-eb16-43a3-a9b7-40880b27c6f1", "0fef347c-6415-4c7d-b120-1d29163bab05", "ca7adf26-c9d5-4966-bf8a-997eb307f3c0" ] }, "single": { "summary": "Single userId", "value": [ "98500cf5-40bb-4209-bf44-fb76e52f55eb" ] } } } } }, "responses": { "200": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "Role removed from user(s) as defined in the VMS instance" }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/roles/{roleCode}/users": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "roleCode", "description": "An unique identifier for Role", "required": true, "example": "HM-1", "schema": { "type": "string", "maxLength": 255 } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-iam-users-by-role", "summary": "User List by Role", "description": "- Provides a list of all active user(s) assigned to an active role\n", "tags": [ "Identity and Access Management" ], "security": [ { "client_auth": [ "read:iam", "write:iam" ] } ], "parameters": [ { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } } ], "responses": { "200": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "List of users assigned to a role as defined in the VMS instance", "content": { "application/json": { "schema": { "type": "object", "description": "A list of users to role", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of users assigned to role." }, "value": { "type": "array", "description": "An array of userIds. If there are no userIds this will be an empty array.", "items": { "type": "string", "format": "uuid" } } } }, "examples": { "simple": { "value": { "maxItems": 3, "value": [ "ed4bf9d0-e2ed-4e89-9b29-21e97d6a8e89", "bc43cc1b-edd0-46b8-9216-0f7d49606b23", "6a7c621a-3c82-4fcc-85ae-37f289405efa" ] } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/users/{userId}/roles": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "userId", "description": "An identifier uniquely identifying the user", "required": true, "example": "d63ff17f-95dd-44ff-b1df-b64fe705c9c9", "schema": { "type": "string", "format": "uuid" } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-iam-roles-by-user", "summary": "Role List by User", "description": "- Provides a list of all active role(s) assigned to an active user\n", "tags": [ "Identity and Access Management" ], "security": [ { "client_auth": [ "read:iam", "write:iam" ] } ], "parameters": [ { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } } ], "responses": { "200": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "List of roles assigned to a user as defined in the VMS instance", "content": { "application/json": { "schema": { "type": "object", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of roles assigned to user." }, "value": { "type": "array", "description": "An array of role codes. If there are no role codes this will be an empty array.", "items": { "type": "string" } } } }, "examples": { "simple": { "value": { "maxItems": 2, "value": [ "HM-1", "FIN-APV" ] } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/user-types": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-iam-type-list", "summary": "Type List", "description": "- Provides details of active types available in the VMS instance\n- Field values that use terminology keys in the VMS will return the default language for the VMS instance\n", "tags": [ "Identity and Access Management" ], "security": [ { "client_auth": [ "read:iam", "write:iam" ] } ], "parameters": [ { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } } ], "responses": { "200": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "List of types defined in the VMS instance", "content": { "application/json": { "schema": { "type": "object", "description": "A list of types", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of types" }, "value": { "type": "array", "description": "An array of types. If there are no types this will be an empty array.", "items": { "type": "object", "description": "A specific Client Type in Beeline", "required": [ "typeCode", "displayName" ], "properties": { "typeCode": { "type": "string", "description": "The code for the type" }, "displayName": { "type": "string", "description": "The name of the type" }, "description": { "type": "string", "description": "A description that explains purpose of the type" } } } } } }, "examples": { "simple": { "value": { "maxItems": 2, "value": [ { "typeCode": "FIN-EVP", "displayName": "Financial Reporting - EVP", "description": "Financial Executive Reporting" }, { "typeCode": "FIN-APV", "displayName": "Financial Approver", "description": "Budget Approver for Contingent Labor" } ] } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/user-types/{typeCode}": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "typeCode", "description": "An unique identifier for type", "required": true, "example": "FIN-EVP", "schema": { "type": "string", "maxLength": 255 } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-iam-single-type", "description": "- Provides details of a specific active type available in the VMS instance\n- Field values that use terminology keys in the VMS will return the default language for the VMS instance.\n", "summary": "Type", "tags": [ "Identity and Access Management" ], "security": [ { "client_auth": [ "read:iam", "write:iam" ] } ], "responses": { "200": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "Specific type data as defined in the VMS instance", "content": { "application/json": { "schema": { "type": "object", "description": "A specific user type in Beeline", "required": [ "displayName" ], "properties": { "displayName": { "type": "string", "description": "The name of the user type" }, "description": { "type": "string", "description": "A description that explains purpose of the user type" } } }, "examples": { "simple": { "value": { "displayName": "Financial Reporting - EVP", "description": "Financial Executive Reporting" } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/user-types/{typeCode}/users/add": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "typeCode", "description": "An unique identifier for type", "required": true, "example": "FIN-EVP", "schema": { "type": "string", "maxLength": 255 } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "post": { "operationId": "post-iam-add-user-type", "summary": "Add Type to User", "description": "- An ability to assign a defined type to one to many active user(s)\n", "security": [ { "client_auth": [ "write:iam" ] } ], "tags": [ "Identity and Access Management" ], "requestBody": { "description": "Add type to user(s)", "content": { "application/json": { "schema": { "type": "object", "description": "A list of users to role", "required": [ "value" ], "properties": { "value": { "type": "array", "description": "An array of userIds. Must provide at least one userId.", "items": { "type": "string", "format": "uuid" } } } }, "examples": { "multiple": { "summary": "List of userIds", "value": [ "d9d2a502-eb16-43a3-a9b7-40880b27c6f1", "0fef347c-6415-4c7d-b120-1d29163bab05", "ca7adf26-c9d5-4966-bf8a-997eb307f3c0" ] }, "single": { "summary": "Single userId", "value": [ "98500cf5-40bb-4209-bf44-fb76e52f55eb" ] } } } } }, "responses": { "200": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "Type added to user(s) as defined in the VMS instance" }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/user-types/{typeCode}/users/remove": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "typeCode", "description": "An unique identifier for type", "required": true, "example": "FIN-EVP", "schema": { "type": "string", "maxLength": 255 } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "post": { "operationId": "post-iam-remove-user-type", "summary": "Remove Type from User", "description": "- An ability to remove a defined type from one to many active user(s)\n", "security": [ { "client_auth": [ "write:iam" ] } ], "tags": [ "Identity and Access Management" ], "requestBody": { "description": "Remove type from user(s)", "content": { "application/json": { "schema": { "type": "object", "description": "A list of users to role", "required": [ "value" ], "properties": { "value": { "type": "array", "description": "An array of userIds. Must provide at least one userId.", "items": { "type": "string", "format": "uuid" } } } }, "examples": { "multiple": { "summary": "List of userIds", "value": [ "d9d2a502-eb16-43a3-a9b7-40880b27c6f1", "0fef347c-6415-4c7d-b120-1d29163bab05", "ca7adf26-c9d5-4966-bf8a-997eb307f3c0" ] }, "single": { "summary": "Single userId", "value": [ "98500cf5-40bb-4209-bf44-fb76e52f55eb" ] } } } } }, "responses": { "200": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "Type removed from user(s) as defined in the VMS instance" }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/user-types/{typeCode}/users": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "typeCode", "description": "An unique identifier for type", "required": true, "example": "FIN-EVP", "schema": { "type": "string", "maxLength": 255 } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-iam-user-types", "summary": "User List by Type", "description": "- Provides a list of all active user(s) assigned to an active type\n", "tags": [ "Identity and Access Management" ], "security": [ { "client_auth": [ "read:iam", "write:iam" ] } ], "parameters": [ { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } } ], "responses": { "200": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "List of users assigned to a type as defined in the VMS instance", "content": { "application/json": { "schema": { "type": "object", "description": "A list of users to role", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of users assigned to role." }, "value": { "type": "array", "description": "An array of userIds. If there are no userIds this will be an empty array.", "items": { "type": "string", "format": "uuid" } } } }, "examples": { "simple": { "value": { "maxItems": 3, "value": [ "ed4bf9d0-e2ed-4e89-9b29-21e97d6a8e89", "bc43cc1b-edd0-46b8-9216-0f7d49606b23", "6a7c621a-3c82-4fcc-85ae-37f289405efa" ] } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/users/{userId}/user-types": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "userId", "description": "An identifier uniquely identifying the user", "required": true, "example": "d63ff17f-95dd-44ff-b1df-b64fe705c9c9", "schema": { "type": "string", "format": "uuid" } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-iam-user-types-user-id", "summary": "Type List by User", "description": "- Provides a list of all active type(s) assigned to an active user\n", "tags": [ "Identity and Access Management" ], "security": [ { "client_auth": [ "read:iam", "write:iam" ] } ], "parameters": [ { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } } ], "responses": { "200": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "List of types assigned to a user as defined in the VMS instance", "content": { "application/json": { "schema": { "type": "object", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of types assigned to user." }, "value": { "type": "array", "description": "An array of type codes. If there are no type codes this will be an empty array.", "items": { "type": "string" } } } }, "examples": { "simple": { "value": { "maxItems": 2, "value": [ "FIN-EVP", "FIN-APV" ] } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/currencies": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-spend-auth-currencies", "summary": "Currency List", "description": "- Provides a list of active currencies available in the VMS instance\n- Field values that use terminology keys in the VMS will return the default language for the VMS instance.\n", "tags": [ "Spend Authority" ], "security": [ { "client_auth": [ "read:spend_authority", "write:spend_authority" ] } ], "parameters": [ { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } } ], "responses": { "200": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "List currencies defined in the VMS instance", "content": { "application/json": { "schema": { "type": "object", "description": "A list of currencies", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of currencies" }, "value": { "type": "array", "description": "An array of currencies. If there are no currencies this will be an empty array.", "items": { "required": [ "displayName", "currencyCode" ], "type": "object", "properties": { "displayName": { "type": "string", "description": "Name of the currency", "maxLength": 3 }, "description": { "type": "string", "description": "Description of currency displayName", "maxLength": 255 }, "currencyCode": { "type": "string", "description": "A code uniquely identifying the currency", "maxLength": 3 } } } } } }, "examples": { "simple": { "value": { "maxItems": 3, "value": [ { "displayName": "GBP", "description": "British Pound", "currencyCode": "GBP" }, { "displayName": "AUD", "description": "Australian Dollar", "currencyCode": "AUD" }, { "displayName": "USD", "description": "US Currency", "currencyCode": "USD" } ] } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/currencies/{currencyCode}": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "currencyCode", "description": "An unique identifier for a currency", "required": true, "example": "CAD", "schema": { "type": "string", "maxLength": 3 } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-spend-auth-currency", "summary": "Currency", "description": "- Provides details of a specific active currency available in the VMS instance\n- Field values that use terminology keys in the VMS will return the default language for the VMS instance.\n", "tags": [ "Spend Authority" ], "security": [ { "client_auth": [ "read:spend_authority", "write:spend_authority" ] } ], "responses": { "200": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "Specific currency data as defined in the VMS instance", "content": { "application/json": { "schema": { "required": [ "displayName", "currencyCode" ], "type": "object", "properties": { "displayName": { "type": "string", "description": "Name of the currency", "maxLength": 3 }, "description": { "type": "string", "description": "Description of currency displayName", "maxLength": 255 }, "currencyCode": { "type": "string", "description": "A code uniquely identifying the currency", "maxLength": 3 } } }, "examples": { "simple": { "value": { "displayName": "GBP", "description": "British Pound", "currencyCode": "GBP" } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/spend-authorities": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-spend-auth-spend-authorities", "summary": "Spend Authority List", "description": "- Provides a list of all active users spend authority by spend type, amount and currency.\n", "tags": [ "Spend Authority" ], "security": [ { "client_auth": [ "read:spend_authority", "write:spend_authority" ] } ], "parameters": [ { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } } ], "responses": { "200": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "List of spend amount(s) assigned to user(s) as defined in the VMS instance", "content": { "application/json": { "schema": { "type": "object", "description": "A list of authorized spend type and amount by user", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of authorized spend type and amount by user" }, "value": { "type": "array", "description": "An array of authorized spend type and amount by user. If there are no authorized spend type and amount by users this will be an empty array.", "items": { "type": "object", "required": [ "spendType", "amount", "currencyCode", "userId" ], "properties": { "spendType": { "type": "string", "enum": [ "manager", "financial" ], "description": "- Manager represents spend authority for procurement spend\n- Financial represents spend authority for financial spend that will be invoiced\n" }, "amount": { "type": "integer", "description": "- An authorized whole number amount of spend allowed by the user.\n- Number must be greater than zero\n- Number must not contain any decimals\n", "maxLength": 10 }, "currencyCode": { "type": "string", "description": "An unique identifier for a currency", "maxLength": 3 }, "userId": { "type": "string", "description": "An identifier uniquely identifying the user", "format": "uuid" } } } } } }, "examples": { "simple": { "value": { "maxItems": 3, "value": [ { "spendType": "manager", "amount": 5000, "currencyCode": "USD", "userId": "e4acdfa5-5aee-4b9f-8dd1-67b401f5cb5d" }, { "spendType": "manager", "amount": 30000, "currencyCode": "AUD", "userId": "e4acdfa5-5aee-4b9f-8dd1-67b401f5cb5d" }, { "spendType": "financial", "amount": 100000, "currencyCode": "CAD", "userId": "e4acdfa5-5aee-4b9f-8dd1-67b401f5cb5d" } ] } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/spend-authorities/{userId}": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "userId", "description": "An identifier uniquely identifying the user", "required": true, "example": "d63ff17f-95dd-44ff-b1df-b64fe705c9c9", "schema": { "type": "string", "format": "uuid" } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "get": { "operationId": "get-spend-auth-spend-authorities-user-id", "summary": "Spend Authority List by User", "description": "- Provides a list of spend authorities by user id.\n", "tags": [ "Spend Authority" ], "security": [ { "client_auth": [ "read:spend_authority", "write:spend_authority" ] } ], "parameters": [ { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } } ], "responses": { "200": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "List of authorized spend type, amount and currency assigned to a user as defined in the VMS instance", "content": { "application/json": { "schema": { "type": "object", "description": "A list of authorized spend type and amount by user", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of authorized spend type and amount by user" }, "value": { "type": "array", "description": "An array of authorized spend type and amount by user. If there are no authorized spend type and amount by users this will be an empty array.", "items": { "type": "object", "required": [ "spendType", "amount", "currencyCode", "userId" ], "properties": { "spendType": { "type": "string", "enum": [ "manager", "financial" ], "description": "- Manager represents spend authority for procurement spend\n- Financial represents spend authority for financial spend that will be invoiced\n" }, "amount": { "type": "integer", "description": "- An authorized whole number amount of spend allowed by the user.\n- Number must be greater than zero\n- Number must not contain any decimals\n", "maxLength": 10 }, "currencyCode": { "type": "string", "description": "An unique identifier for a currency", "maxLength": 3 }, "userId": { "type": "string", "description": "An identifier uniquely identifying the user", "format": "uuid" } } } } } }, "examples": { "simple": { "value": { "maxItems": 3, "value": [ { "spendType": "manager", "amount": 5000, "currencyCode": "USD", "userId": "e4acdfa5-5aee-4b9f-8dd1-67b401f5cb5d" }, { "spendType": "manager", "amount": 30000, "currencyCode": "AUD", "userId": "e4acdfa5-5aee-4b9f-8dd1-67b401f5cb5d" }, { "spendType": "financial", "amount": 100000, "currencyCode": "CAD", "userId": "e4acdfa5-5aee-4b9f-8dd1-67b401f5cb5d" } ] } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/spend-authorities/add": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "post": { "operationId": "post-spend-auth-amount-add", "summary": "Add Spend Authority for a User", "description": "- An ability to add an active user(s) spend authority based on an spend type, amount and currency.\n- If need to change a user(s) spend authority that has been previously provided, then you will need to use the \"Remove Spend Authority for a User\" first.\n", "tags": [ "Spend Authority" ], "security": [ { "client_auth": [ "write:spend_authority" ] } ], "requestBody": { "description": "Add currency and spend to user(s)", "content": { "application/json": { "schema": { "type": "object", "description": "The spend authority is allowed by the given userId(s)", "required": [ "spendType", "amount", "currencyCode", "userIds" ], "properties": { "spendType": { "type": "string", "enum": [ "manager", "financial" ], "description": "- Manager represents spend authority for procurement spend\n- Financial represents spend authority for financial spend that will be invoiced\n" }, "amount": { "type": "integer", "description": "- An authorized whole number amount of spend allowed by the user.\n- Number must be greater than zero\n- Number must not contain any decimals\n", "maxLength": 10 }, "currencyCode": { "type": "string", "description": "A code uniquely identifying the currency for the amount.", "maxLength": 3 }, "userIds": { "type": "array", "description": "An array of userIds. There should be at least one userId.", "maxItems": 100, "items": { "type": "string", "format": "uuid" }, "uniqueItems": true } } }, "examples": { "single": { "summary": "Single spend authority by amount and userId(s)", "value": { "spendType": "manager", "amount": 50000, "currencyCode": "AUD", "userIds": [ "499a3357-c73b-4d05-b7ad-a055d5bea582", "234bedb6-3ecb-4a0d-8745-51187ecc5d0a", "9fff2ff9-c171-464a-986d-73939d6f1c65" ] } } } } } }, "responses": { "200": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "Add user(s) currency and spend to the VMS instance" }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/spend-authorities/remove": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } } ], "post": { "operationId": "post-spend-auth-remove", "summary": "Remove Spend Authority for a User", "description": "- An ability to remove from an user(s) their spend authority based on spend type and currency.\n", "tags": [ "Spend Authority" ], "security": [ { "client_auth": [ "write:spend_authority" ] } ], "requestBody": { "description": "Remove spend authority from user(s)", "content": { "application/json": { "schema": { "type": "object", "description": "The spend authority to be removed by the given spendType, currencyCode and userId(s)", "required": [ "spendType", "currencyCode", "userIds" ], "properties": { "spendType": { "type": "string", "enum": [ "manager", "financial" ], "description": "- Manager represents spend authority for procurement spend\n- Financial represents spend authority for financial spend that will be invoiced\n" }, "currencyCode": { "type": "string", "description": "A code uniquely identifying the currency for the amount.", "maxLength": 3 }, "userIds": { "type": "array", "description": "An array of userIds. There should be at least one userId.", "maxItems": 100, "items": { "type": "string", "format": "uuid" }, "uniqueItems": true } } }, "examples": { "single": { "summary": "The spend authority to be removed by the given spendType, currencyCode and userId(s)", "value": { "spendType": "manager", "currencyCode": "USD", "userIds": [ "67e519d9-8244-4161-b0ab-ffa210efabf0", "870acff5-a05a-4497-84ac-1329077162c0", "11de85cc-104e-4604-9c15-912d734ddb26" ] } } } } } }, "responses": { "200": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "Removed user(s) and spend amount from currency as defined in the VMS instance" }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } } }, "components": { "parameters": { "client-site-id": { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, "api-version": { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-02-28" ] } }, "skip": { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, "top": { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } }, "location-country-code": { "in": "path", "name": "countryCode", "description": "An identifier for a country", "required": true, "schema": { "type": "string", "maxLength": 255 } }, "location-state-code": { "in": "path", "name": "stateCode", "description": "An identifier for a state", "required": true, "schema": { "type": "string", "maxLength": 5 } }, "location-county-code": { "in": "path", "name": "countyCode", "description": "An identifier for a county", "required": true, "schema": { "type": "string", "maxLength": 255 } }, "location-location-code": { "in": "path", "name": "locationCode", "description": "A code uniquely identifying the location", "required": true, "schema": { "type": "string", "maxLength": 255 } }, "org-organization-code": { "in": "path", "name": "organizationCode", "description": "A code uniquely identifying the Organization", "required": true, "schema": { "type": "string", "maxLength": 50 } }, "org-cost-center-number": { "in": "path", "name": "costCenterNumber", "description": "A code uniquely identifying the cost center", "required": true, "schema": { "type": "string", "maxLength": 100 } }, "org-ou-type-display-name": { "in": "path", "name": "ouTypeDisplayName", "description": "A name uniquely identifying an OU Type", "required": true, "schema": { "type": "string", "maxLength": 255 } }, "org-ou-code": { "in": "path", "name": "ouCode", "description": "A code uniquely identifying an OU", "required": true, "schema": { "type": "string", "maxLength": 50 } }, "org-domain-type": { "in": "path", "name": "domainType", "description": "An unique identifier for ou domain type", "required": true, "schema": { "type": "string", "enum": [ "owner", "assistant", "controller", "mspRepresentative" ] } }, "org-domain-user-id": { "in": "path", "name": "userId", "description": "An identifier uniquely identifying the user", "required": true, "example": "d63ff17f-95dd-44ff-b1df-b64fe705c9c9", "schema": { "type": "string", "format": "uuid" } }, "ba-business-area-code": { "in": "path", "name": "businessAreaCode", "description": "An unique identifier for a business area", "required": true, "schema": { "type": "string", "maxLength": 255 } }, "ba-functional-partition-code": { "in": "path", "name": "functionalPartitionCode", "description": "An unique identifier for a functional partition", "required": true, "schema": { "type": "string", "maxLength": 255 } }, "user-user-id": { "in": "path", "name": "userId", "description": "An identifier uniquely identifying the user", "required": true, "example": "d63ff17f-95dd-44ff-b1df-b64fe705c9c9", "schema": { "type": "string", "format": "uuid" } }, "user-user-name": { "in": "path", "name": "userName", "description": "An identifier uniquely identifying the user", "required": true, "schema": { "type": "string", "maxLength": 50 } }, "user-phone-type": { "in": "path", "name": "phoneType", "description": "An unique identifier for phone type", "required": true, "schema": { "type": "string", "enum": [ "business", "fax", "home", "mobile" ] } }, "iam-user-id": { "in": "path", "name": "userId", "description": "An identifier uniquely identifying the user", "required": true, "example": "d63ff17f-95dd-44ff-b1df-b64fe705c9c9", "schema": { "type": "string", "format": "uuid" } }, "iam-role-code": { "in": "path", "name": "roleCode", "description": "An unique identifier for Role", "required": true, "example": "HM-1", "schema": { "type": "string", "maxLength": 255 } }, "iam-type-code": { "in": "path", "name": "typeCode", "description": "An unique identifier for type", "required": true, "example": "FIN-EVP", "schema": { "type": "string", "maxLength": 255 } }, "iam-domain-type": { "in": "path", "name": "domainType", "description": "An unique identifier for ou domain type", "required": true, "schema": { "type": "string", "enum": [ "owner", "assistant", "controller", "mspRepresentative" ] } }, "currency-code": { "in": "path", "name": "currencyCode", "description": "An unique identifier for a currency", "required": true, "example": "CAD", "schema": { "type": "string", "maxLength": 3 } }, "spend-auth-user-id": { "in": "path", "name": "userId", "description": "An identifier uniquely identifying the user", "required": true, "example": "d63ff17f-95dd-44ff-b1df-b64fe705c9c9", "schema": { "type": "string", "format": "uuid" } }, "cost-center-number-query": { "in": "query", "name": "costCenterNumber", "description": "A number identifying the cost center", "required": true, "schema": { "type": "string", "maxLength": 100 } }, "country-code": { "in": "path", "name": "countryCode", "description": "An identifier for a country", "required": true, "schema": { "type": "string", "maxLength": 255 } }, "state-code": { "in": "path", "name": "stateCode", "description": "An identifier for a state", "required": true, "schema": { "type": "string", "maxLength": 5 } }, "county-code": { "in": "path", "name": "countyCode", "description": "An identifier for a county", "required": true, "schema": { "type": "string", "maxLength": 255 } }, "location-code": { "in": "path", "name": "locationCode", "description": "A code uniquely identifying the location", "required": true, "schema": { "type": "string", "maxLength": 255 } }, "ou-type-display-name": { "in": "path", "name": "ouTypeDisplayName", "description": "A name uniquely identifying an OU Type", "required": true, "schema": { "type": "string", "maxLength": 255 } }, "organization-code": { "in": "path", "name": "organizationCode", "description": "A code uniquely identifying the Organization", "required": true, "schema": { "type": "string", "maxLength": 50 } }, "ou-code": { "in": "path", "name": "ouCode", "description": "A code uniquely identifying an OU", "required": true, "schema": { "type": "string", "maxLength": 50 } }, "cost-center-number": { "in": "path", "name": "costCenterNumber", "description": "A code uniquely identifying the cost center", "required": true, "schema": { "type": "string", "maxLength": 100 } }, "domain-type": { "in": "path", "name": "domainType", "description": "An unique identifier for ou domain type", "required": true, "schema": { "type": "string", "enum": [ "owner", "assistant", "controller", "mspRepresentative" ] } }, "user-id": { "in": "path", "name": "userId", "description": "An identifier uniquely identifying the user", "required": true, "example": "d63ff17f-95dd-44ff-b1df-b64fe705c9c9", "schema": { "type": "string", "format": "uuid" } }, "business-area-code": { "in": "path", "name": "businessAreaCode", "description": "An unique identifier for a business area", "required": true, "schema": { "type": "string", "maxLength": 255 } }, "functional-partition-code": { "in": "path", "name": "functionalPartitionCode", "description": "An unique identifier for a functional partition", "required": true, "schema": { "type": "string", "maxLength": 255 } }, "user-name": { "in": "path", "name": "userName", "description": "An identifier uniquely identifying the user", "required": true, "schema": { "type": "string", "maxLength": 50 } }, "role-code": { "in": "path", "name": "roleCode", "description": "An unique identifier for Role", "required": true, "example": "HM-1", "schema": { "type": "string", "maxLength": 255 } }, "type-code": { "in": "path", "name": "typeCode", "description": "An unique identifier for type", "required": true, "example": "FIN-EVP", "schema": { "type": "string", "maxLength": 255 } }, "parameter-currency-code": { "in": "path", "name": "currencyCode", "description": "An unique identifier for a currency", "required": true, "example": "CAD", "schema": { "type": "string", "maxLength": 3 } } }, "headers": { "rate-limit-limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "rate-limit-remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "rate-limit-reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } }, "retry-after": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "responses": { "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "409": { "description": "Conflict", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "400-inner": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "An Error Response.", "required": [ "error" ], "properties": { "error": { "type": "object", "description": "The Error object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes" }, "message": { "type": "string", "description": "a human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error." }, "details": { "type": "array", "description": "An array of details about specific errors that led to this reported error.", "items": { "type": "object", "description": "The Specific Error object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes" }, "message": { "type": "string", "description": "a human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error." } } } }, "innerError": { "type": "object", "description": "An object containing more specific information than the current object about the error.", "properties": { "code": { "type": "string", "description": "A more specific error code than was provided by the containing error." }, "innerError": { "type": "object", "description": "The Inner Error object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes" }, "message": { "type": "string", "description": "a human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error." } } } } } } } } } } } } }, "schemas": { "cost-center-id": { "type": "object", "description": "A cost-center Id", "required": [ "costCenterId" ], "properties": { "costCenterId": { "type": "string", "format": "uuid", "description": "The unique identifier of the cost center\n", "example": "12576b49-e5d8-48ef-9ec8-9e7c6d13ec56" } } }, "detailed-cost-center-array": { "type": "object", "description": "A list of detailed cost centers", "properties": { "maxItems": { "type": "integer", "description": "The total number of detailed cost centers" }, "value": { "type": "array", "description": "An array of detailed cost centers. If there are no cost centers this will be an empty array.", "items": { "type": "object", "description": "A detailed cost center", "required": [ "costCenterId", "costCenterNumber", "organizationCode", "ouCode", "billable" ], "properties": { "costCenterId": { "type": "string", "format": "uuid", "description": "The id of the cost center" }, "costCenterNumber": { "type": "string", "description": "The number of the cost center", "maxLength": 100 }, "displayName": { "type": "string", "description": "The name of the cost center", "maxLength": 255 }, "description": { "type": "string", "description": "A description of the cost center", "maxLength": 255 }, "organizationCode": { "type": "string", "description": "The code of the organization for this cost center", "maxLength": 50 }, "ouCode": { "type": "string", "description": "The code of the organization unit for this cost center", "maxLength": 50 }, "billable": { "type": "boolean", "description": "Billable flag of this cost center" }, "externalId": { "type": "string", "description": "The external ID of the cost center", "maxLength": 255 } } } } } }, "location-id": { "type": "object", "description": "A location Id", "required": [ "locationId" ], "properties": { "locationId": { "type": "string", "format": "uuid", "description": "The unique identifier of the location\n", "example": "cac2573a-7784-440c-b9b5-928f97625dd1" } } }, "location-country-array": { "description": "A set of Countries", "type": "object", "properties": { "maxItems": { "type": "integer", "description": "The total number of items" }, "value": { "type": "array", "description": "The set of items. If there are no items, this will be an empty array.", "items": { "type": "object", "description": "Information", "required": [ "countryCode", "displayName" ], "properties": { "countryCode": { "type": "string", "description": "An identifier for a country", "maxLength": 255 }, "displayName": { "type": "string", "description": "The name of the country", "maxLength": 255 }, "description": { "type": "string", "description": "The long description of the country", "maxLength": 255 } } } } } }, "location-country": { "type": "object", "description": "Information", "required": [ "displayName" ], "properties": { "displayName": { "type": "string", "description": "The name of the country", "maxLength": 255 }, "description": { "type": "string", "description": "The long description of the country", "maxLength": 255 } } }, "location-state-array": { "description": "A set of States", "type": "object", "properties": { "maxItems": { "type": "integer", "description": "The total number of items" }, "value": { "type": "array", "description": "The set of items. If there are no items, this will be an empty array.", "items": { "type": "object", "description": "Information", "required": [ "displayName", "stateCode" ], "properties": { "stateCode": { "type": "string", "description": "An identifier for a state", "maxLength": 5 }, "displayName": { "type": "string", "description": "The name of the state", "maxLength": 255 }, "description": { "type": "string", "description": "The description of the state", "maxLength": 255 } } } } } }, "location-state": { "type": "object", "description": "Information", "required": [ "displayName" ], "properties": { "displayName": { "type": "string", "description": "The name of the state", "maxLength": 255 }, "description": { "type": "string", "description": "The description of the state", "maxLength": 255 } } }, "location-county-array": { "description": "A set of Counties", "type": "object", "properties": { "maxItems": { "type": "integer", "description": "The total number of items" }, "value": { "type": "array", "description": "The set of items. If there are no items, this will be an empty array.", "items": { "type": "object", "description": "Information", "required": [ "countyCode", "displayName" ], "properties": { "countyCode": { "type": "string", "description": "An identifier for a county", "maxLength": 255 }, "displayName": { "type": "string", "description": "The name of the county", "maxLength": 255 }, "description": { "type": "string", "description": "The long name of the county", "maxLength": 255 } } } } } }, "location-county": { "type": "object", "description": "Information", "required": [ "displayName" ], "properties": { "displayName": { "type": "string", "description": "The name of the county", "maxLength": 255 }, "description": { "type": "string", "description": "The long name of the county", "maxLength": 255 } } }, "location-location-array": { "type": "object", "description": "A list of locations", "properties": { "maxItems": { "type": "integer", "description": "The total number of locations" }, "value": { "type": "array", "description": "An array of locations. If there are no locations this will be an empty array.", "items": { "type": "object", "description": "A business location", "required": [ "displayName", "street1", "city", "countryCode", "stateCode", "postalCode", "locationCode" ], "properties": { "locationCode": { "type": "string", "description": "A code uniquely identifying the location", "maxLength": 255 }, "displayName": { "type": "string", "description": "The name of the location", "maxLength": 255 }, "description": { "type": "string", "description": "A description of the location", "maxLength": 255 }, "street1": { "type": "string", "description": "The primary street for this location", "maxLength": 150 }, "street2": { "type": "string", "description": "The secondary street for this location", "maxLength": 150 }, "city": { "type": "string", "description": "A string for storing the city of this location", "maxLength": 50 }, "countryCode": { "type": "string", "description": "A code uniquely identifying the country", "maxLength": 255 }, "stateCode": { "type": "string", "description": "A code uniquely identifying the state within a country", "maxLength": 5 }, "countyCode": { "type": "string", "description": "A code uniquely identifying the county", "maxLength": 255 }, "postalCode": { "type": "string", "description": "The postal code for this location", "maxLength": 10 }, "region": { "type": "string", "description": "The internal region of this location", "maxLength": 255 }, "phoneNumber": { "type": "string", "description": "A phone number for this location", "maxLength": 30 } } } } } }, "location-location": { "type": "object", "description": "A business location", "required": [ "displayName", "street1", "city", "countryCode", "stateCode", "postalCode" ], "properties": { "displayName": { "type": "string", "description": "The name of the location", "maxLength": 255 }, "description": { "type": "string", "description": "A description of the location", "maxLength": 255 }, "street1": { "type": "string", "description": "The primary street for this location", "maxLength": 150 }, "street2": { "type": "string", "description": "The secondary street for this location", "maxLength": 150 }, "city": { "type": "string", "description": "A string for storing the city of this location", "maxLength": 50 }, "countryCode": { "type": "string", "description": "A code uniquely identifying the country", "maxLength": 255 }, "stateCode": { "type": "string", "description": "A code uniquely identifying the state within a country", "maxLength": 5 }, "countyCode": { "type": "string", "description": "A code uniquely identifying the county", "maxLength": 255 }, "postalCode": { "type": "string", "description": "The postal code for this location", "maxLength": 10 }, "region": { "type": "string", "description": "The internal region of this location", "maxLength": 255 }, "phoneNumber": { "type": "string", "description": "A phone number for this location", "maxLength": 30 } } }, "org-organization-array": { "type": "object", "description": "A list of Organizations", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of Organizations" }, "value": { "type": "array", "description": "An array of Organizations. If there are no Organizations this will be an empty array.", "items": { "required": [ "organizationCode", "displayName" ], "properties": { "organizationCode": { "type": "string", "description": "A code uniquely identifying the Organization", "maxLength": 50 }, "displayName": { "type": "string", "maxLength": 255, "description": "Organization Name" }, "description": { "type": "string", "maxLength": 255, "description": "Description of Organization Display Name" } }, "type": "object" } } } }, "org-organization": { "type": "object", "required": [ "displayName" ], "properties": { "displayName": { "type": "string", "maxLength": 255, "description": "Organization Name" }, "description": { "type": "string", "maxLength": 255, "description": "Description of Organization Display Name" } } }, "org-ou-type-array": { "type": "object", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer" }, "value": { "type": "array", "items": { "required": [ "ouTypeDisplayName" ], "properties": { "ouTypeDisplayName": { "type": "string", "maxLength": 255 } }, "type": "object" } } } }, "org-ou-type": { "type": "object", "properties": { "description": { "type": "string", "maxLength": 255 } } }, "org-ou-array": { "type": "object", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer" }, "value": { "type": "array", "items": { "type": "object", "required": [ "ouCode" ], "properties": { "ouCode": { "type": "string", "maxLength": 50, "description": "The organization unit code." } } } } } }, "org-ou": { "type": "object", "required": [ "displayName", "ouTypeDisplayName" ], "properties": { "displayName": { "type": "string", "maxLength": 255 }, "description": { "type": "string", "maxLength": 255 }, "parentOuCode": { "type": "string", "maxLength": 50 }, "ouTypeDisplayName": { "type": "string", "maxLength": 255 }, "externalId": { "type": "string", "maxLength": 255, "description": "Used to store WorkDay specific identifiers" } } }, "org-cost-center-array": { "type": "object", "description": "A list of Cost Centers", "properties": { "maxItems": { "type": "integer", "description": "The total number of Cost Centers" }, "value": { "type": "array", "description": "An array of Cost Centers. If there are no Cost Centers this will be an empty array.", "items": { "properties": { "costCenterNumber": { "type": "string", "description": "A code uniquely identifying the Cost Center", "maxLength": 100 } }, "type": "object" } } } }, "org-cost-center": { "type": "object", "properties": { "displayName": { "type": "string", "description": "The Name of the Cost Center", "maxLength": 255 }, "description": { "type": "string", "description": "A description of the Cost Center", "maxLength": 255 }, "billable": { "type": "boolean", "description": "A flag indicating whether the Cost Center is billable. If no value is supplied, then this will default to \"false\"." }, "externalId": { "type": "string", "description": "A unique identifier a client can provide that can be managed externally from Beeline's VMS.", "maxLength": 255 } } }, "org-user-id-array": { "type": "object", "description": "A list of users to role", "required": [ "value" ], "properties": { "value": { "type": "array", "description": "An array of userIds. Must provide at least one userId.", "items": { "type": "string", "format": "uuid" } } } }, "org-user-ou-array": { "type": "object", "description": "A list of ou domain types for a user", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of ou domain types" }, "value": { "type": "array", "description": "An array of client ou domain types. If there are no ou domain types this will be an empty array.", "items": { "required": [ "ouCode", "domainType" ], "properties": { "ouCode": { "type": "string", "description": "Organizational Unit unique identifier", "maxLength": 50 }, "domainType": { "type": "string", "description": "Domain type a user can be assigned (owner, assistant, controller, mspRepresentative)" } } } } } }, "org-ou-user-array": { "type": "object", "description": "A list of ou users", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of ou users" }, "value": { "type": "array", "description": "An array of ou users. If there are no ou users this will be an empty array.", "items": { "type": "object", "required": [ "userId", "domainType" ], "properties": { "userId": { "type": "string", "description": "An identifier uniquely identifying the user", "example": "d63ff17f-95dd-44ff-b1df-b64fe705c9c9", "format": "uuid" }, "domainType": { "type": "string", "description": "Domain type a user can be assigned (owner, assistant, controller, msp-representative)" } } } } } }, "org-cc-user": { "type": "object", "properties": { "ownerUserId": { "type": [ "string", "null" ], "description": "An identifier uniquely identifying the user", "example": "ce6fd7c5-61c9-4f05-969b-5266a2a884a8", "format": "uuid" }, "assistantUserId": { "type": [ "string", "null" ], "description": "An identifier uniquely identifying the user", "example": "281ba412-9193-4a53-a87a-a445abe7d2ca", "format": "uuid" }, "controllerUserId": { "type": [ "string", "null" ], "description": "An identifier uniquely identifying the user", "example": "150efd42-611f-4e61-acbe-44614631fee5", "format": "uuid" } } }, "ba-business-area-array": { "type": "object", "description": "A list of business areas", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of business areas" }, "value": { "type": "array", "description": "An array of business areas. If there are no business areas this will be an empty array.", "items": { "type": "object", "description": "An area of business, category of business within a client organization which is used for grouping Functional Partitions.", "required": [ "businessAreaCode", "displayName" ], "properties": { "businessAreaCode": { "type": "string", "description": "A code uniquely identifying the business area", "maxLength": 255 }, "displayName": { "type": "string", "description": "The name of the business area", "maxLength": 255 }, "description": { "type": "string", "description": "A description of the business area", "maxLength": 255 } } } } } }, "ba-business-area": { "type": "object", "description": "An area of business, category of business within a client organization which is used for grouping Functional Partitions.", "required": [ "displayName" ], "properties": { "displayName": { "type": "string", "description": "The name of the business area", "maxLength": 255 }, "description": { "type": "string", "description": "A description of the business area", "maxLength": 255 } } }, "ba-functional-partition-array": { "type": "object", "description": "A list of functional partitions", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of functional partitions" }, "value": { "type": "array", "description": "An array of functional partitions. If there are no functional partitions this will be an empty array.", "items": { "type": "object", "description": "A sub-organization, sub-component, sub-function, or business partition within a client organization which are associated to one Business Area.", "required": [ "displayName", "functionalPartitionCode" ], "properties": { "functionalPartitionCode": { "type": "string", "description": "A code uniquely identifying the functional partition", "maxLength": 255 }, "displayName": { "type": "string", "description": "The name of the functional partition", "maxLength": 255 }, "description": { "type": "string", "description": "A description of the functional partition", "maxLength": 255 } } } } } }, "ba-functional-partition": { "type": "object", "description": "A sub-organization, sub-component, sub-function, or business partition within a client organization which are associated to one Business Area.", "required": [ "displayName" ], "properties": { "displayName": { "type": "string", "description": "The name of the functional partition", "maxLength": 255 }, "description": { "type": "string", "description": "A description of the functional partition", "maxLength": 255 } } }, "user-language-code-array": { "type": "object", "description": "A list of language codes", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of language codes" }, "value": { "type": "array", "description": "An array of language codes. If there are no language codes this will be an empty array.", "items": { "required": [ "languageCode" ], "type": "object", "description": "Retrieve a list of Culture Name (Language Codes)", "properties": { "languageCode": { "type": "string", "description": "A uniquely identifying language code, like en-US", "maxLength": 50 } } } } } }, "user-user-array": { "type": "object", "description": "A list of users", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of users" }, "value": { "type": "array", "description": "An array of users. If there are no users this will be an empty array.", "items": { "type": "object", "description": "A user", "required": [ "userId", "userName", "firstName", "lastName", "organizationCode", "ouCode", "costCenterNumber", "languageCode", "locationCode" ], "properties": { "userId": { "type": "string", "format": "uuid", "description": "Uniquely identifies a user" }, "userName": { "type": "string", "description": "The unique user name of the user", "maxLength": 50 }, "firstName": { "type": "string", "description": "First name of the user", "maxLength": 100 }, "middleName": { "type": "string", "description": "Middle name of the user", "maxLength": 100 }, "lastName": { "type": "string", "description": "Last name of the user", "maxLength": 100 }, "localizedFirstName": { "type": "string", "description": "Localized first name of the user in local culture and language", "maxLength": 100 }, "localizedMiddleName": { "type": "string", "description": "Localized middle name of the user in local culture and language", "maxLength": 100 }, "localizedLastName": { "type": "string", "description": "Localized last name of the user in local culture and language", "maxLength": 100 }, "secondaryLastName": { "type": "string", "description": "Secondary last name of the user", "maxLength": 100 }, "email": { "type": "string", "description": "The work email address of the user", "maxLength": 255 }, "title": { "type": "string", "description": "The assigned title of the user", "maxLength": 255 }, "managerUserName": { "type": "string", "description": "The reporting manager of the user", "maxLength": 50 }, "organizationCode": { "type": "string", "description": "The parent organization to which the user belongs", "maxLength": 50 }, "ouCode": { "type": "string", "description": "The organizational unit within organization to which the user belongs", "maxLength": 50 }, "costCenterNumber": { "type": "string", "description": "The default bill to cost center for the user", "maxLength": 100 }, "locationCode": { "type": "string", "description": "A code uniquely identifying the location", "maxLength": 255 }, "languageCode": { "type": "string", "description": "A uniquely identifying language code, like en-US", "maxLength": 20 } } } } } }, "user-user-without-id": { "type": "object", "description": "A user", "required": [ "userName", "firstName", "lastName", "organizationCode", "ouCode", "costCenterNumber", "languageCode", "locationCode" ], "properties": { "userName": { "type": "string", "description": "The unique user name of the user", "maxLength": 50 }, "firstName": { "type": "string", "description": "First name of the user", "maxLength": 100 }, "middleName": { "type": "string", "description": "Middle name of the user", "maxLength": 100 }, "lastName": { "type": "string", "description": "Last name of the user", "maxLength": 100 }, "localizedFirstName": { "type": "string", "description": "Localized first name of the user in local culture and language", "maxLength": 100 }, "localizedMiddleName": { "type": "string", "description": "Localized middle name of the user in local culture and language", "maxLength": 100 }, "localizedLastName": { "type": "string", "description": "Localized last name of the user in local culture and language", "maxLength": 100 }, "secondaryLastName": { "type": "string", "description": "Secondary last name of the user", "maxLength": 100 }, "email": { "type": "string", "description": "The work email address of the user", "maxLength": 255 }, "title": { "type": "string", "description": "The assigned title of the user", "maxLength": 255 }, "managerUserName": { "type": "string", "description": "The reporting manager of the user", "maxLength": 50 }, "organizationCode": { "type": "string", "description": "The parent organization to which the user belongs", "maxLength": 50 }, "ouCode": { "type": "string", "description": "The organizational unit within organization to which the user belongs", "maxLength": 50 }, "costCenterNumber": { "type": "string", "description": "The default bill to cost center for the user", "maxLength": 100 }, "locationCode": { "type": "string", "description": "A code uniquely identifying the location", "maxLength": 255 }, "languageCode": { "type": "string", "description": "A uniquely identifying language code, like en-US", "maxLength": 20 } } }, "user-user-with-id": { "type": "object", "description": "A user", "required": [ "userId", "userName", "firstName", "lastName", "organizationCode", "ouCode", "costCenterNumber", "languageCode", "locationCode" ], "properties": { "userId": { "type": "string", "format": "uuid", "description": "Uniquely identifies a user" }, "userName": { "type": "string", "description": "The unique user name of the user", "maxLength": 50 }, "firstName": { "type": "string", "description": "First name of the user", "maxLength": 100 }, "middleName": { "type": "string", "description": "Middle name of the user", "maxLength": 100 }, "lastName": { "type": "string", "description": "Last name of the user", "maxLength": 100 }, "localizedFirstName": { "type": "string", "description": "Localized first name of the user in local culture and language", "maxLength": 100 }, "localizedMiddleName": { "type": "string", "description": "Localized middle name of the user in local culture and language", "maxLength": 100 }, "localizedLastName": { "type": "string", "description": "Localized last name of the user in local culture and language", "maxLength": 100 }, "secondaryLastName": { "type": "string", "description": "Secondary last name of the user", "maxLength": 100 }, "email": { "type": "string", "description": "The work email address of the user", "maxLength": 255 }, "title": { "type": "string", "description": "The assigned title of the user", "maxLength": 255 }, "managerUserName": { "type": "string", "description": "The reporting manager of the user", "maxLength": 50 }, "organizationCode": { "type": "string", "description": "The parent organization to which the user belongs", "maxLength": 50 }, "ouCode": { "type": "string", "description": "The organizational unit within organization to which the user belongs", "maxLength": 50 }, "costCenterNumber": { "type": "string", "description": "The default bill to cost center for the user", "maxLength": 100 }, "locationCode": { "type": "string", "description": "A code uniquely identifying the location", "maxLength": 255 }, "languageCode": { "type": "string", "description": "A uniquely identifying language code, like en-US", "maxLength": 20 } } }, "user-phone-array": { "type": "array", "description": "Retrieve a list of client user Phone Numbers by Phone Type", "items": { "type": "object", "description": "Retrieve a list of client user Phone Numbers by Phone Type", "required": [ "phoneType", "phoneNumber" ], "properties": { "phoneType": { "type": "string", "description": "Phone type for the phone number", "enum": [ "business", "fax", "home", "mobile" ], "maxLength": 10 }, "phoneNumber": { "type": "string", "description": "Phone number for phone type for a user", "example": "555-555-1212", "maxLength": 30 } } } }, "user-phone-number": { "type": "object", "description": "Retrieve a phone number for a client user", "required": [ "phoneNumber" ], "properties": { "phoneNumber": { "type": "string", "description": "Phone number for phone type for a user", "example": "555-555-1212", "maxLength": 30 } } }, "user-phone": { "type": "object", "description": "Retrieve a list of client user Phone Numbers by Phone Type", "required": [ "phoneType", "phoneNumber" ], "properties": { "phoneType": { "type": "string", "description": "Phone type for the phone number", "enum": [ "business", "fax", "home", "mobile" ], "maxLength": 10 }, "phoneNumber": { "type": "string", "description": "Phone number for phone type for a user", "example": "555-555-1212", "maxLength": 30 } } }, "iam-role-display-name-description": { "type": "object", "description": "A specific client role in Beeline", "required": [ "displayName" ], "properties": { "displayName": { "type": "string", "description": "The name of the role", "maxLength": 255 }, "description": { "type": "string", "description": "A description that explains purpose of the role", "maxLength": 255 } } }, "iam-role-array": { "type": "object", "description": "A list of roles", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of roles" }, "value": { "type": "array", "description": "An array of roles. If there are no roles this will be an empty array.", "items": { "type": "object", "description": "A specific client role in Beeline", "required": [ "roleCode", "displayName" ], "properties": { "roleCode": { "type": "string", "description": "The code for the role" }, "displayName": { "type": "string", "description": "The name of the role" }, "description": { "type": "string", "description": "A description that explains purpose of the role" } } } } } }, "iam-role-code-array": { "type": "object", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of roles assigned to user." }, "value": { "type": "array", "description": "An array of role codes. If there are no role codes this will be an empty array.", "items": { "type": "string" } } } }, "iam-user-id-array": { "type": "object", "description": "A list of users to role", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of users assigned to role." }, "value": { "type": "array", "description": "An array of userIds. If there are no userIds this will be an empty array.", "items": { "type": "string", "format": "uuid" } } } }, "iam-user-id-array-post": { "type": "object", "description": "A list of users to role", "required": [ "value" ], "properties": { "value": { "type": "array", "description": "An array of userIds. Must provide at least one userId.", "items": { "type": "string", "format": "uuid" } } } }, "iam-type-array": { "type": "object", "description": "A list of types", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of types" }, "value": { "type": "array", "description": "An array of types. If there are no types this will be an empty array.", "items": { "type": "object", "description": "A specific Client Type in Beeline", "required": [ "typeCode", "displayName" ], "properties": { "typeCode": { "type": "string", "description": "The code for the type" }, "displayName": { "type": "string", "description": "The name of the type" }, "description": { "type": "string", "description": "A description that explains purpose of the type" } } } } } }, "iam-type-code-array": { "type": "object", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of types assigned to user." }, "value": { "type": "array", "description": "An array of type codes. If there are no type codes this will be an empty array.", "items": { "type": "string" } } } }, "iam-type-display-name-description": { "type": "object", "description": "A specific user type in Beeline", "required": [ "displayName" ], "properties": { "displayName": { "type": "string", "description": "The name of the user type" }, "description": { "type": "string", "description": "A description that explains purpose of the user type" } } }, "spend-auth-currency-array": { "type": "object", "description": "A list of currencies", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of currencies" }, "value": { "type": "array", "description": "An array of currencies. If there are no currencies this will be an empty array.", "items": { "required": [ "displayName", "currencyCode" ], "type": "object", "properties": { "displayName": { "type": "string", "description": "Name of the currency", "maxLength": 3 }, "description": { "type": "string", "description": "Description of currency displayName", "maxLength": 255 }, "currencyCode": { "type": "string", "description": "A code uniquely identifying the currency", "maxLength": 3 } } } } } }, "spend-auth-currency": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Name of the currency", "maxLength": 3 }, "description": { "type": "string", "description": "Description of currency displayName", "maxLength": 255 }, "currencyCode": { "type": "string", "description": "A code uniquely identifying the currency", "maxLength": 3 } } }, "spend-auth-user-array": { "type": "object", "description": "A list of authorized spend type and amount by user", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of authorized spend type and amount by user" }, "value": { "type": "array", "description": "An array of authorized spend type and amount by user. If there are no authorized spend type and amount by users this will be an empty array.", "items": { "type": "object", "required": [ "spendType", "amount", "currencyCode", "userId" ], "properties": { "spendType": { "type": "string", "enum": [ "manager", "financial" ], "description": "- Manager represents spend authority for procurement spend\n- Financial represents spend authority for financial spend that will be invoiced\n" }, "amount": { "type": "integer", "description": "- An authorized whole number amount of spend allowed by the user.\n- Number must be greater than zero\n- Number must not contain any decimals\n", "maxLength": 10 }, "currencyCode": { "type": "string", "description": "An unique identifier for a currency", "maxLength": 3 }, "userId": { "type": "string", "description": "An identifier uniquely identifying the user", "format": "uuid" } } } } } }, "spend-auth-user": { "type": "object", "required": [ "spendType", "amount", "currencyCode", "userId" ], "properties": { "spendType": { "type": "string", "enum": [ "manager", "financial" ], "description": "- Manager represents spend authority for procurement spend\n- Financial represents spend authority for financial spend that will be invoiced\n" }, "amount": { "type": "integer", "description": "- An authorized whole number amount of spend allowed by the user.\n- Number must be greater than zero\n- Number must not contain any decimals\n", "maxLength": 10 }, "currencyCode": { "type": "string", "description": "An unique identifier for a currency", "maxLength": 3 }, "userId": { "type": "string", "description": "An identifier uniquely identifying the user", "format": "uuid" } } }, "spend-auth-add-request": { "type": "object", "description": "The spend authority is allowed by the given userId(s)", "required": [ "spendType", "amount", "currencyCode", "userIds" ], "properties": { "spendType": { "type": "string", "enum": [ "manager", "financial" ], "description": "- Manager represents spend authority for procurement spend\n- Financial represents spend authority for financial spend that will be invoiced\n" }, "amount": { "type": "integer", "description": "- An authorized whole number amount of spend allowed by the user.\n- Number must be greater than zero\n- Number must not contain any decimals\n", "maxLength": 10 }, "currencyCode": { "type": "string", "description": "A code uniquely identifying the currency for the amount.", "maxLength": 3 }, "userIds": { "type": "array", "description": "An array of userIds. There should be at least one userId.", "maxItems": 100, "items": { "type": "string", "format": "uuid" }, "uniqueItems": true } } }, "spend-auth-remove-request": { "type": "object", "description": "The spend authority to be removed by the given spendType, currencyCode and userId(s)", "required": [ "spendType", "currencyCode", "userIds" ], "properties": { "spendType": { "type": "string", "enum": [ "manager", "financial" ], "description": "- Manager represents spend authority for procurement spend\n- Financial represents spend authority for financial spend that will be invoiced\n" }, "currencyCode": { "type": "string", "description": "A code uniquely identifying the currency for the amount.", "maxLength": 3 }, "userIds": { "type": "array", "description": "An array of userIds. There should be at least one userId.", "maxItems": 100, "items": { "type": "string", "format": "uuid" }, "uniqueItems": true } } }, "country-list-response": { "type": "object", "description": "Information", "required": [ "countryCode", "displayName" ], "properties": { "countryCode": { "type": "string", "description": "An identifier for a country", "maxLength": 255 }, "displayName": { "type": "string", "description": "The name of the country", "maxLength": 255 }, "description": { "type": "string", "description": "The long description of the country", "maxLength": 255 } } }, "country-array": { "description": "A set of Countries", "type": "object", "properties": { "maxItems": { "type": "integer", "description": "The total number of items" }, "value": { "type": "array", "description": "The set of items. If there are no items, this will be an empty array.", "items": { "type": "object", "description": "Information", "required": [ "countryCode", "displayName" ], "properties": { "countryCode": { "type": "string", "description": "An identifier for a country", "maxLength": 255 }, "displayName": { "type": "string", "description": "The name of the country", "maxLength": 255 }, "description": { "type": "string", "description": "The long description of the country", "maxLength": 255 } } } } } }, "error": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } }, "error-response": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "empty-response": { "type": "null" }, "country": { "type": "object", "description": "Information", "required": [ "displayName" ], "properties": { "displayName": { "type": "string", "description": "The name of the country", "maxLength": 255 }, "description": { "type": "string", "description": "The long description of the country", "maxLength": 255 } } }, "state-list-response": { "type": "object", "description": "Information", "required": [ "displayName", "stateCode" ], "properties": { "stateCode": { "type": "string", "description": "An identifier for a state", "maxLength": 5 }, "displayName": { "type": "string", "description": "The name of the state", "maxLength": 255 }, "description": { "type": "string", "description": "The description of the state", "maxLength": 255 } } }, "state-array": { "description": "A set of States", "type": "object", "properties": { "maxItems": { "type": "integer", "description": "The total number of items" }, "value": { "type": "array", "description": "The set of items. If there are no items, this will be an empty array.", "items": { "type": "object", "description": "Information", "required": [ "displayName", "stateCode" ], "properties": { "stateCode": { "type": "string", "description": "An identifier for a state", "maxLength": 5 }, "displayName": { "type": "string", "description": "The name of the state", "maxLength": 255 }, "description": { "type": "string", "description": "The description of the state", "maxLength": 255 } } } } } }, "state": { "type": "object", "description": "Information", "required": [ "displayName" ], "properties": { "displayName": { "type": "string", "description": "The name of the state", "maxLength": 255 }, "description": { "type": "string", "description": "The description of the state", "maxLength": 255 } } }, "county-list-response": { "type": "object", "description": "Information", "required": [ "countyCode", "displayName" ], "properties": { "countyCode": { "type": "string", "description": "An identifier for a county", "maxLength": 255 }, "displayName": { "type": "string", "description": "The name of the county", "maxLength": 255 }, "description": { "type": "string", "description": "The long name of the county", "maxLength": 255 } } }, "county-array": { "description": "A set of Counties", "type": "object", "properties": { "maxItems": { "type": "integer", "description": "The total number of items" }, "value": { "type": "array", "description": "The set of items. If there are no items, this will be an empty array.", "items": { "type": "object", "description": "Information", "required": [ "countyCode", "displayName" ], "properties": { "countyCode": { "type": "string", "description": "An identifier for a county", "maxLength": 255 }, "displayName": { "type": "string", "description": "The name of the county", "maxLength": 255 }, "description": { "type": "string", "description": "The long name of the county", "maxLength": 255 } } } } } }, "county": { "type": "object", "description": "Information", "required": [ "displayName" ], "properties": { "displayName": { "type": "string", "description": "The name of the county", "maxLength": 255 }, "description": { "type": "string", "description": "The long name of the county", "maxLength": 255 } } }, "location-list-response": { "type": "object", "description": "A business location", "required": [ "displayName", "street1", "city", "countryCode", "stateCode", "postalCode", "locationCode" ], "properties": { "locationCode": { "type": "string", "description": "A code uniquely identifying the location", "maxLength": 255 }, "displayName": { "type": "string", "description": "The name of the location", "maxLength": 255 }, "description": { "type": "string", "description": "A description of the location", "maxLength": 255 }, "street1": { "type": "string", "description": "The primary street for this location", "maxLength": 150 }, "street2": { "type": "string", "description": "The secondary street for this location", "maxLength": 150 }, "city": { "type": "string", "description": "A string for storing the city of this location", "maxLength": 50 }, "countryCode": { "type": "string", "description": "A code uniquely identifying the country", "maxLength": 255 }, "stateCode": { "type": "string", "description": "A code uniquely identifying the state within a country", "maxLength": 5 }, "countyCode": { "type": "string", "description": "A code uniquely identifying the county", "maxLength": 255 }, "postalCode": { "type": "string", "description": "The postal code for this location", "maxLength": 10 }, "region": { "type": "string", "description": "The internal region of this location", "maxLength": 255 }, "phoneNumber": { "type": "string", "description": "A phone number for this location", "maxLength": 30 } } }, "location-array": { "type": "object", "description": "A list of locations", "properties": { "maxItems": { "type": "integer", "description": "The total number of locations" }, "value": { "type": "array", "description": "An array of locations. If there are no locations this will be an empty array.", "items": { "type": "object", "description": "A business location", "required": [ "displayName", "street1", "city", "countryCode", "stateCode", "postalCode", "locationCode" ], "properties": { "locationCode": { "type": "string", "description": "A code uniquely identifying the location", "maxLength": 255 }, "displayName": { "type": "string", "description": "The name of the location", "maxLength": 255 }, "description": { "type": "string", "description": "A description of the location", "maxLength": 255 }, "street1": { "type": "string", "description": "The primary street for this location", "maxLength": 150 }, "street2": { "type": "string", "description": "The secondary street for this location", "maxLength": 150 }, "city": { "type": "string", "description": "A string for storing the city of this location", "maxLength": 50 }, "countryCode": { "type": "string", "description": "A code uniquely identifying the country", "maxLength": 255 }, "stateCode": { "type": "string", "description": "A code uniquely identifying the state within a country", "maxLength": 5 }, "countyCode": { "type": "string", "description": "A code uniquely identifying the county", "maxLength": 255 }, "postalCode": { "type": "string", "description": "The postal code for this location", "maxLength": 10 }, "region": { "type": "string", "description": "The internal region of this location", "maxLength": 255 }, "phoneNumber": { "type": "string", "description": "A phone number for this location", "maxLength": 30 } } } } } }, "location": { "type": "object", "description": "A business location", "required": [ "displayName", "street1", "city", "countryCode", "stateCode", "postalCode" ], "properties": { "displayName": { "type": "string", "description": "The name of the location", "maxLength": 255 }, "description": { "type": "string", "description": "A description of the location", "maxLength": 255 }, "street1": { "type": "string", "description": "The primary street for this location", "maxLength": 150 }, "street2": { "type": "string", "description": "The secondary street for this location", "maxLength": 150 }, "city": { "type": "string", "description": "A string for storing the city of this location", "maxLength": 50 }, "countryCode": { "type": "string", "description": "A code uniquely identifying the country", "maxLength": 255 }, "stateCode": { "type": "string", "description": "A code uniquely identifying the state within a country", "maxLength": 5 }, "countyCode": { "type": "string", "description": "A code uniquely identifying the county", "maxLength": 255 }, "postalCode": { "type": "string", "description": "The postal code for this location", "maxLength": 10 }, "region": { "type": "string", "description": "The internal region of this location", "maxLength": 255 }, "phoneNumber": { "type": "string", "description": "A phone number for this location", "maxLength": 30 } } }, "ou-type": { "type": "object", "properties": { "description": { "type": "string", "maxLength": 255 } } }, "ou-type-array": { "type": "object", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer" }, "value": { "type": "array", "items": { "required": [ "ouTypeDisplayName" ], "properties": { "ouTypeDisplayName": { "type": "string", "maxLength": 255 } }, "type": "object" } } } }, "organization": { "type": "object", "required": [ "displayName" ], "properties": { "displayName": { "type": "string", "maxLength": 255, "description": "Organization Name" }, "description": { "type": "string", "maxLength": 255, "description": "Description of Organization Display Name" } } }, "organization-array": { "type": "object", "description": "A list of Organizations", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of Organizations" }, "value": { "type": "array", "description": "An array of Organizations. If there are no Organizations this will be an empty array.", "items": { "required": [ "organizationCode", "displayName" ], "properties": { "organizationCode": { "type": "string", "description": "A code uniquely identifying the Organization", "maxLength": 50 }, "displayName": { "type": "string", "maxLength": 255, "description": "Organization Name" }, "description": { "type": "string", "maxLength": 255, "description": "Description of Organization Display Name" } }, "type": "object" } } } }, "ou-summary": { "type": "object", "required": [ "ouCode" ], "properties": { "ouCode": { "type": "string", "maxLength": 50, "description": "The organization unit code." } } }, "ou-array": { "type": "object", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer" }, "value": { "type": "array", "items": { "type": "object", "required": [ "ouCode" ], "properties": { "ouCode": { "type": "string", "maxLength": 50, "description": "The organization unit code." } } } } } }, "ou": { "type": "object", "required": [ "displayName", "ouTypeDisplayName" ], "properties": { "displayName": { "type": "string", "maxLength": 255 }, "description": { "type": "string", "maxLength": 255 }, "parentOuCode": { "type": "string", "maxLength": 50 }, "ouTypeDisplayName": { "type": "string", "maxLength": 255 }, "externalId": { "type": "string", "maxLength": 255, "description": "Used to store WorkDay specific identifiers" } } }, "cost-center": { "type": "object", "properties": { "displayName": { "type": "string", "description": "The Name of the Cost Center", "maxLength": 255 }, "description": { "type": "string", "description": "A description of the Cost Center", "maxLength": 255 }, "billable": { "type": "boolean", "description": "A flag indicating whether the Cost Center is billable. If no value is supplied, then this will default to \"false\"." }, "externalId": { "type": "string", "description": "A unique identifier a client can provide that can be managed externally from Beeline's VMS.", "maxLength": 255 } } }, "cost-center-array": { "type": "object", "description": "A list of Cost Centers", "properties": { "maxItems": { "type": "integer", "description": "The total number of Cost Centers" }, "value": { "type": "array", "description": "An array of Cost Centers. If there are no Cost Centers this will be an empty array.", "items": { "properties": { "costCenterNumber": { "type": "string", "description": "A code uniquely identifying the Cost Center", "maxLength": 100 } }, "type": "object" } } } }, "detailed-cost-center": { "type": "object", "description": "A detailed cost center", "required": [ "costCenterId", "costCenterNumber", "organizationCode", "ouCode", "billable" ], "properties": { "costCenterId": { "type": "string", "format": "uuid", "description": "The id of the cost center" }, "costCenterNumber": { "type": "string", "description": "The number of the cost center", "maxLength": 100 }, "displayName": { "type": "string", "description": "The name of the cost center", "maxLength": 255 }, "description": { "type": "string", "description": "A description of the cost center", "maxLength": 255 }, "organizationCode": { "type": "string", "description": "The code of the organization for this cost center", "maxLength": 50 }, "ouCode": { "type": "string", "description": "The code of the organization unit for this cost center", "maxLength": 50 }, "billable": { "type": "boolean", "description": "Billable flag of this cost center" }, "externalId": { "type": "string", "description": "The external ID of the cost center", "maxLength": 255 } } }, "user-id-array-post": { "type": "object", "description": "A list of users to role", "required": [ "value" ], "properties": { "value": { "type": "array", "description": "An array of userIds. Must provide at least one userId.", "items": { "type": "string", "format": "uuid" } } } }, "user-ou-array": { "type": "object", "description": "A list of ou domain types for a user", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of ou domain types" }, "value": { "type": "array", "description": "An array of client ou domain types. If there are no ou domain types this will be an empty array.", "items": { "required": [ "ouCode", "domainType" ], "properties": { "ouCode": { "type": "string", "description": "Organizational Unit unique identifier", "maxLength": 50 }, "domainType": { "type": "string", "description": "Domain type a user can be assigned (owner, assistant, controller, mspRepresentative)" } } } } } }, "ou-user": { "type": "object", "required": [ "userId", "domainType" ], "properties": { "userId": { "type": "string", "description": "An identifier uniquely identifying the user", "example": "d63ff17f-95dd-44ff-b1df-b64fe705c9c9", "format": "uuid" }, "domainType": { "type": "string", "description": "Domain type a user can be assigned (owner, assistant, controller, msp-representative)" } } }, "ou-user-array": { "type": "object", "description": "A list of ou users", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of ou users" }, "value": { "type": "array", "description": "An array of ou users. If there are no ou users this will be an empty array.", "items": { "type": "object", "required": [ "userId", "domainType" ], "properties": { "userId": { "type": "string", "description": "An identifier uniquely identifying the user", "example": "d63ff17f-95dd-44ff-b1df-b64fe705c9c9", "format": "uuid" }, "domainType": { "type": "string", "description": "Domain type a user can be assigned (owner, assistant, controller, msp-representative)" } } } } } }, "cc-user": { "type": "object", "properties": { "ownerUserId": { "type": [ "string", "null" ], "description": "An identifier uniquely identifying the user", "example": "ce6fd7c5-61c9-4f05-969b-5266a2a884a8", "format": "uuid" }, "assistantUserId": { "type": [ "string", "null" ], "description": "An identifier uniquely identifying the user", "example": "281ba412-9193-4a53-a87a-a445abe7d2ca", "format": "uuid" }, "controllerUserId": { "type": [ "string", "null" ], "description": "An identifier uniquely identifying the user", "example": "150efd42-611f-4e61-acbe-44614631fee5", "format": "uuid" } } }, "business-area-list-response": { "type": "object", "description": "An area of business, category of business within a client organization which is used for grouping Functional Partitions.", "required": [ "businessAreaCode", "displayName" ], "properties": { "businessAreaCode": { "type": "string", "description": "A code uniquely identifying the business area", "maxLength": 255 }, "displayName": { "type": "string", "description": "The name of the business area", "maxLength": 255 }, "description": { "type": "string", "description": "A description of the business area", "maxLength": 255 } } }, "business-area-array": { "type": "object", "description": "A list of business areas", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of business areas" }, "value": { "type": "array", "description": "An array of business areas. If there are no business areas this will be an empty array.", "items": { "type": "object", "description": "An area of business, category of business within a client organization which is used for grouping Functional Partitions.", "required": [ "businessAreaCode", "displayName" ], "properties": { "businessAreaCode": { "type": "string", "description": "A code uniquely identifying the business area", "maxLength": 255 }, "displayName": { "type": "string", "description": "The name of the business area", "maxLength": 255 }, "description": { "type": "string", "description": "A description of the business area", "maxLength": 255 } } } } } }, "business-area": { "type": "object", "description": "An area of business, category of business within a client organization which is used for grouping Functional Partitions.", "required": [ "displayName" ], "properties": { "displayName": { "type": "string", "description": "The name of the business area", "maxLength": 255 }, "description": { "type": "string", "description": "A description of the business area", "maxLength": 255 } } }, "functional-partition-list-response": { "type": "object", "description": "A sub-organization, sub-component, sub-function, or business partition within a client organization which are associated to one Business Area.", "required": [ "displayName", "functionalPartitionCode" ], "properties": { "functionalPartitionCode": { "type": "string", "description": "A code uniquely identifying the functional partition", "maxLength": 255 }, "displayName": { "type": "string", "description": "The name of the functional partition", "maxLength": 255 }, "description": { "type": "string", "description": "A description of the functional partition", "maxLength": 255 } } }, "functional-partition-array": { "type": "object", "description": "A list of functional partitions", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of functional partitions" }, "value": { "type": "array", "description": "An array of functional partitions. If there are no functional partitions this will be an empty array.", "items": { "type": "object", "description": "A sub-organization, sub-component, sub-function, or business partition within a client organization which are associated to one Business Area.", "required": [ "displayName", "functionalPartitionCode" ], "properties": { "functionalPartitionCode": { "type": "string", "description": "A code uniquely identifying the functional partition", "maxLength": 255 }, "displayName": { "type": "string", "description": "The name of the functional partition", "maxLength": 255 }, "description": { "type": "string", "description": "A description of the functional partition", "maxLength": 255 } } } } } }, "functional-partition": { "type": "object", "description": "A sub-organization, sub-component, sub-function, or business partition within a client organization which are associated to one Business Area.", "required": [ "displayName" ], "properties": { "displayName": { "type": "string", "description": "The name of the functional partition", "maxLength": 255 }, "description": { "type": "string", "description": "A description of the functional partition", "maxLength": 255 } } }, "language-code": { "type": "object", "description": "Retrieve a list of Culture Name (Language Codes)", "required": [ "languageCode" ], "properties": { "languageCode": { "type": "string", "description": "A uniquely identifying language code, like en-US", "maxLength": 50 } } }, "language-code-array": { "type": "object", "description": "A list of language codes", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of language codes" }, "value": { "type": "array", "description": "An array of language codes. If there are no language codes this will be an empty array.", "items": { "required": [ "languageCode" ], "type": "object", "description": "Retrieve a list of Culture Name (Language Codes)", "properties": { "languageCode": { "type": "string", "description": "A uniquely identifying language code, like en-US", "maxLength": 50 } } } } } }, "user-with-id": { "type": "object", "description": "A user", "required": [ "userId", "userName", "firstName", "lastName", "organizationCode", "ouCode", "costCenterNumber", "languageCode", "locationCode" ], "properties": { "userId": { "type": "string", "format": "uuid", "description": "Uniquely identifies a user" }, "userName": { "type": "string", "description": "The unique user name of the user", "maxLength": 50 }, "firstName": { "type": "string", "description": "First name of the user", "maxLength": 100 }, "middleName": { "type": "string", "description": "Middle name of the user", "maxLength": 100 }, "lastName": { "type": "string", "description": "Last name of the user", "maxLength": 100 }, "localizedFirstName": { "type": "string", "description": "Localized first name of the user in local culture and language", "maxLength": 100 }, "localizedMiddleName": { "type": "string", "description": "Localized middle name of the user in local culture and language", "maxLength": 100 }, "localizedLastName": { "type": "string", "description": "Localized last name of the user in local culture and language", "maxLength": 100 }, "secondaryLastName": { "type": "string", "description": "Secondary last name of the user", "maxLength": 100 }, "email": { "type": "string", "description": "The work email address of the user", "maxLength": 255 }, "title": { "type": "string", "description": "The assigned title of the user", "maxLength": 255 }, "managerUserName": { "type": "string", "description": "The reporting manager of the user", "maxLength": 50 }, "organizationCode": { "type": "string", "description": "The parent organization to which the user belongs", "maxLength": 50 }, "ouCode": { "type": "string", "description": "The organizational unit within organization to which the user belongs", "maxLength": 50 }, "costCenterNumber": { "type": "string", "description": "The default bill to cost center for the user", "maxLength": 100 }, "locationCode": { "type": "string", "description": "A code uniquely identifying the location", "maxLength": 255 }, "languageCode": { "type": "string", "description": "A uniquely identifying language code, like en-US", "maxLength": 20 } } }, "user-array": { "type": "object", "description": "A list of users", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of users" }, "value": { "type": "array", "description": "An array of users. If there are no users this will be an empty array.", "items": { "type": "object", "description": "A user", "required": [ "userId", "userName", "firstName", "lastName", "organizationCode", "ouCode", "costCenterNumber", "languageCode", "locationCode" ], "properties": { "userId": { "type": "string", "format": "uuid", "description": "Uniquely identifies a user" }, "userName": { "type": "string", "description": "The unique user name of the user", "maxLength": 50 }, "firstName": { "type": "string", "description": "First name of the user", "maxLength": 100 }, "middleName": { "type": "string", "description": "Middle name of the user", "maxLength": 100 }, "lastName": { "type": "string", "description": "Last name of the user", "maxLength": 100 }, "localizedFirstName": { "type": "string", "description": "Localized first name of the user in local culture and language", "maxLength": 100 }, "localizedMiddleName": { "type": "string", "description": "Localized middle name of the user in local culture and language", "maxLength": 100 }, "localizedLastName": { "type": "string", "description": "Localized last name of the user in local culture and language", "maxLength": 100 }, "secondaryLastName": { "type": "string", "description": "Secondary last name of the user", "maxLength": 100 }, "email": { "type": "string", "description": "The work email address of the user", "maxLength": 255 }, "title": { "type": "string", "description": "The assigned title of the user", "maxLength": 255 }, "managerUserName": { "type": "string", "description": "The reporting manager of the user", "maxLength": 50 }, "organizationCode": { "type": "string", "description": "The parent organization to which the user belongs", "maxLength": 50 }, "ouCode": { "type": "string", "description": "The organizational unit within organization to which the user belongs", "maxLength": 50 }, "costCenterNumber": { "type": "string", "description": "The default bill to cost center for the user", "maxLength": 100 }, "locationCode": { "type": "string", "description": "A code uniquely identifying the location", "maxLength": 255 }, "languageCode": { "type": "string", "description": "A uniquely identifying language code, like en-US", "maxLength": 20 } } } } } }, "user-without-id": { "type": "object", "description": "A user", "required": [ "userName", "firstName", "lastName", "organizationCode", "ouCode", "costCenterNumber", "languageCode", "locationCode" ], "properties": { "userName": { "type": "string", "description": "The unique user name of the user", "maxLength": 50 }, "firstName": { "type": "string", "description": "First name of the user", "maxLength": 100 }, "middleName": { "type": "string", "description": "Middle name of the user", "maxLength": 100 }, "lastName": { "type": "string", "description": "Last name of the user", "maxLength": 100 }, "localizedFirstName": { "type": "string", "description": "Localized first name of the user in local culture and language", "maxLength": 100 }, "localizedMiddleName": { "type": "string", "description": "Localized middle name of the user in local culture and language", "maxLength": 100 }, "localizedLastName": { "type": "string", "description": "Localized last name of the user in local culture and language", "maxLength": 100 }, "secondaryLastName": { "type": "string", "description": "Secondary last name of the user", "maxLength": 100 }, "email": { "type": "string", "description": "The work email address of the user", "maxLength": 255 }, "title": { "type": "string", "description": "The assigned title of the user", "maxLength": 255 }, "managerUserName": { "type": "string", "description": "The reporting manager of the user", "maxLength": 50 }, "organizationCode": { "type": "string", "description": "The parent organization to which the user belongs", "maxLength": 50 }, "ouCode": { "type": "string", "description": "The organizational unit within organization to which the user belongs", "maxLength": 50 }, "costCenterNumber": { "type": "string", "description": "The default bill to cost center for the user", "maxLength": 100 }, "locationCode": { "type": "string", "description": "A code uniquely identifying the location", "maxLength": 255 }, "languageCode": { "type": "string", "description": "A uniquely identifying language code, like en-US", "maxLength": 20 } } }, "role": { "type": "object", "description": "A specific client role in Beeline", "required": [ "roleCode", "displayName" ], "properties": { "roleCode": { "type": "string", "description": "The code for the role" }, "displayName": { "type": "string", "description": "The name of the role" }, "description": { "type": "string", "description": "A description that explains purpose of the role" } } }, "role-array": { "type": "object", "description": "A list of roles", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of roles" }, "value": { "type": "array", "description": "An array of roles. If there are no roles this will be an empty array.", "items": { "type": "object", "description": "A specific client role in Beeline", "required": [ "roleCode", "displayName" ], "properties": { "roleCode": { "type": "string", "description": "The code for the role" }, "displayName": { "type": "string", "description": "The name of the role" }, "description": { "type": "string", "description": "A description that explains purpose of the role" } } } } } }, "role-display-name-description": { "type": "object", "description": "A specific client role in Beeline", "required": [ "displayName" ], "properties": { "displayName": { "type": "string", "description": "The name of the role", "maxLength": 255 }, "description": { "type": "string", "description": "A description that explains purpose of the role", "maxLength": 255 } } }, "user-id-array": { "type": "object", "description": "A list of users to role", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of users assigned to role." }, "value": { "type": "array", "description": "An array of userIds. If there are no userIds this will be an empty array.", "items": { "type": "string", "format": "uuid" } } } }, "role-code-array": { "type": "object", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of roles assigned to user." }, "value": { "type": "array", "description": "An array of role codes. If there are no role codes this will be an empty array.", "items": { "type": "string" } } } }, "type": { "type": "object", "description": "A specific Client Type in Beeline", "required": [ "typeCode", "displayName" ], "properties": { "typeCode": { "type": "string", "description": "The code for the type" }, "displayName": { "type": "string", "description": "The name of the type" }, "description": { "type": "string", "description": "A description that explains purpose of the type" } } }, "type-array": { "type": "object", "description": "A list of types", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of types" }, "value": { "type": "array", "description": "An array of types. If there are no types this will be an empty array.", "items": { "type": "object", "description": "A specific Client Type in Beeline", "required": [ "typeCode", "displayName" ], "properties": { "typeCode": { "type": "string", "description": "The code for the type" }, "displayName": { "type": "string", "description": "The name of the type" }, "description": { "type": "string", "description": "A description that explains purpose of the type" } } } } } }, "type-display-name-description": { "type": "object", "description": "A specific user type in Beeline", "required": [ "displayName" ], "properties": { "displayName": { "type": "string", "description": "The name of the user type" }, "description": { "type": "string", "description": "A description that explains purpose of the user type" } } }, "type-code-array": { "type": "object", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of types assigned to user." }, "value": { "type": "array", "description": "An array of type codes. If there are no type codes this will be an empty array.", "items": { "type": "string" } } } }, "currency-model": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Name of the currency", "maxLength": 3 }, "description": { "type": "string", "description": "Description of currency displayName", "maxLength": 255 }, "currencyCode": { "type": "string", "description": "A code uniquely identifying the currency", "maxLength": 3 } } }, "currency-model-array": { "type": "object", "description": "A list of currencies", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of currencies" }, "value": { "type": "array", "description": "An array of currencies. If there are no currencies this will be an empty array.", "items": { "required": [ "displayName", "currencyCode" ], "type": "object", "properties": { "displayName": { "type": "string", "description": "Name of the currency", "maxLength": 3 }, "description": { "type": "string", "description": "Description of currency displayName", "maxLength": 255 }, "currencyCode": { "type": "string", "description": "A code uniquely identifying the currency", "maxLength": 3 } } } } } }, "user-model": { "type": "object", "required": [ "spendType", "amount", "currencyCode", "userId" ], "properties": { "spendType": { "type": "string", "enum": [ "manager", "financial" ], "description": "- Manager represents spend authority for procurement spend\n- Financial represents spend authority for financial spend that will be invoiced\n" }, "amount": { "type": "integer", "description": "- An authorized whole number amount of spend allowed by the user.\n- Number must be greater than zero\n- Number must not contain any decimals\n", "maxLength": 10 }, "currencyCode": { "type": "string", "description": "An unique identifier for a currency", "maxLength": 3 }, "userId": { "type": "string", "description": "An identifier uniquely identifying the user", "format": "uuid" } } }, "user-model-array": { "type": "object", "description": "A list of authorized spend type and amount by user", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of authorized spend type and amount by user" }, "value": { "type": "array", "description": "An array of authorized spend type and amount by user. If there are no authorized spend type and amount by users this will be an empty array.", "items": { "type": "object", "required": [ "spendType", "amount", "currencyCode", "userId" ], "properties": { "spendType": { "type": "string", "enum": [ "manager", "financial" ], "description": "- Manager represents spend authority for procurement spend\n- Financial represents spend authority for financial spend that will be invoiced\n" }, "amount": { "type": "integer", "description": "- An authorized whole number amount of spend allowed by the user.\n- Number must be greater than zero\n- Number must not contain any decimals\n", "maxLength": 10 }, "currencyCode": { "type": "string", "description": "An unique identifier for a currency", "maxLength": 3 }, "userId": { "type": "string", "description": "An identifier uniquely identifying the user", "format": "uuid" } } } } } }, "add-spend-auth-user-request-model": { "type": "object", "description": "The spend authority is allowed by the given userId(s)", "required": [ "spendType", "amount", "currencyCode", "userIds" ], "properties": { "spendType": { "type": "string", "enum": [ "manager", "financial" ], "description": "- Manager represents spend authority for procurement spend\n- Financial represents spend authority for financial spend that will be invoiced\n" }, "amount": { "type": "integer", "description": "- An authorized whole number amount of spend allowed by the user.\n- Number must be greater than zero\n- Number must not contain any decimals\n", "maxLength": 10 }, "currencyCode": { "type": "string", "description": "A code uniquely identifying the currency for the amount.", "maxLength": 3 }, "userIds": { "type": "array", "description": "An array of userIds. There should be at least one userId.", "maxItems": 100, "items": { "type": "string", "format": "uuid" }, "uniqueItems": true } } }, "remove-spend-auth-user-request-model": { "type": "object", "description": "The spend authority to be removed by the given spendType, currencyCode and userId(s)", "required": [ "spendType", "currencyCode", "userIds" ], "properties": { "spendType": { "type": "string", "enum": [ "manager", "financial" ], "description": "- Manager represents spend authority for procurement spend\n- Financial represents spend authority for financial spend that will be invoiced\n" }, "currencyCode": { "type": "string", "description": "A code uniquely identifying the currency for the amount.", "maxLength": 3 }, "userIds": { "type": "array", "description": "An array of userIds. There should be at least one userId.", "maxItems": 100, "items": { "type": "string", "format": "uuid" }, "uniqueItems": true } } }, "inner-error": { "type": "object", "description": "An object containing more specific information than the current object about the error.", "properties": { "code": { "type": "string", "description": "A more specific error code than was provided by the containing error." }, "innerError": { "type": "object", "description": "The Inner Error object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes" }, "message": { "type": "string", "description": "a human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error." } } } } }, "error-inner": { "type": "object", "description": "The Error object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes" }, "message": { "type": "string", "description": "a human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error." }, "details": { "type": "array", "description": "An array of details about specific errors that led to this reported error.", "items": { "type": "object", "description": "The Specific Error object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes" }, "message": { "type": "string", "description": "a human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error." } } } }, "innerError": { "type": "object", "description": "An object containing more specific information than the current object about the error.", "properties": { "code": { "type": "string", "description": "A more specific error code than was provided by the containing error." }, "innerError": { "type": "object", "description": "The Inner Error object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes" }, "message": { "type": "string", "description": "a human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error." } } } } } } }, "error-response-inner": { "type": "object", "description": "An Error Response.", "required": [ "error" ], "properties": { "error": { "type": "object", "description": "The Error object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes" }, "message": { "type": "string", "description": "a human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error." }, "details": { "type": "array", "description": "An array of details about specific errors that led to this reported error.", "items": { "type": "object", "description": "The Specific Error object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes" }, "message": { "type": "string", "description": "a human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error." } } } }, "innerError": { "type": "object", "description": "An object containing more specific information than the current object about the error.", "properties": { "code": { "type": "string", "description": "A more specific error code than was provided by the containing error." }, "innerError": { "type": "object", "description": "The Inner Error object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes" }, "message": { "type": "string", "description": "a human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error." } } } } } } } } } }, "examples": { "detailed-cost-center-array": { "value": { "maxItems": 2, "value": [ { "costCenterId": "12576b49-e5d8-48ef-9ec8-9e7c6d13ec56", "costCenterNumber": "abcd", "displayName": "Main Cost Center", "description": "Main Cost Center for abcd", "organizationCode": "acc", "ouCode": "ou1", "billable": true, "externalId": "external-system-identifier" }, { "costCenterId": "40bfc100-83fa-4aee-9006-b51b47869f5a", "costCenterNumber": "qrst", "displayName": "Cost Center 5", "description": "Cost Center 5 for qrst", "organizationCode": "acc", "ouCode": "ou1", "billable": true } ] } }, "location-country-array": { "value": { "maxItems": 5, "value": [ { "countryCode": "AE", "displayName": "The United Arab Emirates", "description": "Country of UAE" }, { "countryCode": "GB", "displayName": "The United Kingdom of Great Britain and Northern Ireland", "description": "Country of England" }, { "countryCode": "UM", "displayName": "United States Minor Outlying Islands", "description": "Country of USA MOI" }, { "countryCode": "US", "displayName": "The United States of America", "description": "Country of USA" }, { "countryCode": "UZ", "displayName": "The Republic of Uzbekistan", "description": "Country of Uzbekistan" } ] } }, "location-country": { "value": { "displayName": "The United States of America", "description": "Country of USA" } }, "location-state-array": { "value": { "maxItems": 5, "value": [ { "stateCode": "AL", "displayName": "Alabama", "description": "Alabama State" }, { "stateCode": "AK", "displayName": "Alaska", "description": "Alaska State" }, { "stateCode": "AZ", "displayName": "Arizona", "description": "Arizona State" }, { "stateCode": "AR", "displayName": "Arkansas", "description": "Arkansas State" }, { "stateCode": "CA", "displayName": "California", "description": "California State" } ] } }, "location-state": { "value": { "displayName": "California", "description": "California State" } }, "location-county-array": { "value": { "maxItems": 5, "value": [ { "countyCode": "001", "displayName": "Alameda", "description": "Alameda County" }, { "countyCode": "002", "displayName": "Alpine", "description": "Alpine County" }, { "countyCode": "005", "displayName": "Amador", "description": "Amador County" }, { "countyCode": "007", "displayName": "Butte", "description": "Butte County" }, { "countyCode": "009", "displayName": "Calaveras", "description": "Calaveras County" } ] } }, "location-county": { "value": { "displayName": "Alameda", "description": "Alameda County" } }, "location-location-array": { "value": { "maxItems": 2, "value": [ { "locationCode": "Alameda", "displayName": "Main Office", "description": "Main Office Location", "street1": "123 Example Dr", "street2": "Building 3A", "city": "Alameda", "countryCode": "US", "stateCode": "CA", "countyCode": "001", "postalCode": "94501", "region": "Pacific", "phoneNumber": "619-555-1212" }, { "locationCode": "Houston", "displayName": "Houston Branch Office", "description": "Houston Branch Office Location", "street1": "456 Example Ave", "street2": "Box 1234", "city": "Houston", "countryCode": "US", "stateCode": "TX", "countyCode": "201", "postalCode": "77080", "region": "South", "phoneNumber": "281-555-1212" } ] } }, "location-location": { "value": { "displayName": "Main Office", "description": "Main Office Location", "street1": "123 Example Dr", "street2": "Building 3A", "city": "Alameda", "countryCode": "US", "stateCode": "CA", "countyCode": "001", "postalCode": "94501", "region": "Pacific", "phoneNumber": "619-555-1212" } }, "org-organization-array": { "value": { "maxItems": 2, "value": [ { "organizationCode": "acc", "displayName": "Accounting", "description": "Accounting Organization" }, { "organizationCode": "fin", "displayName": "Finance", "description": "Finance Organization" } ] } }, "org-organization": { "value": { "displayName": "Accounting", "description": "Accounting Organization" } }, "org-cost-center-array": { "value": { "maxItems": 5, "value": [ { "costCenterNumber": "abcd", "displayName": "Main Cost Center", "description": "Main Cost Center for abcd", "billable": true, "externalId": "external-system-identifier" }, { "costCenterNumber": "efgh", "displayName": "Cost Center 2", "description": "Cost Center 2 for efgh" }, { "costCenterNumber": "ijkl", "displayName": "Cost Center 3", "description": "Cost Center 3 for ijkl", "billable": false }, { "costCenterNumber": "mnop", "displayName": "Cost Center 4", "description": "Cost Center 5 for mnop", "billable": true }, { "costCenterNumber": "qrst", "displayName": "Cost Center 5", "description": "Cost Center 5 for qrst", "billable": true } ] } }, "org-cost-center": { "value": { "displayName": "Main Cost Center", "description": "Main Cost Center for abcd", "billable": true, "externalId": "external-system-identifier" } }, "org-ou-type-array": { "value": { "maxItems": 4, "value": [ { "ouTypeDisplayName": "outype1", "description": "Description of OU Type1" }, { "ouTypeDisplayName": "outype2", "description": "Description of OU Type2" }, { "ouTypeDisplayName": "outype3", "description": "Description of OU Type3" }, { "ouTypeDisplayName": "outype4", "description": "Description of OU Type4" } ] } }, "org-ou-type": { "value": { "description": "Description of OU Type1" } }, "org-ou-array": { "value": { "maxItems": 5, "value": [ { "ouCode": "ou1" }, { "ouCode": "ou2" }, { "ouCode": "ou3" }, { "ouCode": "ou4" }, { "ouCode": "ou5" } ] } }, "org-ou": { "value": { "displayName": "OU", "description": "Description of OU Display Name", "parentOuCode": "parentOU", "ouTypeDisplayName": "outype1", "externalId": "WRD-001" } }, "org-user-id-single": { "summary": "Single userId", "value": [ "98500cf5-40bb-4209-bf44-fb76e52f55eb" ] }, "org-user-id-array": { "summary": "List of userIds", "value": [ "d9d2a502-eb16-43a3-a9b7-40880b27c6f1", "0fef347c-6415-4c7d-b120-1d29163bab05", "ca7adf26-c9d5-4966-bf8a-997eb307f3c0" ] }, "org-user-ou-array": { "value": { "maxItems": 3, "value": [ { "ouCode": "ou1", "domainType": "owner" }, { "ouCode": "ou2", "domainType": "owner" }, { "ouCode": "ou3", "domainType": "controller" } ] } }, "org-ou-user-array": { "value": { "maxItems": 3, "value": [ { "userId": "07164c59-2a8d-4034-8283-6440c24e58ff", "domainType": "owner" }, { "userId": "b6024aa6-84cf-45eb-a3e9-7c7e86a66b58", "domainType": "controller" }, { "userId": "486d2399-52d3-4757-b523-ed6e0529c867", "domainType": "mspRepresentative" } ] } }, "org-cc-user": { "summary": "Complete example", "value": { "ownerUserId": "0ce6fd7c5-61c9-4f05-969b-5266a2a884a8", "assistantUserId": "281ba412-9193-4a53-a87a-a445abe7d2ca", "controllerUserId": "150efd42-611f-4e61-acbe-44614631fee5" } }, "org-cc-user-null": { "summary": "Partial example", "value": { "ownerUserId": null, "assistantUserId": "281ba412-9193-4a53-a87a-a445abe7d2ca", "controllerUserId": null } }, "ba-business-area-array": { "value": { "maxItems": 2, "value": [ { "businessAreaCode": "ADM", "displayName": "Administration", "description": "Administration Business Unit" }, { "businessAreaCode": "IT", "displayName": "Information Technology", "description": "Information Technology and Services Business Unit" } ] } }, "ba-business-area": { "value": { "displayName": "Administration", "description": "Administration Business Unit" } }, "ba-functional-partition-array": { "value": { "maxItems": 2, "value": [ { "functionalPartitionCode": "AC", "displayName": "Audit and Compliance", "description": "Audit and Compliance Segment" }, { "functionalPartitionCode": "ISC", "displayName": "InfoSec", "description": "Information Security and Compliance Segment" } ] } }, "ba-functional-partition": { "value": { "displayName": "Audit and Compliance", "description": "Audit and Compliance Segment" } }, "user-language-code-array": { "value": { "maxItems": 2, "value": [ { "languageCode": "en-GB" }, { "languageCode": "en-US" } ] } }, "user-user-array": { "value": { "maxItems": 2, "value": [ { "userId": "a53cdeee-fa3a-44af-be6b-7f5b37816982", "userName": "X987123", "firstName": "Molly", "middleName": "Beverly", "lastName": "Howe", "localizedFirstName": "Polly", "localizedMiddleName": "Bev", "localizedLastName": "Red", "secondaryLastName": "van Zijl", "email": "pred@domain.com", "title": "VP of Procurement", "managerUserName": "32109121116", "organizationCode": "Company A", "ouCode": "Division B", "costCenterNumber": "9097", "locationCode": "Alameda", "languageCode": "en-GB" }, { "userId": "53ceeefa-cb73-464d-ba62-90954fb14e58", "userName": "X2771321", "firstName": "Patrick", "middleName": "Stanley", "lastName": "Roy", "localizedFirstName": "Pat", "localizedMiddleName": "Stan", "localizedLastName": "Wha", "secondaryLastName": "van der Meer", "email": "proy@domain.com", "title": "VP of Automation Services", "managerUserName": "32109121116", "organizationalCode": "Company Z", "ouCode": "Division A", "costCenterNumber": "7173", "locationCode": "Houston", "languageCode": "en-US" } ] } }, "user-user-without-id": { "value": { "userName": "X987123", "firstName": "Molly", "middleName": "Beverly", "lastName": "Howe", "localizedFirstName": "Polly", "localizedMiddleName": "Bev", "localizedLastName": "Red", "secondaryLastName": "van Zijl", "email": "pred@domain.com", "title": "VP of Procurement", "managerUserName": "32109121116", "organizationCode": "Company A", "ouCode": "Division B", "costCenterNumber": "9097", "locationCode": "Alameda", "languageCode": "en-GB" } }, "user-user-with-id": { "value": { "userId": "a53cdeee-fa3a-44af-be6b-7f5b37816982", "userName": "X987123", "firstName": "Molly", "middleName": "Beverly", "lastName": "Howe", "localizedFirstName": "Polly", "localizedMiddleName": "Bev", "localizedLastName": "Red", "secondaryLastName": "van Zijl", "email": "pred@domain.com", "title": "VP of Procurement", "managerUserName": "32109121116", "organizationCode": "Company A", "ouCode": "Division B", "costCenterNumber": "9097", "locationCode": "Alameda", "languageCode": "en-GB" } }, "iam-role-display-name-description": { "value": { "displayName": "Hiring Manager", "description": "Client Hiring Manager" } }, "iam-role-array": { "value": { "maxItems": 3, "value": [ { "roleCode": "HM-1", "displayName": "Hiring Manager", "description": "Client Hiring Manager" }, { "roleCode": "RPT", "displayName": "Reporting", "description": "Advanced Reporting" }, { "roleCode": "FIN-APV", "displayName": "Financial Approver", "description": "Approver that has proper fiduciary responsibility" } ] } }, "iam-role-code-array": { "value": { "maxItems": 2, "value": [ "HM-1", "FIN-APV" ] } }, "iam-user-id-array": { "value": { "maxItems": 3, "value": [ "ed4bf9d0-e2ed-4e89-9b29-21e97d6a8e89", "bc43cc1b-edd0-46b8-9216-0f7d49606b23", "6a7c621a-3c82-4fcc-85ae-37f289405efa" ] } }, "iam-user-id-array-post": { "summary": "List of userIds", "value": [ "d9d2a502-eb16-43a3-a9b7-40880b27c6f1", "0fef347c-6415-4c7d-b120-1d29163bab05", "ca7adf26-c9d5-4966-bf8a-997eb307f3c0" ] }, "iam-type-code-array": { "value": { "maxItems": 2, "value": [ "FIN-EVP", "FIN-APV" ] } }, "iam-user-id-single-post": { "summary": "Single userId", "value": [ "98500cf5-40bb-4209-bf44-fb76e52f55eb" ] }, "iam-type-array": { "value": { "maxItems": 2, "value": [ { "typeCode": "FIN-EVP", "displayName": "Financial Reporting - EVP", "description": "Financial Executive Reporting" }, { "typeCode": "FIN-APV", "displayName": "Financial Approver", "description": "Budget Approver for Contingent Labor" } ] } }, "iam-type-display-name-description": { "value": { "displayName": "Financial Reporting - EVP", "description": "Financial Executive Reporting" } }, "spend-auth-user-array": { "value": { "maxItems": 3, "value": [ { "spendType": "manager", "amount": 5000, "currencyCode": "USD", "userId": "e4acdfa5-5aee-4b9f-8dd1-67b401f5cb5d" }, { "spendType": "manager", "amount": 30000, "currencyCode": "AUD", "userId": "e4acdfa5-5aee-4b9f-8dd1-67b401f5cb5d" }, { "spendType": "financial", "amount": 100000, "currencyCode": "CAD", "userId": "e4acdfa5-5aee-4b9f-8dd1-67b401f5cb5d" } ] } }, "spend-auth-add-request": { "summary": "Single spend authority by amount and userId(s)", "value": { "spendType": "manager", "amount": 50000, "currencyCode": "AUD", "userIds": [ "499a3357-c73b-4d05-b7ad-a055d5bea582", "234bedb6-3ecb-4a0d-8745-51187ecc5d0a", "9fff2ff9-c171-464a-986d-73939d6f1c65" ] } }, "spend-auth-remove-request": { "summary": "The spend authority to be removed by the given spendType, currencyCode and userId(s)", "value": { "spendType": "manager", "currencyCode": "USD", "userIds": [ "67e519d9-8244-4161-b0ab-ffa210efabf0", "870acff5-a05a-4497-84ac-1329077162c0", "11de85cc-104e-4604-9c15-912d734ddb26" ] } }, "spend-auth-currency-array": { "value": { "maxItems": 3, "value": [ { "displayName": "GBP", "description": "British Pound", "currencyCode": "GBP" }, { "displayName": "AUD", "description": "Australian Dollar", "currencyCode": "AUD" }, { "displayName": "USD", "description": "US Currency", "currencyCode": "USD" } ] } }, "spend-auth-currency": { "value": { "displayName": "GBP", "description": "British Pound", "currencyCode": "GBP" } }, "country-array": { "value": { "maxItems": 5, "value": [ { "countryCode": "AE", "displayName": "The United Arab Emirates", "description": "Country of UAE" }, { "countryCode": "GB", "displayName": "The United Kingdom of Great Britain and Northern Ireland", "description": "Country of England" }, { "countryCode": "UM", "displayName": "United States Minor Outlying Islands", "description": "Country of USA MOI" }, { "countryCode": "US", "displayName": "The United States of America", "description": "Country of USA" }, { "countryCode": "UZ", "displayName": "The Republic of Uzbekistan", "description": "Country of Uzbekistan" } ] } }, "rate-limit-error-response": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } }, "country": { "value": { "displayName": "The United States of America", "description": "Country of USA" } }, "state-array": { "value": { "maxItems": 5, "value": [ { "stateCode": "AL", "displayName": "Alabama", "description": "Alabama State" }, { "stateCode": "AK", "displayName": "Alaska", "description": "Alaska State" }, { "stateCode": "AZ", "displayName": "Arizona", "description": "Arizona State" }, { "stateCode": "AR", "displayName": "Arkansas", "description": "Arkansas State" }, { "stateCode": "CA", "displayName": "California", "description": "California State" } ] } }, "state": { "value": { "displayName": "California", "description": "California State" } }, "county-array": { "value": { "maxItems": 5, "value": [ { "countyCode": "001", "displayName": "Alameda", "description": "Alameda County" }, { "countyCode": "002", "displayName": "Alpine", "description": "Alpine County" }, { "countyCode": "005", "displayName": "Amador", "description": "Amador County" }, { "countyCode": "007", "displayName": "Butte", "description": "Butte County" }, { "countyCode": "009", "displayName": "Calaveras", "description": "Calaveras County" } ] } }, "county": { "value": { "displayName": "Alameda", "description": "Alameda County" } }, "location-array": { "value": { "maxItems": 2, "value": [ { "locationCode": "Alameda", "displayName": "Main Office", "description": "Main Office Location", "street1": "123 Example Dr", "street2": "Building 3A", "city": "Alameda", "countryCode": "US", "stateCode": "CA", "countyCode": "001", "postalCode": "94501", "region": "Pacific", "phoneNumber": "619-555-1212" }, { "locationCode": "Houston", "displayName": "Houston Branch Office", "description": "Houston Branch Office Location", "street1": "456 Example Ave", "street2": "Box 1234", "city": "Houston", "countryCode": "US", "stateCode": "TX", "countyCode": "201", "postalCode": "77080", "region": "South", "phoneNumber": "281-555-1212" } ] } }, "location": { "value": { "displayName": "Main Office", "description": "Main Office Location", "street1": "123 Example Dr", "street2": "Building 3A", "city": "Alameda", "countryCode": "US", "stateCode": "CA", "countyCode": "001", "postalCode": "94501", "region": "Pacific", "phoneNumber": "619-555-1212" } }, "ou-type-array": { "value": { "maxItems": 4, "value": [ { "ouTypeDisplayName": "outype1", "description": "Description of OU Type1" }, { "ouTypeDisplayName": "outype2", "description": "Description of OU Type2" }, { "ouTypeDisplayName": "outype3", "description": "Description of OU Type3" }, { "ouTypeDisplayName": "outype4", "description": "Description of OU Type4" } ] } }, "ou-type": { "value": { "description": "Description of OU Type1" } }, "organization-array": { "value": { "maxItems": 2, "value": [ { "organizationCode": "acc", "displayName": "Accounting", "description": "Accounting Organization" }, { "organizationCode": "fin", "displayName": "Finance", "description": "Finance Organization" } ] } }, "organization": { "value": { "displayName": "Accounting", "description": "Accounting Organization" } }, "ou-array": { "value": { "maxItems": 5, "value": [ { "ouCode": "ou1" }, { "ouCode": "ou2" }, { "ouCode": "ou3" }, { "ouCode": "ou4" }, { "ouCode": "ou5" } ] } }, "ou": { "value": { "displayName": "OU", "description": "Description of OU Display Name", "parentOuCode": "parentOU", "ouTypeDisplayName": "outype1", "externalId": "WRD-001" } }, "cost-center-array": { "value": { "maxItems": 5, "value": [ { "costCenterNumber": "abcd", "displayName": "Main Cost Center", "description": "Main Cost Center for abcd", "billable": true, "externalId": "external-system-identifier" }, { "costCenterNumber": "efgh", "displayName": "Cost Center 2", "description": "Cost Center 2 for efgh" }, { "costCenterNumber": "ijkl", "displayName": "Cost Center 3", "description": "Cost Center 3 for ijkl", "billable": false }, { "costCenterNumber": "mnop", "displayName": "Cost Center 4", "description": "Cost Center 5 for mnop", "billable": true }, { "costCenterNumber": "qrst", "displayName": "Cost Center 5", "description": "Cost Center 5 for qrst", "billable": true } ] } }, "cost-center": { "value": { "displayName": "Main Cost Center", "description": "Main Cost Center for abcd", "billable": true, "externalId": "external-system-identifier" } }, "user-id-array-post": { "summary": "List of userIds", "value": [ "d9d2a502-eb16-43a3-a9b7-40880b27c6f1", "0fef347c-6415-4c7d-b120-1d29163bab05", "ca7adf26-c9d5-4966-bf8a-997eb307f3c0" ] }, "user-id-single-post": { "summary": "Single userId", "value": [ "98500cf5-40bb-4209-bf44-fb76e52f55eb" ] }, "user-ou-array": { "value": { "maxItems": 3, "value": [ { "ouCode": "ou1", "domainType": "owner" }, { "ouCode": "ou2", "domainType": "owner" }, { "ouCode": "ou3", "domainType": "controller" } ] } }, "ou-user-array": { "value": { "maxItems": 3, "value": [ { "userId": "07164c59-2a8d-4034-8283-6440c24e58ff", "domainType": "owner" }, { "userId": "b6024aa6-84cf-45eb-a3e9-7c7e86a66b58", "domainType": "controller" }, { "userId": "486d2399-52d3-4757-b523-ed6e0529c867", "domainType": "mspRepresentative" } ] } }, "cc-user": { "summary": "Complete example", "value": { "ownerUserId": "0ce6fd7c5-61c9-4f05-969b-5266a2a884a8", "assistantUserId": "281ba412-9193-4a53-a87a-a445abe7d2ca", "controllerUserId": "150efd42-611f-4e61-acbe-44614631fee5" } }, "cc-user-null": { "summary": "Partial example", "value": { "ownerUserId": null, "assistantUserId": "281ba412-9193-4a53-a87a-a445abe7d2ca", "controllerUserId": null } }, "business-area-array": { "value": { "maxItems": 2, "value": [ { "businessAreaCode": "ADM", "displayName": "Administration", "description": "Administration Business Unit" }, { "businessAreaCode": "IT", "displayName": "Information Technology", "description": "Information Technology and Services Business Unit" } ] } }, "business-area": { "value": { "displayName": "Administration", "description": "Administration Business Unit" } }, "functional-partition-array": { "value": { "maxItems": 2, "value": [ { "functionalPartitionCode": "AC", "displayName": "Audit and Compliance", "description": "Audit and Compliance Segment" }, { "functionalPartitionCode": "ISC", "displayName": "InfoSec", "description": "Information Security and Compliance Segment" } ] } }, "functional-partition": { "value": { "displayName": "Audit and Compliance", "description": "Audit and Compliance Segment" } }, "language-code-array": { "value": { "maxItems": 2, "value": [ { "languageCode": "en-GB" }, { "languageCode": "en-US" } ] } }, "user-array": { "value": { "maxItems": 2, "value": [ { "userId": "a53cdeee-fa3a-44af-be6b-7f5b37816982", "userName": "X987123", "firstName": "Molly", "middleName": "Beverly", "lastName": "Howe", "localizedFirstName": "Polly", "localizedMiddleName": "Bev", "localizedLastName": "Red", "secondaryLastName": "van Zijl", "email": "pred@domain.com", "title": "VP of Procurement", "managerUserName": "32109121116", "organizationCode": "Company A", "ouCode": "Division B", "costCenterNumber": "9097", "locationCode": "Alameda", "languageCode": "en-GB" }, { "userId": "53ceeefa-cb73-464d-ba62-90954fb14e58", "userName": "X2771321", "firstName": "Patrick", "middleName": "Stanley", "lastName": "Roy", "localizedFirstName": "Pat", "localizedMiddleName": "Stan", "localizedLastName": "Wha", "secondaryLastName": "van der Meer", "email": "proy@domain.com", "title": "VP of Automation Services", "managerUserName": "32109121116", "organizationalCode": "Company Z", "ouCode": "Division A", "costCenterNumber": "7173", "locationCode": "Houston", "languageCode": "en-US" } ] } }, "user-without-id": { "value": { "userName": "X987123", "firstName": "Molly", "middleName": "Beverly", "lastName": "Howe", "localizedFirstName": "Polly", "localizedMiddleName": "Bev", "localizedLastName": "Red", "secondaryLastName": "van Zijl", "email": "pred@domain.com", "title": "VP of Procurement", "managerUserName": "32109121116", "organizationCode": "Company A", "ouCode": "Division B", "costCenterNumber": "9097", "locationCode": "Alameda", "languageCode": "en-GB" } }, "user-with-id": { "value": { "userId": "a53cdeee-fa3a-44af-be6b-7f5b37816982", "userName": "X987123", "firstName": "Molly", "middleName": "Beverly", "lastName": "Howe", "localizedFirstName": "Polly", "localizedMiddleName": "Bev", "localizedLastName": "Red", "secondaryLastName": "van Zijl", "email": "pred@domain.com", "title": "VP of Procurement", "managerUserName": "32109121116", "organizationCode": "Company A", "ouCode": "Division B", "costCenterNumber": "9097", "locationCode": "Alameda", "languageCode": "en-GB" } }, "role-array": { "value": { "maxItems": 3, "value": [ { "roleCode": "HM-1", "displayName": "Hiring Manager", "description": "Client Hiring Manager" }, { "roleCode": "RPT", "displayName": "Reporting", "description": "Advanced Reporting" }, { "roleCode": "FIN-APV", "displayName": "Financial Approver", "description": "Approver that has proper fiduciary responsibility" } ] } }, "role-display-name-description": { "value": { "displayName": "Hiring Manager", "description": "Client Hiring Manager" } }, "user-id-array": { "value": { "maxItems": 3, "value": [ "ed4bf9d0-e2ed-4e89-9b29-21e97d6a8e89", "bc43cc1b-edd0-46b8-9216-0f7d49606b23", "6a7c621a-3c82-4fcc-85ae-37f289405efa" ] } }, "role-code-array": { "value": { "maxItems": 2, "value": [ "HM-1", "FIN-APV" ] } }, "type-array": { "value": { "maxItems": 2, "value": [ { "typeCode": "FIN-EVP", "displayName": "Financial Reporting - EVP", "description": "Financial Executive Reporting" }, { "typeCode": "FIN-APV", "displayName": "Financial Approver", "description": "Budget Approver for Contingent Labor" } ] } }, "type-display-name-description": { "value": { "displayName": "Financial Reporting - EVP", "description": "Financial Executive Reporting" } }, "type-code-array": { "value": { "maxItems": 2, "value": [ "FIN-EVP", "FIN-APV" ] } }, "currency-model-array-example": { "value": { "maxItems": 3, "value": [ { "displayName": "GBP", "description": "British Pound", "currencyCode": "GBP" }, { "displayName": "AUD", "description": "Australian Dollar", "currencyCode": "AUD" }, { "displayName": "USD", "description": "US Currency", "currencyCode": "USD" } ] } }, "currency-model-example": { "value": { "displayName": "GBP", "description": "British Pound", "currencyCode": "GBP" } }, "user-model-array-example": { "value": { "maxItems": 3, "value": [ { "spendType": "manager", "amount": 5000, "currencyCode": "USD", "userId": "e4acdfa5-5aee-4b9f-8dd1-67b401f5cb5d" }, { "spendType": "manager", "amount": 30000, "currencyCode": "AUD", "userId": "e4acdfa5-5aee-4b9f-8dd1-67b401f5cb5d" }, { "spendType": "financial", "amount": 100000, "currencyCode": "CAD", "userId": "e4acdfa5-5aee-4b9f-8dd1-67b401f5cb5d" } ] } }, "add-spend-auth-user-request-model-example": { "summary": "Single spend authority by amount and userId(s)", "value": { "spendType": "manager", "amount": 50000, "currencyCode": "AUD", "userIds": [ "499a3357-c73b-4d05-b7ad-a055d5bea582", "234bedb6-3ecb-4a0d-8745-51187ecc5d0a", "9fff2ff9-c171-464a-986d-73939d6f1c65" ] } }, "remove-spend-auth-user-request-model-example": { "summary": "The spend authority to be removed by the given spendType, currencyCode and userId(s)", "value": { "spendType": "manager", "currencyCode": "USD", "userIds": [ "67e519d9-8244-4161-b0ab-ffa210efabf0", "870acff5-a05a-4497-84ac-1329077162c0", "11de85cc-104e-4604-9c15-912d734ddb26" ] } } }, "securitySchemes": { "client_auth": { "type": "oauth2", "flows": { "clientCredentials": { "tokenUrl": "https://integrations.auth.beeline.com/oauth/token", "scopes": { "read:iam": "Read Identity and Access Management data", "write:iam": "Read or Write Identity and Access Management data", "read:location": "Read Location data", "write:location": "Read or Write Location data", "read:org": "Read Organization data", "write:org": "Read or Write Organization data", "read:business_area": "Read Business Area data", "write:business_area": "Read or Write Business Area data", "read:user": "Read User data", "write:user": "Write User data", "read:spend_authority": "Read Spend Authority data", "write:spend_authority": "Write Spend Authority data" } } } } } } }