{ "openapi": "3.1.0", "info": { "title": "Open ADMS API", "version": "0.0.0", "license": { "name": "Apache-2.0", "identifier": "Apache-2.0" } }, "paths": { "/health": { "get": { "operationId": "health", "summary": "That the API answers. Anybody may ask.", "x-open-adms-access": "ANYBODY", "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "ok" } }, "required": ["status"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/readiness": { "get": { "operationId": "readiness", "summary": "That the API answers and its database answers it: status 503 UNAVAILABLE otherwise. Anybody may ask.", "x-open-adms-access": "ANYBODY", "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "ok" } }, "required": ["status"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/brand": { "get": { "operationId": "brand", "summary": "The name the firm calls its ADMS and the Open ADMS release it is built on, for the pages that brand themselves. Anybody may ask.", "x-open-adms-access": "ANYBODY", "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 40 }, "version": { "type": "string", "minLength": 5, "maxLength": 32, "pattern": "^\\d+\\.\\d+\\.\\d+(?:-[0-9A-Za-z.-]+)?$" } }, "required": ["name", "version"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/password-resets": { "post": { "operationId": "requestPasswordReset", "summary": "Asks for a password reset to be sent to an email address. Anybody may ask; the answer is the same whether or not a person has that address.", "x-open-adms-access": "ANYBODY", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "minLength": 3, "maxLength": 320 } }, "required": ["email"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "accepted" } }, "required": ["status"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/password-resets/completions": { "post": { "operationId": "completePasswordReset", "summary": "Sets a new password with the code a reset message carried. The code is good once.", "x-open-adms-access": "ANYBODY", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1, "maxLength": 512 }, "password": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "required": ["code", "password"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "ok" } }, "required": ["status"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/sessions": { "post": { "operationId": "signIn", "summary": "Signs a back-office or outside user in with their email address and password, and their authenticator code where they have one. The tokens are set as cookies; the answer holds none.", "x-open-adms-access": "ANYBODY", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "minLength": 1, "maxLength": 320 }, "password": { "type": "string", "minLength": 1, "maxLength": 4096 }, "code": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": ["email", "password"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "role": { "type": "string", "enum": ["ADMIN", "MANAGER_ANALYST", "READ_ONLY_VIEWER"] }, "viewerKind": { "anyOf": [ { "type": "string", "enum": ["CLIENT", "CONTRACTOR", "AUDITOR"] }, { "type": "null" } ] } }, "required": ["id", "name", "role", "viewerKind"], "additionalProperties": false }, "granted": { "type": "array", "items": { "type": "string", "enum": [ "CORRECT", "RENUMBER", "VOID", "ACCEPT_FLAG", "QC", "LOCK_INVOICED", "UNLOCK_INVOICED", "APPROVE_HOURS", "SETUP", "DISPATCH", "VIEW_REVIEW", "VIEW_SETUP", "VIEW_DISPATCH" ] } }, "passwordChangeRequired": { "type": "boolean" }, "twoStepSetUp": { "type": "boolean" }, "twoStepSetupRequired": { "type": "boolean" }, "csrf": { "type": "string", "minLength": 1 } }, "required": [ "user", "granted", "passwordChangeRequired", "twoStepSetUp", "twoStepSetupRequired", "csrf" ], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } }, "get": { "operationId": "listOwnSessions", "summary": "The signed-in person’s own sessions open now, newest first: when each was opened, when it ends at the latest, and which is this one.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST", "READ_ONLY_VIEWER"], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "sessions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "openedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "endsBy": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "current": { "type": "boolean" } }, "required": ["id", "openedAt", "endsBy", "current"], "additionalProperties": false } } }, "required": ["sessions"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/sessions/refreshes": { "post": { "operationId": "refreshSession", "summary": "Gives a session a new access token and a new refresh token. A refresh token is good once: one presented a second time ends its session.", "x-open-adms-access": "REFRESH_TOKEN", "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "role": { "type": "string", "enum": ["ADMIN", "MANAGER_ANALYST", "READ_ONLY_VIEWER"] }, "viewerKind": { "anyOf": [ { "type": "string", "enum": ["CLIENT", "CONTRACTOR", "AUDITOR"] }, { "type": "null" } ] } }, "required": ["id", "name", "role", "viewerKind"], "additionalProperties": false }, "granted": { "type": "array", "items": { "type": "string", "enum": [ "CORRECT", "RENUMBER", "VOID", "ACCEPT_FLAG", "QC", "LOCK_INVOICED", "UNLOCK_INVOICED", "APPROVE_HOURS", "SETUP", "DISPATCH", "VIEW_REVIEW", "VIEW_SETUP", "VIEW_DISPATCH" ] } }, "passwordChangeRequired": { "type": "boolean" }, "twoStepSetUp": { "type": "boolean" }, "twoStepSetupRequired": { "type": "boolean" }, "csrf": { "type": "string", "minLength": 1 } }, "required": [ "user", "granted", "passwordChangeRequired", "twoStepSetUp", "twoStepSetupRequired", "csrf" ], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/sessions/sign-outs": { "post": { "operationId": "signOut", "summary": "Ends the session on the server and clears its cookies.", "x-open-adms-access": "REFRESH_TOKEN", "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "signed-out" } }, "required": ["status"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/sessions/current": { "get": { "operationId": "currentSession", "summary": "Who is signed in.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST", "READ_ONLY_VIEWER"], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "role": { "type": "string", "enum": ["ADMIN", "MANAGER_ANALYST", "READ_ONLY_VIEWER"] }, "viewerKind": { "anyOf": [ { "type": "string", "enum": ["CLIENT", "CONTRACTOR", "AUDITOR"] }, { "type": "null" } ] } }, "required": ["id", "name", "role", "viewerKind"], "additionalProperties": false }, "granted": { "type": "array", "items": { "type": "string", "enum": [ "CORRECT", "RENUMBER", "VOID", "ACCEPT_FLAG", "QC", "LOCK_INVOICED", "UNLOCK_INVOICED", "APPROVE_HOURS", "SETUP", "DISPATCH", "VIEW_REVIEW", "VIEW_SETUP", "VIEW_DISPATCH" ] } }, "passwordChangeRequired": { "type": "boolean" }, "twoStepSetUp": { "type": "boolean" }, "twoStepSetupRequired": { "type": "boolean" }, "csrf": { "type": "string", "minLength": 1 } }, "required": [ "user", "granted", "passwordChangeRequired", "twoStepSetUp", "twoStepSetupRequired", "csrf" ], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/sessions/csrf": { "get": { "operationId": "sessionCsrf", "summary": "The CSRF value of the session the refresh token belongs to, for a page that was loaded anew.", "x-open-adms-access": "REFRESH_TOKEN", "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "csrf": { "type": "string", "minLength": 1 } }, "required": ["csrf"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/sessions/endings": { "post": { "operationId": "endOwnSession", "summary": "The signed-in person ends one of their own other sessions (this one ends by signing out). Not found for a session that isn’t theirs or has ended.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST", "READ_ONLY_VIEWER"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "sessionId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["sessionId"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "ended" }, "sessions": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["status", "sessions"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/password-changes": { "post": { "operationId": "changePassword", "summary": "The signed-in person sets a new password, giving their current one. Their other sessions end.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST", "READ_ONLY_VIEWER"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "current": { "type": "string", "minLength": 1, "maxLength": 4096 }, "password": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "required": ["current", "password"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "ok" } }, "required": ["status"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/two-step/setups": { "post": { "operationId": "beginTwoStepSetup", "summary": "Begins setting up the signed-in person’s authenticator: answers the secret for the app. Nothing is kept until a code proves it.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST", "READ_ONLY_VIEWER"], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "secret": { "type": "string", "minLength": 1 }, "uri": { "type": "string", "minLength": 1 }, "setup": { "type": "string", "minLength": 1 }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["secret", "uri", "setup", "expiresAt"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/two-step/setups/confirmations": { "post": { "operationId": "confirmTwoStepSetup", "summary": "Finishes setting up the signed-in person’s authenticator with a code from it. Their other sessions end.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST", "READ_ONLY_VIEWER"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "setup": { "type": "string", "minLength": 1, "maxLength": 1024 }, "code": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": ["setup", "code"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "role": { "type": "string", "enum": ["ADMIN", "MANAGER_ANALYST", "READ_ONLY_VIEWER"] }, "viewerKind": { "anyOf": [ { "type": "string", "enum": ["CLIENT", "CONTRACTOR", "AUDITOR"] }, { "type": "null" } ] } }, "required": ["id", "name", "role", "viewerKind"], "additionalProperties": false }, "granted": { "type": "array", "items": { "type": "string", "enum": [ "CORRECT", "RENUMBER", "VOID", "ACCEPT_FLAG", "QC", "LOCK_INVOICED", "UNLOCK_INVOICED", "APPROVE_HOURS", "SETUP", "DISPATCH", "VIEW_REVIEW", "VIEW_SETUP", "VIEW_DISPATCH" ] } }, "passwordChangeRequired": { "type": "boolean" }, "twoStepSetUp": { "type": "boolean" }, "twoStepSetupRequired": { "type": "boolean" }, "csrf": { "type": "string", "minLength": 1 } }, "required": [ "user", "granted", "passwordChangeRequired", "twoStepSetUp", "twoStepSetupRequired", "csrf" ], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/two-step/removals": { "post": { "operationId": "removeOwnTwoStep", "summary": "The signed-in person removes their own authenticator, giving a code from it. Their other sessions end; it is a security event, and they are told by mail. Whoever must have one then sets a new one up before anything else. A code that isn’t taken is a wrong try, as at sign-in.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST", "READ_ONLY_VIEWER"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": ["code"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "cleared" } }, "required": ["status"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/people/{userId}/two-step-clearings": { "post": { "operationId": "clearTwoStep", "summary": "An admin clears another person’s authenticator. Their sessions end; it is a security event.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN"], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "cleared" } }, "required": ["status"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/people": { "post": { "operationId": "createPerson", "summary": "An admin creates an admin, a manager/analyst or a read-only viewer (a client user, a contractor user with its contractor, or an auditor). Never a monitor. The person has no password until an admin sets one.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "email": { "type": "string", "maxLength": 320, "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "phone": { "type": "string", "minLength": 1, "maxLength": 40 }, "role": { "type": "string", "enum": ["ADMIN", "MANAGER_ANALYST"] } }, "required": ["name", "email", "role"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "email": { "type": "string", "maxLength": 320, "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "phone": { "type": "string", "minLength": 1, "maxLength": 40 }, "role": { "type": "string", "const": "READ_ONLY_VIEWER" }, "viewerKind": { "type": "string", "enum": ["CLIENT", "AUDITOR"] }, "seesPrivateCitizens": { "type": "boolean" } }, "required": ["name", "email", "role", "viewerKind"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "email": { "type": "string", "maxLength": 320, "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "phone": { "type": "string", "minLength": 1, "maxLength": 40 }, "role": { "type": "string", "const": "READ_ONLY_VIEWER" }, "viewerKind": { "type": "string", "const": "CONTRACTOR" }, "contractorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "seesPrivateCitizens": { "type": "boolean" } }, "required": ["name", "email", "role", "viewerKind", "contractorId"], "additionalProperties": false } ] } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "role": { "type": "string", "enum": ["ADMIN", "MANAGER_ANALYST", "MONITOR", "READ_ONLY_VIEWER"] }, "viewerKind": { "anyOf": [ { "type": "string", "enum": ["CLIENT", "CONTRACTOR", "AUDITOR"] }, { "type": "null" } ] }, "contractorId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "seesPrivateCitizens": { "type": ["boolean", "null"] }, "monitorId": { "type": ["string", "null"] }, "email": { "type": ["string", "null"] }, "phone": { "type": ["string", "null"] }, "employerId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "employerNumber": { "type": ["string", "null"] }, "archived": { "type": "boolean" }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "CORRECT", "RENUMBER", "VOID", "ACCEPT_FLAG", "QC", "LOCK_INVOICED", "UNLOCK_INVOICED", "APPROVE_HOURS", "SETUP", "DISPATCH", "VIEW_REVIEW", "VIEW_SETUP", "VIEW_DISPATCH" ] } }, "projectIds": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "id", "name", "role", "viewerKind", "contractorId", "seesPrivateCitizens", "monitorId", "email", "employerId", "employerNumber", "archived", "permissions", "projectIds" ], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } }, "get": { "operationId": "listPeople", "summary": "The firm’s people, a page at a time, in the order they were added or by name: those in service, or the archived ones, of one role, or those whose name holds what is searched. A monitor’s phone number is in an admin’s answer only.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_DISPATCH", "parameters": [ { "name": "role", "in": "query", "required": false, "schema": { "type": "string", "enum": ["ADMIN", "MANAGER_ANALYST", "MONITOR", "READ_ONLY_VIEWER"] } }, { "name": "archived", "in": "query", "required": false, "schema": { "type": "string", "enum": ["true", "false"] } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "enum": ["ADDED", "NAME"] } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "people": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "role": { "type": "string", "enum": ["ADMIN", "MANAGER_ANALYST", "MONITOR", "READ_ONLY_VIEWER"] }, "viewerKind": { "anyOf": [ { "type": "string", "enum": ["CLIENT", "CONTRACTOR", "AUDITOR"] }, { "type": "null" } ] }, "contractorId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "seesPrivateCitizens": { "type": ["boolean", "null"] }, "monitorId": { "type": ["string", "null"] }, "email": { "type": ["string", "null"] }, "phone": { "type": ["string", "null"] }, "employerId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "employerNumber": { "type": ["string", "null"] }, "archived": { "type": "boolean" }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "CORRECT", "RENUMBER", "VOID", "ACCEPT_FLAG", "QC", "LOCK_INVOICED", "UNLOCK_INVOICED", "APPROVE_HOURS", "SETUP", "DISPATCH", "VIEW_REVIEW", "VIEW_SETUP", "VIEW_DISPATCH" ] } }, "projectIds": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "id", "name", "role", "viewerKind", "contractorId", "seesPrivateCitizens", "monitorId", "email", "employerId", "employerNumber", "archived", "permissions", "projectIds" ], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["people", "next"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/people/{userId}": { "get": { "operationId": "readPerson", "summary": "One person, as an admin or a manager/analyst reads them. A monitor’s phone number is in an admin’s answer only.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_DISPATCH", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "role": { "type": "string", "enum": ["ADMIN", "MANAGER_ANALYST", "MONITOR", "READ_ONLY_VIEWER"] }, "viewerKind": { "anyOf": [ { "type": "string", "enum": ["CLIENT", "CONTRACTOR", "AUDITOR"] }, { "type": "null" } ] }, "contractorId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "seesPrivateCitizens": { "type": ["boolean", "null"] }, "monitorId": { "type": ["string", "null"] }, "email": { "type": ["string", "null"] }, "phone": { "type": ["string", "null"] }, "employerId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "employerNumber": { "type": ["string", "null"] }, "archived": { "type": "boolean" }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "CORRECT", "RENUMBER", "VOID", "ACCEPT_FLAG", "QC", "LOCK_INVOICED", "UNLOCK_INVOICED", "APPROVE_HOURS", "SETUP", "DISPATCH", "VIEW_REVIEW", "VIEW_SETUP", "VIEW_DISPATCH" ] } }, "projectIds": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "id", "name", "role", "viewerKind", "contractorId", "seesPrivateCitizens", "monitorId", "email", "employerId", "employerNumber", "archived", "permissions", "projectIds" ], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } }, "patch": { "operationId": "changePerson", "summary": "An admin changes a person’s name, email address or phone number, their employer and its ID for them, and a read-only viewer’s kind, contractor and whether they see private citizens by name. Only what is stated changes; an address is cleared only on a monitor. A changed sign-in address is told to the old one where the firm has mail.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN"], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "email": { "anyOf": [ { "type": "string", "maxLength": 320, "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 40 }, { "type": "null" } ] }, "viewerKind": { "type": "string", "enum": ["CLIENT", "CONTRACTOR", "AUDITOR"] }, "contractorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "seesPrivateCitizens": { "type": "boolean" }, "employerId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "employerNumber": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 60 }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "role": { "type": "string", "enum": ["ADMIN", "MANAGER_ANALYST", "MONITOR", "READ_ONLY_VIEWER"] }, "viewerKind": { "anyOf": [ { "type": "string", "enum": ["CLIENT", "CONTRACTOR", "AUDITOR"] }, { "type": "null" } ] }, "contractorId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "seesPrivateCitizens": { "type": ["boolean", "null"] }, "monitorId": { "type": ["string", "null"] }, "email": { "type": ["string", "null"] }, "phone": { "type": ["string", "null"] }, "employerId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "employerNumber": { "type": ["string", "null"] }, "archived": { "type": "boolean" }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "CORRECT", "RENUMBER", "VOID", "ACCEPT_FLAG", "QC", "LOCK_INVOICED", "UNLOCK_INVOICED", "APPROVE_HOURS", "SETUP", "DISPATCH", "VIEW_REVIEW", "VIEW_SETUP", "VIEW_DISPATCH" ] } }, "projectIds": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "id", "name", "role", "viewerKind", "contractorId", "seesPrivateCitizens", "monitorId", "email", "employerId", "employerNumber", "archived", "permissions", "projectIds" ], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/people/{userId}/permissions": { "put": { "operationId": "setPermissions", "summary": "An admin states the permissions a manager/analyst holds from now on. One taken away refuses that person’s very next request.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN"], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "permissions": { "maxItems": 13, "type": "array", "items": { "type": "string", "enum": [ "CORRECT", "RENUMBER", "VOID", "ACCEPT_FLAG", "QC", "LOCK_INVOICED", "UNLOCK_INVOICED", "APPROVE_HOURS", "SETUP", "DISPATCH", "VIEW_REVIEW", "VIEW_SETUP", "VIEW_DISPATCH" ] } } }, "required": ["permissions"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "role": { "type": "string", "enum": ["ADMIN", "MANAGER_ANALYST", "MONITOR", "READ_ONLY_VIEWER"] }, "viewerKind": { "anyOf": [ { "type": "string", "enum": ["CLIENT", "CONTRACTOR", "AUDITOR"] }, { "type": "null" } ] }, "contractorId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "seesPrivateCitizens": { "type": ["boolean", "null"] }, "monitorId": { "type": ["string", "null"] }, "email": { "type": ["string", "null"] }, "phone": { "type": ["string", "null"] }, "employerId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "employerNumber": { "type": ["string", "null"] }, "archived": { "type": "boolean" }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "CORRECT", "RENUMBER", "VOID", "ACCEPT_FLAG", "QC", "LOCK_INVOICED", "UNLOCK_INVOICED", "APPROVE_HOURS", "SETUP", "DISPATCH", "VIEW_REVIEW", "VIEW_SETUP", "VIEW_DISPATCH" ] } }, "projectIds": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "id", "name", "role", "viewerKind", "contractorId", "seesPrivateCitizens", "monitorId", "email", "employerId", "employerNumber", "archived", "permissions", "projectIds" ], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/people/{userId}/viewer-projects": { "put": { "operationId": "setViewerProjects", "summary": "An admin states the projects a read-only viewer sees from now on. One not named is taken away.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN"], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "projectIds": { "maxItems": 1000, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": ["projectIds"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "role": { "type": "string", "enum": ["ADMIN", "MANAGER_ANALYST", "MONITOR", "READ_ONLY_VIEWER"] }, "viewerKind": { "anyOf": [ { "type": "string", "enum": ["CLIENT", "CONTRACTOR", "AUDITOR"] }, { "type": "null" } ] }, "contractorId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "seesPrivateCitizens": { "type": ["boolean", "null"] }, "monitorId": { "type": ["string", "null"] }, "email": { "type": ["string", "null"] }, "phone": { "type": ["string", "null"] }, "employerId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "employerNumber": { "type": ["string", "null"] }, "archived": { "type": "boolean" }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "CORRECT", "RENUMBER", "VOID", "ACCEPT_FLAG", "QC", "LOCK_INVOICED", "UNLOCK_INVOICED", "APPROVE_HOURS", "SETUP", "DISPATCH", "VIEW_REVIEW", "VIEW_SETUP", "VIEW_DISPATCH" ] } }, "projectIds": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "id", "name", "role", "viewerKind", "contractorId", "seesPrivateCitizens", "monitorId", "email", "employerId", "employerNumber", "archived", "permissions", "projectIds" ], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/people/{userId}/passwords": { "post": { "operationId": "setPersonPassword", "summary": "An admin sets a person’s password. Their sessions end, and they set one of their own at their next sign-in.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN"], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "password": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "required": ["password"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "ok" } }, "required": ["status"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/people/{userId}/session-endings": { "post": { "operationId": "endPersonSessions", "summary": "An admin ends every session a person has open.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN"], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "ended" }, "sessions": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["status", "sessions"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/people/{userId}/archivings": { "post": { "operationId": "archivePerson", "summary": "An admin archives a person. Their sessions end and they are refused at once. The only admin can’t be archived.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN"], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "role": { "type": "string", "enum": ["ADMIN", "MANAGER_ANALYST", "MONITOR", "READ_ONLY_VIEWER"] }, "viewerKind": { "anyOf": [ { "type": "string", "enum": ["CLIENT", "CONTRACTOR", "AUDITOR"] }, { "type": "null" } ] }, "contractorId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "seesPrivateCitizens": { "type": ["boolean", "null"] }, "monitorId": { "type": ["string", "null"] }, "email": { "type": ["string", "null"] }, "phone": { "type": ["string", "null"] }, "employerId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "employerNumber": { "type": ["string", "null"] }, "archived": { "type": "boolean" }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "CORRECT", "RENUMBER", "VOID", "ACCEPT_FLAG", "QC", "LOCK_INVOICED", "UNLOCK_INVOICED", "APPROVE_HOURS", "SETUP", "DISPATCH", "VIEW_REVIEW", "VIEW_SETUP", "VIEW_DISPATCH" ] } }, "projectIds": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "id", "name", "role", "viewerKind", "contractorId", "seesPrivateCitizens", "monitorId", "email", "employerId", "employerNumber", "archived", "permissions", "projectIds" ], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/people/{userId}/role": { "put": { "operationId": "setPersonRole", "summary": "An admin makes a manager/analyst an admin, or an admin a manager/analyst. Their very next request is asked as the new role. The only admin stays one; a monitor’s and a read-only viewer’s role never changes.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN"], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "role": { "type": "string", "enum": ["ADMIN", "MANAGER_ANALYST"] } }, "required": ["role"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "role": { "type": "string", "enum": ["ADMIN", "MANAGER_ANALYST", "MONITOR", "READ_ONLY_VIEWER"] }, "viewerKind": { "anyOf": [ { "type": "string", "enum": ["CLIENT", "CONTRACTOR", "AUDITOR"] }, { "type": "null" } ] }, "contractorId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "seesPrivateCitizens": { "type": ["boolean", "null"] }, "monitorId": { "type": ["string", "null"] }, "email": { "type": ["string", "null"] }, "phone": { "type": ["string", "null"] }, "employerId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "employerNumber": { "type": ["string", "null"] }, "archived": { "type": "boolean" }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "CORRECT", "RENUMBER", "VOID", "ACCEPT_FLAG", "QC", "LOCK_INVOICED", "UNLOCK_INVOICED", "APPROVE_HOURS", "SETUP", "DISPATCH", "VIEW_REVIEW", "VIEW_SETUP", "VIEW_DISPATCH" ] } }, "projectIds": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "id", "name", "role", "viewerKind", "contractorId", "seesPrivateCitizens", "monitorId", "email", "employerId", "employerNumber", "archived", "permissions", "projectIds" ], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/people/{userId}/unarchivings": { "post": { "operationId": "unarchivePerson", "summary": "An admin takes a person out of the archive. They are in service again with what they held, and sign in again; refused while somebody in service signs in with their email address.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN"], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "role": { "type": "string", "enum": ["ADMIN", "MANAGER_ANALYST", "MONITOR", "READ_ONLY_VIEWER"] }, "viewerKind": { "anyOf": [ { "type": "string", "enum": ["CLIENT", "CONTRACTOR", "AUDITOR"] }, { "type": "null" } ] }, "contractorId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "seesPrivateCitizens": { "type": ["boolean", "null"] }, "monitorId": { "type": ["string", "null"] }, "email": { "type": ["string", "null"] }, "phone": { "type": ["string", "null"] }, "employerId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "employerNumber": { "type": ["string", "null"] }, "archived": { "type": "boolean" }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "CORRECT", "RENUMBER", "VOID", "ACCEPT_FLAG", "QC", "LOCK_INVOICED", "UNLOCK_INVOICED", "APPROVE_HOURS", "SETUP", "DISPATCH", "VIEW_REVIEW", "VIEW_SETUP", "VIEW_DISPATCH" ] } }, "projectIds": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "id", "name", "role", "viewerKind", "contractorId", "seesPrivateCitizens", "monitorId", "email", "employerId", "employerNumber", "archived", "permissions", "projectIds" ], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/clients": { "get": { "operationId": "findClients", "summary": "The firm’s clients whose name holds what was typed; none archived.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "contactName": { "type": ["string", "null"] }, "contactEmail": { "type": ["string", "null"] }, "contactPhone": { "type": ["string", "null"] }, "notes": { "type": ["string", "null"] }, "archived": { "type": "boolean" } }, "required": [ "id", "name", "contactName", "contactEmail", "contactPhone", "notes", "archived" ], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["records", "next"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } }, "post": { "operationId": "createClient", "summary": "Creates a client: the jurisdiction or agency paying for the work.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "contactName": { "type": "string", "minLength": 1, "maxLength": 200 }, "contactEmail": { "type": "string", "maxLength": 320, "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "contactPhone": { "type": "string", "minLength": 1, "maxLength": 40 }, "notes": { "type": "string", "minLength": 1, "maxLength": 4000 } }, "required": ["name"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "contactName": { "type": ["string", "null"] }, "contactEmail": { "type": ["string", "null"] }, "contactPhone": { "type": ["string", "null"] }, "notes": { "type": ["string", "null"] }, "archived": { "type": "boolean" } }, "required": [ "id", "name", "contactName", "contactEmail", "contactPhone", "notes", "archived" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/clients/{clientId}": { "patch": { "operationId": "changeClient", "summary": "Changes a client’s name, contact or notes; one left out stays as it is, and a contact or the notes are cleared with null. Audited with the value before.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "contactName": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "contactEmail": { "anyOf": [ { "type": "string", "maxLength": 320, "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, { "type": "null" } ] }, "contactPhone": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 40 }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 4000 }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "contactName": { "type": ["string", "null"] }, "contactEmail": { "type": ["string", "null"] }, "contactPhone": { "type": ["string", "null"] }, "notes": { "type": ["string", "null"] }, "archived": { "type": "boolean" } }, "required": [ "id", "name", "contactName", "contactEmail", "contactPhone", "notes", "archived" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/declaration-events": { "get": { "operationId": "findDeclarationEvents", "summary": "The declaration events whose name or reference holds what was typed; none archived.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "reference": { "type": "string" }, "referenceTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "archived": { "type": "boolean" } }, "required": ["id", "name", "reference", "referenceTypeId", "archived"], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["records", "next"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } }, "post": { "operationId": "createDeclarationEvent", "summary": "Creates a declaration event: the disaster and its reference as written, its reference type picked from the firm’s list.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "reference": { "type": "string", "minLength": 1, "maxLength": 200 }, "referenceTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["name", "reference", "referenceTypeId"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "reference": { "type": "string" }, "referenceTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "archived": { "type": "boolean" } }, "required": ["id", "name", "reference", "referenceTypeId", "archived"], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/declaration-events/{declarationEventId}": { "patch": { "operationId": "changeDeclarationEvent", "summary": "Changes a declaration event’s name, its reference as written or its reference type; one left out stays as it is. Audited with the value before.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "declarationEventId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "reference": { "type": "string", "minLength": 1, "maxLength": 200 }, "referenceTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "reference": { "type": "string" }, "referenceTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "archived": { "type": "boolean" } }, "required": ["id", "name", "reference", "referenceTypeId", "archived"], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects": { "post": { "operationId": "createProject", "summary": "Creates a project under a client and a declaration event, with its time zone, active window, ticket-number source, ticket types and kinds of unit rate work.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "clientId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "declarationEventId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "programTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "timeZone": { "type": "string", "minLength": 1, "maxLength": 64 }, "activeFrom": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "activeTo": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "ticketNumberSource": { "type": "string", "enum": ["CONTROL", "GENERATED"] }, "workflows": { "minItems": 1, "maxItems": 3, "type": "array", "items": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] } }, "kindOfWorkIds": { "maxItems": 200, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "numbersFrom": { "type": "object", "properties": { "LOAD": { "type": "integer", "minimum": 1, "maximum": 2000000000 }, "HAUL_OUT": { "type": "integer", "minimum": 1, "maximum": 2000000000 }, "UNIT_RATE": { "type": "integer", "minimum": 1, "maximum": 2000000000 }, "CERTIFICATION": { "type": "integer", "minimum": 1, "maximum": 2000000000 }, "ROE": { "type": "integer", "minimum": 1, "maximum": 2000000000 } }, "additionalProperties": false } }, "required": [ "name", "clientId", "declarationEventId", "programTypeId", "timeZone", "activeFrom", "activeTo", "ticketNumberSource", "workflows", "kindOfWorkIds" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "clientId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "declarationEventId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "programTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "timeZone": { "type": "string" }, "activeFrom": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "activeTo": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "ticketNumberSource": { "type": "string", "enum": ["CONTROL", "GENERATED"] }, "workflows": { "type": "array", "items": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] } }, "allowSplitLoads": { "type": "boolean" }, "loadCallLowLimit": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "loadCallHighLimit": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "stumpFillDepthInches": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "stumpCheckRootBallWider": { "type": "boolean" }, "stumpCheckFillNeedsExposure": { "type": "boolean" }, "siteCircleMeters": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "timeClockEnabled": { "type": "boolean" }, "closedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "id", "name", "clientId", "declarationEventId", "programTypeId", "timeZone", "activeFrom", "activeTo", "ticketNumberSource", "workflows", "allowSplitLoads", "loadCallLowLimit", "loadCallHighLimit", "stumpFillDepthInches", "stumpCheckRootBallWider", "stumpCheckFillNeedsExposure", "siteCircleMeters", "timeClockEnabled", "closedAt" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } }, "get": { "operationId": "listProjects", "summary": "The firm’s projects, a page at a time, in name order: each with its settings, its active window and whether it is closed.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "parameters": [ { "name": "closed", "in": "query", "required": false, "schema": { "type": "string", "enum": ["true", "false"] } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "projects": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "clientId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "declarationEventId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "programTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "timeZone": { "type": "string" }, "activeFrom": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "activeTo": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "ticketNumberSource": { "type": "string", "enum": ["CONTROL", "GENERATED"] }, "workflows": { "type": "array", "items": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] } }, "allowSplitLoads": { "type": "boolean" }, "loadCallLowLimit": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "loadCallHighLimit": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "stumpFillDepthInches": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "stumpCheckRootBallWider": { "type": "boolean" }, "stumpCheckFillNeedsExposure": { "type": "boolean" }, "siteCircleMeters": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "timeClockEnabled": { "type": "boolean" }, "closedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "id", "name", "clientId", "declarationEventId", "programTypeId", "timeZone", "activeFrom", "activeTo", "ticketNumberSource", "workflows", "allowSplitLoads", "loadCallLowLimit", "loadCallHighLimit", "stumpFillDepthInches", "stumpCheckRootBallWider", "stumpCheckFillNeedsExposure", "siteCircleMeters", "timeClockEnabled", "closedAt" ], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["projects", "next"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}": { "get": { "operationId": "readProject", "summary": "One project’s page: its settings, active window and whether it is closed, its kinds of work, each contractor’s place on it by name, and its contracts.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "project": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "clientId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "declarationEventId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "programTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "timeZone": { "type": "string" }, "activeFrom": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "activeTo": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "ticketNumberSource": { "type": "string", "enum": ["CONTROL", "GENERATED"] }, "workflows": { "type": "array", "items": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] } }, "allowSplitLoads": { "type": "boolean" }, "loadCallLowLimit": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "loadCallHighLimit": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "stumpFillDepthInches": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "stumpCheckRootBallWider": { "type": "boolean" }, "stumpCheckFillNeedsExposure": { "type": "boolean" }, "siteCircleMeters": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "timeClockEnabled": { "type": "boolean" }, "closedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "id", "name", "clientId", "declarationEventId", "programTypeId", "timeZone", "activeFrom", "activeTo", "ticketNumberSource", "workflows", "allowSplitLoads", "loadCallLowLimit", "loadCallHighLimit", "stumpFillDepthInches", "stumpCheckRootBallWider", "stumpCheckFillNeedsExposure", "siteCircleMeters", "timeClockEnabled", "closedAt" ], "additionalProperties": false }, "kindOfWorkIds": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "contractors": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "contractorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "position": { "type": "string", "enum": ["PRIME", "SUB_TIER_1", "SUB_TIER_2"] }, "primeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "archived": { "type": "boolean" }, "name": { "type": "string" } }, "required": [ "id", "projectId", "contractorId", "position", "primeId", "archived", "name" ], "additionalProperties": false } }, "contracts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "primeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "signedCopyUrl": { "type": ["string", "null"] }, "archived": { "type": "boolean" } }, "required": [ "id", "projectId", "name", "primeId", "signedCopyUrl", "archived" ], "additionalProperties": false } }, "numberSeries": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "series": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE", "CERTIFICATION", "ROE"] }, "firstNumber": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "nextNumber": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": ["id", "projectId", "series", "firstNumber", "nextNumber"], "additionalProperties": false } }, "controlRanges": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "series": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE", "CERTIFICATION", "ROE"] }, "firstNumber": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "lastNumber": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "archived": { "type": "boolean" } }, "required": [ "id", "projectId", "series", "firstNumber", "lastNumber", "archived" ], "additionalProperties": false } } }, "required": [ "project", "kindOfWorkIds", "contractors", "contracts", "numberSeries", "controlRanges" ], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/review-queue": { "get": { "operationId": "reviewQueue", "summary": "The review queue of one workflow on a project: the tickets whose field events stand pending or in review, a page at a time by number, each with its open flags (not cleared, no acceptance in force); and the project’s open flags counted by cause. Narrowed to one cause, only the tickets with an open flag of it.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_REVIEW", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "workflow", "in": "query", "required": true, "schema": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] } }, { "name": "cause", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "DEBRIS_TYPE_MISMATCH", "CERT_NUMBER_MISMATCH", "DISPOSAL_BEFORE_COLLECTION_ENDED", "OVERLAPPING_LOADS", "SPLIT_SUFFIX_GAP", "CARRIED_COUNT_MISMATCH", "NO_CERTIFICATION", "TYPED_CAPACITY_DIFFERS", "TAG_EXPIRED", "CERTIFICATION_REVOKED", "CERTIFICATION_REPLACED", "OUTSIDE_PROJECT_BOUNDARY", "NO_ZONE", "OUTSIDE_SITE_AREA", "PROJECT_NOT_ACTIVE", "SITE_NOT_YET_ACTIVE", "SITE_CLOSED", "NO_ROAD_ROUTE", "DEVICE_CLOCK_OFF", "WORK_TIME_AFTER_RECEIVED", "WORK_TIME_BEFORE_ENROLMENT", "DEVICE_TIME_ZONE_DIFFERS", "PHONE_OUT_OF_SERVICE", "TYPED_TICKET_NUMBER", "BACK_OFFICE_RECORD", "SITE_DOES_NOT_TAKE_LOADS", "SITE_NOT_FOR_HAUL_OUTS", "INELIGIBLE_SITE", "TIPPING_FEE_RULE_MISSING", "HAUL_OUT_DUMPED_AT_TDSR", "LOAD_CALL_ZERO", "LOAD_CALL_LOW", "LOAD_CALL_HIGH", "PILE_CALL_NOT_HIGHER", "QUANTITY_MISSING_FOR_PAY_ITEM", "SHARED_SCALE_WEIGHT", "RECEIPT_TWO_DEBRIS_TYPES", "SCALE_WEIGHT_UNUSABLE", "CARRIED_TICKET_NOT_FOUND", "CARRIED_TICKET_ON_ANOTHER_LOAD", "MEASUREMENT_MISSING", "GPS_MISSING", "PHOTOS_MISSING", "DECIMAL_COUNT", "NO_SIZE_BAND", "OUTSIDE_SIZE_BAND", "MARKED_INELIGIBLE", "STUMP_UNDER_24", "ROOT_BALL_NOT_WIDER", "FILL_WITHOUT_EXPOSED_ROOT_BALL", "ROOT_BALL_MISSING", "NO_SURVEY", "CREW_ITEM_OVER_12_HOURS", "CREW_TIME_OVERLAP", "ROE_MISSING", "ROE_NOT_ON_PROJECT", "ROE_UNSIGNED", "ROE_OUT_OF_SCOPE", "NO_PRE_WORK_SURVEY", "CERTIFICATION_PHOTO_MISSING", "PERMIT_OUTSTANDING", "NO_PRICING_RULE", "DUPLICATE_TRANSACTION_NUMBER", "NO_RATE_FOR_PRIME", "RATE_TO_BE_NEGOTIATED", "NOT_PROCESSED", "DETAIL_MISSING", "TYPED_NUMBER_NO_REASON", "WRONG_KIND_OF_BADGE", "GPS_UNREADABLE", "NOT_A_TICKET_NUMBER", "ENDED_BEFORE_STARTED", "SPLIT_NOT_ALLOWED", "OUTSIDE_CONTROL_RANGES", "ASSIGNMENT_ON_ANOTHER_PROJECT", "SCALE_NET_DISAGREES", "TWO_QUANTITIES", "NOT_PROCESSED_LINES_STAND", "SUB_NAME_ALIKE", "MONITOR_NOT_SIGNED_IN", "ASSIGNMENT_OF_ANOTHER_PERSON" ] } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 40 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "causes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "DEBRIS_TYPE_MISMATCH", "CERT_NUMBER_MISMATCH", "DISPOSAL_BEFORE_COLLECTION_ENDED", "OVERLAPPING_LOADS", "SPLIT_SUFFIX_GAP", "CARRIED_COUNT_MISMATCH", "NO_CERTIFICATION", "TYPED_CAPACITY_DIFFERS", "TAG_EXPIRED", "CERTIFICATION_REVOKED", "CERTIFICATION_REPLACED", "OUTSIDE_PROJECT_BOUNDARY", "NO_ZONE", "OUTSIDE_SITE_AREA", "PROJECT_NOT_ACTIVE", "SITE_NOT_YET_ACTIVE", "SITE_CLOSED", "NO_ROAD_ROUTE", "DEVICE_CLOCK_OFF", "WORK_TIME_AFTER_RECEIVED", "WORK_TIME_BEFORE_ENROLMENT", "DEVICE_TIME_ZONE_DIFFERS", "PHONE_OUT_OF_SERVICE", "TYPED_TICKET_NUMBER", "BACK_OFFICE_RECORD", "SITE_DOES_NOT_TAKE_LOADS", "SITE_NOT_FOR_HAUL_OUTS", "INELIGIBLE_SITE", "TIPPING_FEE_RULE_MISSING", "HAUL_OUT_DUMPED_AT_TDSR", "LOAD_CALL_ZERO", "LOAD_CALL_LOW", "LOAD_CALL_HIGH", "PILE_CALL_NOT_HIGHER", "QUANTITY_MISSING_FOR_PAY_ITEM", "SHARED_SCALE_WEIGHT", "RECEIPT_TWO_DEBRIS_TYPES", "SCALE_WEIGHT_UNUSABLE", "CARRIED_TICKET_NOT_FOUND", "CARRIED_TICKET_ON_ANOTHER_LOAD", "MEASUREMENT_MISSING", "GPS_MISSING", "PHOTOS_MISSING", "DECIMAL_COUNT", "NO_SIZE_BAND", "OUTSIDE_SIZE_BAND", "MARKED_INELIGIBLE", "STUMP_UNDER_24", "ROOT_BALL_NOT_WIDER", "FILL_WITHOUT_EXPOSED_ROOT_BALL", "ROOT_BALL_MISSING", "NO_SURVEY", "CREW_ITEM_OVER_12_HOURS", "CREW_TIME_OVERLAP", "ROE_MISSING", "ROE_NOT_ON_PROJECT", "ROE_UNSIGNED", "ROE_OUT_OF_SCOPE", "NO_PRE_WORK_SURVEY", "CERTIFICATION_PHOTO_MISSING", "PERMIT_OUTSTANDING", "NO_PRICING_RULE", "DUPLICATE_TRANSACTION_NUMBER", "NO_RATE_FOR_PRIME", "RATE_TO_BE_NEGOTIATED", "NOT_PROCESSED", "DETAIL_MISSING", "TYPED_NUMBER_NO_REASON", "WRONG_KIND_OF_BADGE", "GPS_UNREADABLE", "NOT_A_TICKET_NUMBER", "ENDED_BEFORE_STARTED", "SPLIT_NOT_ALLOWED", "OUTSIDE_CONTROL_RANGES", "ASSIGNMENT_ON_ANOTHER_PROJECT", "SCALE_NET_DISAGREES", "TWO_QUANTITIES", "NOT_PROCESSED_LINES_STAND", "SUB_NAME_ALIKE", "MONITOR_NOT_SIGNED_IN", "ASSIGNMENT_OF_ANOTHER_PERSON" ] }, "flags": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["code", "flags", "tickets"], "additionalProperties": false } }, "tickets": { "type": "array", "items": { "type": "object", "properties": { "workflow": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] }, "ticketNumber": { "type": "string" }, "statuses": { "type": "array", "items": { "type": "string", "enum": ["PENDING", "COMPLETED", "MANUAL_REVIEW", "VOID"] } }, "flags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "code": { "type": "string", "enum": [ "DEBRIS_TYPE_MISMATCH", "CERT_NUMBER_MISMATCH", "DISPOSAL_BEFORE_COLLECTION_ENDED", "OVERLAPPING_LOADS", "SPLIT_SUFFIX_GAP", "CARRIED_COUNT_MISMATCH", "NO_CERTIFICATION", "TYPED_CAPACITY_DIFFERS", "TAG_EXPIRED", "CERTIFICATION_REVOKED", "CERTIFICATION_REPLACED", "OUTSIDE_PROJECT_BOUNDARY", "NO_ZONE", "OUTSIDE_SITE_AREA", "PROJECT_NOT_ACTIVE", "SITE_NOT_YET_ACTIVE", "SITE_CLOSED", "NO_ROAD_ROUTE", "DEVICE_CLOCK_OFF", "WORK_TIME_AFTER_RECEIVED", "WORK_TIME_BEFORE_ENROLMENT", "DEVICE_TIME_ZONE_DIFFERS", "PHONE_OUT_OF_SERVICE", "TYPED_TICKET_NUMBER", "BACK_OFFICE_RECORD", "SITE_DOES_NOT_TAKE_LOADS", "SITE_NOT_FOR_HAUL_OUTS", "INELIGIBLE_SITE", "TIPPING_FEE_RULE_MISSING", "HAUL_OUT_DUMPED_AT_TDSR", "LOAD_CALL_ZERO", "LOAD_CALL_LOW", "LOAD_CALL_HIGH", "PILE_CALL_NOT_HIGHER", "QUANTITY_MISSING_FOR_PAY_ITEM", "SHARED_SCALE_WEIGHT", "RECEIPT_TWO_DEBRIS_TYPES", "SCALE_WEIGHT_UNUSABLE", "CARRIED_TICKET_NOT_FOUND", "CARRIED_TICKET_ON_ANOTHER_LOAD", "MEASUREMENT_MISSING", "GPS_MISSING", "PHOTOS_MISSING", "DECIMAL_COUNT", "NO_SIZE_BAND", "OUTSIDE_SIZE_BAND", "MARKED_INELIGIBLE", "STUMP_UNDER_24", "ROOT_BALL_NOT_WIDER", "FILL_WITHOUT_EXPOSED_ROOT_BALL", "ROOT_BALL_MISSING", "NO_SURVEY", "CREW_ITEM_OVER_12_HOURS", "CREW_TIME_OVERLAP", "ROE_MISSING", "ROE_NOT_ON_PROJECT", "ROE_UNSIGNED", "ROE_OUT_OF_SCOPE", "NO_PRE_WORK_SURVEY", "CERTIFICATION_PHOTO_MISSING", "PERMIT_OUTSTANDING", "NO_PRICING_RULE", "DUPLICATE_TRANSACTION_NUMBER", "NO_RATE_FOR_PRIME", "RATE_TO_BE_NEGOTIATED", "NOT_PROCESSED", "DETAIL_MISSING", "TYPED_NUMBER_NO_REASON", "WRONG_KIND_OF_BADGE", "GPS_UNREADABLE", "NOT_A_TICKET_NUMBER", "ENDED_BEFORE_STARTED", "SPLIT_NOT_ALLOWED", "OUTSIDE_CONTROL_RANGES", "ASSIGNMENT_ON_ANOTHER_PROJECT", "SCALE_NET_DISAGREES", "TWO_QUANTITIES", "NOT_PROCESSED_LINES_STAND", "SUB_NAME_ALIKE", "MONITOR_NOT_SIGNED_IN", "ASSIGNMENT_OF_ANOTHER_PERSON" ] }, "message": { "type": "string" }, "billing": { "type": "string", "enum": ["BILLS", "LINE_NOT_BILLED", "NOT_BILLED"] }, "raisedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["id", "code", "message", "billing", "raisedAt"], "additionalProperties": false } }, "waitingOnSetAsideJob": { "type": "boolean" } }, "required": [ "workflow", "ticketNumber", "statuses", "flags", "waitingOnSetAsideJob" ], "additionalProperties": false } }, "waitingOnSetAsideJobs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "next": { "type": ["string", "null"] } }, "required": ["causes", "tickets", "waitingOnSetAsideJobs", "next"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/review-names": { "get": { "operationId": "reviewNames", "summary": "The names a reviewer reads a project’s tickets by: its people (a monitor with their Monitor ID), sites, the debris types of its forms, pay items by code and description, contractors, contracts, rules and zones, and the firm’s lists a ticket names (payable types, kinds of work and their item names, field tags, reasons with where each is offered, survey work types, incident types and sub-types); each archived one said so. Never a rate.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_REVIEW", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "people": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "monitorNumber": { "type": ["string", "null"] }, "monitor": { "type": "boolean" }, "archived": { "type": "boolean" } }, "required": ["id", "name", "monitorNumber", "monitor", "archived"], "additionalProperties": false } }, "sites": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "archived": { "type": "boolean" } }, "required": ["id", "name", "archived"], "additionalProperties": false } }, "debrisTypes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "archived": { "type": "boolean" }, "debrisTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "formName": { "type": "string" }, "documentType": { "type": "string" }, "reduced": { "type": "boolean" } }, "required": [ "id", "name", "archived", "debrisTypeId", "formName", "documentType", "reduced" ], "additionalProperties": false } }, "payItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "code": { "type": "string" }, "description": { "type": "string" }, "archived": { "type": "boolean" } }, "required": ["id", "code", "description", "archived"], "additionalProperties": false } }, "contractors": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "archived": { "type": "boolean" } }, "required": ["id", "name", "archived"], "additionalProperties": false } }, "contracts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "archived": { "type": "boolean" } }, "required": ["id", "name", "archived"], "additionalProperties": false } }, "rules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "archived": { "type": "boolean" } }, "required": ["id", "name", "archived"], "additionalProperties": false } }, "zones": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false } }, "payableTypes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "archived": { "type": "boolean" } }, "required": ["id", "name", "archived"], "additionalProperties": false } }, "kindsOfWork": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "archived": { "type": "boolean" } }, "required": ["id", "name", "archived"], "additionalProperties": false } }, "itemNames": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "archived": { "type": "boolean" }, "kindOfWorkId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["id", "name", "archived", "kindOfWorkId"], "additionalProperties": false } }, "fieldTags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "archived": { "type": "boolean" } }, "required": ["id", "name", "archived"], "additionalProperties": false } }, "reasons": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "archived": { "type": "boolean" }, "uses": { "type": "array", "items": { "type": "string" } } }, "required": ["id", "name", "archived", "uses"], "additionalProperties": false } }, "surveyWorkTypes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "archived": { "type": "boolean" } }, "required": ["id", "name", "archived"], "additionalProperties": false } }, "incidentTypes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "archived": { "type": "boolean" } }, "required": ["id", "name", "archived"], "additionalProperties": false } }, "incidentSubTypes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "archived": { "type": "boolean" }, "incidentTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["id", "name", "archived", "incidentTypeId"], "additionalProperties": false } }, "formDefinitions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "documentType": { "type": "string" }, "version": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "fields": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "type": { "type": "string", "enum": ["TEXT", "NUMBER", "YES_NO", "PICK", "PHOTO"] }, "required": { "type": "boolean" }, "choices": { "minItems": 1, "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": ["id", "label", "type", "required"], "additionalProperties": false } } }, "required": ["id", "documentType", "version", "fields"], "additionalProperties": false } } }, "required": [ "people", "sites", "debrisTypes", "payItems", "contractors", "contracts", "rules", "zones", "payableTypes", "kindsOfWork", "itemNames", "fieldTags", "reasons", "surveyWorkTypes", "incidentTypes", "incidentSubTypes", "formDefinitions" ], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/flags": { "get": { "operationId": "listFlags", "summary": "A project’s flags, a page at a time, oldest first: on a ticket or on another record (a certification, a site, a survey), of one cause or every one, open or cleared, each with every acceptance it had and whether it was taken back.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_REVIEW", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "cause", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "DEBRIS_TYPE_MISMATCH", "CERT_NUMBER_MISMATCH", "DISPOSAL_BEFORE_COLLECTION_ENDED", "OVERLAPPING_LOADS", "SPLIT_SUFFIX_GAP", "CARRIED_COUNT_MISMATCH", "NO_CERTIFICATION", "TYPED_CAPACITY_DIFFERS", "TAG_EXPIRED", "CERTIFICATION_REVOKED", "CERTIFICATION_REPLACED", "OUTSIDE_PROJECT_BOUNDARY", "NO_ZONE", "OUTSIDE_SITE_AREA", "PROJECT_NOT_ACTIVE", "SITE_NOT_YET_ACTIVE", "SITE_CLOSED", "NO_ROAD_ROUTE", "DEVICE_CLOCK_OFF", "WORK_TIME_AFTER_RECEIVED", "WORK_TIME_BEFORE_ENROLMENT", "DEVICE_TIME_ZONE_DIFFERS", "PHONE_OUT_OF_SERVICE", "TYPED_TICKET_NUMBER", "BACK_OFFICE_RECORD", "SITE_DOES_NOT_TAKE_LOADS", "SITE_NOT_FOR_HAUL_OUTS", "INELIGIBLE_SITE", "TIPPING_FEE_RULE_MISSING", "HAUL_OUT_DUMPED_AT_TDSR", "LOAD_CALL_ZERO", "LOAD_CALL_LOW", "LOAD_CALL_HIGH", "PILE_CALL_NOT_HIGHER", "QUANTITY_MISSING_FOR_PAY_ITEM", "SHARED_SCALE_WEIGHT", "RECEIPT_TWO_DEBRIS_TYPES", "SCALE_WEIGHT_UNUSABLE", "CARRIED_TICKET_NOT_FOUND", "CARRIED_TICKET_ON_ANOTHER_LOAD", "MEASUREMENT_MISSING", "GPS_MISSING", "PHOTOS_MISSING", "DECIMAL_COUNT", "NO_SIZE_BAND", "OUTSIDE_SIZE_BAND", "MARKED_INELIGIBLE", "STUMP_UNDER_24", "ROOT_BALL_NOT_WIDER", "FILL_WITHOUT_EXPOSED_ROOT_BALL", "ROOT_BALL_MISSING", "NO_SURVEY", "CREW_ITEM_OVER_12_HOURS", "CREW_TIME_OVERLAP", "ROE_MISSING", "ROE_NOT_ON_PROJECT", "ROE_UNSIGNED", "ROE_OUT_OF_SCOPE", "NO_PRE_WORK_SURVEY", "CERTIFICATION_PHOTO_MISSING", "PERMIT_OUTSTANDING", "NO_PRICING_RULE", "DUPLICATE_TRANSACTION_NUMBER", "NO_RATE_FOR_PRIME", "RATE_TO_BE_NEGOTIATED", "NOT_PROCESSED", "DETAIL_MISSING", "TYPED_NUMBER_NO_REASON", "WRONG_KIND_OF_BADGE", "GPS_UNREADABLE", "NOT_A_TICKET_NUMBER", "ENDED_BEFORE_STARTED", "SPLIT_NOT_ALLOWED", "OUTSIDE_CONTROL_RANGES", "ASSIGNMENT_ON_ANOTHER_PROJECT", "SCALE_NET_DISAGREES", "TWO_QUANTITIES", "NOT_PROCESSED_LINES_STAND", "SUB_NAME_ALIKE", "MONITOR_NOT_SIGNED_IN", "ASSIGNMENT_OF_ANOTHER_PERSON" ] } }, { "name": "open", "in": "query", "required": false, "schema": { "type": "string", "enum": ["true", "false"] } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "flags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workflow": { "anyOf": [ { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] }, { "type": "null" } ] }, "ticketNumber": { "type": ["string", "null"] }, "fieldEventId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certificationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "disposalSiteId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "surveyId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "code": { "type": "string", "enum": [ "DEBRIS_TYPE_MISMATCH", "CERT_NUMBER_MISMATCH", "DISPOSAL_BEFORE_COLLECTION_ENDED", "OVERLAPPING_LOADS", "SPLIT_SUFFIX_GAP", "CARRIED_COUNT_MISMATCH", "NO_CERTIFICATION", "TYPED_CAPACITY_DIFFERS", "TAG_EXPIRED", "CERTIFICATION_REVOKED", "CERTIFICATION_REPLACED", "OUTSIDE_PROJECT_BOUNDARY", "NO_ZONE", "OUTSIDE_SITE_AREA", "PROJECT_NOT_ACTIVE", "SITE_NOT_YET_ACTIVE", "SITE_CLOSED", "NO_ROAD_ROUTE", "DEVICE_CLOCK_OFF", "WORK_TIME_AFTER_RECEIVED", "WORK_TIME_BEFORE_ENROLMENT", "DEVICE_TIME_ZONE_DIFFERS", "PHONE_OUT_OF_SERVICE", "TYPED_TICKET_NUMBER", "BACK_OFFICE_RECORD", "SITE_DOES_NOT_TAKE_LOADS", "SITE_NOT_FOR_HAUL_OUTS", "INELIGIBLE_SITE", "TIPPING_FEE_RULE_MISSING", "HAUL_OUT_DUMPED_AT_TDSR", "LOAD_CALL_ZERO", "LOAD_CALL_LOW", "LOAD_CALL_HIGH", "PILE_CALL_NOT_HIGHER", "QUANTITY_MISSING_FOR_PAY_ITEM", "SHARED_SCALE_WEIGHT", "RECEIPT_TWO_DEBRIS_TYPES", "SCALE_WEIGHT_UNUSABLE", "CARRIED_TICKET_NOT_FOUND", "CARRIED_TICKET_ON_ANOTHER_LOAD", "MEASUREMENT_MISSING", "GPS_MISSING", "PHOTOS_MISSING", "DECIMAL_COUNT", "NO_SIZE_BAND", "OUTSIDE_SIZE_BAND", "MARKED_INELIGIBLE", "STUMP_UNDER_24", "ROOT_BALL_NOT_WIDER", "FILL_WITHOUT_EXPOSED_ROOT_BALL", "ROOT_BALL_MISSING", "NO_SURVEY", "CREW_ITEM_OVER_12_HOURS", "CREW_TIME_OVERLAP", "ROE_MISSING", "ROE_NOT_ON_PROJECT", "ROE_UNSIGNED", "ROE_OUT_OF_SCOPE", "NO_PRE_WORK_SURVEY", "CERTIFICATION_PHOTO_MISSING", "PERMIT_OUTSTANDING", "NO_PRICING_RULE", "DUPLICATE_TRANSACTION_NUMBER", "NO_RATE_FOR_PRIME", "RATE_TO_BE_NEGOTIATED", "NOT_PROCESSED", "DETAIL_MISSING", "TYPED_NUMBER_NO_REASON", "WRONG_KIND_OF_BADGE", "GPS_UNREADABLE", "NOT_A_TICKET_NUMBER", "ENDED_BEFORE_STARTED", "SPLIT_NOT_ALLOWED", "OUTSIDE_CONTROL_RANGES", "ASSIGNMENT_ON_ANOTHER_PROJECT", "SCALE_NET_DISAGREES", "TWO_QUANTITIES", "NOT_PROCESSED_LINES_STAND", "SUB_NAME_ALIKE", "MONITOR_NOT_SIGNED_IN", "ASSIGNMENT_OF_ANOTHER_PERSON" ] }, "message": { "type": "string" }, "billing": { "type": "string", "enum": ["BILLS", "LINE_NOT_BILLED", "NOT_BILLED"] }, "slot": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "payItemId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "raisedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "clearedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "acceptances": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "flagId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "reasonId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "note": { "type": ["string", "null"] }, "acceptedById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "acceptedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "withdrawnById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "withdrawnAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "withdrawNote": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "flagId", "reasonId", "note", "acceptedById", "acceptedAt", "withdrawnById", "withdrawnAt", "withdrawNote" ], "additionalProperties": false } } }, "required": [ "id", "projectId", "workflow", "ticketNumber", "fieldEventId", "certificationId", "disposalSiteId", "surveyId", "code", "message", "billing", "slot", "payItemId", "raisedAt", "clearedAt", "acceptances" ], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["flags", "next"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/tickets/{workflow}/{ticketNumber}": { "get": { "operationId": "readTicket", "summary": "One ticket whole, as the back office reads it: its field events in field time (as recorded and corrected, with their status, zone and worked-out pay item), the completed record that stands with its collection rows, its lines with their rates and amounts, its flags with their acceptances, its QC mark, every lock it had, its voids and unvoids. A ticket with no field event is not found.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_REVIEW", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "workflow", "in": "path", "required": true, "schema": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] } }, { "name": "ticketNumber", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 40 } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workflow": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] }, "ticketNumber": { "type": "string" }, "statuses": { "type": "array", "items": { "type": "string", "enum": ["PENDING", "COMPLETED", "MANUAL_REVIEW", "VOID"] } }, "fieldEvents": { "minItems": 1, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workflow": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] }, "ticketNumber": { "type": "string" }, "kind": { "type": "string", "enum": [ "COLLECTION", "DISPOSAL", "HAUL_OUT_COLLECTION", "HAUL_OUT_DISPOSAL", "UNIT_RATE" ] }, "splitSuffix": { "type": "string" }, "source": { "type": "string", "enum": ["DEVICE", "BACK_OFFICE"] }, "masterPasscodeSession": { "anyOf": [ { "type": "string", "enum": ["AS_MONITOR", "TEMPORARY"] }, { "type": "null" } ] }, "createdById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "createdReasonId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "monitorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "startedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "endedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "start": { "anyOf": [ { "type": "object", "properties": { "latitude": { "type": "string" }, "longitude": { "type": "string" } }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "end": { "anyOf": [ { "type": "object", "properties": { "latitude": { "type": "string" }, "longitude": { "type": "string" } }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "address": { "type": ["string", "null"] }, "addressSource": { "anyOf": [ { "type": "string", "enum": ["LOOKED_UP", "TYPED"] }, { "type": "null" } ] }, "notes": { "type": ["string", "null"] }, "certNumber": { "type": "string" }, "certificationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certKeyedByHand": { "type": "boolean" }, "typedCapacityCy": { "type": ["number", "null"] }, "numberTyped": { "type": "boolean" }, "numberTypedReasonId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "siteId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "formDebrisTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "fieldTagId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "roeNumber": { "type": ["string", "null"] }, "roeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "estimateCy": { "type": ["number", "null"] }, "loadCall": { "type": ["number", "null"] }, "scaleReceiptId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "carriedCount": { "type": ["number", "null"] }, "kindOfWorkId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "payableTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "payItemId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "unitCount": { "type": ["number", "null"] }, "measurementInches": { "type": ["number", "null"] }, "measuredAs": { "anyOf": [ { "type": "string", "enum": ["CIRCUMFERENCE", "DIAMETER"] }, { "type": "null" } ] }, "rootBallInches": { "type": ["number", "null"] }, "rootBallHalfExposed": { "type": ["boolean", "null"] }, "surveyNumber": { "type": ["string", "null"] }, "markedIneligible": { "type": ["boolean", "null"] }, "status": { "type": "string", "enum": ["PENDING", "COMPLETED", "MANUAL_REVIEW", "VOID"] }, "receivedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "reconciledAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "zoneId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "mapVersionId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "workedOutPayItemId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "deviceId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "assignmentId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "setupVersion": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "id", "projectId", "workflow", "ticketNumber", "kind", "splitSuffix", "source", "masterPasscodeSession", "createdById", "createdReasonId", "monitorId", "startedAt", "endedAt", "deviceUtcOffsetMinutes", "start", "end", "address", "addressSource", "notes", "certNumber", "certificationId", "certKeyedByHand", "typedCapacityCy", "numberTyped", "numberTypedReasonId", "siteId", "formDebrisTypeId", "fieldTagId", "roeNumber", "roeId", "estimateCy", "loadCall", "scaleReceiptId", "carriedCount", "kindOfWorkId", "payableTypeId", "payItemId", "unitCount", "measurementInches", "measuredAs", "rootBallInches", "rootBallHalfExposed", "surveyNumber", "markedIneligible", "status", "receivedAt", "reconciledAt", "zoneId", "mapVersionId", "workedOutPayItemId", "deviceId", "assignmentId", "setupVersion" ], "additionalProperties": false } }, "completed": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "disposalEventId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "quantitySource": { "type": "string", "enum": ["LOAD_CALL", "SCALE_WEIGHT", "CARRIED_TICKETS"] }, "capacityCy": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "loadCall": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "volumeCy": { "anyOf": [ { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, { "type": "null" } ] }, "weightTons": { "anyOf": [ { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, { "type": "null" } ] }, "weightIsShare": { "type": "boolean" }, "carriedCount": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "collections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "collectionEventId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "splitSuffix": { "type": "string" }, "shareFraction": { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, "pileLoadCall": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "volumeCy": { "anyOf": [ { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, { "type": "null" } ] }, "weightTons": { "anyOf": [ { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, { "type": "null" } ] }, "mileage": { "anyOf": [ { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, { "type": "null" } ] }, "mileageSource": { "anyOf": [ { "type": "string", "enum": ["ROAD_ROUTE", "STRAIGHT_LINE"] }, { "type": "null" } ] }, "snappedAddress": { "type": ["string", "null"] } }, "required": [ "id", "collectionEventId", "splitSuffix", "shareFraction", "pileLoadCall", "volumeCy", "weightTons", "mileage", "mileageSource", "snappedAddress" ], "additionalProperties": false } } }, "required": [ "id", "disposalEventId", "quantitySource", "capacityCy", "loadCall", "volumeCy", "weightTons", "weightIsShare", "carriedCount", "collections" ], "additionalProperties": false }, { "type": "null" } ] }, "lines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "splitSuffix": { "type": "string" }, "slot": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "ruleId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "payItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "contractId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "primeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "operatingSubId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "unit": { "type": "string", "enum": ["CY", "TN", "EA", "LB", "HR", "CREW_DAY", "TBN"] }, "quantity": { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, "rate": { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, "amount": { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" } }, "required": [ "id", "splitSuffix", "slot", "ruleId", "payItemId", "contractId", "primeId", "operatingSubId", "unit", "quantity", "rate", "amount" ], "additionalProperties": false } }, "flags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workflow": { "anyOf": [ { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] }, { "type": "null" } ] }, "ticketNumber": { "type": ["string", "null"] }, "fieldEventId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certificationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "disposalSiteId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "surveyId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "code": { "type": "string", "enum": [ "DEBRIS_TYPE_MISMATCH", "CERT_NUMBER_MISMATCH", "DISPOSAL_BEFORE_COLLECTION_ENDED", "OVERLAPPING_LOADS", "SPLIT_SUFFIX_GAP", "CARRIED_COUNT_MISMATCH", "NO_CERTIFICATION", "TYPED_CAPACITY_DIFFERS", "TAG_EXPIRED", "CERTIFICATION_REVOKED", "CERTIFICATION_REPLACED", "OUTSIDE_PROJECT_BOUNDARY", "NO_ZONE", "OUTSIDE_SITE_AREA", "PROJECT_NOT_ACTIVE", "SITE_NOT_YET_ACTIVE", "SITE_CLOSED", "NO_ROAD_ROUTE", "DEVICE_CLOCK_OFF", "WORK_TIME_AFTER_RECEIVED", "WORK_TIME_BEFORE_ENROLMENT", "DEVICE_TIME_ZONE_DIFFERS", "PHONE_OUT_OF_SERVICE", "TYPED_TICKET_NUMBER", "BACK_OFFICE_RECORD", "SITE_DOES_NOT_TAKE_LOADS", "SITE_NOT_FOR_HAUL_OUTS", "INELIGIBLE_SITE", "TIPPING_FEE_RULE_MISSING", "HAUL_OUT_DUMPED_AT_TDSR", "LOAD_CALL_ZERO", "LOAD_CALL_LOW", "LOAD_CALL_HIGH", "PILE_CALL_NOT_HIGHER", "QUANTITY_MISSING_FOR_PAY_ITEM", "SHARED_SCALE_WEIGHT", "RECEIPT_TWO_DEBRIS_TYPES", "SCALE_WEIGHT_UNUSABLE", "CARRIED_TICKET_NOT_FOUND", "CARRIED_TICKET_ON_ANOTHER_LOAD", "MEASUREMENT_MISSING", "GPS_MISSING", "PHOTOS_MISSING", "DECIMAL_COUNT", "NO_SIZE_BAND", "OUTSIDE_SIZE_BAND", "MARKED_INELIGIBLE", "STUMP_UNDER_24", "ROOT_BALL_NOT_WIDER", "FILL_WITHOUT_EXPOSED_ROOT_BALL", "ROOT_BALL_MISSING", "NO_SURVEY", "CREW_ITEM_OVER_12_HOURS", "CREW_TIME_OVERLAP", "ROE_MISSING", "ROE_NOT_ON_PROJECT", "ROE_UNSIGNED", "ROE_OUT_OF_SCOPE", "NO_PRE_WORK_SURVEY", "CERTIFICATION_PHOTO_MISSING", "PERMIT_OUTSTANDING", "NO_PRICING_RULE", "DUPLICATE_TRANSACTION_NUMBER", "NO_RATE_FOR_PRIME", "RATE_TO_BE_NEGOTIATED", "NOT_PROCESSED", "DETAIL_MISSING", "TYPED_NUMBER_NO_REASON", "WRONG_KIND_OF_BADGE", "GPS_UNREADABLE", "NOT_A_TICKET_NUMBER", "ENDED_BEFORE_STARTED", "SPLIT_NOT_ALLOWED", "OUTSIDE_CONTROL_RANGES", "ASSIGNMENT_ON_ANOTHER_PROJECT", "SCALE_NET_DISAGREES", "TWO_QUANTITIES", "NOT_PROCESSED_LINES_STAND", "SUB_NAME_ALIKE", "MONITOR_NOT_SIGNED_IN", "ASSIGNMENT_OF_ANOTHER_PERSON" ] }, "message": { "type": "string" }, "billing": { "type": "string", "enum": ["BILLS", "LINE_NOT_BILLED", "NOT_BILLED"] }, "slot": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "payItemId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "raisedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "clearedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "acceptances": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "flagId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "reasonId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "note": { "type": ["string", "null"] }, "acceptedById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "acceptedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "withdrawnById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "withdrawnAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "withdrawNote": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "flagId", "reasonId", "note", "acceptedById", "acceptedAt", "withdrawnById", "withdrawnAt", "withdrawNote" ], "additionalProperties": false } } }, "required": [ "id", "projectId", "workflow", "ticketNumber", "fieldEventId", "certificationId", "disposalSiteId", "surveyId", "code", "message", "billing", "slot", "payItemId", "raisedAt", "clearedAt", "acceptances" ], "additionalProperties": false } }, "qcMark": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "completedLoadId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "completedHaulOutId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "unitRateTicketId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certificationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "roeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "surveyId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "incidentId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "dropOffLogId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "status": { "type": "string", "enum": ["QC_REVIEW", "QC_APPROVED", "QC_ISSUES", "QC_VOID"] }, "setById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "setAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "note": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "completedLoadId", "completedHaulOutId", "unitRateTicketId", "certificationId", "roeId", "surveyId", "incidentId", "dropOffLogId", "status", "setById", "setAt", "note" ], "additionalProperties": false }, { "type": "null" } ] }, "locks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "completedLoadId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "completedHaulOutId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "unitRateTicketId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "invoiceBatchId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "lockedById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "lockedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "unlockedById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "unlockedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "unlockNote": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "completedLoadId", "completedHaulOutId", "unitRateTicketId", "invoiceBatchId", "lockedById", "lockedAt", "unlockedById", "unlockedAt", "unlockNote" ], "additionalProperties": false } }, "voids": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workflow": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] }, "ticketNumber": { "type": "string" }, "reasonId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "note": { "type": ["string", "null"] }, "voidedById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "voidedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "liftedById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "liftedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "liftNote": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "workflow", "ticketNumber", "reasonId", "note", "voidedById", "voidedAt", "liftedById", "liftedAt", "liftNote" ], "additionalProperties": false } }, "unvoids": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workflow": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] }, "ticketNumber": { "type": "string" }, "note": { "type": ["string", "null"] }, "unvoidedById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "unvoidedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "id", "projectId", "workflow", "ticketNumber", "note", "unvoidedById", "unvoidedAt" ], "additionalProperties": false } } }, "required": [ "projectId", "workflow", "ticketNumber", "statuses", "fieldEvents", "completed", "lines", "flags", "qcMark", "locks", "voids", "unvoids" ], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/tickets/{workflow}/{ticketNumber}/decisions": { "get": { "operationId": "readTicketDecisions", "summary": "What each reconciliation run decided for one ticket and why, newest first, a page at a time: the run (what started it, when), the status it left, its words, the field events it grouped and the kinds still to arrive, the lines it priced with the rule that made each, the flags it raised, and the rule or person that voided it; whether the ticket could be processed. A ticket with no field event is not found.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_REVIEW", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "workflow", "in": "path", "required": true, "schema": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] } }, { "name": "ticketNumber", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 40 } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "decisions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "run": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "trigger": { "type": "string", "enum": ["SYNC", "CORRECTION", "SETUP_CHANGE", "REPROCESS"] }, "startedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["id", "trigger", "startedAt"], "additionalProperties": false }, "status": { "type": "string", "enum": ["PENDING", "COMPLETED", "MANUAL_REVIEW", "VOID"] }, "why": { "type": "string" }, "processed": { "type": "boolean" }, "fieldEvents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "kind": { "type": "string", "enum": [ "COLLECTION", "DISPOSAL", "HAUL_OUT_COLLECTION", "HAUL_OUT_DISPOSAL", "UNIT_RATE" ] }, "splitSuffix": { "type": ["string", "null"] }, "startedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "endedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["id", "kind", "splitSuffix", "startedAt", "endedAt"], "additionalProperties": false } }, "waitingFor": { "type": "array", "items": { "type": "string", "enum": [ "COLLECTION", "DISPOSAL", "HAUL_OUT_COLLECTION", "HAUL_OUT_DISPOSAL", "UNIT_RATE" ] } }, "lines": { "type": "array", "items": { "type": "object", "properties": { "splitSuffix": { "type": "string" }, "slot": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "ruleId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "payItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "quantity": { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, "rate": { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, "amount": { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" } }, "required": [ "splitSuffix", "slot", "ruleId", "payItemId", "quantity", "rate", "amount" ], "additionalProperties": false } }, "flags": { "type": "array", "items": { "type": "string", "enum": [ "DEBRIS_TYPE_MISMATCH", "CERT_NUMBER_MISMATCH", "DISPOSAL_BEFORE_COLLECTION_ENDED", "OVERLAPPING_LOADS", "SPLIT_SUFFIX_GAP", "CARRIED_COUNT_MISMATCH", "NO_CERTIFICATION", "TYPED_CAPACITY_DIFFERS", "TAG_EXPIRED", "CERTIFICATION_REVOKED", "CERTIFICATION_REPLACED", "OUTSIDE_PROJECT_BOUNDARY", "NO_ZONE", "OUTSIDE_SITE_AREA", "PROJECT_NOT_ACTIVE", "SITE_NOT_YET_ACTIVE", "SITE_CLOSED", "NO_ROAD_ROUTE", "DEVICE_CLOCK_OFF", "WORK_TIME_AFTER_RECEIVED", "WORK_TIME_BEFORE_ENROLMENT", "DEVICE_TIME_ZONE_DIFFERS", "PHONE_OUT_OF_SERVICE", "TYPED_TICKET_NUMBER", "BACK_OFFICE_RECORD", "SITE_DOES_NOT_TAKE_LOADS", "SITE_NOT_FOR_HAUL_OUTS", "INELIGIBLE_SITE", "TIPPING_FEE_RULE_MISSING", "HAUL_OUT_DUMPED_AT_TDSR", "LOAD_CALL_ZERO", "LOAD_CALL_LOW", "LOAD_CALL_HIGH", "PILE_CALL_NOT_HIGHER", "QUANTITY_MISSING_FOR_PAY_ITEM", "SHARED_SCALE_WEIGHT", "RECEIPT_TWO_DEBRIS_TYPES", "SCALE_WEIGHT_UNUSABLE", "CARRIED_TICKET_NOT_FOUND", "CARRIED_TICKET_ON_ANOTHER_LOAD", "MEASUREMENT_MISSING", "GPS_MISSING", "PHOTOS_MISSING", "DECIMAL_COUNT", "NO_SIZE_BAND", "OUTSIDE_SIZE_BAND", "MARKED_INELIGIBLE", "STUMP_UNDER_24", "ROOT_BALL_NOT_WIDER", "FILL_WITHOUT_EXPOSED_ROOT_BALL", "ROOT_BALL_MISSING", "NO_SURVEY", "CREW_ITEM_OVER_12_HOURS", "CREW_TIME_OVERLAP", "ROE_MISSING", "ROE_NOT_ON_PROJECT", "ROE_UNSIGNED", "ROE_OUT_OF_SCOPE", "NO_PRE_WORK_SURVEY", "CERTIFICATION_PHOTO_MISSING", "PERMIT_OUTSTANDING", "NO_PRICING_RULE", "DUPLICATE_TRANSACTION_NUMBER", "NO_RATE_FOR_PRIME", "RATE_TO_BE_NEGOTIATED", "NOT_PROCESSED", "DETAIL_MISSING", "TYPED_NUMBER_NO_REASON", "WRONG_KIND_OF_BADGE", "GPS_UNREADABLE", "NOT_A_TICKET_NUMBER", "ENDED_BEFORE_STARTED", "SPLIT_NOT_ALLOWED", "OUTSIDE_CONTROL_RANGES", "ASSIGNMENT_ON_ANOTHER_PROJECT", "SCALE_NET_DISAGREES", "TWO_QUANTITIES", "NOT_PROCESSED_LINES_STAND", "SUB_NAME_ALIKE", "MONITOR_NOT_SIGNED_IN", "ASSIGNMENT_OF_ANOTHER_PERSON" ] } }, "voidedByRules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false } }, "voidedByPerson": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string" }, "reason": { "type": "string" } }, "required": ["name", "reason"], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "run", "status", "why", "processed", "fieldEvents", "waitingFor", "lines", "flags", "voidedByRules", "voidedByPerson" ], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["decisions", "next"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/tickets/{workflow}/{ticketNumber}/history": { "get": { "operationId": "readTicketHistory", "summary": "What the audit log holds of one ticket, newest first, a page at a time: every change to its field events and what is recorded beside them (item lines, carried tickets, photographs’ records), the completed record and its rows, its lines (those the worker removed included, each copied whole first), its flags and their acceptances, and its QC marks, locks, voids and unvoids; each with the values before and after, who made it, from where and why. A ticket with no field event is not found.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_REVIEW", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "workflow", "in": "path", "required": true, "schema": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] } }, { "name": "ticketNumber", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 40 } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[1-9][0-9]{0,18}$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "entries": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9]+$" }, "occurredAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "tableName": { "type": "string" }, "recordId": { "type": "string" }, "operation": { "type": "string", "enum": ["INSERT", "UPDATE", "DELETE"] }, "changedFields": { "type": "array", "items": { "type": "string" } }, "priorValue": { "anyOf": [ { "$ref": "#/$defs/__schema0" }, { "type": "null" } ] }, "newValue": { "anyOf": [ { "$ref": "#/$defs/__schema1" }, { "type": "null" } ] }, "actor": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] }, "source": { "type": "string", "enum": ["DEVICE", "BACK_OFFICE", "SYSTEM"] }, "deviceId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "reason": { "type": ["string", "null"] } }, "required": [ "id", "occurredAt", "tableName", "recordId", "operation", "changedFields", "priorValue", "newValue", "actor", "source", "deviceId", "reason" ], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "pattern": "^[0-9]+$" }, { "type": "null" } ] } }, "required": ["entries", "next"], "additionalProperties": false, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/$defs/__schema0" } } ] }, "__schema1": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/$defs/__schema1" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/$defs/__schema1" } } ] } } } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/audit-records": { "get": { "operationId": "readRecordHistory", "summary": "What the audit log holds of one record, by its table and id, newest first, a page at a time. Read by the area it belongs to: a ticket’s records with view review, setup with view setup, people, phones and the board with view dispatch; sign-in’s and the firm’s security records by an admin alone. A person’s phone number is shown to an admin alone.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[1-9][0-9]{0,18}$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } }, { "name": "tableName", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[a-z][a-z_]{0,62}$" } }, { "name": "recordId", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[0-9A-Za-z-]{1,40}$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "entries": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9]+$" }, "occurredAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "tableName": { "type": "string" }, "recordId": { "type": "string" }, "operation": { "type": "string", "enum": ["INSERT", "UPDATE", "DELETE"] }, "changedFields": { "type": "array", "items": { "type": "string" } }, "priorValue": { "anyOf": [ { "$ref": "#/$defs/__schema0" }, { "type": "null" } ] }, "newValue": { "anyOf": [ { "$ref": "#/$defs/__schema1" }, { "type": "null" } ] }, "actor": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] }, "source": { "type": "string", "enum": ["DEVICE", "BACK_OFFICE", "SYSTEM"] }, "deviceId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "reason": { "type": ["string", "null"] } }, "required": [ "id", "occurredAt", "tableName", "recordId", "operation", "changedFields", "priorValue", "newValue", "actor", "source", "deviceId", "reason" ], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "pattern": "^[0-9]+$" }, { "type": "null" } ] } }, "required": ["entries", "next"], "additionalProperties": false, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/$defs/__schema0" } } ] }, "__schema1": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/$defs/__schema1" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/$defs/__schema1" } } ] } } } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/set-aside-jobs": { "get": { "operationId": "listSetAsideJobs", "summary": "A project’s jobs set aside after failing too often, newest first, a page at a time: when each was queued and set aside, what queued it and who asked, its tries, and its tickets, each said to be waiting where no job has worked it since. Put one back with a reprocess naming it. Never why it failed.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_REVIEW", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "trigger": { "type": "string", "enum": ["SYNC", "CORRECTION", "SETUP_CHANGE", "REPROCESS"] }, "requestedById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "queuedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "setAsideAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "tries": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tickets": { "type": "array", "items": { "type": "object", "properties": { "workflow": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] }, "ticketNumber": { "type": "string" }, "waiting": { "type": "boolean" } }, "required": ["workflow", "ticketNumber", "waiting"], "additionalProperties": false } } }, "required": [ "id", "trigger", "requestedById", "queuedAt", "setAsideAt", "tries", "tickets" ], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["jobs", "next"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/ledger": { "get": { "operationId": "readLedger", "summary": "A project’s ledger as it stands, a page at a time in the order the worker wrote its lines: each line with its ticket (and property or pile), workflow, # slot, pay item, unit, quantity, rate, amount, contract, prime, operating sub, rule, ticket date, the ticket’s status, QC status and lock. Narrowed by workflow, pay item, prime, invoice batch, locked or not, and the days its work counts on (the project’s time zone). With the page, what every line the filters match comes to: how many, and their sum to the cent, added by the database.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_REVIEW", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "workflow", "in": "query", "required": false, "schema": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] } }, { "name": "payItemId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "primeId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "invoiceBatchId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "locked", "in": "query", "required": false, "schema": { "type": "string", "enum": ["true", "false"] } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "lines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workflow": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] }, "ticketNumber": { "type": "string" }, "splitSuffix": { "type": "string" }, "slot": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "payItem": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "code": { "type": "string" }, "description": { "type": "string" } }, "required": ["id", "code", "description"], "additionalProperties": false }, "payableType": { "type": "string" }, "unit": { "type": "string", "enum": ["CY", "TN", "EA", "LB", "HR", "CREW_DAY", "TBN"] }, "quantity": { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, "rate": { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, "amount": { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, "contract": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, "prime": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, "operatingSub": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] }, "rule": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, "ticketDate": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "status": { "type": "string", "enum": ["PENDING", "COMPLETED", "MANUAL_REVIEW", "VOID"] }, "qcStatus": { "anyOf": [ { "type": "string", "enum": ["QC_REVIEW", "QC_APPROVED", "QC_ISSUES", "QC_VOID"] }, { "type": "null" } ] }, "lock": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "lockedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "invoiceBatch": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] } }, "required": ["id", "lockedAt", "invoiceBatch"], "additionalProperties": false }, { "type": "null" } ] }, "mileage": { "anyOf": [ { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, { "type": "null" } ] }, "mileageSource": { "anyOf": [ { "type": "string", "enum": ["ROAD_ROUTE", "STRAIGHT_LINE"] }, { "type": "null" } ] } }, "required": [ "id", "workflow", "ticketNumber", "splitSuffix", "slot", "payItem", "payableType", "unit", "quantity", "rate", "amount", "contract", "prime", "operatingSub", "rule", "ticketDate", "status", "qcStatus", "lock", "mileage", "mileageSource" ], "additionalProperties": false } }, "total": { "type": "object", "properties": { "lines": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "amount": { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" } }, "required": ["lines", "amount"], "additionalProperties": false }, "next": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["lines", "total", "next"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/tickets": { "get": { "operationId": "listProjectTickets", "summary": "A project’s tickets of one workflow, any status, by number a page at a time: each with its statuses, ticket date, field events, what a QC mark or a lock names, its QC status, its lock and batch, what its lines come to, and why it can’t be locked as invoiced now where it can’t, in plain words. Narrowed by status, QC status (NONE: no mark yet), locked or not, an invoice batch, and the days it counts on.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_REVIEW", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "workflow", "in": "query", "required": true, "schema": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": ["PENDING", "COMPLETED", "MANUAL_REVIEW", "VOID"] } }, { "name": "qcStatus", "in": "query", "required": false, "schema": { "type": "string", "enum": ["QC_REVIEW", "QC_APPROVED", "QC_ISSUES", "QC_VOID", "NONE"] } }, { "name": "locked", "in": "query", "required": false, "schema": { "type": "string", "enum": ["true", "false"] } }, { "name": "invoiceBatchId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 40 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "tickets": { "type": "array", "items": { "type": "object", "properties": { "workflow": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] }, "ticketNumber": { "type": "string" }, "statuses": { "type": "array", "items": { "type": "string", "enum": ["PENDING", "COMPLETED", "MANUAL_REVIEW", "VOID"] } }, "ticketDate": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "fieldEvents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "kind": { "type": "string", "enum": [ "COLLECTION", "DISPOSAL", "HAUL_OUT_COLLECTION", "HAUL_OUT_DISPOSAL", "UNIT_RATE" ] }, "splitSuffix": { "type": "string" } }, "required": ["id", "kind", "splitSuffix"], "additionalProperties": false } }, "target": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "completedLoadId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["completedLoadId"], "additionalProperties": false }, { "type": "object", "properties": { "completedHaulOutId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["completedHaulOutId"], "additionalProperties": false }, { "type": "object", "properties": { "unitRateTicketId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["unitRateTicketId"], "additionalProperties": false } ] }, { "type": "null" } ] }, "qcStatus": { "anyOf": [ { "type": "string", "enum": ["QC_REVIEW", "QC_APPROVED", "QC_ISSUES", "QC_VOID"] }, { "type": "null" } ] }, "lock": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "lockedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "invoiceBatch": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] } }, "required": ["id", "lockedAt", "invoiceBatch"], "additionalProperties": false }, { "type": "null" } ] }, "lines": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "amount": { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, "lockRefusal": { "anyOf": [ { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": ["code", "message"], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "workflow", "ticketNumber", "statuses", "ticketDate", "fieldEvents", "target", "qcStatus", "lock", "lines", "amount", "lockRefusal" ], "additionalProperties": false } }, "next": { "type": ["string", "null"] } }, "required": ["tickets", "next"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/audit-records": { "get": { "operationId": "readProjectAuditTrail", "summary": "What the audit log holds of a project, newest first, a page at a time: every change to its records, each with the values before and after, who made it, from where and why. Narrowed by the log’s domain (security, billing, operations, records) and by who made the change. Each reader is shown what their areas let them read, as a record’s history is: a ticket’s records with view review, setup with view setup, the board with view dispatch, the security domain an admin alone.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[1-9][0-9]{0,18}$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } }, { "name": "domain", "in": "query", "required": false, "schema": { "type": "string", "enum": ["SECURITY", "BILLING", "OPERATIONS", "RECORDS"] } }, { "name": "actorId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "entries": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9]+$" }, "occurredAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "tableName": { "type": "string" }, "recordId": { "type": "string" }, "operation": { "type": "string", "enum": ["INSERT", "UPDATE", "DELETE"] }, "changedFields": { "type": "array", "items": { "type": "string" } }, "priorValue": { "anyOf": [ { "$ref": "#/$defs/__schema0" }, { "type": "null" } ] }, "newValue": { "anyOf": [ { "$ref": "#/$defs/__schema1" }, { "type": "null" } ] }, "actor": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] }, "source": { "type": "string", "enum": ["DEVICE", "BACK_OFFICE", "SYSTEM"] }, "deviceId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "reason": { "type": ["string", "null"] } }, "required": [ "id", "occurredAt", "tableName", "recordId", "operation", "changedFields", "priorValue", "newValue", "actor", "source", "deviceId", "reason" ], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "pattern": "^[0-9]+$" }, { "type": "null" } ] } }, "required": ["entries", "next"], "additionalProperties": false, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/$defs/__schema0" } } ] }, "__schema1": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/$defs/__schema1" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/$defs/__schema1" } } ] } } } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/debris-totals": { "get": { "operationId": "readDebrisTotals", "summary": "What a project moved over a range of days (a day, a week, a month, any range up to 366 days) in its time zone, never a cost: completed loads by debris type (loads, CY, tons), completed haul-outs by the site they were dumped at and their debris type, unit rate tickets by payable type and pay item (tickets and units), the trucks, trailers and crews whose badges were scanned, incidents filed and open, monitors on shift, and each day’s counts. Narrowed by workflow, debris type, site and contractor. Read each time, kept nowhere.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_REVIEW", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" } }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" } }, { "name": "workflow", "in": "query", "required": false, "schema": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] } }, { "name": "debrisTypeId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "siteId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "contractorId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "project": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "client": { "type": "string" }, "declarationEvent": { "type": "string" }, "reference": { "type": "string" }, "programType": { "type": "string" }, "timeZone": { "type": "string" } }, "required": [ "id", "name", "client", "declarationEvent", "reference", "programType", "timeZone" ], "additionalProperties": false }, "from": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "to": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "headings": { "type": "object", "properties": { "loads": { "type": "string" }, "haulOuts": { "type": "string" }, "unitRate": { "type": "string" } }, "required": ["loads", "haulOuts", "unitRate"], "additionalProperties": false }, "loads": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "debrisType": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] }, "loads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "cy": { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, "tons": { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" } }, "required": ["debrisType", "loads", "cy", "tons"], "additionalProperties": false } }, "total": { "type": "object", "properties": { "loads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "cy": { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, "tons": { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" } }, "required": ["loads", "cy", "tons"], "additionalProperties": false }, "equipment": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "crew": { "type": "boolean" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["name", "crew", "count"], "additionalProperties": false } } }, "required": ["rows", "total", "equipment"], "additionalProperties": false }, "haulOuts": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "site": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] }, "debrisType": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] }, "loads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "cy": { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, "tons": { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" } }, "required": ["site", "debrisType", "loads", "cy", "tons"], "additionalProperties": false } }, "total": { "type": "object", "properties": { "loads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "cy": { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, "tons": { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" } }, "required": ["loads", "cy", "tons"], "additionalProperties": false }, "equipment": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "crew": { "type": "boolean" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["name", "crew", "count"], "additionalProperties": false } } }, "required": ["rows", "total", "equipment"], "additionalProperties": false }, "unitRate": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "payableType": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] }, "payItem": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "code": { "type": "string" }, "description": { "type": "string" } }, "required": ["id", "code", "description"], "additionalProperties": false }, { "type": "null" } ] }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "units": { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, "hours": { "type": "boolean" } }, "required": ["payableType", "payItem", "tickets", "units", "hours"], "additionalProperties": false } }, "total": { "type": "object", "properties": { "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "units": { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, "hours": { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" } }, "required": ["tickets", "units", "hours"], "additionalProperties": false }, "equipment": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "crew": { "type": "boolean" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["name", "crew", "count"], "additionalProperties": false } } }, "required": ["rows", "total", "equipment"], "additionalProperties": false }, "incidents": { "type": "object", "properties": { "filed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "open": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["filed", "open"], "additionalProperties": false }, "monitorsOnShift": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "byDay": { "type": "array", "items": { "type": "object", "properties": { "day": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "loads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "loadCy": { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, "haulOuts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "haulOutCy": { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, "unitRateTickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "day", "loads", "loadCy", "haulOuts", "haulOutCy", "unitRateTickets" ], "additionalProperties": false } } }, "required": [ "project", "from", "to", "headings", "loads", "haulOuts", "unitRate", "incidents", "monitorsOnShift", "byDay" ], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/email-summary": { "get": { "operationId": "readEmailSummary", "summary": "The debris totals as the email summary’s plain text, to paste: the project’s reference and name, the days, a section per operation headed and lined with the project’s own forms, debris types, sites, payable types and lists, its totals, the project’s other stats, and \"All figures in this report are pending final reconciliation\". Never a cost.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_REVIEW", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" } }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" } }, { "name": "workflow", "in": "query", "required": false, "schema": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] } }, { "name": "debrisTypeId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "siteId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "contractorId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "subject": { "type": "string" }, "text": { "type": "string" } }, "required": ["subject", "text"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/daily-report": { "get": { "operationId": "dailyReportFile", "summary": "The daily report as a landscape PDF, for the same days and filters as the debris totals: a title page; the email’s outline without its figures; a page per operation (loads, haul-outs, unit rate) with its details and a map of the boundary, zones, sites and field events drawn as plain lines, no map tiles; the project’s other stats with each day; its estimates and objectives (none is recorded, and the page says so); and an end page with the firm’s address for its list. Sent as a download, never as a page. Never a cost.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_REVIEW", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" } }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" } }, { "name": "workflow", "in": "query", "required": false, "schema": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] } }, { "name": "debrisTypeId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "siteId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "contractorId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/pdf": { "schema": { "type": "string", "contentMediaType": "application/pdf" } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/exports/{dataset}": { "get": { "operationId": "exportFile", "summary": "A project’s tickets, transactions (the ledger, line by line, with its rates and amounts), certifications or audit history as a file to take away: CSV, Excel-compatible CSV (UTF-8 with its byte order mark) or JSON. Narrowed as the ledger is (workflow, pay item, prime, invoice batch, locked or not, days); the audit history as the reader may read it, the security domain an admin’s alone. A cell beginning =, +, -, @, a tab or a carriage return is written as text. Sent as a download, never as a page; made each time, kept nowhere. Never a driver’s phone or licence number.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_REVIEW", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "dataset", "in": "path", "required": true, "schema": { "type": "string", "enum": ["tickets", "transactions", "certifications", "audit-history"] } }, { "name": "format", "in": "query", "required": true, "schema": { "type": "string", "enum": ["csv", "excel", "json"] } }, { "name": "workflow", "in": "query", "required": false, "schema": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] } }, { "name": "payItemId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "primeId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "invoiceBatchId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "locked", "in": "query", "required": false, "schema": { "type": "string", "enum": ["true", "false"] } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" } } ], "responses": { "200": { "description": "The answer.", "content": { "text/csv; charset=utf-8": { "schema": { "type": "string", "contentMediaType": "text/csv; charset=utf-8" } }, "application/json; charset=utf-8": { "schema": { "type": "string", "contentMediaType": "application/json; charset=utf-8" } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/photo-pdf": { "get": { "operationId": "photoPdf", "summary": "A PDF of photographs built for an auditor, in one of two layouts: several items a page (each a row of its details and up to three photographs, three rows a page, never cropped), or one item a page with its receipt beside its details. Items are tickets (each field event with its photographs, narrowed by workflow and days, or by the ticket numbers given), certifications (all, or the cert numbers given) or incidents (by days). A photograph removed from the record is left out; one the PDF can’t show (HEIC, HEIF, TIFF) is named in its place. Refused for more items than one document draws. Sent as a download, never as a page.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_REVIEW", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "items", "in": "query", "required": true, "schema": { "type": "string", "enum": ["tickets", "certifications", "incidents"] } }, { "name": "layout", "in": "query", "required": true, "schema": { "type": "string", "enum": ["several", "one"] } }, { "name": "workflow", "in": "query", "required": false, "schema": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" } }, { "name": "numbers", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 4000 } } ], "responses": { "200": { "description": "The answer.", "content": { "application/pdf": { "schema": { "type": "string", "contentMediaType": "application/pdf" } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/receipt-batch": { "get": { "operationId": "receiptBatch", "summary": "A PDF of the receipts of one or more ticket numbers, pasted with any separator (spaces, commas, semicolons, lines): just their receipts, each field event’s as its phone prints it, or the full record of each with its photographs and its receipt. Its first page names every number the project doesn’t have; none is dropped. Narrowed to one workflow where asked. Refused for more field events than one document draws. Sent as a download, never as a page.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_REVIEW", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "numbers", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 4000 } }, { "name": "workflow", "in": "query", "required": false, "schema": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] } }, { "name": "content", "in": "query", "required": true, "schema": { "type": "string", "enum": ["receipts", "full"] } } ], "responses": { "200": { "description": "The answer.", "content": { "application/pdf": { "schema": { "type": "string", "contentMediaType": "application/pdf" } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/settings": { "patch": { "operationId": "changeProjectSettings", "summary": "Changes a project’s own settings; one left out stays as it is. Its tickets not locked as invoiced are queued.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "allowSplitLoads": { "type": "boolean" }, "loadCallLowLimit": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "loadCallHighLimit": { "anyOf": [ { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, { "type": "null" } ] }, "stumpFillDepthInches": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "stumpCheckRootBallWider": { "type": "boolean" }, "stumpCheckFillNeedsExposure": { "type": "boolean" }, "siteCircleMeters": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "timeClockEnabled": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "clientId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "declarationEventId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "programTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "timeZone": { "type": "string" }, "activeFrom": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "activeTo": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "ticketNumberSource": { "type": "string", "enum": ["CONTROL", "GENERATED"] }, "workflows": { "type": "array", "items": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] } }, "allowSplitLoads": { "type": "boolean" }, "loadCallLowLimit": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "loadCallHighLimit": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "stumpFillDepthInches": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "stumpCheckRootBallWider": { "type": "boolean" }, "stumpCheckFillNeedsExposure": { "type": "boolean" }, "siteCircleMeters": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "timeClockEnabled": { "type": "boolean" }, "closedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "id", "name", "clientId", "declarationEventId", "programTypeId", "timeZone", "activeFrom", "activeTo", "ticketNumberSource", "workflows", "allowSplitLoads", "loadCallLowLimit", "loadCallHighLimit", "stumpFillDepthInches", "stumpCheckRootBallWider", "stumpCheckFillNeedsExposure", "siteCircleMeters", "timeClockEnabled", "closedAt" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/active-window": { "patch": { "operationId": "changeProjectWindow", "summary": "Changes a project’s active window: either end; the end may be emptied. Its tickets not locked as invoiced are queued.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "activeFrom": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "activeTo": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "clientId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "declarationEventId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "programTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "timeZone": { "type": "string" }, "activeFrom": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "activeTo": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "ticketNumberSource": { "type": "string", "enum": ["CONTROL", "GENERATED"] }, "workflows": { "type": "array", "items": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] } }, "allowSplitLoads": { "type": "boolean" }, "loadCallLowLimit": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "loadCallHighLimit": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "stumpFillDepthInches": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "stumpCheckRootBallWider": { "type": "boolean" }, "stumpCheckFillNeedsExposure": { "type": "boolean" }, "siteCircleMeters": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "timeClockEnabled": { "type": "boolean" }, "closedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "id", "name", "clientId", "declarationEventId", "programTypeId", "timeZone", "activeFrom", "activeTo", "ticketNumberSource", "workflows", "allowSplitLoads", "loadCallLowLimit", "loadCallHighLimit", "stumpFillDepthInches", "stumpCheckRootBallWider", "stumpCheckFillNeedsExposure", "siteCircleMeters", "timeClockEnabled", "closedAt" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/closing-check": { "get": { "operationId": "closingCheck", "summary": "What is still open on a project before an admin closes it: phones that took its work and weren’t turned in, tickets not QC Approved or not locked as invoiced, records waiting for a person. It never stops the close.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN"], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } } }, "required": ["items"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/closings": { "post": { "operationId": "closeProject", "summary": "An admin closes a project: its assignments are withdrawn and its phones’ unused numbers retired, and nothing in it changes after; what was still open is said with it. Field work for it that arrives later is held for a person. A project closed already is answered as it stands. Refused only while the worker is still working its tickets.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN"], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "clientId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "declarationEventId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "programTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "timeZone": { "type": "string" }, "activeFrom": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "activeTo": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "ticketNumberSource": { "type": "string", "enum": ["CONTROL", "GENERATED"] }, "workflows": { "type": "array", "items": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] } }, "allowSplitLoads": { "type": "boolean" }, "loadCallLowLimit": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "loadCallHighLimit": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "stumpFillDepthInches": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "stumpCheckRootBallWider": { "type": "boolean" }, "stumpCheckFillNeedsExposure": { "type": "boolean" }, "siteCircleMeters": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "timeClockEnabled": { "type": "boolean" }, "closedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "id", "name", "clientId", "declarationEventId", "programTypeId", "timeZone", "activeFrom", "activeTo", "ticketNumberSource", "workflows", "allowSplitLoads", "loadCallLowLimit", "loadCallHighLimit", "stumpFillDepthInches", "stumpCheckRootBallWider", "stumpCheckFillNeedsExposure", "siteCircleMeters", "timeClockEnabled", "closedAt" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/reopenings": { "post": { "operationId": "reopenProject", "summary": "An admin reopens a closed project, with a reason, audited. Its withdrawn assignments and retired numbers stay as they are.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN"], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "reason": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["reason"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "clientId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "declarationEventId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "programTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "timeZone": { "type": "string" }, "activeFrom": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "activeTo": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "ticketNumberSource": { "type": "string", "enum": ["CONTROL", "GENERATED"] }, "workflows": { "type": "array", "items": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] } }, "allowSplitLoads": { "type": "boolean" }, "loadCallLowLimit": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "loadCallHighLimit": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "stumpFillDepthInches": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "stumpCheckRootBallWider": { "type": "boolean" }, "stumpCheckFillNeedsExposure": { "type": "boolean" }, "siteCircleMeters": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "timeClockEnabled": { "type": "boolean" }, "closedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "id", "name", "clientId", "declarationEventId", "programTypeId", "timeZone", "activeFrom", "activeTo", "ticketNumberSource", "workflows", "allowSplitLoads", "loadCallLowLimit", "loadCallHighLimit", "stumpFillDepthInches", "stumpCheckRootBallWider", "stumpCheckFillNeedsExposure", "siteCircleMeters", "timeClockEnabled", "closedAt" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/number-series": { "post": { "operationId": "startNumberSeries", "summary": "Starts a number series the project doesn’t have yet (its cert numbers), from the number the firm says.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "series": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE", "CERTIFICATION", "ROE"] }, "firstNumber": { "type": "integer", "minimum": 1, "maximum": 2000000000 } }, "required": ["series", "firstNumber"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "series": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE", "CERTIFICATION", "ROE"] }, "firstNumber": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "nextNumber": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": ["id", "projectId", "series", "firstNumber", "nextNumber"], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/control-ranges": { "post": { "operationId": "enterControlRange", "summary": "Enters a run of pre-printed control tickets on a project that numbers its tickets from them.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "series": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE", "CERTIFICATION", "ROE"] }, "firstNumber": { "type": "integer", "minimum": 1, "maximum": 2000000000 }, "lastNumber": { "type": "integer", "minimum": 1, "maximum": 2000000000 } }, "required": ["series", "firstNumber", "lastNumber"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "series": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE", "CERTIFICATION", "ROE"] }, "firstNumber": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "lastNumber": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "archived": { "type": "boolean" } }, "required": [ "id", "projectId", "series", "firstNumber", "lastNumber", "archived" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/control-ranges/{controlRangeId}/archivings": { "post": { "operationId": "archiveControlRange", "summary": "Takes off a control range entered by mistake. It is archived, never deleted.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "controlRangeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "series": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE", "CERTIFICATION", "ROE"] }, "firstNumber": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "lastNumber": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "archived": { "type": "boolean" } }, "required": [ "id", "projectId", "series", "firstNumber", "lastNumber", "archived" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/field-tags": { "post": { "operationId": "addFieldTag", "summary": "Adds a field tag at the end of the project’s own list.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": ["name"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "position": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "archived": { "type": "boolean" } }, "required": ["id", "projectId", "name", "position", "archived"], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/contractors": { "get": { "operationId": "findContractors", "summary": "The firm’s contractors whose name holds what was typed; none archived.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "kind": { "type": "string", "enum": ["HAULER", "MONITORING", "CREW", "OTHER"] }, "contactName": { "type": ["string", "null"] }, "contactEmail": { "type": ["string", "null"] }, "contactPhone": { "type": ["string", "null"] }, "mergedIntoId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "archived": { "type": "boolean" } }, "required": [ "id", "name", "kind", "contactName", "contactEmail", "contactPhone", "mergedIntoId", "archived" ], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["records", "next"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } }, "post": { "operationId": "createContractor", "summary": "Creates a contractor record, firm-wide. Whoever adds it says its kind.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "kind": { "type": "string", "enum": ["HAULER", "MONITORING", "CREW", "OTHER"] }, "contactName": { "type": "string", "minLength": 1, "maxLength": 200 }, "contactEmail": { "type": "string", "maxLength": 320, "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "contactPhone": { "type": "string", "minLength": 1, "maxLength": 40 } }, "required": ["name", "kind"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "kind": { "type": "string", "enum": ["HAULER", "MONITORING", "CREW", "OTHER"] }, "contactName": { "type": ["string", "null"] }, "contactEmail": { "type": ["string", "null"] }, "contactPhone": { "type": ["string", "null"] }, "mergedIntoId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "archived": { "type": "boolean" } }, "required": [ "id", "name", "kind", "contactName", "contactEmail", "contactPhone", "mergedIntoId", "archived" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/contractors/{contractorId}": { "patch": { "operationId": "changeContractor", "summary": "Changes a contractor’s name, kind or contact; one left out stays as it is, and a contact is cleared with null. Audited with the value before.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "contractorId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "kind": { "type": "string", "enum": ["HAULER", "MONITORING", "CREW", "OTHER"] }, "contactName": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "contactEmail": { "anyOf": [ { "type": "string", "maxLength": 320, "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, { "type": "null" } ] }, "contactPhone": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 40 }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "kind": { "type": "string", "enum": ["HAULER", "MONITORING", "CREW", "OTHER"] }, "contactName": { "type": ["string", "null"] }, "contactEmail": { "type": ["string", "null"] }, "contactPhone": { "type": ["string", "null"] }, "mergedIntoId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "archived": { "type": "boolean" } }, "required": [ "id", "name", "kind", "contactName", "contactEmail", "contactPhone", "mergedIntoId", "archived" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/primes": { "post": { "operationId": "addPrime", "summary": "Adds a contractor to a project as a prime.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contractorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["contractorId"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "contractorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "position": { "type": "string", "enum": ["PRIME", "SUB_TIER_1", "SUB_TIER_2"] }, "primeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "archived": { "type": "boolean" } }, "required": [ "id", "projectId", "contractorId", "position", "primeId", "archived" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/contracts": { "post": { "operationId": "createContract", "summary": "Creates a contract on a project: its name, one of the project’s primes, and an optional link to the signed copy.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "primeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "signedCopyUrl": { "type": "string", "maxLength": 2000, "format": "uri" } }, "required": ["name", "primeId"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "primeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "signedCopyUrl": { "type": ["string", "null"] }, "archived": { "type": "boolean" } }, "required": [ "id", "projectId", "name", "primeId", "signedCopyUrl", "archived" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/contracts/{contractId}": { "patch": { "operationId": "changeContract", "summary": "Changes a contract’s name or the link to its signed copy (cleared with null); its prime stays as entered (a contract has one prime; another prime has a contract of its own). Audited with the value before.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "contractId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "signedCopyUrl": { "anyOf": [ { "type": "string", "maxLength": 2000, "format": "uri" }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "primeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "signedCopyUrl": { "type": ["string", "null"] }, "archived": { "type": "boolean" } }, "required": [ "id", "projectId", "name", "primeId", "signedCopyUrl", "archived" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/debris-types": { "post": { "operationId": "addDebrisType", "summary": "Adds a debris type to the firm’s library, named as its contracts name the work.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": ["name"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "key": { "type": ["string", "null"] }, "name": { "type": "string" }, "position": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "archived": { "type": "boolean" } }, "required": ["id", "key", "name", "position", "archived"], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/payable-types": { "post": { "operationId": "addPayableType", "summary": "Adds a payable type to the firm’s list: the work a pay item prices.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": ["name"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "key": { "type": ["string", "null"] }, "name": { "type": "string" }, "position": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "archived": { "type": "boolean" } }, "required": ["id", "key", "name", "position", "archived"], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/lists/{list}/values": { "post": { "operationId": "addListValue", "summary": "Adds a value of the firm’s own to one of its lists, at the end, with a name and what its list asks beside it: a program type whether it requires ROEs, a kind of unit rate work the shape of its count (and, if it says so, that its photographs are taken by stage: before the work, its measurement and after), an item name its kind of work, a vehicle type what it certifies, an incident sub-type its incident type, a reason where it is offered. A field tag is added on its project.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "list", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "program-types", "declaration-reference-types", "debris-types", "reduction-methods", "payable-types", "kinds-of-work", "item-names", "vehicle-types", "vehicle-features", "crew-types", "site-types", "site-labels", "incident-types", "incident-sub-types", "reasons", "survey-work-types", "clock-activities", "field-tags" ] } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "requiresRoe": { "type": "boolean" }, "countShape": { "type": "string", "enum": ["NUMBER", "ITEM_COUNTS", "ITEM_HOURS"] }, "photosByStage": { "type": "boolean" }, "kindOfWorkId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "certifies": { "type": "string", "enum": ["CONTAINER", "CREW"] }, "incidentTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "uses": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": ["VOID", "TYPED_NUMBER", "ACCEPT_FLAG", "BACK_OFFICE_RECORD"] } } }, "required": ["name"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "key": { "type": ["string", "null"] }, "name": { "type": "string" }, "position": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "archived": { "type": "boolean" } }, "required": ["id", "key", "name", "position", "archived"], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } }, "get": { "operationId": "listListValues", "summary": "One of the firm’s lists, a page at a time, in its order: its values in service, or the archived ones apart, each with what its list asks beside its name (a field tag its project).", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "parameters": [ { "name": "list", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "program-types", "declaration-reference-types", "debris-types", "reduction-methods", "payable-types", "kinds-of-work", "item-names", "vehicle-types", "vehicle-features", "crew-types", "site-types", "site-labels", "incident-types", "incident-sub-types", "reasons", "survey-work-types", "clock-activities", "field-tags" ] } }, { "name": "archived", "in": "query", "required": false, "schema": { "type": "string", "enum": ["true", "false"] } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "key": { "type": ["string", "null"] }, "name": { "type": "string" }, "position": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "archived": { "type": "boolean" }, "requiresRoe": { "type": ["boolean", "null"] }, "countShape": { "type": ["string", "null"] }, "photosByStage": { "type": ["boolean", "null"] }, "kindOfWorkId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certifies": { "anyOf": [ { "type": "string", "enum": ["CONTAINER", "CREW"] }, { "type": "null" } ] }, "incidentTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "uses": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": [ "id", "key", "name", "position", "archived", "requiresRoe", "countShape", "photosByStage", "kindOfWorkId", "certifies", "incidentTypeId", "uses", "projectId" ], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["values", "next"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/lists/{list}/values/{valueId}": { "patch": { "operationId": "renameListValue", "summary": "Renames a value of one of the firm’s lists, or a project’s field tag; a built-in value too. Nothing the system does follows a name.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "list", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "program-types", "declaration-reference-types", "debris-types", "reduction-methods", "payable-types", "kinds-of-work", "item-names", "vehicle-types", "vehicle-features", "crew-types", "site-types", "site-labels", "incident-types", "incident-sub-types", "reasons", "survey-work-types", "clock-activities", "field-tags" ] } }, { "name": "valueId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": ["name"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "key": { "type": ["string", "null"] }, "name": { "type": "string" }, "position": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "archived": { "type": "boolean" } }, "required": ["id", "key", "name", "position", "archived"], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/lists/{list}/values/{valueId}/archivings": { "post": { "operationId": "archiveListValue", "summary": "Archives a value of one of the firm’s lists, or a project’s field tag: off new picks, kept on old records. A built-in value is never archived. Each project whose rules pick it has its tickets not locked as invoiced queued.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "list", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "program-types", "declaration-reference-types", "debris-types", "reduction-methods", "payable-types", "kinds-of-work", "item-names", "vehicle-types", "vehicle-features", "crew-types", "site-types", "site-labels", "incident-types", "incident-sub-types", "reasons", "survey-work-types", "clock-activities", "field-tags" ] } }, { "name": "valueId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "key": { "type": ["string", "null"] }, "name": { "type": "string" }, "position": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "archived": { "type": "boolean" } }, "required": ["id", "key", "name", "position", "archived"], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/lists/{list}/values/{valueId}/unarchivings": { "post": { "operationId": "unarchiveListValue", "summary": "Puts an archived list value back, as it was. Each project whose rules pick it has its tickets not locked as invoiced queued.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "list", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "program-types", "declaration-reference-types", "debris-types", "reduction-methods", "payable-types", "kinds-of-work", "item-names", "vehicle-types", "vehicle-features", "crew-types", "site-types", "site-labels", "incident-types", "incident-sub-types", "reasons", "survey-work-types", "clock-activities", "field-tags" ] } }, { "name": "valueId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "key": { "type": ["string", "null"] }, "name": { "type": "string" }, "position": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "archived": { "type": "boolean" } }, "required": ["id", "key", "name", "position", "archived"], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/lists/{list}/values/{valueId}/settings": { "patch": { "operationId": "changeListValueSettings", "summary": "Changes what a value of one of the firm’s lists states beside its name, where its list lets it change once added: a kind of unit rate work whether its photographs are taken by stage (before the work, its measurement and after it). Phones are shown it with their next lists; nothing is queued, since no rule reads it.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "list", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "program-types", "declaration-reference-types", "debris-types", "reduction-methods", "payable-types", "kinds-of-work", "item-names", "vehicle-types", "vehicle-features", "crew-types", "site-types", "site-labels", "incident-types", "incident-sub-types", "reasons", "survey-work-types", "clock-activities", "field-tags" ] } }, { "name": "valueId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "photosByStage": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "key": { "type": ["string", "null"] }, "name": { "type": "string" }, "position": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "archived": { "type": "boolean" } }, "required": ["id", "key", "name", "position", "archived"], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/forms": { "get": { "operationId": "listForms", "summary": "A project’s forms, one for each document type at most: each with its debris types’ entries (those archived kept, marked) and the newest version of its own fields.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_SETUP", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "forms": { "type": "array", "items": { "type": "object", "properties": { "form": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "documentType": { "type": "string", "enum": [ "LOAD", "HAUL_OUT", "UNIT_RATE", "CERTIFICATION", "ROE", "SURVEY", "INCIDENT", "DROP_OFF_LOG" ] }, "name": { "type": "string" }, "gpsRequired": { "type": ["boolean", "null"] }, "incidentOffers": { "type": "array", "items": { "type": "string", "enum": ["CONTRACTOR", "CERT_NUMBER", "ROE_NUMBER"] } }, "archived": { "type": "boolean" } }, "required": [ "id", "projectId", "documentType", "name", "gpsRequired", "incidentOffers", "archived" ], "additionalProperties": false }, "debrisTypes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "formId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "debrisTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "reduced": { "type": "boolean" }, "reductionMethodId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "hiddenOnPhones": { "type": "boolean" }, "archived": { "type": "boolean" } }, "required": [ "id", "formId", "debrisTypeId", "reduced", "reductionMethodId", "hiddenOnPhones", "archived" ], "additionalProperties": false } }, "definition": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "formId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "version": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "fields": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "type": { "type": "string", "enum": ["TEXT", "NUMBER", "YES_NO", "PICK", "PHOTO"] }, "required": { "type": "boolean" }, "choices": { "minItems": 1, "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": ["id", "label", "type", "required"], "additionalProperties": false } } }, "required": ["id", "formId", "version", "fields"], "additionalProperties": false }, { "type": "null" } ] } }, "required": ["form", "debrisTypes", "definition"], "additionalProperties": false } } }, "required": ["forms"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } }, "post": { "operationId": "createForm", "summary": "Creates a project’s form for one document type. \"GPS required\" is stated on an ROE form, and what an incident offers its monitors on an incident form; on no other.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "documentType": { "type": "string", "enum": [ "LOAD", "HAUL_OUT", "UNIT_RATE", "CERTIFICATION", "ROE", "SURVEY", "INCIDENT", "DROP_OFF_LOG" ] }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "gpsRequired": { "type": "boolean" }, "incidentOffers": { "maxItems": 3, "type": "array", "items": { "type": "string", "enum": ["CONTRACTOR", "CERT_NUMBER", "ROE_NUMBER"] } } }, "required": ["documentType", "name"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "documentType": { "type": "string", "enum": [ "LOAD", "HAUL_OUT", "UNIT_RATE", "CERTIFICATION", "ROE", "SURVEY", "INCIDENT", "DROP_OFF_LOG" ] }, "name": { "type": "string" }, "gpsRequired": { "type": ["boolean", "null"] }, "incidentOffers": { "type": "array", "items": { "type": "string", "enum": ["CONTRACTOR", "CERT_NUMBER", "ROE_NUMBER"] } }, "archived": { "type": "boolean" } }, "required": [ "id", "projectId", "documentType", "name", "gpsRequired", "incidentOffers", "archived" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/forms/{formId}": { "patch": { "operationId": "changeForm", "summary": "Changes a form’s name, \"GPS required\" (the ROE form’s) or what an incident offers the monitors (the incident form’s); one left out stays as it is.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "formId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "gpsRequired": { "type": "boolean" }, "incidentOffers": { "maxItems": 3, "type": "array", "items": { "type": "string", "enum": ["CONTRACTOR", "CERT_NUMBER", "ROE_NUMBER"] } } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "documentType": { "type": "string", "enum": [ "LOAD", "HAUL_OUT", "UNIT_RATE", "CERTIFICATION", "ROE", "SURVEY", "INCIDENT", "DROP_OFF_LOG" ] }, "name": { "type": "string" }, "gpsRequired": { "type": ["boolean", "null"] }, "incidentOffers": { "type": "array", "items": { "type": "string", "enum": ["CONTRACTOR", "CERT_NUMBER", "ROE_NUMBER"] } }, "archived": { "type": "boolean" } }, "required": [ "id", "projectId", "documentType", "name", "gpsRequired", "incidentOffers", "archived" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/forms/{formId}/debris-types": { "post": { "operationId": "addFormDebrisType", "summary": "Adds a debris type from the firm’s library to a load or haul-out form. One not marked Reduced on a haul-out form is saved with a warning.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "formId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "debrisTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "reduced": { "type": "boolean" }, "reductionMethodId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "hiddenOnPhones": { "type": "boolean" } }, "required": ["debrisTypeId", "reduced", "hiddenOnPhones"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "formId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "debrisTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "reduced": { "type": "boolean" }, "reductionMethodId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "hiddenOnPhones": { "type": "boolean" }, "archived": { "type": "boolean" } }, "required": [ "id", "formId", "debrisTypeId", "reduced", "reductionMethodId", "hiddenOnPhones", "archived" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/form-debris-types/{formDebrisTypeId}": { "patch": { "operationId": "changeFormDebrisType", "summary": "Changes a debris type’s entry on a form: Reduced, its reduction method (cleared with null) or whether phones hide it; one left out stays as it is. One not Reduced on a haul-out form is saved with a warning.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "formDebrisTypeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "reduced": { "type": "boolean" }, "reductionMethodId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "hiddenOnPhones": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "formId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "debrisTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "reduced": { "type": "boolean" }, "reductionMethodId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "hiddenOnPhones": { "type": "boolean" }, "archived": { "type": "boolean" } }, "required": [ "id", "formId", "debrisTypeId", "reduced", "reductionMethodId", "hiddenOnPhones", "archived" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/forms/{formId}/definitions": { "post": { "operationId": "addFormDefinition", "summary": "Saves the firm’s own fields on an ROE, survey, incident or drop-off log form as its next version. A version is never edited.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "formId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "type": { "type": "string", "enum": ["TEXT", "NUMBER", "YES_NO", "PICK", "PHOTO"] }, "required": { "type": "boolean" }, "choices": { "minItems": 1, "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": ["id", "label", "type", "required"], "additionalProperties": false } } }, "required": ["fields"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "formId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "version": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "fields": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "type": { "type": "string", "enum": ["TEXT", "NUMBER", "YES_NO", "PICK", "PHOTO"] }, "required": { "type": "boolean" }, "choices": { "minItems": 1, "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": ["id", "label", "type", "required"], "additionalProperties": false } } }, "required": ["id", "formId", "version", "fields"], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/pay-items": { "get": { "operationId": "listPayItems", "summary": "A project’s pay items, a page at a time, by code: each as the firm entered it, with its crew day’s steps in force. Never a rate: a pay item’s rates are a read that takes Setup.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_SETUP", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "payItems": { "type": "array", "items": { "type": "object", "properties": { "payItem": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "code": { "type": "string" }, "description": { "type": "string" }, "payableTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "unit": { "type": "string", "enum": ["CY", "TN", "EA", "LB", "HR", "CREW_DAY", "TBN"] }, "kindOfWorkId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "bandFrom": { "type": ["number", "null"] }, "bandTo": { "type": ["number", "null"] }, "countIsAlwaysOne": { "type": "boolean" }, "gpsRequired": { "type": "boolean" }, "measurementRequired": { "type": "boolean" }, "decimalsAllowed": { "type": "boolean" }, "photosRequired": { "type": "boolean" }, "monitorMayMarkIneligible": { "type": "boolean" }, "quantityFromCarriedTickets": { "type": "boolean" }, "crewTimeConversion": { "anyOf": [ { "type": "string", "enum": ["PER_HOUR", "PER_DAY_EXACT", "PER_DAY_STEPS"] }, { "type": "null" } ] }, "crewDayHours": { "type": ["number", "null"] }, "archived": { "type": "boolean" } }, "required": [ "id", "projectId", "code", "description", "payableTypeId", "unit", "kindOfWorkId", "bandFrom", "bandTo", "countIsAlwaysOne", "gpsRequired", "measurementRequired", "decimalsAllowed", "photosRequired", "monitorMayMarkIneligible", "quantityFromCarriedTickets", "crewTimeConversion", "crewDayHours", "archived" ], "additionalProperties": false }, "crewDaySteps": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fromHours": { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, "toHours": { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, "quantity": { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" } }, "required": ["id", "fromHours", "toHours", "quantity"], "additionalProperties": false } } }, "required": ["payItem", "crewDaySteps"], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["payItems", "next"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } }, "post": { "operationId": "createPayItem", "summary": "Enters a pay item read off the contract: its code, unique on the project, its description, payable type, Unit of Measure, size band, capture settings, and a rate for each prime. A band that overlaps another of its payable type isn’t saved. The project’s tickets not locked as invoiced are queued.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1, "maxLength": 60 }, "description": { "type": "string", "minLength": 1, "maxLength": 200 }, "payableTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "unit": { "type": "string", "enum": ["CY", "TN", "EA", "LB", "HR", "CREW_DAY", "TBN"] }, "kindOfWorkId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "bandFrom": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 9999999 }, { "type": "null" } ] }, "bandTo": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 9999999 }, { "type": "null" } ] }, "countIsAlwaysOne": { "type": "boolean" }, "gpsRequired": { "type": "boolean" }, "measurementRequired": { "type": "boolean" }, "decimalsAllowed": { "type": "boolean" }, "photosRequired": { "type": "boolean" }, "monitorMayMarkIneligible": { "type": "boolean" }, "quantityFromCarriedTickets": { "type": "boolean" }, "crewTimeConversion": { "anyOf": [ { "type": "string", "enum": ["PER_HOUR", "PER_DAY_EXACT", "PER_DAY_STEPS"] }, { "type": "null" } ] }, "crewDayHours": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 99 }, { "type": "null" } ] }, "rates": { "maxItems": 200, "type": "array", "items": { "type": "object", "properties": { "primeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "rate": { "type": "string", "pattern": "^\\d{1,10}(\\.\\d{1,4})?$" } }, "required": ["primeId", "rate"], "additionalProperties": false } } }, "required": [ "code", "description", "payableTypeId", "unit", "kindOfWorkId", "bandFrom", "bandTo", "countIsAlwaysOne", "gpsRequired", "measurementRequired", "decimalsAllowed", "photosRequired", "monitorMayMarkIneligible", "quantityFromCarriedTickets", "crewTimeConversion", "crewDayHours", "rates" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "code": { "type": "string" }, "description": { "type": "string" }, "payableTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "unit": { "type": "string", "enum": ["CY", "TN", "EA", "LB", "HR", "CREW_DAY", "TBN"] }, "kindOfWorkId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "bandFrom": { "type": ["number", "null"] }, "bandTo": { "type": ["number", "null"] }, "countIsAlwaysOne": { "type": "boolean" }, "gpsRequired": { "type": "boolean" }, "measurementRequired": { "type": "boolean" }, "decimalsAllowed": { "type": "boolean" }, "photosRequired": { "type": "boolean" }, "monitorMayMarkIneligible": { "type": "boolean" }, "quantityFromCarriedTickets": { "type": "boolean" }, "crewTimeConversion": { "anyOf": [ { "type": "string", "enum": ["PER_HOUR", "PER_DAY_EXACT", "PER_DAY_STEPS"] }, { "type": "null" } ] }, "crewDayHours": { "type": ["number", "null"] }, "archived": { "type": "boolean" } }, "required": [ "id", "projectId", "code", "description", "payableTypeId", "unit", "kindOfWorkId", "bandFrom", "bandTo", "countIsAlwaysOne", "gpsRequired", "measurementRequired", "decimalsAllowed", "photosRequired", "monitorMayMarkIneligible", "quantityFromCarriedTickets", "crewTimeConversion", "crewDayHours", "archived" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/pay-item-rates": { "get": { "operationId": "listPayItemRates", "summary": "A project’s rates, a page at a time, by pay item and then prime: each an exact decimal, those archived kept, marked. Read only by whoever may set one.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "rates": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "payItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "primeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "rate": { "type": "string" }, "archived": { "type": "boolean" } }, "required": ["id", "payItemId", "primeId", "rate", "archived"], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["rates", "next"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/pay-items/{payItemId}": { "patch": { "operationId": "changePayItem", "summary": "Changes a pay item: its code, description, Unit of Measure, size band, crew-time conversion or capture settings; one left out stays as it is. The rules its \"Pays when\" wrote are renamed with it. The project’s tickets not locked as invoiced are queued.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "payItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1, "maxLength": 60 }, "description": { "type": "string", "minLength": 1, "maxLength": 200 }, "unit": { "type": "string", "enum": ["CY", "TN", "EA", "LB", "HR", "CREW_DAY", "TBN"] }, "bandFrom": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 9999999 }, { "type": "null" } ] }, "bandTo": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 9999999 }, { "type": "null" } ] }, "countIsAlwaysOne": { "type": "boolean" }, "gpsRequired": { "type": "boolean" }, "measurementRequired": { "type": "boolean" }, "decimalsAllowed": { "type": "boolean" }, "photosRequired": { "type": "boolean" }, "monitorMayMarkIneligible": { "type": "boolean" }, "quantityFromCarriedTickets": { "type": "boolean" }, "crewTimeConversion": { "anyOf": [ { "type": "string", "enum": ["PER_HOUR", "PER_DAY_EXACT", "PER_DAY_STEPS"] }, { "type": "null" } ] }, "crewDayHours": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 99 }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "code": { "type": "string" }, "description": { "type": "string" }, "payableTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "unit": { "type": "string", "enum": ["CY", "TN", "EA", "LB", "HR", "CREW_DAY", "TBN"] }, "kindOfWorkId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "bandFrom": { "type": ["number", "null"] }, "bandTo": { "type": ["number", "null"] }, "countIsAlwaysOne": { "type": "boolean" }, "gpsRequired": { "type": "boolean" }, "measurementRequired": { "type": "boolean" }, "decimalsAllowed": { "type": "boolean" }, "photosRequired": { "type": "boolean" }, "monitorMayMarkIneligible": { "type": "boolean" }, "quantityFromCarriedTickets": { "type": "boolean" }, "crewTimeConversion": { "anyOf": [ { "type": "string", "enum": ["PER_HOUR", "PER_DAY_EXACT", "PER_DAY_STEPS"] }, { "type": "null" } ] }, "crewDayHours": { "type": ["number", "null"] }, "archived": { "type": "boolean" } }, "required": [ "id", "projectId", "code", "description", "payableTypeId", "unit", "kindOfWorkId", "bandFrom", "bandTo", "countIsAlwaysOne", "gpsRequired", "measurementRequired", "decimalsAllowed", "photosRequired", "monitorMayMarkIneligible", "quantityFromCarriedTickets", "crewTimeConversion", "crewDayHours", "archived" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/pay-items/{payItemId}/previews": { "post": { "operationId": "previewPayItemChange", "summary": "What a change to a pay item would do, before it is saved: the record as it would be, its warnings and how many tickets it would queue (and pass by, locked as invoiced), or why it wouldn’t be saved. Nothing is kept.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "payItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1, "maxLength": 60 }, "description": { "type": "string", "minLength": 1, "maxLength": 200 }, "unit": { "type": "string", "enum": ["CY", "TN", "EA", "LB", "HR", "CREW_DAY", "TBN"] }, "bandFrom": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 9999999 }, { "type": "null" } ] }, "bandTo": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 9999999 }, { "type": "null" } ] }, "countIsAlwaysOne": { "type": "boolean" }, "gpsRequired": { "type": "boolean" }, "measurementRequired": { "type": "boolean" }, "decimalsAllowed": { "type": "boolean" }, "photosRequired": { "type": "boolean" }, "monitorMayMarkIneligible": { "type": "boolean" }, "quantityFromCarriedTickets": { "type": "boolean" }, "crewTimeConversion": { "anyOf": [ { "type": "string", "enum": ["PER_HOUR", "PER_DAY_EXACT", "PER_DAY_STEPS"] }, { "type": "null" } ] }, "crewDayHours": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 99 }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "wouldSave": { "type": "boolean", "const": true }, "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "code": { "type": "string" }, "description": { "type": "string" }, "payableTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "unit": { "type": "string", "enum": ["CY", "TN", "EA", "LB", "HR", "CREW_DAY", "TBN"] }, "kindOfWorkId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "bandFrom": { "type": ["number", "null"] }, "bandTo": { "type": ["number", "null"] }, "countIsAlwaysOne": { "type": "boolean" }, "gpsRequired": { "type": "boolean" }, "measurementRequired": { "type": "boolean" }, "decimalsAllowed": { "type": "boolean" }, "photosRequired": { "type": "boolean" }, "monitorMayMarkIneligible": { "type": "boolean" }, "quantityFromCarriedTickets": { "type": "boolean" }, "crewTimeConversion": { "anyOf": [ { "type": "string", "enum": ["PER_HOUR", "PER_DAY_EXACT", "PER_DAY_STEPS"] }, { "type": "null" } ] }, "crewDayHours": { "type": ["number", "null"] }, "archived": { "type": "boolean" } }, "required": [ "id", "projectId", "code", "description", "payableTypeId", "unit", "kindOfWorkId", "bandFrom", "bandTo", "countIsAlwaysOne", "gpsRequired", "measurementRequired", "decimalsAllowed", "photosRequired", "monitorMayMarkIneligible", "quantityFromCarriedTickets", "crewTimeConversion", "crewDayHours", "archived" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["wouldSave", "record", "warnings"], "additionalProperties": false }, { "type": "object", "properties": { "wouldSave": { "type": "boolean", "const": false }, "reason": { "type": "string" }, "message": { "type": "string" } }, "required": ["wouldSave", "reason", "message"], "additionalProperties": false } ] } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/pay-items/{payItemId}/rates/{primeId}": { "put": { "operationId": "setPayItemRate", "summary": "Sets a prime’s rate on a pay item: for the first time, changed (audited with the rate before), or put back. The project’s tickets not locked as invoiced are queued.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "payItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "primeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "rate": { "type": "string", "pattern": "^\\d{1,10}(\\.\\d{1,4})?$" } }, "required": ["rate"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "payItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "primeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "rate": { "type": "string" }, "archived": { "type": "boolean" } }, "required": ["id", "payItemId", "primeId", "rate", "archived"], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/pay-items/{payItemId}/rates/{primeId}/previews": { "post": { "operationId": "previewPayItemRate", "summary": "What a prime’s rate would do, before it is saved: the record as it would be, its warnings and how many tickets it would queue (and pass by, locked as invoiced), or why it wouldn’t be saved. Nothing is kept.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "payItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "primeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "rate": { "type": "string", "pattern": "^\\d{1,10}(\\.\\d{1,4})?$" } }, "required": ["rate"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "wouldSave": { "type": "boolean", "const": true }, "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "payItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "primeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "rate": { "type": "string" }, "archived": { "type": "boolean" } }, "required": ["id", "payItemId", "primeId", "rate", "archived"], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["wouldSave", "record", "warnings"], "additionalProperties": false }, { "type": "object", "properties": { "wouldSave": { "type": "boolean", "const": false }, "reason": { "type": "string" }, "message": { "type": "string" } }, "required": ["wouldSave", "reason", "message"], "additionalProperties": false } ] } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/pay-items/{payItemId}/crew-day-steps": { "put": { "operationId": "setCrewDaySteps", "summary": "States a pay item’s crew day steps whole: hours from and to, both included, and the quantity they bill. One not named is taken off. Two that share an hour aren’t saved. The project’s tickets not locked as invoiced are queued.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "payItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "steps": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "fromHours": { "type": "string", "pattern": "^\\d{1,2}(\\.\\d{1,2})?$" }, "toHours": { "type": "string", "pattern": "^\\d{1,2}(\\.\\d{1,2})?$" }, "quantity": { "type": "string", "pattern": "^\\d{1,10}(\\.\\d{1,4})?$" } }, "required": ["fromHours", "toHours", "quantity"], "additionalProperties": false } } }, "required": ["steps"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "payItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "steps": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fromHours": { "type": "string" }, "toHours": { "type": "string" }, "quantity": { "type": "string" } }, "required": ["id", "fromHours", "toHours", "quantity"], "additionalProperties": false } } }, "required": ["payItemId", "steps"], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/pay-items/{payItemId}/pays-when": { "put": { "operationId": "savePaysWhen", "summary": "Saves a pay item’s \"Pays when\": for each form it pays on, the criteria and the transaction # it adds. A rule is written and kept for each of the project’s contracts whose prime has a rate on it; the answer says which rules were added, changed, archived and left alone.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "payItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "pays": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "formId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "slot": { "type": "integer", "minimum": 1, "maximum": 999 }, "criteria": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "criterion": { "type": "string", "enum": [ "TICKET_DATE", "CONTRACTOR", "DEBRIS_TYPE", "FIELD_TAG", "WEIGHT", "VOLUME", "COLLECTION_ADDRESS", "ZONE", "DISPOSAL_SITE", "FROM_SITE", "DISPOSAL_SITE_TYPE", "MILEAGE", "PAY_ITEM", "UNIT_COUNT", "MEASUREMENT", "ITEM" ] }, "operator": { "type": "string", "enum": [ "EQUALS", "NOT_EQUALS", "IS_ONE_OF", "IS_NOT_ONE_OF", "BETWEEN", "AT_LEAST", "AT_MOST", "MORE_THAN", "LESS_THAN", "ON", "NOT_ON", "ON_OR_BEFORE", "ON_OR_AFTER", "CONTAINS", "STARTS_WITH", "IS_EMPTY", "IS_NOT_EMPTY" ] }, "picks": { "maxItems": 200, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "numberFrom": { "type": "number", "minimum": -9999999999, "maximum": 9999999999 }, "numberTo": { "type": "number", "minimum": -9999999999, "maximum": 9999999999 }, "dateFrom": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "dateTo": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "text": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["criterion", "operator"], "additionalProperties": false } }, "quantityFrom": { "type": "string", "enum": ["ALL_ITEMS", "CHOSEN_ITEMS"] }, "itemNameIds": { "maxItems": 200, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": ["formId", "slot", "criteria"], "additionalProperties": false } } }, "required": ["pays"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "added": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "changed": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "archived": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "unchanged": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": ["added", "changed", "archived", "unchanged"], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/pay-items/{payItemId}/pays-when/previews": { "post": { "operationId": "previewPaysWhen", "summary": "What saving a pay item’s \"Pays when\" would do, before it is saved: the record as it would be, its warnings and how many tickets it would queue (and pass by, locked as invoiced), or why it wouldn’t be saved. Nothing is kept.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "payItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "pays": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "formId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "slot": { "type": "integer", "minimum": 1, "maximum": 999 }, "criteria": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "criterion": { "type": "string", "enum": [ "TICKET_DATE", "CONTRACTOR", "DEBRIS_TYPE", "FIELD_TAG", "WEIGHT", "VOLUME", "COLLECTION_ADDRESS", "ZONE", "DISPOSAL_SITE", "FROM_SITE", "DISPOSAL_SITE_TYPE", "MILEAGE", "PAY_ITEM", "UNIT_COUNT", "MEASUREMENT", "ITEM" ] }, "operator": { "type": "string", "enum": [ "EQUALS", "NOT_EQUALS", "IS_ONE_OF", "IS_NOT_ONE_OF", "BETWEEN", "AT_LEAST", "AT_MOST", "MORE_THAN", "LESS_THAN", "ON", "NOT_ON", "ON_OR_BEFORE", "ON_OR_AFTER", "CONTAINS", "STARTS_WITH", "IS_EMPTY", "IS_NOT_EMPTY" ] }, "picks": { "maxItems": 200, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "numberFrom": { "type": "number", "minimum": -9999999999, "maximum": 9999999999 }, "numberTo": { "type": "number", "minimum": -9999999999, "maximum": 9999999999 }, "dateFrom": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "dateTo": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "text": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["criterion", "operator"], "additionalProperties": false } }, "quantityFrom": { "type": "string", "enum": ["ALL_ITEMS", "CHOSEN_ITEMS"] }, "itemNameIds": { "maxItems": 200, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": ["formId", "slot", "criteria"], "additionalProperties": false } } }, "required": ["pays"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "wouldSave": { "type": "boolean", "const": true }, "record": { "type": "object", "properties": { "added": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "changed": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "archived": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "unchanged": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": ["added", "changed", "archived", "unchanged"], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["wouldSave", "record", "warnings"], "additionalProperties": false }, { "type": "object", "properties": { "wouldSave": { "type": "boolean", "const": false }, "reason": { "type": "string" }, "message": { "type": "string" } }, "required": ["wouldSave", "reason", "message"], "additionalProperties": false } ] } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/rules": { "get": { "operationId": "listRules", "summary": "A project’s rules, a page at a time, in the order written: each whole as the rule builder states it (each picked value with its name and whether it is gone), the pay item whose \"Pays when\" wrote it, and whether it is valid now and why not.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_SETUP", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "archived", "in": "query", "required": false, "schema": { "type": "string", "enum": ["true", "false"] } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "rules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "formId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "form": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] }, "contractId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "archived": { "type": "boolean" }, "fromPayItemId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "criteria": { "type": "array", "items": { "type": "object", "properties": { "criterion": { "type": "string" }, "operator": { "type": "string" }, "picks": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "name": { "type": "string" }, "gone": { "type": "boolean" } }, "required": ["value", "name", "gone"], "additionalProperties": false } }, "numberFrom": { "type": ["number", "null"] }, "numberTo": { "type": ["number", "null"] }, "dateFrom": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "dateTo": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "text": { "type": ["string", "null"] } }, "required": [ "criterion", "operator", "picks", "numberFrom", "numberTo", "dateFrom", "dateTo", "text" ], "additionalProperties": false } }, "actions": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string" }, "slot": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "payItemId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "quantityFrom": { "anyOf": [ { "type": "string", "enum": ["ALL_ITEMS", "CHOSEN_ITEMS"] }, { "type": "null" } ] }, "itemNameIds": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "kind", "slot", "payItemId", "quantityFrom", "itemNameIds" ], "additionalProperties": false } }, "valid": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "name", "formId", "form", "contractId", "active", "archived", "fromPayItemId", "criteria", "actions", "valid", "reasons" ], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["rules", "next"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } }, "post": { "operationId": "createRule", "summary": "Writes a rule on one of the project’s load, haul-out or unit rate forms. An exact copy of another rule isn’t saved. Its form’s tickets not locked as invoiced are queued.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "formId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "contractId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "criteria": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "criterion": { "type": "string", "enum": [ "TICKET_DATE", "CONTRACTOR", "DEBRIS_TYPE", "FIELD_TAG", "WEIGHT", "VOLUME", "COLLECTION_ADDRESS", "ZONE", "DISPOSAL_SITE", "FROM_SITE", "DISPOSAL_SITE_TYPE", "MILEAGE", "PAY_ITEM", "UNIT_COUNT", "MEASUREMENT", "ITEM" ] }, "operator": { "type": "string", "enum": [ "EQUALS", "NOT_EQUALS", "IS_ONE_OF", "IS_NOT_ONE_OF", "BETWEEN", "AT_LEAST", "AT_MOST", "MORE_THAN", "LESS_THAN", "ON", "NOT_ON", "ON_OR_BEFORE", "ON_OR_AFTER", "CONTAINS", "STARTS_WITH", "IS_EMPTY", "IS_NOT_EMPTY" ] }, "picks": { "maxItems": 200, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "numberFrom": { "type": "number", "minimum": -9999999999, "maximum": 9999999999 }, "numberTo": { "type": "number", "minimum": -9999999999, "maximum": 9999999999 }, "dateFrom": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "dateTo": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "text": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["criterion", "operator"], "additionalProperties": false } }, "actions": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": ["ADD_TRANSACTION", "REMOVE_TRANSACTION", "VOID_TICKET"] }, "slot": { "type": "integer", "minimum": 1, "maximum": 999 }, "payItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "quantityFrom": { "type": "string", "enum": ["ALL_ITEMS", "CHOSEN_ITEMS"] }, "itemNameIds": { "maxItems": 200, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": ["kind"], "additionalProperties": false } } }, "required": ["formId", "name", "contractId", "active", "criteria", "actions"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "valid": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": ["id", "valid", "reasons"], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/rules/previews": { "post": { "operationId": "previewNewRule", "summary": "What a new rule would do, before it is saved: the record as it would be, its warnings and how many tickets it would queue (and pass by, locked as invoiced), or why it wouldn’t be saved. Nothing is kept.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "formId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "contractId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "criteria": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "criterion": { "type": "string", "enum": [ "TICKET_DATE", "CONTRACTOR", "DEBRIS_TYPE", "FIELD_TAG", "WEIGHT", "VOLUME", "COLLECTION_ADDRESS", "ZONE", "DISPOSAL_SITE", "FROM_SITE", "DISPOSAL_SITE_TYPE", "MILEAGE", "PAY_ITEM", "UNIT_COUNT", "MEASUREMENT", "ITEM" ] }, "operator": { "type": "string", "enum": [ "EQUALS", "NOT_EQUALS", "IS_ONE_OF", "IS_NOT_ONE_OF", "BETWEEN", "AT_LEAST", "AT_MOST", "MORE_THAN", "LESS_THAN", "ON", "NOT_ON", "ON_OR_BEFORE", "ON_OR_AFTER", "CONTAINS", "STARTS_WITH", "IS_EMPTY", "IS_NOT_EMPTY" ] }, "picks": { "maxItems": 200, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "numberFrom": { "type": "number", "minimum": -9999999999, "maximum": 9999999999 }, "numberTo": { "type": "number", "minimum": -9999999999, "maximum": 9999999999 }, "dateFrom": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "dateTo": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "text": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["criterion", "operator"], "additionalProperties": false } }, "actions": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": ["ADD_TRANSACTION", "REMOVE_TRANSACTION", "VOID_TICKET"] }, "slot": { "type": "integer", "minimum": 1, "maximum": 999 }, "payItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "quantityFrom": { "type": "string", "enum": ["ALL_ITEMS", "CHOSEN_ITEMS"] }, "itemNameIds": { "maxItems": 200, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": ["kind"], "additionalProperties": false } } }, "required": ["formId", "name", "contractId", "active", "criteria", "actions"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "wouldSave": { "type": "boolean", "const": true }, "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "valid": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": ["id", "valid", "reasons"], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["wouldSave", "record", "warnings"], "additionalProperties": false }, { "type": "object", "properties": { "wouldSave": { "type": "boolean", "const": false }, "reason": { "type": "string" }, "message": { "type": "string" } }, "required": ["wouldSave", "reason", "message"], "additionalProperties": false } ] } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/rules/{ruleId}": { "put": { "operationId": "changeRule", "summary": "States a rule anew, whole: its form, name, contract, Active tick, criteria and actions. A rule a pay item’s \"Pays when\" wrote is changed only there. The tickets of its form, and of the form it had, not locked as invoiced are queued.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "formId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "contractId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "criteria": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "criterion": { "type": "string", "enum": [ "TICKET_DATE", "CONTRACTOR", "DEBRIS_TYPE", "FIELD_TAG", "WEIGHT", "VOLUME", "COLLECTION_ADDRESS", "ZONE", "DISPOSAL_SITE", "FROM_SITE", "DISPOSAL_SITE_TYPE", "MILEAGE", "PAY_ITEM", "UNIT_COUNT", "MEASUREMENT", "ITEM" ] }, "operator": { "type": "string", "enum": [ "EQUALS", "NOT_EQUALS", "IS_ONE_OF", "IS_NOT_ONE_OF", "BETWEEN", "AT_LEAST", "AT_MOST", "MORE_THAN", "LESS_THAN", "ON", "NOT_ON", "ON_OR_BEFORE", "ON_OR_AFTER", "CONTAINS", "STARTS_WITH", "IS_EMPTY", "IS_NOT_EMPTY" ] }, "picks": { "maxItems": 200, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "numberFrom": { "type": "number", "minimum": -9999999999, "maximum": 9999999999 }, "numberTo": { "type": "number", "minimum": -9999999999, "maximum": 9999999999 }, "dateFrom": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "dateTo": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "text": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["criterion", "operator"], "additionalProperties": false } }, "actions": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": ["ADD_TRANSACTION", "REMOVE_TRANSACTION", "VOID_TICKET"] }, "slot": { "type": "integer", "minimum": 1, "maximum": 999 }, "payItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "quantityFrom": { "type": "string", "enum": ["ALL_ITEMS", "CHOSEN_ITEMS"] }, "itemNameIds": { "maxItems": 200, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": ["kind"], "additionalProperties": false } } }, "required": ["formId", "name", "contractId", "active", "criteria", "actions"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "valid": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": ["id", "valid", "reasons"], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/rules/{ruleId}/previews": { "post": { "operationId": "previewRuleChange", "summary": "What a change to a rule would do, before it is saved: the record as it would be, its warnings and how many tickets it would queue (and pass by, locked as invoiced), or why it wouldn’t be saved. Nothing is kept.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "formId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "contractId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "criteria": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "criterion": { "type": "string", "enum": [ "TICKET_DATE", "CONTRACTOR", "DEBRIS_TYPE", "FIELD_TAG", "WEIGHT", "VOLUME", "COLLECTION_ADDRESS", "ZONE", "DISPOSAL_SITE", "FROM_SITE", "DISPOSAL_SITE_TYPE", "MILEAGE", "PAY_ITEM", "UNIT_COUNT", "MEASUREMENT", "ITEM" ] }, "operator": { "type": "string", "enum": [ "EQUALS", "NOT_EQUALS", "IS_ONE_OF", "IS_NOT_ONE_OF", "BETWEEN", "AT_LEAST", "AT_MOST", "MORE_THAN", "LESS_THAN", "ON", "NOT_ON", "ON_OR_BEFORE", "ON_OR_AFTER", "CONTAINS", "STARTS_WITH", "IS_EMPTY", "IS_NOT_EMPTY" ] }, "picks": { "maxItems": 200, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "numberFrom": { "type": "number", "minimum": -9999999999, "maximum": 9999999999 }, "numberTo": { "type": "number", "minimum": -9999999999, "maximum": 9999999999 }, "dateFrom": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "dateTo": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "text": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["criterion", "operator"], "additionalProperties": false } }, "actions": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": ["ADD_TRANSACTION", "REMOVE_TRANSACTION", "VOID_TICKET"] }, "slot": { "type": "integer", "minimum": 1, "maximum": 999 }, "payItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "quantityFrom": { "type": "string", "enum": ["ALL_ITEMS", "CHOSEN_ITEMS"] }, "itemNameIds": { "maxItems": 200, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": ["kind"], "additionalProperties": false } } }, "required": ["formId", "name", "contractId", "active", "criteria", "actions"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "wouldSave": { "type": "boolean", "const": true }, "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "valid": { "type": "boolean" }, "reasons": { "type": "array", "items": { "type": "string" } } }, "required": ["id", "valid", "reasons"], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["wouldSave", "record", "warnings"], "additionalProperties": false }, { "type": "object", "properties": { "wouldSave": { "type": "boolean", "const": false }, "reason": { "type": "string" }, "message": { "type": "string" } }, "required": ["wouldSave", "reason", "message"], "additionalProperties": false } ] } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/sites": { "get": { "operationId": "listSites", "summary": "A project’s sites, a page at a time, in name order: each with its labels, its tipping fee links and its own shape’s newest version.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_SETUP", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "sites": { "type": "array", "items": { "type": "object", "properties": { "site": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "shortCode": { "type": ["string", "null"] }, "siteTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "takesLoads": { "type": "boolean" }, "haulOutsLeaveHere": { "type": "boolean" }, "chargesTippingFee": { "type": "boolean" }, "ineligibleSite": { "type": "boolean" }, "permitNumber": { "type": ["string", "null"] }, "latitude": { "type": "string" }, "longitude": { "type": "string" }, "activationDate": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "closeDate": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "archived": { "type": "boolean" } }, "required": [ "id", "projectId", "name", "shortCode", "siteTypeId", "takesLoads", "haulOutsLeaveHere", "chargesTippingFee", "ineligibleSite", "permitNumber", "latitude", "longitude", "activationDate", "closeDate", "archived" ], "additionalProperties": false }, "labels": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "siteLabelId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "archived": { "type": "boolean" } }, "required": ["id", "siteId", "siteLabelId", "archived"], "additionalProperties": false } }, "tippingFees": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "payItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "archived": { "type": "boolean" } }, "required": ["id", "projectId", "siteId", "payItemId", "archived"], "additionalProperties": false } }, "shape": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "version": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "source": { "type": "string", "enum": ["DRAWN", "UPLOAD", "ESRI_LAYER"] }, "sourceName": { "type": ["string", "null"] }, "fileKept": { "type": "boolean" }, "effectiveFrom": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "id", "siteId", "version", "source", "sourceName", "fileKept", "effectiveFrom" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": ["site", "labels", "tippingFees", "shape"], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["sites", "next"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } }, "post": { "operationId": "createSite", "summary": "Enters a disposal site on a project: its site type, the four site facts, its GPS, a permit number (empty: permit outstanding) and its dates. \"Haul-outs leave here\" is saved only on a TDSR/DMS site.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "shortCode": { "type": "string", "minLength": 1, "maxLength": 20 }, "siteTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "takesLoads": { "type": "boolean" }, "haulOutsLeaveHere": { "type": "boolean" }, "chargesTippingFee": { "type": "boolean" }, "ineligibleSite": { "type": "boolean" }, "permitNumber": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "latitude": { "type": "string", "pattern": "^-?\\d{1,3}(\\.\\d{1,8})?$" }, "longitude": { "type": "string", "pattern": "^-?\\d{1,3}(\\.\\d{1,8})?$" }, "activationDate": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "closeDate": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" } }, "required": [ "name", "siteTypeId", "takesLoads", "haulOutsLeaveHere", "chargesTippingFee", "ineligibleSite", "permitNumber", "latitude", "longitude", "activationDate" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "shortCode": { "type": ["string", "null"] }, "siteTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "takesLoads": { "type": "boolean" }, "haulOutsLeaveHere": { "type": "boolean" }, "chargesTippingFee": { "type": "boolean" }, "ineligibleSite": { "type": "boolean" }, "permitNumber": { "type": ["string", "null"] }, "latitude": { "type": "string" }, "longitude": { "type": "string" }, "activationDate": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "closeDate": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "archived": { "type": "boolean" } }, "required": [ "id", "projectId", "name", "shortCode", "siteTypeId", "takesLoads", "haulOutsLeaveHere", "chargesTippingFee", "ineligibleSite", "permitNumber", "latitude", "longitude", "activationDate", "closeDate", "archived" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/sites/{siteId}": { "patch": { "operationId": "changeSite", "summary": "Changes a site: its name, short code, site type, site facts, permit number, GPS or dates; one left out stays as it is. The tickets with a field event at the site not locked as invoiced are queued.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "shortCode": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 20 }, { "type": "null" } ] }, "siteTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "takesLoads": { "type": "boolean" }, "haulOutsLeaveHere": { "type": "boolean" }, "chargesTippingFee": { "type": "boolean" }, "ineligibleSite": { "type": "boolean" }, "permitNumber": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "latitude": { "type": "string", "pattern": "^-?\\d{1,3}(\\.\\d{1,8})?$" }, "longitude": { "type": "string", "pattern": "^-?\\d{1,3}(\\.\\d{1,8})?$" }, "activationDate": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "closeDate": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "shortCode": { "type": ["string", "null"] }, "siteTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "takesLoads": { "type": "boolean" }, "haulOutsLeaveHere": { "type": "boolean" }, "chargesTippingFee": { "type": "boolean" }, "ineligibleSite": { "type": "boolean" }, "permitNumber": { "type": ["string", "null"] }, "latitude": { "type": "string" }, "longitude": { "type": "string" }, "activationDate": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "closeDate": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "archived": { "type": "boolean" } }, "required": [ "id", "projectId", "name", "shortCode", "siteTypeId", "takesLoads", "haulOutsLeaveHere", "chargesTippingFee", "ineligibleSite", "permitNumber", "latitude", "longitude", "activationDate", "closeDate", "archived" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/sites/{siteId}/labels/{siteLabelId}": { "put": { "operationId": "giveSiteLabel", "summary": "Gives a site one of the firm’s own site labels, or gives back one removed. It changes nothing the system does.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "siteLabelId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "siteLabelId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "archived": { "type": "boolean" } }, "required": ["id", "siteId", "siteLabelId", "archived"], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/sites/{siteId}/labels/{siteLabelId}/removals": { "post": { "operationId": "removeSiteLabel", "summary": "Removes a label given to a site by mistake: audited, never deleted; give it again to put it back.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "siteLabelId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "siteLabelId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "archived": { "type": "boolean" } }, "required": ["id", "siteId", "siteLabelId", "archived"], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/sites/{siteId}/shapes": { "get": { "operationId": "listSiteShapes", "summary": "A site’s own shape, every version, newest first: each with its shape, how it came (drawn, a file, an Esri layer), its file’s name or the layer’s address, and whether its file was kept. Never where.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_SETUP", "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "versions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "version": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "source": { "type": "string", "enum": ["DRAWN", "UPLOAD", "ESRI_LAYER"] }, "sourceName": { "type": ["string", "null"] }, "fileKept": { "type": "boolean" }, "effectiveFrom": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "shape": { "$ref": "#/$defs/__schema0" } }, "required": [ "id", "siteId", "version", "source", "sourceName", "fileKept", "effectiveFrom", "shape" ], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["versions", "next"], "additionalProperties": false, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/$defs/__schema0" } } ] } } } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } }, "post": { "operationId": "addSiteShape", "summary": "Saves a site’s own shape as its next version: from then on the site is checked against the shape in place of the project’s circle, and an earlier shape stays as it was. The tickets with a field event at the site not locked as invoiced are queued.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "source": { "type": "string", "enum": ["DRAWN", "UPLOAD", "ESRI_LAYER"] }, "shape": { "$ref": "#/$defs/__schema0" } }, "required": ["source", "shape"], "additionalProperties": false, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/$defs/__schema0" } } ] } } } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "version": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "source": { "type": "string", "enum": ["DRAWN", "UPLOAD", "ESRI_LAYER"] }, "sourceName": { "type": ["string", "null"] }, "fileKept": { "type": "boolean" }, "effectiveFrom": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "id", "siteId", "version", "source", "sourceName", "fileKept", "effectiveFrom" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/site-shapes/{siteAreaVersionId}/file": { "get": { "operationId": "siteShapeFile", "summary": "The file a site’s shape version was loaded from, as it was kept: the bytes that were stored, under the type they were kept as, sent as a download and never as a page. None for a shape that was drawn.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_SETUP", "parameters": [ { "name": "siteAreaVersionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/zip": { "schema": { "type": "string", "contentMediaType": "application/zip" } }, "application/geo+json": { "schema": { "type": "string", "contentMediaType": "application/geo+json" } }, "application/vnd.google-earth.kml+xml": { "schema": { "type": "string", "contentMediaType": "application/vnd.google-earth.kml+xml" } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/sites/{siteId}/tipping-fees": { "post": { "operationId": "linkTippingFee", "summary": "Links a site to a tipping fee pay item written from it: how a fee line is told from a hauling line. A site may keep several. A link removed is linked again.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "payItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["payItemId"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "payItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "archived": { "type": "boolean" } }, "required": ["id", "projectId", "siteId", "payItemId", "archived"], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/sites/{siteId}/tipping-fees/{payItemId}/removals": { "post": { "operationId": "removeTippingFee", "summary": "Removes a site’s link to a tipping fee pay item made by mistake: audited, never deleted; link it again to put it back. The tickets with a field event at the site not locked as invoiced are queued.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "payItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "payItemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "archived": { "type": "boolean" } }, "required": ["id", "projectId", "siteId", "payItemId", "archived"], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/map-versions": { "get": { "operationId": "listMapVersions", "summary": "A project’s map versions, a page at a time, newest first: each with how it came, its file’s name or the layer’s address, the zones’ own layer and whether its copy was kept, and its zones’ names.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_SETUP", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "mapVersions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "version": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "source": { "type": "string", "enum": ["UPLOAD", "ESRI_LAYER", "DRAWN"] }, "sourceName": { "type": ["string", "null"] }, "zoneNameField": { "type": ["string", "null"] }, "fileKept": { "type": "boolean" }, "zonesSourceName": { "type": ["string", "null"] }, "loadedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "zonesFileKept": { "type": "boolean" }, "zones": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false } } }, "required": [ "id", "projectId", "version", "source", "sourceName", "zoneNameField", "fileKept", "zonesSourceName", "loadedAt", "zonesFileKept", "zones" ], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["mapVersions", "next"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } }, "post": { "operationId": "loadMap", "summary": "Loads a project’s map as its next version: its boundary and, if it has any, its zones, each named in the field picked. An earlier version and its zones stay as they were. The project’s tickets not locked as invoiced are queued.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "source": { "type": "string", "enum": ["UPLOAD", "ESRI_LAYER", "DRAWN"] }, "sourceName": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2000 }, { "type": "null" } ] }, "boundary": { "$ref": "#/$defs/__schema0" }, "zones": { "anyOf": [ { "$ref": "#/$defs/__schema0" }, { "type": "null" } ] }, "zoneNameField": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] } }, "required": ["source", "sourceName", "boundary", "zones", "zoneNameField"], "additionalProperties": false, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/$defs/__schema0" } } ] } } } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "version": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "source": { "type": "string", "enum": ["UPLOAD", "ESRI_LAYER", "DRAWN"] }, "sourceName": { "type": ["string", "null"] }, "zoneNameField": { "type": ["string", "null"] }, "fileKept": { "type": "boolean" }, "zonesSourceName": { "type": ["string", "null"] }, "loadedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "id", "projectId", "version", "source", "sourceName", "zoneNameField", "fileKept", "zonesSourceName", "loadedAt" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/map-versions/{mapVersionId}": { "get": { "operationId": "readMapVersion", "summary": "One map version with its boundary and each zone’s shape, as they were loaded.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_SETUP", "parameters": [ { "name": "mapVersionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "mapVersion": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "version": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "source": { "type": "string", "enum": ["UPLOAD", "ESRI_LAYER", "DRAWN"] }, "sourceName": { "type": ["string", "null"] }, "zoneNameField": { "type": ["string", "null"] }, "fileKept": { "type": "boolean" }, "zonesSourceName": { "type": ["string", "null"] }, "loadedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "zonesFileKept": { "type": "boolean" }, "zones": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false } } }, "required": [ "id", "projectId", "version", "source", "sourceName", "zoneNameField", "fileKept", "zonesSourceName", "loadedAt", "zonesFileKept", "zones" ], "additionalProperties": false }, "boundary": { "$ref": "#/$defs/__schema0" }, "zones": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "shape": { "$ref": "#/$defs/__schema0" } }, "required": ["id", "name", "shape"], "additionalProperties": false } } }, "required": ["mapVersion", "boundary", "zones"], "additionalProperties": false, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/$defs/__schema0" } } ] } } } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/map-versions/{mapVersionId}/files/{file}": { "get": { "operationId": "mapVersionFile", "summary": "A map version’s file as it was kept, or the copy of its zones’ own Esri layer: the bytes that were stored, under the type they were kept as, sent as a download and never as a page.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_SETUP", "parameters": [ { "name": "mapVersionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "file", "in": "path", "required": true, "schema": { "type": "string", "enum": ["map", "zones"] } } ], "responses": { "200": { "description": "The answer.", "content": { "application/zip": { "schema": { "type": "string", "contentMediaType": "application/zip" } }, "application/geo+json": { "schema": { "type": "string", "contentMediaType": "application/geo+json" } }, "application/vnd.google-earth.kml+xml": { "schema": { "type": "string", "contentMediaType": "application/vnd.google-earth.kml+xml" } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/map-files": { "post": { "operationId": "sendMapFile", "summary": "Sends a map’s file for a project, whole, as bytes: a zipped shapefile (its .shp, .dbf and .prj; a projected one is converted to longitude and latitude) or a GeoJSON file, at most the policy’s size. The server tells its kind by its own first bytes, reads every layer it holds and keeps it once, where it places it; a file it can’t read is not kept, and the answer says why. The answer is the file’s id and, for each layer, its features, its fields and whether it is one shape. The same file sent again is the same file. Nothing is loaded yet.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/offset+octet-stream": { "schema": { "type": "string", "contentMediaType": "application/octet-stream" } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{64}$" }, "type": { "type": "string", "enum": [ "application/zip", "application/geo+json", "application/vnd.google-earth.kml+xml" ] }, "bytes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "layers": { "minItems": 1, "type": "array", "items": { "type": "object", "properties": { "name": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "features": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "fields": { "type": "array", "items": { "type": "string" } }, "problem": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "required": ["name", "features", "fields", "problem"], "additionalProperties": false } } }, "required": ["id", "type", "bytes", "layers"], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/map-files/{mapFileId}/map-versions": { "post": { "operationId": "loadMapFile", "summary": "Loads a project’s map from a map’s file sent before, as its next version: the layer that is its boundary and, if it has any, the layer of its zones, each named in the field picked. A layer left unnamed is the file’s only one. The file is kept with the version. An earlier version and its zones stay as they were. The project’s tickets not locked as invoiced are queued.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "mapFileId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{64}$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "sourceName": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2000 }, { "type": "null" } ] }, "boundaryLayer": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 500 }, { "type": "null" } ] }, "zones": { "anyOf": [ { "type": "object", "properties": { "layer": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 500 }, { "type": "null" } ] }, "nameField": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": ["layer", "nameField"], "additionalProperties": false }, { "type": "null" } ] } }, "required": ["sourceName", "boundaryLayer", "zones"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "version": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "source": { "type": "string", "enum": ["UPLOAD", "ESRI_LAYER", "DRAWN"] }, "sourceName": { "type": ["string", "null"] }, "zoneNameField": { "type": ["string", "null"] }, "fileKept": { "type": "boolean" }, "zonesSourceName": { "type": ["string", "null"] }, "loadedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "id", "projectId", "version", "source", "sourceName", "zoneNameField", "fileKept", "zonesSourceName", "loadedAt" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/sites/{siteId}/map-files/{mapFileId}/shapes": { "post": { "operationId": "addSiteShapeFile", "summary": "Saves a site’s own shape from a map’s file sent before for the site’s project, as its next version: the layer named, or the file’s only one, as one shape. From then on the site is checked against the shape in place of the project’s circle, and an earlier shape stays as it was. The tickets with a field event at the site not locked as invoiced are queued.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "mapFileId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{64}$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "layer": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 500 }, { "type": "null" } ] } }, "required": ["layer"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "version": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "source": { "type": "string", "enum": ["DRAWN", "UPLOAD", "ESRI_LAYER"] }, "sourceName": { "type": ["string", "null"] }, "fileKept": { "type": "boolean" }, "effectiveFrom": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "id", "siteId", "version", "source", "sourceName", "fileKept", "effectiveFrom" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/esri-map-versions": { "post": { "operationId": "loadEsriMap", "summary": "Loads a project’s map from Esri feature layers as its next version: the boundary’s layer and, if it has any, the zones’ layer (the same or another), named in the field picked. The API fetches each as GeoJSON in WGS84 and keeps the copy with the version. An earlier version and its zones stay as they were. The project’s tickets not locked as invoiced are queued.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "boundaryLayer": { "type": "string", "maxLength": 2000, "pattern": "^https:\\/\\/[^/@?#]+\\/[^?#]*$" }, "zones": { "anyOf": [ { "type": "object", "properties": { "layer": { "type": "string", "maxLength": 2000, "pattern": "^https:\\/\\/[^/@?#]+\\/[^?#]*$" }, "nameField": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": ["layer", "nameField"], "additionalProperties": false }, { "type": "null" } ] }, "token": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "required": ["boundaryLayer", "zones"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "version": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "source": { "type": "string", "enum": ["UPLOAD", "ESRI_LAYER", "DRAWN"] }, "sourceName": { "type": ["string", "null"] }, "zoneNameField": { "type": ["string", "null"] }, "fileKept": { "type": "boolean" }, "zonesSourceName": { "type": ["string", "null"] }, "loadedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "id", "projectId", "version", "source", "sourceName", "zoneNameField", "fileKept", "zonesSourceName", "loadedAt" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/map-versions/{mapVersionId}/esri-refreshes": { "post": { "operationId": "refreshEsriMap", "summary": "Refresh from Esri: loads a project’s map again from the layers a version fetched from Esri named, as its next version. The version itself never changes. The project’s tickets not locked as invoiced are queued.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "mapVersionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "version": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "source": { "type": "string", "enum": ["UPLOAD", "ESRI_LAYER", "DRAWN"] }, "sourceName": { "type": ["string", "null"] }, "zoneNameField": { "type": ["string", "null"] }, "fileKept": { "type": "boolean" }, "zonesSourceName": { "type": ["string", "null"] }, "loadedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "id", "projectId", "version", "source", "sourceName", "zoneNameField", "fileKept", "zonesSourceName", "loadedAt" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/sites/{siteId}/esri-shapes": { "post": { "operationId": "addSiteShapeFromEsri", "summary": "Saves a site’s own shape from an Esri feature layer as its next version, the layer’s features as one shape. The API fetches it as GeoJSON in WGS84 and keeps the copy. An earlier shape stays as it was. The tickets with a field event at the site not locked as invoiced are queued.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "layer": { "type": "string", "maxLength": 2000, "pattern": "^https:\\/\\/[^/@?#]+\\/[^?#]*$" }, "token": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "required": ["layer"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "version": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "source": { "type": "string", "enum": ["DRAWN", "UPLOAD", "ESRI_LAYER"] }, "sourceName": { "type": ["string", "null"] }, "fileKept": { "type": "boolean" }, "effectiveFrom": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "id", "siteId", "version", "source", "sourceName", "fileKept", "effectiveFrom" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/setup-check": { "get": { "operationId": "setupCheck", "summary": "The setup check: everything a project’s setup leaves open, in plain words; none when it is whole. It lists and never refuses.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_SETUP", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "gaps": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "TIPPING_FEE_SITE_NO_PAY_ITEM", "DEBRIS_TYPE_NO_RULE", "NO_RATE_FOR_PRIME", "SIZE_BANDS_OVERLAP", "SIZE_BAND_GAP", "CREW_DAY_STEP_GAP", "RULE_NOT_VALID" ] }, "message": { "type": "string", "minLength": 1 }, "siteId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "debrisTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "payItemId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "primeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "ruleId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": [ "code", "message", "siteId", "debrisTypeId", "payItemId", "primeId", "ruleId" ], "additionalProperties": false } } }, "required": ["gaps"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/quantity-lookup": { "get": { "operationId": "quantityLookup", "summary": "What each site’s phones ask for: the load call, the scale weight, a count of the items carried or nothing more, for each site, debris type and prime. Worked out from the setup as it stands.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_SETUP", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "asks": { "type": "array", "items": { "type": "object", "properties": { "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "form": { "type": "string", "enum": ["LOAD", "HAUL_OUT"] }, "debrisTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "primeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "asks": { "type": "string", "enum": ["LOAD_CALL", "SCALE_WEIGHT", "CARRIED_COUNT", "NOTHING_MORE"] } }, "required": ["siteId", "form", "debrisTypeId", "primeId", "asks"], "additionalProperties": false } } }, "required": ["asks"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/sites/{siteId}/quantity-lookup": { "get": { "operationId": "siteQuantityLookup", "summary": "What one site’s phones ask for: its rows of the project’s quantity lookup, worked out from the setup as it stands; or, asked with a setup version, as its phones held them under that version, for the debris types phones are shown. No such version of its project: not found.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_SETUP", "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "setupVersion", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[1-9][0-9]{0,8}$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "asks": { "type": "array", "items": { "type": "object", "properties": { "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "form": { "type": "string", "enum": ["LOAD", "HAUL_OUT"] }, "debrisTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "primeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "asks": { "type": "string", "enum": ["LOAD_CALL", "SCALE_WEIGHT", "CARRIED_COUNT", "NOTHING_MORE"] } }, "required": ["siteId", "form", "debrisTypeId", "primeId", "asks"], "additionalProperties": false } } }, "required": ["asks"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/firm-settings": { "get": { "operationId": "firmSettings", "summary": "The firm’s own settings: how many hours a phone marked lost or retired keeps its key (or off), whether read-only viewers must use two-step sign-in, how many hours a monitor’s sign-in on a phone lasts, and the email address a reader of the firm’s reports writes to.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "phoneKeyRevokedAfterHours": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 8760 }, { "type": "null" } ] }, "viewerTwoStepRequired": { "type": "boolean" }, "monitorSessionHours": { "type": "integer", "minimum": 1, "maximum": 24 }, "reportContactEmail": { "type": ["string", "null"] }, "brandName": { "type": "string", "minLength": 1, "maxLength": 40 } }, "required": [ "phoneKeyRevokedAfterHours", "viewerTwoStepRequired", "monitorSessionHours", "reportContactEmail", "brandName" ], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/firm-settings/phone-key": { "patch": { "operationId": "changePhoneKeyHours", "summary": "Sets how many whole hours (1 to 8,760) a phone marked lost or retired keeps its key, counted from its last mark, before the worker revokes it; null switches it off. A phone revoked so may still sync and be turned in under the master passcode. Audited.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "hours": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 8760 }, { "type": "null" } ] }, "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["hours"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "phoneKeyRevokedAfterHours": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 8760 }, { "type": "null" } ] }, "viewerTwoStepRequired": { "type": "boolean" }, "monitorSessionHours": { "type": "integer", "minimum": 1, "maximum": 24 }, "reportContactEmail": { "type": ["string", "null"] }, "brandName": { "type": "string", "minLength": 1, "maxLength": 40 } }, "required": [ "phoneKeyRevokedAfterHours", "viewerTwoStepRequired", "monitorSessionHours", "reportContactEmail", "brandName" ], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/firm-settings/report-contact": { "patch": { "operationId": "changeReportContact", "summary": "Sets the email address printed on the last page of the firm’s reports, for a reader who wants to be added to their list; null prints none. Audited.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "anyOf": [ { "type": "string", "maxLength": 320, "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, { "type": "null" } ] }, "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["email"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "phoneKeyRevokedAfterHours": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 8760 }, { "type": "null" } ] }, "viewerTwoStepRequired": { "type": "boolean" }, "monitorSessionHours": { "type": "integer", "minimum": 1, "maximum": 24 }, "reportContactEmail": { "type": ["string", "null"] }, "brandName": { "type": "string", "minLength": 1, "maxLength": 40 } }, "required": [ "phoneKeyRevokedAfterHours", "viewerTwoStepRequired", "monitorSessionHours", "reportContactEmail", "brandName" ], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/firm-settings/brand-name": { "patch": { "operationId": "changeBrandName", "summary": "Sets what the firm calls its ADMS: plain text of one to forty characters, shown on every screen and in what the server writes for the firm’s people and clients, beside the Open ADMS release it is built on. Audited.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "SETUP", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 40 }, "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["name"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "phoneKeyRevokedAfterHours": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 8760 }, { "type": "null" } ] }, "viewerTwoStepRequired": { "type": "boolean" }, "monitorSessionHours": { "type": "integer", "minimum": 1, "maximum": 24 }, "reportContactEmail": { "type": ["string", "null"] }, "brandName": { "type": "string", "minLength": 1, "maxLength": 40 } }, "required": [ "phoneKeyRevokedAfterHours", "viewerTwoStepRequired", "monitorSessionHours", "reportContactEmail", "brandName" ], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/firm-settings/viewer-two-step": { "patch": { "operationId": "changeViewerTwoStep", "summary": "An admin sets whether read-only viewers must use two-step sign-in. Once it is required, a viewer with no authenticator sets one up before anything else, at their very next request. Turning it off clears nobody’s. Audited.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "required": { "type": "boolean" }, "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["required"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "phoneKeyRevokedAfterHours": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 8760 }, { "type": "null" } ] }, "viewerTwoStepRequired": { "type": "boolean" }, "monitorSessionHours": { "type": "integer", "minimum": 1, "maximum": 24 }, "reportContactEmail": { "type": ["string", "null"] }, "brandName": { "type": "string", "minLength": 1, "maxLength": 40 } }, "required": [ "phoneKeyRevokedAfterHours", "viewerTwoStepRequired", "monitorSessionHours", "reportContactEmail", "brandName" ], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/firm-settings/monitor-sessions": { "patch": { "operationId": "changeMonitorSessionHours", "summary": "An admin sets how many whole hours (1 to 24) a monitor’s sign-in on a phone lasts, online or made with no connection, and a session under the master passcode at most. It applies to sign-ins made from then on; a session already open keeps its end. Audited.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "hours": { "type": "integer", "minimum": 1, "maximum": 24 }, "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["hours"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "phoneKeyRevokedAfterHours": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 8760 }, { "type": "null" } ] }, "viewerTwoStepRequired": { "type": "boolean" }, "monitorSessionHours": { "type": "integer", "minimum": 1, "maximum": 24 }, "reportContactEmail": { "type": ["string", "null"] }, "brandName": { "type": "string", "minLength": 1, "maxLength": 40 } }, "required": [ "phoneKeyRevokedAfterHours", "viewerTwoStepRequired", "monitorSessionHours", "reportContactEmail", "brandName" ], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/phones": { "get": { "operationId": "listPhones", "summary": "The firm’s phones, a page at a time, in the order they were enrolled: those in service, or those taken out of it. Each says which version of the master passcode’s check it holds, when it was marked lost or retired and why, and which revoked its key.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_DISPATCH", "parameters": [ { "name": "outOfService", "in": "query", "required": false, "schema": { "type": "string", "enum": ["true", "false"] } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "phones": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "status": { "type": "string", "enum": ["ACTIVE", "LOST", "RETIRED"] }, "enrolledAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "outOfServiceAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "outOfServiceMarkedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "outOfServiceReasonId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "outOfServiceReason": { "type": ["string", "null"] }, "keyRevokedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "keyRevokedBy": { "anyOf": [ { "type": "string", "enum": ["TURN_IN", "FIRM_TIME"] }, { "type": "null" } ] }, "masterPasscodeVersion": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "holdsCurrentPasscode": { "type": "boolean" }, "heldBudgetPassedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "id", "name", "status", "enrolledAt", "outOfServiceAt", "outOfServiceMarkedAt", "outOfServiceReasonId", "outOfServiceReason", "keyRevokedAt", "keyRevokedBy", "masterPasscodeVersion", "holdsCurrentPasscode", "heldBudgetPassedAt" ], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["phones", "next"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/phones/{deviceId}/sessions": { "get": { "operationId": "listPhoneSessions", "summary": "A phone’s sessions, a page at a time, newest first: whose, when made, until when and whether ended, which way one opened under the master passcode was, and whether it came from a sign-in made on the phone offline. Never a token.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_DISPATCH", "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "sessions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "userId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "revokedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "masterPasscodeSession": { "anyOf": [ { "type": "string", "enum": ["AS_MONITOR", "TEMPORARY"] }, { "type": "null" } ] }, "offlineSignIn": { "type": "boolean" }, "signedInAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "signedInUtcOffsetMinutes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "id", "userId", "createdAt", "expiresAt", "revokedAt", "masterPasscodeSession", "offlineSignIn", "signedInAt", "signedInUtcOffsetMinutes" ], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["sessions", "next"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/phones/enrolments": { "post": { "operationId": "enrolPhone", "summary": "A phone is enrolled, once, under the firm’s master passcode: it sends its name on the dispatch board and the public half of the key it made. The answer is the phone’s id and the version of the master passcode it was enrolled under. Nobody is signed in. A passcode that isn’t taken is refused by one code; wrong tries in a row make the next wait longer, and at the policy’s count lock enrolment until an admin changes the passcode.", "x-open-adms-access": "ANYBODY", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "passcode": { "type": "string", "minLength": 1, "maxLength": 4096 }, "publicKey": { "type": "string", "minLength": 1, "maxLength": 400 } }, "required": ["name", "passcode", "publicKey"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "masterPasscodeVersion": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 } }, "required": ["deviceId", "masterPasscodeVersion"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/phones/{deviceId}/challenges": { "post": { "operationId": "challengePhone", "summary": "Makes a challenge for a phone to sign with its device key. Nobody is signed in; one is made for any id, and the server keeps nothing of it. It may be sent back signed for the policy’s time, once.", "x-open-adms-access": "ANYBODY", "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "challenge": { "type": "string", "minLength": 1 }, "expiresInSeconds": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 } }, "required": ["challenge", "expiresInSeconds"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/phones/{deviceId}/proofs": { "post": { "operationId": "provePhone", "summary": "A phone proves itself: it sends back the challenge it was made and its signature over it. The answer is a token for that phone, good for the policy’s minutes, which the calls of its sync carry as Authorization: Bearer. A challenge is good once. A proof that isn’t one is refused by one code, whatever the reason; a phone taken out of service still proves itself, one whose key its turn-in revoked does not. Whoever holds the master passcode may send it beside the signature: the master user is then at the phone, and its token opens what a proof by the key opens and counts as somebody signed in on the phone for what it sends. A phone whose key the firm’s time revoked proves itself only so, and its token opens only its sync, its photographs’ files, its reports, its turn-in and its read of itself; without the passcode it is told the passcode is needed. Each passcode taken is a security event; one that isn’t is refused by the proof’s one code, and counts as a wrong try as it does when a phone is enrolled.", "x-open-adms-access": "ANYBODY", "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "challenge": { "type": "string", "minLength": 1, "maxLength": 400 }, "signature": { "type": "string", "minLength": 1, "maxLength": 400 }, "passcode": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "required": ["challenge", "signature"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "minLength": 1 }, "expiresInSeconds": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 } }, "required": ["token", "expiresInSeconds"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/phones/current": { "get": { "operationId": "provenPhone", "summary": "The phone a proof’s token is of, as the server has it now: its name, whether it is in service, the version of the master passcode whose check it holds and the version in force. Open to a phone that has proved itself, by its token.", "x-open-adms-access": "PROVEN_PHONE", "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "status": { "type": "string", "enum": ["ACTIVE", "LOST", "RETIRED"] }, "outOfServiceAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "keyRevoked": { "type": "boolean" }, "masterPasscodeVersion": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "masterPasscodeVersionInForce": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "brandName": { "type": "string", "minLength": 1, "maxLength": 40 } }, "required": [ "deviceId", "name", "status", "outOfServiceAt", "keyRevoked", "masterPasscodeVersion", "masterPasscodeVersionInForce", "brandName" ], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/phones/current/monitors": { "post": { "operationId": "createMonitorOnPhone", "summary": "A field monitor is created on an enrolled phone, under the firm’s master passcode: their name, their password and, if the firm keeps one, their phone number. The answer is the Monitor ID the system issued, which is their username. Open to a phone in service that has proved itself, by its token. A passcode that isn’t taken is refused by one code; wrong tries count as they do when a phone is enrolled.", "x-open-adms-access": "PROVEN_PHONE", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "password": { "type": "string", "minLength": 1, "maxLength": 4096 }, "phone": { "type": "string", "minLength": 1, "maxLength": 40 }, "passcode": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "required": ["name", "password", "passcode"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "monitorNumber": { "type": "string", "pattern": "^M\\d{6,}$" }, "name": { "type": "string" } }, "required": ["userId", "monitorNumber", "name"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/phones/current/sign-ins": { "post": { "operationId": "signInOnPhone", "summary": "A field monitor signs in on an enrolled phone, online, with their Monitor ID and password. The answer is their session’s token, which the phone’s calls carry in the x-adms-monitor-session header beside the phone’s own token, how long it lasts, and the assignment the phone takes: theirs for the day, by its project’s own time zone, or none with the reason (none that day; several that day and nothing to say which is this phone’s). Nobody enters the master passcode and nobody picks a project. Open to a phone in service that has proved itself, by its token. Whatever is wrong is refused by one code; wrong tries in a row make the next wait longer, and at the policy’s count lock the login until an admin sets the password anew.", "x-open-adms-access": "PROVEN_PHONE", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "monitorNumber": { "type": "string", "minLength": 1, "maxLength": 20 }, "password": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "required": ["monitorNumber", "password"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "minLength": 1 }, "userId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "monitorNumber": { "type": "string", "pattern": "^M\\d{6,}$" }, "name": { "type": "string" }, "expiresInSeconds": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "assignment": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workDate": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "project": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "timeZone": { "type": "string" } }, "required": ["id", "name", "timeZone"], "additionalProperties": false }, "fieldEventKinds": { "type": "array", "items": { "type": "string", "enum": [ "COLLECTION", "DISPOSAL", "HAUL_OUT_COLLECTION", "HAUL_OUT_DISPOSAL", "UNIT_RATE" ] } }, "certifying": { "type": "boolean" }, "formDocumentTypes": { "type": "array", "items": { "type": "string", "enum": ["ROE", "SURVEY", "INCIDENT", "DROP_OFF_LOG"] } }, "site": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "workDate", "project", "fieldEventKinds", "certifying", "formDocumentTypes", "site" ], "additionalProperties": false }, { "type": "null" } ] }, "noAssignment": { "anyOf": [ { "type": "string", "enum": ["NONE_THAT_DAY", "SEVERAL_THAT_DAY"] }, { "type": "null" } ] } }, "required": [ "token", "userId", "monitorNumber", "name", "expiresInSeconds", "assignment", "noAssignment" ], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/phones/current/passcode-sessions": { "post": { "operationId": "openPasscodeSessionOnPhone", "summary": "A session is opened on an enrolled phone under the firm’s master passcode, for a monitor in service: as the phone’s monitor, or the temporary session for a monitor picked from the roster. The answer is what a monitor’s own sign-in is answered (the session’s token for the x-adms-monitor-session header, how long it lasts, the assignment the phone takes or why none) and which way it was opened. The session is marked as the master passcode’s and is no sign-in of the monitor’s. Neither lasts longer than a monitor’s own sign-in; the temporary one also ends at the end of the day of the project whose assignment the phone takes, by that project’s time zone. Any other session on the phone ends. Open to a phone in service that has proved itself, by its token. A passcode that isn’t taken is refused by one code; wrong tries count as they do when a phone is enrolled.", "x-open-adms-access": "PROVEN_PHONE", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "personId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "kind": { "type": "string", "enum": ["AS_MONITOR", "TEMPORARY"] }, "passcode": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "required": ["personId", "kind", "passcode"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "minLength": 1 }, "userId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "monitorNumber": { "type": "string", "pattern": "^M\\d{6,}$" }, "name": { "type": "string" }, "expiresInSeconds": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "assignment": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workDate": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "project": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "timeZone": { "type": "string" } }, "required": ["id", "name", "timeZone"], "additionalProperties": false }, "fieldEventKinds": { "type": "array", "items": { "type": "string", "enum": [ "COLLECTION", "DISPOSAL", "HAUL_OUT_COLLECTION", "HAUL_OUT_DISPOSAL", "UNIT_RATE" ] } }, "certifying": { "type": "boolean" }, "formDocumentTypes": { "type": "array", "items": { "type": "string", "enum": ["ROE", "SURVEY", "INCIDENT", "DROP_OFF_LOG"] } }, "site": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "workDate", "project", "fieldEventKinds", "certifying", "formDocumentTypes", "site" ], "additionalProperties": false }, { "type": "null" } ] }, "noAssignment": { "anyOf": [ { "type": "string", "enum": ["NONE_THAT_DAY", "SEVERAL_THAT_DAY"] }, { "type": "null" } ] }, "masterPasscodeSession": { "type": "string", "enum": ["AS_MONITOR", "TEMPORARY"] } }, "required": [ "token", "userId", "monitorNumber", "name", "expiresInSeconds", "assignment", "noAssignment", "masterPasscodeSession" ], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/phones/current/offline-sign-ins": { "post": { "operationId": "takeOfflineSignInOnPhone", "summary": "A phone reports a sign-in made on it with no connection, once it has one: the monitor’s own password checked against its login list, or a session opened under the master passcode as the phone’s monitor or the temporary one. It says who, how, when by its own clock with the offset, the version of the master passcode whose check it held (under the passcode only), and its proof: an HMAC-SHA256 over what the sign-in says, keyed by the first slow hash of what was typed, which the server checks against the monitor’s offline seed or its own hash of the passcode in force. Taken, the answer is a session’s token for the x-adms-monitor-session header and how long it has left, counted from the sign-in by the firm’s hours (a temporary session also ends with the project’s day); any other session on the phone ends, and it is a security event. Refused by one code, and written as a security event the back office is shown, where the proof isn’t one, the password was set anew or the passcode changed since, the monitor is not in service, the session has already run out, or the server knows of a sign-in or sign-out on the phone after it: the phone keeps everything and its monitor signs in online. The same sign-in reported again by the phone gives a new token and ends the one before. Open to a phone in service that has proved itself, by its token.", "x-open-adms-access": "PROVEN_PHONE", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "kind": { "type": "string", "enum": ["OWN_PASSWORD", "AS_MONITOR", "TEMPORARY"] }, "personId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "signedInAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -720, "maximum": 840 }, "masterPasscodeVersion": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 2147483647 }, { "type": "null" } ] }, "proof": { "type": "string", "pattern": "^[A-Za-z0-9_-]{43}$" } }, "required": [ "id", "kind", "personId", "signedInAt", "deviceUtcOffsetMinutes", "masterPasscodeVersion", "proof" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "minLength": 1 }, "userId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "monitorNumber": { "type": "string", "pattern": "^M\\d{6,}$" }, "name": { "type": "string" }, "expiresInSeconds": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "masterPasscodeSession": { "anyOf": [ { "type": "string", "enum": ["AS_MONITOR", "TEMPORARY"] }, { "type": "null" } ] } }, "required": [ "token", "userId", "monitorNumber", "name", "expiresInSeconds", "masterPasscodeSession" ], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/phones/current/passcode-uses": { "post": { "operationId": "reportPasscodeUse", "summary": "A phone reports a use of the firm’s master passcode it logged with no connection: the phone passed to a monitor who has their own assignment, a session opened on it as the phone’s monitor or the temporary session for a monitor picked from the roster, its sign-in screen unlocked after too many wrong tries at it, or the passcode typed wrong. It says when by the phone’s own clock, with the clock’s offset, and for which monitor; an unlock and a wrong try name nobody. The id is the phone’s own: the same report sent again is answered as already saved and kept once. It is kept as the phone reports it, for a monitor archived since and from a phone out of service too, and is not saved only where it names somebody who is no monitor or its id is another record’s. The passcode itself is never sent: the phone checked it, and a wrong try reported here does not count toward the lock on the server’s own check. Each one saved is a security event at the phone’s own time: a phone switched and a use of the master passcode; a use that says which way a session was opened; a use for the unlock; or a failed try. A switch or a session saved ends what anybody else had open on that phone before it, by the phone’s clock. A setup, a site move and a switch to a monitor who has no assignment are reported as an unplanned assignment instead. Open to a phone that has proved itself, by its token, with somebody signed in on it: the monitor, by their session’s token in the x-adms-monitor-session header, or the master user, by the master passcode sent beside the phone’s proof. A phone taken out of service sends it too.", "x-open-adms-access": "PHONE_IN_USE", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "use": { "type": "string", "enum": [ "MONITOR_SWITCH", "SESSION_AS_MONITOR", "TEMPORARY_SESSION", "SIGN_IN_UNLOCK", "WRONG_TRY" ] }, "personId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "loggedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -720, "maximum": 840 } }, "required": ["id", "use", "personId", "loggedAt", "deviceUtcOffsetMinutes"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "useId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "answer": { "type": "string", "enum": ["SAVED", "ALREADY_SAVED", "NOT_SAVED"] }, "reason": { "anyOf": [ { "type": "string", "enum": ["NOT_A_MONITOR", "ID_ALREADY_HELD"] }, { "type": "null" } ] } }, "required": ["useId", "answer", "reason"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/phones/current/sign-outs": { "post": { "operationId": "signOutOnPhone", "summary": "The monitor signed in on the phone signs out: their session ends on the server. Open to a proven phone with its monitor’s session token.", "x-open-adms-access": "MONITOR_ON_PHONE", "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "signed-out" } }, "required": ["status"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/phones/current/monitor": { "get": { "operationId": "phoneMonitor", "summary": "The monitor signed in on the phone, as the server has them now, and how long their sign-in has left. Open to a proven phone with its monitor’s session token.", "x-open-adms-access": "MONITOR_ON_PHONE", "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "monitorNumber": { "type": "string", "pattern": "^M\\d{6,}$" }, "name": { "type": "string" }, "expiresInSeconds": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "masterPasscodeSession": { "anyOf": [ { "type": "string", "enum": ["AS_MONITOR", "TEMPORARY"] }, { "type": "null" } ] } }, "required": [ "userId", "monitorNumber", "name", "expiresInSeconds", "masterPasscodeSession" ], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/phones/current/lists": { "get": { "operationId": "phoneLists", "summary": "The lists a phone holds for its work, asked for at any time it has a connection: the assignment the phone takes now for the monitor signed in (the sign-in’s own rule, asked again) and that assignment’s lists, or neither with the reason. The lists are the blocks of numbers the phone holds, the forms’ debris types without those hidden on phones, the field tags, the reasons for a typed number, the unit rate pay items the assignment names, what its incidents and surveys pick from, and the setup version they are, which every field event the phone makes records. Never a rate, a rule, a transaction or a load’s pay item. Nothing is written but a new setup version, made when what the project’s phones are shown differs from the newest one. Open to a proven phone with its monitor’s session token.", "x-open-adms-access": "MONITOR_ON_PHONE", "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "assignment": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workDate": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "project": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "timeZone": { "type": "string" } }, "required": ["id", "name", "timeZone"], "additionalProperties": false }, "fieldEventKinds": { "type": "array", "items": { "type": "string", "enum": [ "COLLECTION", "DISPOSAL", "HAUL_OUT_COLLECTION", "HAUL_OUT_DISPOSAL", "UNIT_RATE" ] } }, "certifying": { "type": "boolean" }, "formDocumentTypes": { "type": "array", "items": { "type": "string", "enum": ["ROE", "SURVEY", "INCIDENT", "DROP_OFF_LOG"] } }, "site": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "workDate", "project", "fieldEventKinds", "certifying", "formDocumentTypes", "site" ], "additionalProperties": false }, { "type": "null" } ] }, "noAssignment": { "anyOf": [ { "type": "string", "enum": ["NONE_THAT_DAY", "SEVERAL_THAT_DAY"] }, { "type": "null" } ] }, "lists": { "anyOf": [ { "type": "object", "properties": { "setupVersion": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "blocks": { "type": "array", "items": { "type": "object", "properties": { "series": { "type": "string", "enum": [ "LOAD", "HAUL_OUT", "UNIT_RATE", "CERTIFICATION", "ROE" ] }, "firstNumber": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "lastNumber": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "lastUsedNumber": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "status": { "type": "string", "const": "ISSUED" } }, "required": [ "series", "firstNumber", "lastNumber", "lastUsedNumber", "status" ], "additionalProperties": false } }, "numbering": { "type": "object", "properties": { "ticketNumberSource": { "type": "string", "enum": ["CONTROL", "GENERATED"] }, "series": { "type": "array", "items": { "type": "string", "enum": [ "LOAD", "HAUL_OUT", "UNIT_RATE", "CERTIFICATION", "ROE" ] } } }, "required": ["ticketNumberSource", "series"], "additionalProperties": false }, "allowSplitLoads": { "type": "boolean" }, "controlRanges": { "type": "array", "items": { "type": "object", "properties": { "series": { "type": "string", "enum": [ "LOAD", "HAUL_OUT", "UNIT_RATE", "CERTIFICATION", "ROE" ] }, "firstNumber": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "lastNumber": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": ["series", "firstNumber", "lastNumber"], "additionalProperties": false } }, "debrisTypes": { "type": "object", "properties": { "LOAD": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false } }, "HAUL_OUT": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false } } }, "required": ["LOAD", "HAUL_OUT"], "additionalProperties": false }, "fieldTags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false } }, "typedNumberReasons": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false } }, "certifications": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "certNumber": { "type": "string" }, "kind": { "type": "string", "enum": ["CONTAINER", "CREW"] }, "capacityCy": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "prime": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, "firstTierSub": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] }, "secondTierSub": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "certNumber", "kind", "capacityCy", "prime", "firstTierSub", "secondTierSub" ], "additionalProperties": false } }, "sites": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "siteType": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, "takesLoads": { "type": "boolean" }, "haulOutsLeaveHere": { "type": "boolean" }, "latitude": { "type": "string", "pattern": "^-?\\d+\\.\\d{8}$" }, "longitude": { "type": "string", "pattern": "^-?\\d+\\.\\d{8}$" }, "area": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "CIRCLE" }, "meters": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 } }, "required": ["kind", "meters"], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "SHAPE" }, "geometry": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "Polygon" }, "coordinates": { "type": "array", "items": { "type": "array", "items": { "type": "array", "prefixItems": [ { "type": "number" }, { "type": "number" } ], "items": false, "minItems": 2, "maxItems": 2 } } } }, "required": ["type", "coordinates"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "MultiPolygon" }, "coordinates": { "type": "array", "items": { "type": "array", "items": { "type": "array", "items": { "type": "array", "prefixItems": [ { "type": "number" }, { "type": "number" } ], "items": false, "minItems": 2, "maxItems": 2 } } } } }, "required": ["type", "coordinates"], "additionalProperties": false } ] }, "box": { "type": "object", "properties": { "westLongitude": { "type": "string", "pattern": "^-?\\d+\\.\\d{8}$" }, "southLatitude": { "type": "string", "pattern": "^-?\\d+\\.\\d{8}$" }, "eastLongitude": { "type": "string", "pattern": "^-?\\d+\\.\\d{8}$" }, "northLatitude": { "type": "string", "pattern": "^-?\\d+\\.\\d{8}$" } }, "required": [ "westLongitude", "southLatitude", "eastLongitude", "northLatitude" ], "additionalProperties": false } }, "required": ["kind", "geometry", "box"], "additionalProperties": false } ] } }, "required": [ "id", "name", "siteType", "takesLoads", "haulOutsLeaveHere", "latitude", "longitude", "area" ], "additionalProperties": false } }, "roes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "roeNumber": { "type": "string" }, "address": { "type": ["string", "null"] }, "parcelId": { "type": ["string", "null"] }, "preWorkSurveyDone": { "type": "boolean" } }, "required": [ "id", "roeNumber", "address", "parcelId", "preWorkSurveyDone" ], "additionalProperties": false } }, "payItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "code": { "type": "string" }, "bandFrom": { "type": ["number", "null"] }, "bandTo": { "type": ["number", "null"] }, "archived": { "type": "boolean" }, "payableType": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, "kindOfWork": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "key": { "anyOf": [ { "type": "string", "enum": ["STUMPS"] }, { "type": "null" } ] }, "countShape": { "type": "string", "enum": ["NUMBER", "ITEM_COUNTS", "ITEM_HOURS"] }, "photosByStage": { "default": false, "type": "boolean" } }, "required": [ "id", "name", "key", "countShape", "photosByStage" ], "additionalProperties": false }, "countIsAlwaysOne": { "type": "boolean" }, "gpsRequired": { "type": "boolean" }, "measurementRequired": { "type": "boolean" }, "decimalsAllowed": { "type": "boolean" }, "photosRequired": { "type": "boolean" }, "monitorMayMarkIneligible": { "type": "boolean" }, "quantityFromCarriedTickets": { "type": "boolean" } }, "required": [ "id", "code", "bandFrom", "bandTo", "archived", "payableType", "kindOfWork", "countIsAlwaysOne", "gpsRequired", "measurementRequired", "decimalsAllowed", "photosRequired", "monitorMayMarkIneligible", "quantityFromCarriedTickets" ], "additionalProperties": false } }, "itemNames": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "kindOfWorkId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["id", "name", "kindOfWorkId"], "additionalProperties": false } }, "incidentTypes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "subTypes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false } } }, "required": ["id", "name", "subTypes"], "additionalProperties": false } }, "incidentOffers": { "type": "array", "items": { "type": "string", "enum": ["CONTRACTOR", "CERT_NUMBER", "ROE_NUMBER"] } }, "contractors": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false } }, "surveyWorkTypes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "key": { "anyOf": [ { "type": "string", "enum": ["PRE_WORK", "POST_WORK", "ROE"] }, { "type": "null" } ] } }, "required": ["id", "name", "key"], "additionalProperties": false } }, "forms": { "type": "array", "items": { "type": "object", "properties": { "documentType": { "type": "string", "enum": ["ROE", "SURVEY", "INCIDENT", "DROP_OFF_LOG"] }, "gpsRequired": { "type": "boolean" }, "definition": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "version": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "fields": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "type": { "type": "string", "enum": [ "TEXT", "NUMBER", "YES_NO", "PICK", "PHOTO" ] }, "required": { "type": "boolean" }, "choices": { "minItems": 1, "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": ["id", "label", "type", "required"], "additionalProperties": false } } }, "required": ["id", "version", "fields"], "additionalProperties": false }, { "type": "null" } ] } }, "required": ["documentType", "gpsRequired", "definition"], "additionalProperties": false } }, "vehicleTypes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "kind": { "type": "string", "enum": ["CONTAINER", "CREW"] } }, "required": ["id", "name", "kind"], "additionalProperties": false } }, "vehicleFeatures": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false } }, "crewTypes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false } }, "primes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "subs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "tier": { "anyOf": [ { "type": "number", "const": 1 }, { "type": "number", "const": 2 } ] } }, "required": ["id", "name", "tier"], "additionalProperties": false } } }, "required": ["id", "name", "subs"], "additionalProperties": false } }, "helpers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false } }, "quantityLookup": { "type": "array", "items": { "type": "object", "properties": { "form": { "type": "string", "enum": ["LOAD", "HAUL_OUT"] }, "debrisTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "primeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "asks": { "type": "string", "enum": [ "LOAD_CALL", "SCALE_WEIGHT", "CARRIED_COUNT", "NOTHING_MORE" ] } }, "required": ["form", "debrisTypeId", "primeId", "asks"], "additionalProperties": false } }, "timeClock": { "default": { "enabled": false, "activities": [] }, "type": "object", "properties": { "enabled": { "type": "boolean" }, "activities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false } } }, "required": ["enabled", "activities"], "additionalProperties": false } }, "required": [ "setupVersion", "blocks", "numbering", "allowSplitLoads", "controlRanges", "debrisTypes", "fieldTags", "typedNumberReasons", "certifications", "sites", "roes", "payItems", "itemNames", "incidentTypes", "incidentOffers", "contractors", "surveyWorkTypes", "forms", "vehicleTypes", "vehicleFeatures", "crewTypes", "primes", "helpers", "quantityLookup", "timeClock" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": ["assignment", "noAssignment", "lists"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/phones/current/login-list": { "post": { "operationId": "phoneLoginList", "summary": "The login list and the master passcode’s check a phone holds for signing in with no connection, asked for at any time it has one. The phone says what it holds: the version of the master passcode whose check it has, and a mark for each monitor’s entry. The answer is the version in force, with its check where the phone holds another or none; and the login list of the project of the assignment the phone takes now for the monitor signed in: that monitor and every monitor in service with an assignment that stands on the project for its today or later, each with the mark of their entry, and the entry itself where the phone didn’t send that mark. An entry is a slow hash made for this phone alone, kept nowhere on the server; a password set anew makes its mark good no more. One call makes a bounded number of entries and says there are more. With no assignment there is no list and the phone keeps what it holds. Never a password or a hash the server checks a sign-in against. Nothing is written but which version of the master passcode’s check the phone was sent. Open to a proven phone with its monitor’s session token.", "x-open-adms-access": "MONITOR_ON_PHONE", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "masterPasscodeVersion": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 2147483647 }, { "type": "null" } ] }, "entries": { "maxItems": 5000, "type": "array", "items": { "type": "object", "properties": { "monitorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "mark": { "type": "string", "minLength": 1, "maxLength": 100 } }, "required": ["monitorId", "mark"], "additionalProperties": false } } }, "required": ["masterPasscodeVersion", "entries"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "masterPasscode": { "type": "object", "properties": { "version": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "check": { "anyOf": [ { "type": "object", "properties": { "first": { "type": "object", "properties": { "salt": { "type": "string", "pattern": "^[A-Za-z0-9+/]+$" }, "memory": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "passes": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "parallelism": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "bytes": { "type": "integer", "minimum": 16, "maximum": 9007199254740991 } }, "required": ["salt", "memory", "passes", "parallelism", "bytes"], "additionalProperties": false }, "check": { "type": "string", "pattern": "^\\$argon2id\\$v=19\\$m=\\d+,t=\\d+,p=\\d+\\$[A-Za-z0-9+/]+\\$[A-Za-z0-9+/]+$" } }, "required": ["first", "check"], "additionalProperties": false }, { "type": "null" } ] } }, "required": ["version", "check"], "additionalProperties": false }, "noAssignment": { "anyOf": [ { "type": "string", "enum": ["NONE_THAT_DAY", "SEVERAL_THAT_DAY"] }, { "type": "null" } ] }, "loginList": { "anyOf": [ { "type": "object", "properties": { "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "monitors": { "type": "array", "items": { "type": "object", "properties": { "monitorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "monitorNumber": { "type": "string", "pattern": "^M\\d{6,}$" }, "name": { "type": "string" }, "mark": { "type": "string", "minLength": 1 }, "check": { "anyOf": [ { "type": "object", "properties": { "first": { "type": "object", "properties": { "salt": { "type": "string", "pattern": "^[A-Za-z0-9+/]+$" }, "memory": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "passes": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "parallelism": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "bytes": { "type": "integer", "minimum": 16, "maximum": 9007199254740991 } }, "required": [ "salt", "memory", "passes", "parallelism", "bytes" ], "additionalProperties": false }, "check": { "type": "string", "pattern": "^\\$argon2id\\$v=19\\$m=\\d+,t=\\d+,p=\\d+\\$[A-Za-z0-9+/]+\\$[A-Za-z0-9+/]+$" } }, "required": ["first", "check"], "additionalProperties": false }, { "type": "null" } ] } }, "required": ["monitorId", "monitorNumber", "name", "mark", "check"], "additionalProperties": false } }, "more": { "type": "boolean" } }, "required": ["projectId", "monitors", "more"], "additionalProperties": false }, { "type": "null" } ] } }, "required": ["masterPasscode", "noAssignment", "loginList"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/phones/current/address-lookups": { "post": { "operationId": "phoneAddressLookup", "summary": "The address of a GPS point, for a collection’s \"Look up address\": the street number and name our own address server finds there, or none with the reason (the map has no street there; the address server gave no answer in time). The monitor then types it, as with no connection. The phone asks the API and the API asks the address server, which no phone and no browser reaches. The point is sent in the body, never in the address of the request; neither the point nor the address is logged or kept. Nothing is written. Open to a proven phone with its monitor’s session token.", "x-open-adms-access": "MONITOR_ON_PHONE", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "latitude": { "type": "string", "pattern": "^-?\\d{1,3}(\\.\\d{1,8})?$" }, "longitude": { "type": "string", "pattern": "^-?\\d{1,3}(\\.\\d{1,8})?$" } }, "required": ["latitude", "longitude"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "noAddress": { "anyOf": [ { "type": "string", "enum": ["NO_STREET_THERE", "NOT_ANSWERED"] }, { "type": "null" } ] } }, "required": ["address", "noAddress"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/phones/current/setup-choices": { "post": { "operationId": "phoneSetupChoices", "summary": "What a phone being set up under the firm’s master passcode picks from, with a connection and nobody signed in: the firm’s open projects; the monitors in service by name and Monitor ID, a thousand a call at most (the answer says where to ask on from); and, where an open project is named, that project’s live sites and its unit rate pay items in service, as a phone’s lists show them. A project that is closed or is none is answered no lists. Never a rate, a rule or a load’s pay item; never a password or a phone number. Nothing is written but the use of the passcode, a security event naming the phone. Open to a phone in service that has proved itself, by its token. A passcode that isn’t taken is refused by one code; wrong tries count as they do when a phone is enrolled.", "x-open-adms-access": "PROVEN_PHONE", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "passcode": { "type": "string", "minLength": 1, "maxLength": 4096 }, "projectId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "monitorsAfter": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["passcode", "projectId", "monitorsAfter"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "projects": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "timeZone": { "type": "string" } }, "required": ["id", "name", "timeZone"], "additionalProperties": false } }, "project": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "sites": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "siteType": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, "takesLoads": { "type": "boolean" }, "haulOutsLeaveHere": { "type": "boolean" }, "latitude": { "type": "string", "pattern": "^-?\\d+\\.\\d{8}$" }, "longitude": { "type": "string", "pattern": "^-?\\d+\\.\\d{8}$" }, "area": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "CIRCLE" }, "meters": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 } }, "required": ["kind", "meters"], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "SHAPE" }, "geometry": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "Polygon" }, "coordinates": { "type": "array", "items": { "type": "array", "items": { "type": "array", "prefixItems": [ { "type": "number" }, { "type": "number" } ], "items": false, "minItems": 2, "maxItems": 2 } } } }, "required": ["type", "coordinates"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "MultiPolygon" }, "coordinates": { "type": "array", "items": { "type": "array", "items": { "type": "array", "items": { "type": "array", "prefixItems": [ { "type": "number" }, { "type": "number" } ], "items": false, "minItems": 2, "maxItems": 2 } } } } }, "required": ["type", "coordinates"], "additionalProperties": false } ] }, "box": { "type": "object", "properties": { "westLongitude": { "type": "string", "pattern": "^-?\\d+\\.\\d{8}$" }, "southLatitude": { "type": "string", "pattern": "^-?\\d+\\.\\d{8}$" }, "eastLongitude": { "type": "string", "pattern": "^-?\\d+\\.\\d{8}$" }, "northLatitude": { "type": "string", "pattern": "^-?\\d+\\.\\d{8}$" } }, "required": [ "westLongitude", "southLatitude", "eastLongitude", "northLatitude" ], "additionalProperties": false } }, "required": ["kind", "geometry", "box"], "additionalProperties": false } ] } }, "required": [ "id", "name", "siteType", "takesLoads", "haulOutsLeaveHere", "latitude", "longitude", "area" ], "additionalProperties": false } }, "payItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "code": { "type": "string" }, "bandFrom": { "type": ["number", "null"] }, "bandTo": { "type": ["number", "null"] }, "archived": { "type": "boolean" }, "payableType": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, "kindOfWork": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "key": { "anyOf": [ { "type": "string", "enum": ["STUMPS"] }, { "type": "null" } ] }, "countShape": { "type": "string", "enum": ["NUMBER", "ITEM_COUNTS", "ITEM_HOURS"] }, "photosByStage": { "default": false, "type": "boolean" } }, "required": [ "id", "name", "key", "countShape", "photosByStage" ], "additionalProperties": false }, "countIsAlwaysOne": { "type": "boolean" }, "gpsRequired": { "type": "boolean" }, "measurementRequired": { "type": "boolean" }, "decimalsAllowed": { "type": "boolean" }, "photosRequired": { "type": "boolean" }, "monitorMayMarkIneligible": { "type": "boolean" }, "quantityFromCarriedTickets": { "type": "boolean" } }, "required": [ "id", "code", "bandFrom", "bandTo", "archived", "payableType", "kindOfWork", "countIsAlwaysOne", "gpsRequired", "measurementRequired", "decimalsAllowed", "photosRequired", "monitorMayMarkIneligible", "quantityFromCarriedTickets" ], "additionalProperties": false } } }, "required": ["id", "sites", "payItems"], "additionalProperties": false }, { "type": "null" } ] }, "monitors": { "maxItems": 1000, "type": "array", "items": { "type": "object", "properties": { "monitorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "monitorNumber": { "type": "string", "pattern": "^M\\d{6,}$" }, "name": { "type": "string" } }, "required": ["monitorId", "monitorNumber", "name"], "additionalProperties": false } }, "moreMonitorsAfter": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["projects", "project", "monitors", "moreMonitorsAfter"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/phones/current/unplanned-assignments": { "post": { "operationId": "reportUnplannedAssignment", "summary": "A phone reports an unplanned assignment made on it under the firm’s master passcode, when its monitor had none: the project, the monitor, their work (the kinds of field event, certifying, the forms, the unit rate pay items), one site where the work is at one, and when it was made by the phone’s own clock, with the clock’s offset. The id is the phone’s own: the same report sent again is answered as already saved and kept once. It is kept as the phone reports it, marked unplanned on the dispatch board and never flagged, for a phone out of service too; its day is the day the phone’s clock said, in the project’s time zone. It is not saved only where something it names is no record of the kind it must be, or its id is another record’s. The passcode itself is never sent: the phone checked it. It says what it was made at: the phone set up (a phone moved to another of its project’s sites is set up anew there, and the earlier assignment stands with everything recorded under it), or the phone passed to another monitor, who had no assignment it could take. Each one saved is two security events at the phone’s own time: a phone set up or a phone switched, and a use of the master passcode. Where several of a monitor’s assignments for a day name one phone, their sign-in on it takes the one made on it last. Open to a phone that has proved itself, by its token, with somebody signed in on it: the monitor, by their session’s token in the x-adms-monitor-session header, or the master user, by the master passcode sent beside the phone’s proof. A phone taken out of service sends it too.", "x-open-adms-access": "PHONE_IN_USE", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "personId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fieldEventKinds": { "maxItems": 5, "type": "array", "items": { "type": "string", "enum": [ "COLLECTION", "DISPOSAL", "HAUL_OUT_COLLECTION", "HAUL_OUT_DISPOSAL", "UNIT_RATE" ] } }, "certifying": { "type": "boolean" }, "formDocumentTypes": { "maxItems": 4, "type": "array", "items": { "type": "string", "enum": ["ROE", "SURVEY", "INCIDENT", "DROP_OFF_LOG"] } }, "siteId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "payItemIds": { "maxItems": 200, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "occasion": { "type": "string", "enum": ["SETUP", "MONITOR_SWITCH"] }, "madeAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -720, "maximum": 840 } }, "required": [ "id", "projectId", "personId", "fieldEventKinds", "certifying", "formDocumentTypes", "siteId", "payItemIds", "occasion", "madeAt", "deviceUtcOffsetMinutes" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "assignmentId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "answer": { "type": "string", "enum": ["SAVED", "ALREADY_SAVED", "NOT_SAVED"] }, "reason": { "anyOf": [ { "type": "string", "enum": [ "UNKNOWN_PROJECT", "NOT_A_MONITOR", "NOT_THE_PROJECTS_SITE", "NOT_THE_PROJECTS_UNIT_RATE_PAY_ITEM", "ID_ALREADY_HELD", "PROJECT_CLOSED" ] }, { "type": "null" } ] } }, "required": ["assignmentId", "answer", "reason"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/phones/current/syncs": { "post": { "operationId": "syncPhone", "summary": "A phone syncs: it sends its clock, the unplanned assignments made on it, the uses of the master passcode it logged, its records (field events, scale receipts, incidents, drop-off logs, surveys, ROEs and certifications, each under the id the phone made for it, 200 at most) and the last number it used of each series. The server keeps the sync with both clocks and their difference, then reads each thing in that order and gives each its own answer, in the order sent. A record is saved; already saved, where it was sent before (never stored twice, and never taken for a duplicate ticket number); kept in quarantine, not saved, where another record holds its number, with the reason and the record that holds it; or not saved, where it can’t be read, names something the server doesn’t have, was made under an assignment that was not saved, or is a certification its own rules refuse: what was sent is then held on the server exactly as sent, for a person, and the answer says so. One record never stops the others. Nothing is refused over eligibility, and no answer carries a status, a flag or money: reconciliation is queued for what arrived and never waited for. For each series reported the answer lists the blocks of numbers the phone holds now, topped up to a full block where the project has such a series and the phone is in service. A phone in service is brought the master passcode’s version in force, with its check where the phone holds another, and the setup version of the project whose lists it holds; a phone out of service, or proven with the passcode because the firm’s time revoked its key, is given no numbers and brought nothing. A phone with more than one sync’s worth sends another. Open to a phone that has proved itself, by its token, with somebody signed in on it: the monitor, by their session’s token in the x-adms-monitor-session header, or the master user, by the master passcode sent beside the phone’s proof. A phone taken out of service sends it too.", "x-open-adms-access": "PHONE_IN_USE", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "clockAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -720, "maximum": 840 }, "unplannedAssignments": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "personId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fieldEventKinds": { "maxItems": 5, "type": "array", "items": { "type": "string", "enum": [ "COLLECTION", "DISPOSAL", "HAUL_OUT_COLLECTION", "HAUL_OUT_DISPOSAL", "UNIT_RATE" ] } }, "certifying": { "type": "boolean" }, "formDocumentTypes": { "maxItems": 4, "type": "array", "items": { "type": "string", "enum": ["ROE", "SURVEY", "INCIDENT", "DROP_OFF_LOG"] } }, "siteId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "payItemIds": { "maxItems": 200, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "occasion": { "type": "string", "enum": ["SETUP", "MONITOR_SWITCH"] }, "madeAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -720, "maximum": 840 } }, "required": [ "id", "projectId", "personId", "fieldEventKinds", "certifying", "formDocumentTypes", "siteId", "payItemIds", "occasion", "madeAt", "deviceUtcOffsetMinutes" ], "additionalProperties": false } }, "passcodeUses": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "use": { "type": "string", "enum": [ "MONITOR_SWITCH", "SESSION_AS_MONITOR", "TEMPORARY_SESSION", "SIGN_IN_UNLOCK", "WRONG_TRY" ] }, "personId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "loggedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -720, "maximum": 840 } }, "required": ["id", "use", "personId", "loggedAt", "deviceUtcOffsetMinutes"], "additionalProperties": false } }, "records": { "maxItems": 200, "type": "array", "items": {} }, "photos": { "maxItems": 200, "type": "array", "items": {} }, "lastUsed": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "series": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE", "CERTIFICATION", "ROE"] }, "lastUsedNumber": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 2000000000 }, { "type": "null" } ] } }, "required": ["projectId", "series", "lastUsedNumber"], "additionalProperties": false } }, "holds": { "type": "object", "properties": { "masterPasscodeVersion": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 2147483647 }, { "type": "null" } ] }, "listsProjectId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["masterPasscodeVersion", "listsProjectId"], "additionalProperties": false } }, "required": [ "clockAt", "deviceUtcOffsetMinutes", "unplannedAssignments", "passcodeUses", "records", "photos", "lastUsed", "holds" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "unplannedAssignments": { "type": "array", "items": { "type": "object", "properties": { "assignmentId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "answer": { "type": "string", "enum": ["SAVED", "ALREADY_SAVED", "NOT_SAVED"] }, "reason": { "anyOf": [ { "type": "string", "enum": [ "UNKNOWN_PROJECT", "NOT_A_MONITOR", "NOT_THE_PROJECTS_SITE", "NOT_THE_PROJECTS_UNIT_RATE_PAY_ITEM", "ID_ALREADY_HELD", "PROJECT_CLOSED" ] }, { "type": "null" } ] } }, "required": ["assignmentId", "answer", "reason"], "additionalProperties": false } }, "passcodeUses": { "type": "array", "items": { "type": "object", "properties": { "useId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "answer": { "type": "string", "enum": ["SAVED", "ALREADY_SAVED", "NOT_SAVED"] }, "reason": { "anyOf": [ { "type": "string", "enum": ["NOT_A_MONITOR", "ID_ALREADY_HELD"] }, { "type": "null" } ] } }, "required": ["useId", "answer", "reason"], "additionalProperties": false } }, "records": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "answer": { "type": "string", "const": "SAVED" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "notes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "enum": ["GPS_UNREADABLE", "ANSWERS_DO_NOT_FIT"] }, "message": { "type": "string" } }, "required": ["code", "message"], "additionalProperties": false } } }, "required": ["answer", "id", "notes"], "additionalProperties": false }, { "type": "object", "properties": { "answer": { "type": "string", "const": "ALREADY_SAVED" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["answer", "id"], "additionalProperties": false }, { "type": "object", "properties": { "answer": { "type": "string", "const": "QUARANTINED" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "reason": { "type": "string", "enum": ["DUPLICATE_FIELD_EVENT", "DUPLICATE_ROE_NUMBER"] }, "message": { "type": "string" }, "heldBy": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["answer", "id", "reason", "message", "heldBy"], "additionalProperties": false }, { "type": "object", "properties": { "answer": { "type": "string", "const": "NOT_SAVED" }, "id": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "reason": { "type": "string", "enum": [ "NOT_A_RECORD", "NAMES_NO_RECORD", "ASSIGNMENT_NOT_SAVED", "CERTIFICATION_REFUSED", "OWNER_NOT_SAVED", "PROJECT_CLOSED" ] }, "message": { "type": "string" } }, "required": ["answer", "id", "reason", "message"], "additionalProperties": false } ] } }, "photos": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "answer": { "type": "string", "const": "SAVED" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "notes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "enum": ["GPS_UNREADABLE", "ANSWERS_DO_NOT_FIT"] }, "message": { "type": "string" } }, "required": ["code", "message"], "additionalProperties": false } } }, "required": ["answer", "id", "notes"], "additionalProperties": false }, { "type": "object", "properties": { "answer": { "type": "string", "const": "ALREADY_SAVED" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["answer", "id"], "additionalProperties": false }, { "type": "object", "properties": { "answer": { "type": "string", "const": "NOT_SAVED" }, "id": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "reason": { "type": "string", "enum": [ "NOT_A_RECORD", "NAMES_NO_RECORD", "ASSIGNMENT_NOT_SAVED", "CERTIFICATION_REFUSED", "OWNER_NOT_SAVED", "PROJECT_CLOSED" ] }, "message": { "type": "string" } }, "required": ["answer", "id", "reason", "message"], "additionalProperties": false } ] } }, "numbers": { "type": "array", "items": { "type": "object", "properties": { "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "series": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE", "CERTIFICATION", "ROE"] }, "toppedUp": { "type": "boolean" }, "blocks": { "type": "array", "items": { "type": "object", "properties": { "firstNumber": { "type": "integer", "minimum": 1, "maximum": 2000000000 }, "lastNumber": { "type": "integer", "minimum": 1, "maximum": 2000000000 }, "lastUsedNumber": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 2000000000 }, { "type": "null" } ] } }, "required": ["firstNumber", "lastNumber", "lastUsedNumber"], "additionalProperties": false } } }, "required": ["projectId", "series", "toppedUp", "blocks"], "additionalProperties": false } }, "masterPasscode": { "anyOf": [ { "type": "object", "properties": { "version": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "check": { "anyOf": [ { "type": "object", "properties": { "first": { "type": "object", "properties": { "salt": { "type": "string", "pattern": "^[A-Za-z0-9+/]+$" }, "memory": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "passes": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "parallelism": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "bytes": { "type": "integer", "minimum": 16, "maximum": 9007199254740991 } }, "required": [ "salt", "memory", "passes", "parallelism", "bytes" ], "additionalProperties": false }, "check": { "type": "string", "pattern": "^\\$argon2id\\$v=19\\$m=\\d+,t=\\d+,p=\\d+\\$[A-Za-z0-9+/]+\\$[A-Za-z0-9+/]+$" } }, "required": ["first", "check"], "additionalProperties": false }, { "type": "null" } ] } }, "required": ["version", "check"], "additionalProperties": false }, { "type": "null" } ] }, "setupVersion": { "anyOf": [ { "type": "object", "properties": { "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "version": { "type": "integer", "minimum": 1, "maximum": 2147483647 } }, "required": ["projectId", "version"], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "unplannedAssignments", "passcodeUses", "records", "photos", "numbers", "masterPasscode", "setupVersion" ], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/phones/current/turn-ins": { "post": { "operationId": "turnInPhone", "summary": "A phone is turned in (\"Sync and turn in\") under the firm’s master passcode, after it has synced every queue and sent every photograph’s file. It sends the passcode, everything it still holds by the ids it made (its unplanned assignments, the uses of the master passcode it logged, its records, its photographs) and by fingerprint what it sent with no id the server could read, and the last number it used of each series it holds numbers of. Only when the server has all of it from that phone (a record saved, kept in quarantine, or held for a person; a photograph saved with every file kept) is the phone turned in: the unused rest of each series it reported is handed back for the next phone, and a series it doesn’t report, or every block of a phone marked lost, is retired whole; a phone in service is taken out of service as retired; its sessions end; its key is revoked, so it proves nothing again; and the answer tells it to wipe. Otherwise nothing is changed and nothing is wiped, and the answer names what the server doesn’t have. A phone out of service is turned in the same way. Each use of the passcode is a security event, and a turn-in another. Open to a phone that has proved itself, by its token; nobody need be signed in. A passcode that isn’t taken is refused by one code; wrong tries count as they do when a phone is enrolled.", "x-open-adms-access": "PROVEN_PHONE", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "passcode": { "type": "string", "minLength": 1, "maxLength": 4096 }, "holds": { "type": "object", "properties": { "unplannedAssignments": { "maxItems": 1000, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "passcodeUses": { "maxItems": 1000, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "records": { "maxItems": 10000, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "held": { "maxItems": 1000, "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{64}$" } }, "photos": { "maxItems": 10000, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "unplannedAssignments", "passcodeUses", "records", "held", "photos" ], "additionalProperties": false }, "lastUsed": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "series": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE", "CERTIFICATION", "ROE"] }, "lastUsedNumber": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 2000000000 }, { "type": "null" } ] } }, "required": ["projectId", "series", "lastUsedNumber"], "additionalProperties": false } } }, "required": ["passcode", "holds", "lastUsed"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "turnedIn": { "type": "boolean", "const": true }, "wipe": { "type": "boolean", "const": true }, "numbers": { "type": "array", "items": { "type": "object", "properties": { "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "series": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE", "CERTIFICATION", "ROE"] }, "ended": { "type": "string", "enum": ["RECLAIMED", "RETIRED"] }, "blocks": { "type": "array", "items": { "type": "object", "properties": { "firstNumber": { "type": "integer", "minimum": 1, "maximum": 2000000000 }, "lastNumber": { "type": "integer", "minimum": 1, "maximum": 2000000000 }, "lastUsedNumber": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 2000000000 }, { "type": "null" } ] } }, "required": ["firstNumber", "lastNumber", "lastUsedNumber"], "additionalProperties": false } } }, "required": ["projectId", "series", "ended", "blocks"], "additionalProperties": false } } }, "required": ["turnedIn", "wipe", "numbers"], "additionalProperties": false }, { "type": "object", "properties": { "turnedIn": { "type": "boolean", "const": false }, "wipe": { "type": "boolean", "const": false }, "message": { "type": "string" }, "notOnTheServer": { "type": "object", "properties": { "unplannedAssignments": { "maxItems": 1000, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "passcodeUses": { "maxItems": 1000, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "records": { "maxItems": 10000, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "held": { "maxItems": 1000, "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{64}$" } }, "photos": { "maxItems": 10000, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "unplannedAssignments", "passcodeUses", "records", "held", "photos" ], "additionalProperties": false } }, "required": ["turnedIn", "wipe", "message", "notOnTheServer"], "additionalProperties": false } ] } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/phones/current/photos/{photoId}/files/{file}": { "get": { "operationId": "photoFile", "summary": "Where a photograph’s file stands: kept (nothing more to send), or how many of its bytes the server has taken, of a file how long, so the phone sends the rest from there (none, where it holds none). The photograph is named by its own id, and the file is the photograph itself or the depth file beside it; only the phone that took it may ask, once its record is saved. Open to a phone that has proved itself, by its token, with somebody signed in on it: the monitor, by their session’s token in the x-adms-monitor-session header, or the master user, by the master passcode sent beside the phone’s proof. A phone taken out of service sends it too.", "x-open-adms-access": "PHONE_IN_USE", "parameters": [ { "name": "photoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "file", "in": "path", "required": true, "schema": { "type": "string", "enum": ["photo", "depth"] } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "upload": { "type": "string", "const": "KEPT" } }, "required": ["upload"], "additionalProperties": false }, { "type": "object", "properties": { "upload": { "type": "string", "const": "RECEIVING" }, "received": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "length": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": ["upload", "received", "length"], "additionalProperties": false }, { "type": "object", "properties": { "upload": { "type": "string", "const": "NOT_MATCHED" } }, "required": ["upload"], "additionalProperties": false } ] } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } }, "patch": { "operationId": "sendPhotoFilePart", "summary": "A part of a photograph’s file, sent by the phone that took it, once its record is saved: the bytes in the body, the offset they go at and the whole file’s length in the query. Taken only where it goes on from the last part the server took, or starts the file; otherwise the answer says where to go on from. The file is at most the policy’s size and a part at most the policy’s; its first part is told to be an image by its own first bytes (JPEG, HEIC or HEIF, PNG, TIFF), or refused. When the last part arrives the server reads the whole file’s SHA-256: the one the phone gave in the photograph’s record (or the depth file’s) and the file is kept, once, where the server placed it, never overwritten, and its upload time written; any other, and the file is set aside on the server for a person, never kept as the photograph’s, and the phone sends its file again from the first byte. A file kept already is answered kept, and nothing changes. Open to a phone that has proved itself, by its token, with somebody signed in on it: the monitor, by their session’s token in the x-adms-monitor-session header, or the master user, by the master passcode sent beside the phone’s proof. A phone taken out of service sends it too.", "x-open-adms-access": "PHONE_IN_USE", "parameters": [ { "name": "photoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "file", "in": "path", "required": true, "schema": { "type": "string", "enum": ["photo", "depth"] } }, { "name": "offset", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^(0|[1-9][0-9]{0,9})$" } }, { "name": "length", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[1-9][0-9]{0,9}$" } } ], "requestBody": { "required": true, "content": { "application/offset+octet-stream": { "schema": { "type": "string", "contentMediaType": "application/octet-stream" } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "upload": { "type": "string", "const": "KEPT" } }, "required": ["upload"], "additionalProperties": false }, { "type": "object", "properties": { "upload": { "type": "string", "const": "RECEIVING" }, "received": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "length": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": ["upload", "received", "length"], "additionalProperties": false }, { "type": "object", "properties": { "upload": { "type": "string", "const": "NOT_MATCHED" } }, "required": ["upload"], "additionalProperties": false } ] } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/phones/{deviceId}": { "patch": { "operationId": "renamePhone", "summary": "A phone is given another name, as the dispatch board calls it. Nothing else of it changes.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "DISPATCH", "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 80 } }, "required": ["name"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "status": { "type": "string", "enum": ["ACTIVE", "LOST", "RETIRED"] }, "enrolledAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "outOfServiceAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "outOfServiceMarkedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "outOfServiceReasonId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "outOfServiceReason": { "type": ["string", "null"] }, "keyRevokedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "keyRevokedBy": { "anyOf": [ { "type": "string", "enum": ["TURN_IN", "FIRM_TIME"] }, { "type": "null" } ] }, "masterPasscodeVersion": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "holdsCurrentPasscode": { "type": "boolean" }, "heldBudgetPassedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "id", "name", "status", "enrolledAt", "outOfServiceAt", "outOfServiceMarkedAt", "outOfServiceReasonId", "outOfServiceReason", "keyRevokedAt", "keyRevokedBy", "masterPasscodeVersion", "holdsCurrentPasscode", "heldBudgetPassedAt" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/phones/{deviceId}/removals": { "post": { "operationId": "removePhone", "summary": "A phone is taken out of service, as lost or retired, from this moment or from a removal time stated by hand (never after now, never before it was enrolled), with a reason from the firm’s list where one is picked. A phone marked lost may then be marked retired, its removal time kept unless one is stated. Its record is kept; what it made later is received and flagged, never refused. Each mark starts the firm’s time again, after which the worker revokes its key. Refused for a phone already out of service otherwise, and for one whose key is revoked.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "DISPATCH", "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": ["LOST", "RETIRED"] }, "outOfServiceAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "reasonId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["status"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "status": { "type": "string", "enum": ["ACTIVE", "LOST", "RETIRED"] }, "enrolledAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "outOfServiceAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "outOfServiceMarkedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "outOfServiceReasonId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "outOfServiceReason": { "type": ["string", "null"] }, "keyRevokedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "keyRevokedBy": { "anyOf": [ { "type": "string", "enum": ["TURN_IN", "FIRM_TIME"] }, { "type": "null" } ] }, "masterPasscodeVersion": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "holdsCurrentPasscode": { "type": "boolean" }, "heldBudgetPassedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "id", "name", "status", "enrolledAt", "outOfServiceAt", "outOfServiceMarkedAt", "outOfServiceReasonId", "outOfServiceReason", "keyRevokedAt", "keyRevokedBy", "masterPasscodeVersion", "holdsCurrentPasscode", "heldBudgetPassedAt" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/phones/{deviceId}/returns": { "post": { "operationId": "returnPhone", "summary": "A phone found again is put back in service, with a note saying why. Refused for a phone in service, and for one whose key is revoked: that one is wiped and enrolled anew.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "DISPATCH", "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["note"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "status": { "type": "string", "enum": ["ACTIVE", "LOST", "RETIRED"] }, "enrolledAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "outOfServiceAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "outOfServiceMarkedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "outOfServiceReasonId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "outOfServiceReason": { "type": ["string", "null"] }, "keyRevokedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "keyRevokedBy": { "anyOf": [ { "type": "string", "enum": ["TURN_IN", "FIRM_TIME"] }, { "type": "null" } ] }, "masterPasscodeVersion": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "holdsCurrentPasscode": { "type": "boolean" }, "heldBudgetPassedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "id", "name", "status", "enrolledAt", "outOfServiceAt", "outOfServiceMarkedAt", "outOfServiceReasonId", "outOfServiceReason", "keyRevokedAt", "keyRevokedBy", "masterPasscodeVersion", "holdsCurrentPasscode", "heldBudgetPassedAt" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/master-passcode/versions": { "post": { "operationId": "changeMasterPasscode", "summary": "An admin changes the firm’s master passcode, giving their own password again. A new version is kept, as a slow hash only; each phone’s check moves to it at its next sync. Refused for a passcode shorter or longer than the policy allows (8 and 128 characters as shipped), or known from breaches.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "currentPassword": { "type": "string", "minLength": 1, "maxLength": 4096 }, "passcode": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "required": ["currentPassword", "passcode"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "const": "ok" }, "version": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 } }, "required": ["status", "version"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/assignments": { "get": { "operationId": "listAssignments", "summary": "One project’s dispatch board for one day, a page at a time, in the order the assignments were written: those that stand, or the withdrawn ones. One made on a phone under the master passcode is among them, marked unplanned.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_DISPATCH", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "workDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" } }, { "name": "withdrawn", "in": "query", "required": false, "schema": { "type": "string", "enum": ["true", "false"] } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "assignments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "person": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "monitorId": { "type": ["string", "null"] } }, "required": ["id", "name", "monitorId"], "additionalProperties": false }, "workDate": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "fieldEventKinds": { "type": "array", "items": { "type": "string", "enum": [ "COLLECTION", "DISPOSAL", "HAUL_OUT_COLLECTION", "HAUL_OUT_DISPOSAL", "UNIT_RATE" ] } }, "certifying": { "type": "boolean" }, "formDocumentTypes": { "type": "array", "items": { "type": "string", "enum": ["ROE", "SURVEY", "INCIDENT", "DROP_OFF_LOG"] } }, "site": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] }, "payItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "code": { "type": "string" }, "description": { "type": "string" } }, "required": ["id", "code", "description"], "additionalProperties": false } }, "origin": { "type": "string", "enum": ["PLANNED", "UNPLANNED"] }, "madeBy": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] }, "withdrawnAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "withdrawalNote": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "person", "workDate", "fieldEventKinds", "certifying", "formDocumentTypes", "site", "phone", "payItems", "origin", "madeBy", "withdrawnAt", "withdrawalNote" ], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["assignments", "next"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } }, "post": { "operationId": "writeAssignment", "summary": "An assignment is written on a project’s board: a person, a day, their work, one site where the work is at one, optionally a phone. Planned, and it says who wrote it. Refused for a read-only viewer or an archived person, a phone out of service, and a pay item that is no unit rate pay item.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "DISPATCH", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "personId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workDate": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "fieldEventKinds": { "maxItems": 5, "type": "array", "items": { "type": "string", "enum": [ "COLLECTION", "DISPOSAL", "HAUL_OUT_COLLECTION", "HAUL_OUT_DISPOSAL", "UNIT_RATE" ] } }, "certifying": { "type": "boolean" }, "formDocumentTypes": { "maxItems": 4, "type": "array", "items": { "type": "string", "enum": ["ROE", "SURVEY", "INCIDENT", "DROP_OFF_LOG"] } }, "siteId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "deviceId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "payItemIds": { "maxItems": 200, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "personId", "workDate", "fieldEventKinds", "certifying", "formDocumentTypes", "siteId", "deviceId", "payItemIds" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "person": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "monitorId": { "type": ["string", "null"] } }, "required": ["id", "name", "monitorId"], "additionalProperties": false }, "workDate": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "fieldEventKinds": { "type": "array", "items": { "type": "string", "enum": [ "COLLECTION", "DISPOSAL", "HAUL_OUT_COLLECTION", "HAUL_OUT_DISPOSAL", "UNIT_RATE" ] } }, "certifying": { "type": "boolean" }, "formDocumentTypes": { "type": "array", "items": { "type": "string", "enum": ["ROE", "SURVEY", "INCIDENT", "DROP_OFF_LOG"] } }, "site": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] }, "payItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "code": { "type": "string" }, "description": { "type": "string" } }, "required": ["id", "code", "description"], "additionalProperties": false } }, "origin": { "type": "string", "enum": ["PLANNED", "UNPLANNED"] }, "madeBy": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] }, "withdrawnAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "withdrawalNote": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "person", "workDate", "fieldEventKinds", "certifying", "formDocumentTypes", "site", "phone", "payItems", "origin", "madeBy", "withdrawnAt", "withdrawalNote" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/assignments/{assignmentId}": { "patch": { "operationId": "changeAssignment", "summary": "An assignment’s work, site or phone is changed; only what is stated changes, and a list is stated whole. Its person, day and project never change. Refused for a withdrawn one and for one made on a phone.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "DISPATCH", "parameters": [ { "name": "assignmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fieldEventKinds": { "maxItems": 5, "type": "array", "items": { "type": "string", "enum": [ "COLLECTION", "DISPOSAL", "HAUL_OUT_COLLECTION", "HAUL_OUT_DISPOSAL", "UNIT_RATE" ] } }, "certifying": { "type": "boolean" }, "formDocumentTypes": { "maxItems": 4, "type": "array", "items": { "type": "string", "enum": ["ROE", "SURVEY", "INCIDENT", "DROP_OFF_LOG"] } }, "siteId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "deviceId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "payItemIds": { "maxItems": 200, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "person": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "monitorId": { "type": ["string", "null"] } }, "required": ["id", "name", "monitorId"], "additionalProperties": false }, "workDate": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "fieldEventKinds": { "type": "array", "items": { "type": "string", "enum": [ "COLLECTION", "DISPOSAL", "HAUL_OUT_COLLECTION", "HAUL_OUT_DISPOSAL", "UNIT_RATE" ] } }, "certifying": { "type": "boolean" }, "formDocumentTypes": { "type": "array", "items": { "type": "string", "enum": ["ROE", "SURVEY", "INCIDENT", "DROP_OFF_LOG"] } }, "site": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] }, "payItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "code": { "type": "string" }, "description": { "type": "string" } }, "required": ["id", "code", "description"], "additionalProperties": false } }, "origin": { "type": "string", "enum": ["PLANNED", "UNPLANNED"] }, "madeBy": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] }, "withdrawnAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "withdrawalNote": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "person", "workDate", "fieldEventKinds", "certifying", "formDocumentTypes", "site", "phone", "payItems", "origin", "madeBy", "withdrawnAt", "withdrawalNote" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/assignments/{assignmentId}/withdrawals": { "post": { "operationId": "withdrawAssignment", "summary": "An assignment is withdrawn from the board, from this moment, with a note if the dispatcher writes one. It is kept, and so is everything recorded under it. Refused for one already withdrawn and for one made on a phone.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "DISPATCH", "parameters": [ { "name": "assignmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "person": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "monitorId": { "type": ["string", "null"] } }, "required": ["id", "name", "monitorId"], "additionalProperties": false }, "workDate": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "fieldEventKinds": { "type": "array", "items": { "type": "string", "enum": [ "COLLECTION", "DISPOSAL", "HAUL_OUT_COLLECTION", "HAUL_OUT_DISPOSAL", "UNIT_RATE" ] } }, "certifying": { "type": "boolean" }, "formDocumentTypes": { "type": "array", "items": { "type": "string", "enum": ["ROE", "SURVEY", "INCIDENT", "DROP_OFF_LOG"] } }, "site": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] }, "payItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "code": { "type": "string" }, "description": { "type": "string" } }, "required": ["id", "code", "description"], "additionalProperties": false } }, "origin": { "type": "string", "enum": ["PLANNED", "UNPLANNED"] }, "madeBy": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] }, "withdrawnAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "withdrawalNote": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "person", "workDate", "fieldEventKinds", "certifying", "formDocumentTypes", "site", "phone", "payItems", "origin", "madeBy", "withdrawnAt", "withdrawalNote" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/assignments/{assignmentId}/reinstatements": { "post": { "operationId": "reinstateAssignment", "summary": "A withdrawn assignment is put back on the board, as it was; its note is cleared (the audit keeps it). Refused for one that stands, one made on a phone, an archived person and a phone out of service.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "DISPATCH", "parameters": [ { "name": "assignmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "person": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "monitorId": { "type": ["string", "null"] } }, "required": ["id", "name", "monitorId"], "additionalProperties": false }, "workDate": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "fieldEventKinds": { "type": "array", "items": { "type": "string", "enum": [ "COLLECTION", "DISPOSAL", "HAUL_OUT_COLLECTION", "HAUL_OUT_DISPOSAL", "UNIT_RATE" ] } }, "certifying": { "type": "boolean" }, "formDocumentTypes": { "type": "array", "items": { "type": "string", "enum": ["ROE", "SURVEY", "INCIDENT", "DROP_OFF_LOG"] } }, "site": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] }, "payItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "code": { "type": "string" }, "description": { "type": "string" } }, "required": ["id", "code", "description"], "additionalProperties": false } }, "origin": { "type": "string", "enum": ["PLANNED", "UNPLANNED"] }, "madeBy": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] }, "withdrawnAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "withdrawalNote": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "person", "workDate", "fieldEventKinds", "certifying", "formDocumentTypes", "site", "phone", "payItems", "origin", "madeBy", "withdrawnAt", "withdrawalNote" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/assignments": { "get": { "operationId": "searchBoard", "summary": "The dispatch board searched: a person’s or a phone’s assignments (or a project’s), from one day to another (62 days at most), standing or withdrawn, a page at a time by day and then in the order written; each with what the board warns of beside it (a second assignment for the person or the phone that day, a day outside the project’s active window, a closed project, unit rate pay items named with no unit rate work, a site not yet active or closed). A warning never stops anything.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_DISPATCH", "parameters": [ { "name": "userId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "deviceId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "projectId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" } }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" } }, { "name": "withdrawn", "in": "query", "required": false, "schema": { "type": "string", "enum": ["true", "false"] } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "assignments": { "type": "array", "items": { "type": "object", "properties": { "assignment": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "person": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "monitorId": { "type": ["string", "null"] } }, "required": ["id", "name", "monitorId"], "additionalProperties": false }, "workDate": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "fieldEventKinds": { "type": "array", "items": { "type": "string", "enum": [ "COLLECTION", "DISPOSAL", "HAUL_OUT_COLLECTION", "HAUL_OUT_DISPOSAL", "UNIT_RATE" ] } }, "certifying": { "type": "boolean" }, "formDocumentTypes": { "type": "array", "items": { "type": "string", "enum": ["ROE", "SURVEY", "INCIDENT", "DROP_OFF_LOG"] } }, "site": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] }, "payItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "code": { "type": "string" }, "description": { "type": "string" } }, "required": ["id", "code", "description"], "additionalProperties": false } }, "origin": { "type": "string", "enum": ["PLANNED", "UNPLANNED"] }, "madeBy": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] }, "withdrawnAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "withdrawalNote": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "person", "workDate", "fieldEventKinds", "certifying", "formDocumentTypes", "site", "phone", "payItems", "origin", "madeBy", "withdrawnAt", "withdrawalNote" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "PERSON_TWICE_THAT_DAY", "PHONE_TWICE_THAT_DAY", "OUTSIDE_THE_ACTIVE_WINDOW", "PROJECT_CLOSED", "PAY_ITEMS_WITHOUT_UNIT_RATE_WORK", "SITE_NOT_ACTIVE" ] }, "message": { "type": "string" } }, "required": ["code", "message"], "additionalProperties": false } } }, "required": ["assignment", "warnings"], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["assignments", "next"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/hours": { "get": { "operationId": "listHours", "summary": "A project’s workers’ days on the time clock, from one day to another (62 days at most), a page at a time by day and then by assignment: each assignment with an entry, standing or withdrawn; its entries and the activity lines its clock-out carried, as the worker’s phone sent them; what its hours come to (worked and on a break inside the day, which ends before midnight in the project’s time zone, and what fell outside it by the day it counts on (past midnight, the next), whether still clocked in, entries that fit no stretch), in whole minutes, with no limit on hours; and its approval in force, with whether anything of it arrived after. What the export of hours reads. Never a rate or a pay, and never crew time’s hours.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_DISPATCH", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" } }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "days": { "type": "array", "items": { "type": "object", "properties": { "assignmentId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "person": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "monitorId": { "type": ["string", "null"] } }, "required": ["id", "name", "monitorId"], "additionalProperties": false }, "workDate": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "withdrawn": { "type": "boolean" }, "entries": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "kind": { "type": "string", "enum": ["IN", "BREAK_START", "BREAK_END", "OUT"] }, "at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "receivedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "phone": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false } }, "required": [ "id", "kind", "at", "deviceUtcOffsetMinutes", "receivedAt", "phone" ], "additionalProperties": false } }, "activityLines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "clockEntryId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "position": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "startedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "endedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "activity": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] }, "fieldEventId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "fieldEvent": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "COLLECTION", "DISPOSAL", "HAUL_OUT_COLLECTION", "HAUL_OUT_DISPOSAL", "UNIT_RATE" ] }, "ticketNumber": { "type": "string" }, "splitSuffix": { "type": "string" } }, "required": ["kind", "ticketNumber", "splitSuffix"], "additionalProperties": false }, { "type": "null" } ] }, "note": { "type": ["string", "null"] } }, "required": [ "id", "clockEntryId", "position", "startedAt", "endedAt", "activity", "fieldEventId", "fieldEvent", "note" ], "additionalProperties": false } }, "hours": { "type": "object", "properties": { "workedMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "breakMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "otherDays": { "type": "array", "items": { "type": "object", "properties": { "workDate": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "workedMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "breakMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["workDate", "workedMinutes", "breakMinutes"], "additionalProperties": false } }, "stillClockedIn": { "type": "boolean" }, "unmatchedEntries": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "workedMinutes", "breakMinutes", "otherDays", "stillClockedIn", "unmatchedEntries" ], "additionalProperties": false }, "approval": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "assignmentId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "approvedBy": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, "approvedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "unlockedBy": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] }, "unlockedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "unlockNote": { "type": ["string", "null"] } }, "required": [ "id", "assignmentId", "approvedBy", "approvedAt", "unlockedBy", "unlockedAt", "unlockNote" ], "additionalProperties": false }, { "type": "null" } ] }, "receivedAfterApproval": { "type": "boolean" } }, "required": [ "assignmentId", "person", "workDate", "withdrawn", "entries", "activityLines", "hours", "approval", "receivedAfterApproval" ], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["days", "next"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/assignments/{assignmentId}/day-approvals": { "post": { "operationId": "approveDay", "summary": "A worker’s day on the time clock is approved, and so locked: nothing of its entries or activity lines changes until it is unlocked. A phone’s entry that arrives after is still taken, and the hours read say so. Refused for one’s own day and for a day already approved.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "APPROVE_HOURS", "parameters": [ { "name": "assignmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "assignmentId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "approvedBy": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, "approvedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "unlockedBy": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] }, "unlockedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "unlockNote": { "type": ["string", "null"] } }, "required": [ "id", "assignmentId", "approvedBy", "approvedAt", "unlockedBy", "unlockedAt", "unlockNote" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/assignments/{assignmentId}/day-unlocks": { "post": { "operationId": "unlockDay", "summary": "An approved day is unlocked, with a note saying why; the approval is kept and says who unlocked it and when, and the day is approved again as a new approval. Refused for a day that isn’t approved.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "APPROVE_HOURS", "parameters": [ { "name": "assignmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["note"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "assignmentId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "approvedBy": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, "approvedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "unlockedBy": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] }, "unlockedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "unlockNote": { "type": ["string", "null"] } }, "required": [ "id", "assignmentId", "approvedBy", "approvedAt", "unlockedBy", "unlockedAt", "unlockNote" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/ticket-voids": { "post": { "operationId": "voidTicket", "summary": "A ticket is voided, with a reason picked from the firm’s list and the reviewer’s own note. Nothing asks whether the choice is right. Refused for a number no field event of the project is under, a ticket already void, a reason the firm doesn’t offer for voiding and a ticket locked as invoiced.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VOID", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "workflow": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] }, "ticketNumber": { "type": "string", "minLength": 1, "maxLength": 40 }, "reasonId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["workflow", "ticketNumber", "reasonId"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workflow": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] }, "ticketNumber": { "type": "string" }, "reasonId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "note": { "type": ["string", "null"] }, "voidedById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "voidedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "liftedById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "liftedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "liftNote": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "workflow", "ticketNumber", "reasonId", "note", "voidedById", "voidedAt", "liftedById", "liftedAt", "liftNote" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/ticket-unvoids": { "post": { "operationId": "unvoidTicket", "summary": "A void ticket is unvoided: the unvoid is a record of its own, and a person’s void is kept, marked lifted. Refused for a ticket that isn’t void.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VOID", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "workflow": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] }, "ticketNumber": { "type": "string", "minLength": 1, "maxLength": 40 }, "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["workflow", "ticketNumber"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workflow": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] }, "ticketNumber": { "type": "string" }, "note": { "type": ["string", "null"] }, "unvoidedById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "unvoidedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "id", "projectId", "workflow", "ticketNumber", "note", "unvoidedById", "unvoidedAt" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/flags/{flagId}/acceptances": { "post": { "operationId": "acceptFlag", "summary": "A flag that stands is accepted, with a reason picked from the firm’s list and the reviewer’s own note. Refused for a flag the worker has cleared, one already accepted, a reason the firm doesn’t offer for accepting a flag and a ticket locked as invoiced.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "ACCEPT_FLAG", "parameters": [ { "name": "flagId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "reasonId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["reasonId"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "flagId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "reasonId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "note": { "type": ["string", "null"] }, "acceptedById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "acceptedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "withdrawnById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "withdrawnAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "withdrawNote": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "flagId", "reasonId", "note", "acceptedById", "acceptedAt", "withdrawnById", "withdrawnAt", "withdrawNote" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/flag-acceptances/{flagAcceptanceId}/withdrawals": { "post": { "operationId": "withdrawAcceptance", "summary": "A flag’s acceptance is taken back, with the reviewer’s note: who and when are kept on it, and the flag stands again on the run it queues. Accepting the flag again is a new acceptance. Refused for an acceptance already taken back and a ticket locked as invoiced.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "ACCEPT_FLAG", "parameters": [ { "name": "flagAcceptanceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["note"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "flagId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "reasonId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "note": { "type": ["string", "null"] }, "acceptedById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "acceptedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "withdrawnById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "withdrawnAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "withdrawNote": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "flagId", "reasonId", "note", "acceptedById", "acceptedAt", "withdrawnById", "withdrawnAt", "withdrawNote" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/qc-marks": { "put": { "operationId": "setQcStatus", "summary": "The QC status of a completed load or haul-out, a unit rate ticket, a certification, an ROE, a survey, an incident or a drop-off log is set. Refused for a load’s or a haul-out’s single field event and for a ticket locked as invoiced.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "QC", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "anyOf": [ { "type": "object", "properties": { "completedLoadId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["completedLoadId"], "additionalProperties": false }, { "type": "object", "properties": { "completedHaulOutId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["completedHaulOutId"], "additionalProperties": false }, { "type": "object", "properties": { "unitRateTicketId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["unitRateTicketId"], "additionalProperties": false }, { "type": "object", "properties": { "certificationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["certificationId"], "additionalProperties": false }, { "type": "object", "properties": { "roeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["roeId"], "additionalProperties": false }, { "type": "object", "properties": { "surveyId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["surveyId"], "additionalProperties": false }, { "type": "object", "properties": { "incidentId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["incidentId"], "additionalProperties": false }, { "type": "object", "properties": { "dropOffLogId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["dropOffLogId"], "additionalProperties": false } ] }, "status": { "type": "string", "enum": ["QC_REVIEW", "QC_APPROVED", "QC_ISSUES", "QC_VOID"] }, "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["record", "status"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "completedLoadId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "completedHaulOutId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "unitRateTicketId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certificationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "roeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "surveyId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "incidentId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "dropOffLogId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "status": { "type": "string", "enum": ["QC_REVIEW", "QC_APPROVED", "QC_ISSUES", "QC_VOID"] }, "setById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "setAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "note": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "completedLoadId", "completedHaulOutId", "unitRateTicketId", "certificationId", "roeId", "surveyId", "incidentId", "dropOffLogId", "status", "setById", "setAt", "note" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/qc-marks/several": { "put": { "operationId": "setQcStatuses", "summary": "QC statuses set on many records at once, up to 200, each as one would be: in the order sent, each its own piece of work and each answered, saved with its mark or not with its reason and words (a ticket locked as invoiced among them). One refused never stops the rest.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "QC", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "marks": { "minItems": 1, "maxItems": 200, "type": "array", "items": { "type": "object", "properties": { "record": { "anyOf": [ { "type": "object", "properties": { "completedLoadId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["completedLoadId"], "additionalProperties": false }, { "type": "object", "properties": { "completedHaulOutId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["completedHaulOutId"], "additionalProperties": false }, { "type": "object", "properties": { "unitRateTicketId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["unitRateTicketId"], "additionalProperties": false }, { "type": "object", "properties": { "certificationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["certificationId"], "additionalProperties": false }, { "type": "object", "properties": { "roeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["roeId"], "additionalProperties": false }, { "type": "object", "properties": { "surveyId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["surveyId"], "additionalProperties": false }, { "type": "object", "properties": { "incidentId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["incidentId"], "additionalProperties": false }, { "type": "object", "properties": { "dropOffLogId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["dropOffLogId"], "additionalProperties": false } ] }, "status": { "type": "string", "enum": ["QC_REVIEW", "QC_APPROVED", "QC_ISSUES", "QC_VOID"] }, "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["record", "status"], "additionalProperties": false } } }, "required": ["marks"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "outcomes": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "saved": { "type": "boolean", "const": true }, "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "completedLoadId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "completedHaulOutId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "unitRateTicketId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certificationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "roeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "surveyId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "incidentId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "dropOffLogId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "status": { "type": "string", "enum": ["QC_REVIEW", "QC_APPROVED", "QC_ISSUES", "QC_VOID"] }, "setById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "setAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "note": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "completedLoadId", "completedHaulOutId", "unitRateTicketId", "certificationId", "roeId", "surveyId", "incidentId", "dropOffLogId", "status", "setById", "setAt", "note" ], "additionalProperties": false } }, "required": ["saved", "record"], "additionalProperties": false }, { "type": "object", "properties": { "saved": { "type": "boolean", "const": false }, "reason": { "type": "string" }, "message": { "type": "string" } }, "required": ["saved", "reason", "message"], "additionalProperties": false } ] } } }, "required": ["outcomes"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/invoice-batches": { "get": { "operationId": "listInvoiceBatches", "summary": "A project’s invoice batches, a page at a time, in name order: each with how many locks in force it holds.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_REVIEW", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "batches": { "type": "array", "items": { "type": "object", "properties": { "batch": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "createdById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["id", "projectId", "name", "createdById", "createdAt"], "additionalProperties": false }, "locksInForce": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["batch", "locksInForce"], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["batches", "next"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } }, "post": { "operationId": "createInvoiceBatch", "summary": "An invoice batch is named on a project. Refused for a name another batch of the project has.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "LOCK_INVOICED", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": ["name"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "createdById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["id", "projectId", "name", "createdById", "createdAt"], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/invoice-batches/{invoiceBatchId}": { "get": { "operationId": "readInvoiceBatch", "summary": "One invoice batch and what it holds: each lock in force that names it, with the ticket it locks. No amount: a batch is a name and its tickets.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_REVIEW", "parameters": [ { "name": "invoiceBatchId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "batch": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "createdById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["id", "projectId", "name", "createdById", "createdAt"], "additionalProperties": false }, "locks": { "type": "array", "items": { "type": "object", "properties": { "lock": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "completedLoadId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "completedHaulOutId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "unitRateTicketId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "invoiceBatchId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "lockedById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "lockedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "unlockedById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "unlockedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "unlockNote": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "completedLoadId", "completedHaulOutId", "unitRateTicketId", "invoiceBatchId", "lockedById", "lockedAt", "unlockedById", "unlockedAt", "unlockNote" ], "additionalProperties": false }, "ticket": { "type": "object", "properties": { "workflow": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] }, "ticketNumber": { "type": "string" } }, "required": ["workflow", "ticketNumber"], "additionalProperties": false } }, "required": ["lock", "ticket"], "additionalProperties": false } } }, "required": ["batch", "locks"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } }, "patch": { "operationId": "renameInvoiceBatch", "summary": "An invoice batch is renamed: a name used once on its project, never blank. Its locks and tickets are as they were.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "LOCK_INVOICED", "parameters": [ { "name": "invoiceBatchId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": ["name"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "createdById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["id", "projectId", "name", "createdById", "createdAt"], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/invoice-locks": { "post": { "operationId": "lockAsInvoiced", "summary": "A ticket is locked as invoiced, in a batch of its project where one is named. Refused for a ticket that isn’t whole, COMPLETED and QC Approved, one already locked and a batch of another project.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "LOCK_INVOICED", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ticket": { "anyOf": [ { "type": "object", "properties": { "completedLoadId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["completedLoadId"], "additionalProperties": false }, { "type": "object", "properties": { "completedHaulOutId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["completedHaulOutId"], "additionalProperties": false }, { "type": "object", "properties": { "unitRateTicketId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["unitRateTicketId"], "additionalProperties": false } ] }, "invoiceBatchId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["ticket"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "completedLoadId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "completedHaulOutId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "unitRateTicketId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "invoiceBatchId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "lockedById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "lockedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "unlockedById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "unlockedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "unlockNote": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "completedLoadId", "completedHaulOutId", "unitRateTicketId", "invoiceBatchId", "lockedById", "lockedAt", "unlockedById", "unlockedAt", "unlockNote" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/invoice-locks/several": { "post": { "operationId": "lockSeveralAsInvoiced", "summary": "Many tickets locked as invoiced at once, up to 200, each in the batch named where one is: in the order sent, each its own piece of work and each answered, locked or not with its reason and words (not QC Approved, not whole, flagged, already locked). One refused never stops the rest.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "LOCK_INVOICED", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tickets": { "minItems": 1, "maxItems": 200, "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "completedLoadId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["completedLoadId"], "additionalProperties": false }, { "type": "object", "properties": { "completedHaulOutId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["completedHaulOutId"], "additionalProperties": false }, { "type": "object", "properties": { "unitRateTicketId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["unitRateTicketId"], "additionalProperties": false } ] } }, "invoiceBatchId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["tickets"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "outcomes": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "saved": { "type": "boolean", "const": true }, "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "completedLoadId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "completedHaulOutId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "unitRateTicketId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "invoiceBatchId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "lockedById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "lockedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "unlockedById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "unlockedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "unlockNote": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "completedLoadId", "completedHaulOutId", "unitRateTicketId", "invoiceBatchId", "lockedById", "lockedAt", "unlockedById", "unlockedAt", "unlockNote" ], "additionalProperties": false } }, "required": ["saved", "record"], "additionalProperties": false }, { "type": "object", "properties": { "saved": { "type": "boolean", "const": false }, "reason": { "type": "string" }, "message": { "type": "string" } }, "required": ["saved", "reason", "message"], "additionalProperties": false } ] } } }, "required": ["outcomes"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/invoice-locks/batch": { "put": { "operationId": "setLockBatch", "summary": "A locked ticket is put in an invoice batch of its project, moved to another or taken out of one. Refused for a ticket that isn’t locked and a batch of another project.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "LOCK_INVOICED", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ticket": { "anyOf": [ { "type": "object", "properties": { "completedLoadId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["completedLoadId"], "additionalProperties": false }, { "type": "object", "properties": { "completedHaulOutId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["completedHaulOutId"], "additionalProperties": false }, { "type": "object", "properties": { "unitRateTicketId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["unitRateTicketId"], "additionalProperties": false } ] }, "invoiceBatchId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["ticket", "invoiceBatchId"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "completedLoadId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "completedHaulOutId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "unitRateTicketId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "invoiceBatchId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "lockedById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "lockedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "unlockedById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "unlockedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "unlockNote": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "completedLoadId", "completedHaulOutId", "unitRateTicketId", "invoiceBatchId", "lockedById", "lockedAt", "unlockedById", "unlockedAt", "unlockNote" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/invoice-unlocks": { "post": { "operationId": "unlockInvoiced", "summary": "A ticket locked as invoiced is unlocked, and queued to be worked again as the setup now stands. Refused for a ticket that isn’t locked.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "UNLOCK_INVOICED", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ticket": { "anyOf": [ { "type": "object", "properties": { "completedLoadId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["completedLoadId"], "additionalProperties": false }, { "type": "object", "properties": { "completedHaulOutId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["completedHaulOutId"], "additionalProperties": false }, { "type": "object", "properties": { "unitRateTicketId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["unitRateTicketId"], "additionalProperties": false } ] }, "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["ticket"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "completedLoadId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "completedHaulOutId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "unitRateTicketId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "invoiceBatchId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "lockedById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "lockedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "unlockedById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "unlockedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "unlockNote": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "completedLoadId", "completedHaulOutId", "unitRateTicketId", "invoiceBatchId", "lockedById", "lockedAt", "unlockedById", "unlockedAt", "unlockNote" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/reprocesses": { "post": { "operationId": "reprocessTickets", "summary": "Tickets of the project are queued to be worked again as their records and the setup stand, nothing changed: those named, or the tickets of a job the worker set aside, by its id. One job, naming the person; a ticket locked as invoiced is left off it and counted. Refused for more tickets than the installation’s policy lets one job name, a number no field event of the project is under, and a job that isn’t one of the project’s set aside.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "CORRECT", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "tickets": { "minItems": 1, "maxItems": 100000, "type": "array", "items": { "type": "object", "properties": { "workflow": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] }, "ticketNumber": { "type": "string", "minLength": 1, "maxLength": 40 } }, "required": ["workflow", "ticketNumber"], "additionalProperties": false } }, "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["tickets"], "additionalProperties": false }, { "type": "object", "properties": { "setAsideJobId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["setAsideJobId"], "additionalProperties": false } ] } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "setAsideJobId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "tickets": { "type": "array", "items": { "type": "object", "properties": { "workflow": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] }, "ticketNumber": { "type": "string" } }, "required": ["workflow", "ticketNumber"], "additionalProperties": false } }, "lockedAsInvoiced": { "type": "array", "items": { "type": "object", "properties": { "workflow": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] }, "ticketNumber": { "type": "string" } }, "required": ["workflow", "ticketNumber"], "additionalProperties": false } }, "requestedById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "projectId", "setAsideJobId", "tickets", "lockedAsInvoiced", "requestedById" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/field-events/{fieldEventId}": { "get": { "operationId": "readFieldEvent", "summary": "One field event as recorded and corrected, with its status, its item lines and the tickets it carries (those taken off kept, marked), its photographs’ records (each with its view, when it was taken and when its file reached storage) and the scale receipt it names. Never where a file is kept.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_REVIEW", "parameters": [ { "name": "fieldEventId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "fieldEvent": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workflow": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] }, "ticketNumber": { "type": "string" }, "kind": { "type": "string", "enum": [ "COLLECTION", "DISPOSAL", "HAUL_OUT_COLLECTION", "HAUL_OUT_DISPOSAL", "UNIT_RATE" ] }, "splitSuffix": { "type": "string" }, "source": { "type": "string", "enum": ["DEVICE", "BACK_OFFICE"] }, "masterPasscodeSession": { "anyOf": [ { "type": "string", "enum": ["AS_MONITOR", "TEMPORARY"] }, { "type": "null" } ] }, "createdById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "createdReasonId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "monitorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "startedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "endedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "start": { "anyOf": [ { "type": "object", "properties": { "latitude": { "type": "string" }, "longitude": { "type": "string" } }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "end": { "anyOf": [ { "type": "object", "properties": { "latitude": { "type": "string" }, "longitude": { "type": "string" } }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "address": { "type": ["string", "null"] }, "addressSource": { "anyOf": [ { "type": "string", "enum": ["LOOKED_UP", "TYPED"] }, { "type": "null" } ] }, "notes": { "type": ["string", "null"] }, "certNumber": { "type": "string" }, "certificationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certKeyedByHand": { "type": "boolean" }, "typedCapacityCy": { "type": ["number", "null"] }, "numberTyped": { "type": "boolean" }, "numberTypedReasonId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "siteId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "formDebrisTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "fieldTagId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "roeNumber": { "type": ["string", "null"] }, "roeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "estimateCy": { "type": ["number", "null"] }, "loadCall": { "type": ["number", "null"] }, "scaleReceiptId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "carriedCount": { "type": ["number", "null"] }, "kindOfWorkId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "payableTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "payItemId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "unitCount": { "type": ["number", "null"] }, "measurementInches": { "type": ["number", "null"] }, "measuredAs": { "anyOf": [ { "type": "string", "enum": ["CIRCUMFERENCE", "DIAMETER"] }, { "type": "null" } ] }, "rootBallInches": { "type": ["number", "null"] }, "rootBallHalfExposed": { "type": ["boolean", "null"] }, "surveyNumber": { "type": ["string", "null"] }, "markedIneligible": { "type": ["boolean", "null"] }, "status": { "type": "string", "enum": ["PENDING", "COMPLETED", "MANUAL_REVIEW", "VOID"] }, "receivedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "reconciledAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "zoneId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "mapVersionId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "workedOutPayItemId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "deviceId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "assignmentId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "setupVersion": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "id", "projectId", "workflow", "ticketNumber", "kind", "splitSuffix", "source", "masterPasscodeSession", "createdById", "createdReasonId", "monitorId", "startedAt", "endedAt", "deviceUtcOffsetMinutes", "start", "end", "address", "addressSource", "notes", "certNumber", "certificationId", "certKeyedByHand", "typedCapacityCy", "numberTyped", "numberTypedReasonId", "siteId", "formDebrisTypeId", "fieldTagId", "roeNumber", "roeId", "estimateCy", "loadCall", "scaleReceiptId", "carriedCount", "kindOfWorkId", "payableTypeId", "payItemId", "unitCount", "measurementInches", "measuredAs", "rootBallInches", "rootBallHalfExposed", "surveyNumber", "markedIneligible", "status", "receivedAt", "reconciledAt", "zoneId", "mapVersionId", "workedOutPayItemId", "deviceId", "assignmentId", "setupVersion" ], "additionalProperties": false }, "itemLines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fieldEventId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "itemNameId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "quantity": { "type": "number" }, "takenOffAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": ["id", "fieldEventId", "itemNameId", "quantity", "takenOffAt"], "additionalProperties": false } }, "carriedTickets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fieldEventId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "carriedTicketNumber": { "type": "string" }, "takenOffAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": ["id", "fieldEventId", "carriedTicketNumber", "takenOffAt"], "additionalProperties": false } }, "waypoints": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fieldEventId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "position": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "markedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "fix": { "anyOf": [ { "type": "object", "properties": { "latitude": { "type": "string" }, "longitude": { "type": "string" } }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "unreadableGps": { "anyOf": [ { "type": "object", "properties": { "latitude": {}, "longitude": {} }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "takenOffAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "id", "fieldEventId", "position", "markedAt", "fix", "unreadableGps", "takenOffAt" ], "additionalProperties": false } }, "photographs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fieldEventId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certificationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "scaleReceiptId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "roeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "surveyId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "incidentId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "dropOffLogId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "view": { "anyOf": [ { "type": "string", "enum": [ "OPERATOR_WITH_PLACARD", "INTERIOR_OR_BACK", "RIGHT", "LEFT", "FRONT" ] }, { "type": "null" } ] }, "stage": { "anyOf": [ { "type": "string", "enum": ["PRE_WORK", "MEASUREMENT", "POST_WORK"] }, { "type": "null" } ] }, "capturedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "uploadedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "removedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "label": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "fieldEventId", "certificationId", "scaleReceiptId", "roeId", "surveyId", "incidentId", "dropOffLogId", "view", "stage", "capturedAt", "uploadedAt", "removedAt", "label" ], "additionalProperties": false } }, "scaleReceipt": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "receiptNumber": { "type": "string" }, "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "grossWeightLb": { "type": ["number", "null"] }, "tareWeightLb": { "type": ["number", "null"] }, "netWeightLb": { "type": ["number", "null"] }, "netWeightTons": { "type": ["number", "null"] }, "enteredById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "enteredAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "notes": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "receiptNumber", "siteId", "grossWeightLb", "tareWeightLb", "netWeightLb", "netWeightTons", "enteredById", "enteredAt", "notes" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "fieldEvent", "itemLines", "carriedTickets", "waypoints", "photographs", "scaleReceipt" ], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } }, "patch": { "operationId": "correctFieldEvent", "summary": "A field event’s captured details are corrected in place: only what is stated changes, and `null` empties a detail that may be empty. A corrected cert number finds its certification again, an ROE number its ROE, a debris type its form. Its ticket and the tickets that read it are queued. Never its number (a renumber), its kind, its workflow or its project. Refused for a ticket locked as invoiced, and for a detail its kind of field event doesn’t record.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "CORRECT", "parameters": [ { "name": "fieldEventId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "changes": { "type": "object", "properties": { "monitorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "startedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "endedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -720, "maximum": 840 }, "start": { "anyOf": [ { "type": "object", "properties": { "latitude": { "type": "string", "pattern": "^-?\\d{1,3}(\\.\\d{1,8})?$" }, "longitude": { "type": "string", "pattern": "^-?\\d{1,3}(\\.\\d{1,8})?$" } }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "end": { "anyOf": [ { "type": "object", "properties": { "latitude": { "type": "string", "pattern": "^-?\\d{1,3}(\\.\\d{1,8})?$" }, "longitude": { "type": "string", "pattern": "^-?\\d{1,3}(\\.\\d{1,8})?$" } }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2000 }, { "type": "null" } ] }, "addressSource": { "anyOf": [ { "type": "string", "enum": ["LOOKED_UP", "TYPED"] }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2000 }, { "type": "null" } ] }, "certNumber": { "type": "string", "minLength": 1, "maxLength": 40 }, "certKeyedByHand": { "type": "boolean" }, "typedCapacityCy": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9999 }, { "type": "null" } ] }, "numberTyped": { "type": "boolean" }, "numberTypedReasonId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "siteId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "formDebrisTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "fieldTagId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "roeNumber": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 40 }, { "type": "null" } ] }, "estimateCy": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 9999999.9, "multipleOf": 0.1 }, { "type": "null" } ] }, "loadCall": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "scaleReceiptId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "carriedCount": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9999 }, { "type": "null" } ] }, "kindOfWorkId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "payableTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "payItemId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "unitCount": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 99999999.99, "multipleOf": 0.01 }, { "type": "null" } ] }, "measurementInches": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 9999999.9, "multipleOf": 0.1 }, { "type": "null" } ] }, "measuredAs": { "anyOf": [ { "type": "string", "enum": ["CIRCUMFERENCE", "DIAMETER"] }, { "type": "null" } ] }, "rootBallInches": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 9999999.9, "multipleOf": 0.1 }, { "type": "null" } ] }, "rootBallHalfExposed": { "type": ["boolean", "null"] }, "surveyNumber": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 40 }, { "type": "null" } ] }, "markedIneligible": { "type": ["boolean", "null"] } }, "additionalProperties": false }, "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["changes"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workflow": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] }, "ticketNumber": { "type": "string" }, "kind": { "type": "string", "enum": [ "COLLECTION", "DISPOSAL", "HAUL_OUT_COLLECTION", "HAUL_OUT_DISPOSAL", "UNIT_RATE" ] }, "splitSuffix": { "type": "string" }, "source": { "type": "string", "enum": ["DEVICE", "BACK_OFFICE"] }, "masterPasscodeSession": { "anyOf": [ { "type": "string", "enum": ["AS_MONITOR", "TEMPORARY"] }, { "type": "null" } ] }, "createdById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "createdReasonId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "monitorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "startedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "endedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "start": { "anyOf": [ { "type": "object", "properties": { "latitude": { "type": "string" }, "longitude": { "type": "string" } }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "end": { "anyOf": [ { "type": "object", "properties": { "latitude": { "type": "string" }, "longitude": { "type": "string" } }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "address": { "type": ["string", "null"] }, "addressSource": { "anyOf": [ { "type": "string", "enum": ["LOOKED_UP", "TYPED"] }, { "type": "null" } ] }, "notes": { "type": ["string", "null"] }, "certNumber": { "type": "string" }, "certificationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certKeyedByHand": { "type": "boolean" }, "typedCapacityCy": { "type": ["number", "null"] }, "numberTyped": { "type": "boolean" }, "numberTypedReasonId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "siteId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "formDebrisTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "fieldTagId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "roeNumber": { "type": ["string", "null"] }, "roeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "estimateCy": { "type": ["number", "null"] }, "loadCall": { "type": ["number", "null"] }, "scaleReceiptId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "carriedCount": { "type": ["number", "null"] }, "kindOfWorkId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "payableTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "payItemId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "unitCount": { "type": ["number", "null"] }, "measurementInches": { "type": ["number", "null"] }, "measuredAs": { "anyOf": [ { "type": "string", "enum": ["CIRCUMFERENCE", "DIAMETER"] }, { "type": "null" } ] }, "rootBallInches": { "type": ["number", "null"] }, "rootBallHalfExposed": { "type": ["boolean", "null"] }, "surveyNumber": { "type": ["string", "null"] }, "markedIneligible": { "type": ["boolean", "null"] } }, "required": [ "id", "projectId", "workflow", "ticketNumber", "kind", "splitSuffix", "source", "masterPasscodeSession", "createdById", "createdReasonId", "monitorId", "startedAt", "endedAt", "deviceUtcOffsetMinutes", "start", "end", "address", "addressSource", "notes", "certNumber", "certificationId", "certKeyedByHand", "typedCapacityCy", "numberTyped", "numberTypedReasonId", "siteId", "formDebrisTypeId", "fieldTagId", "roeNumber", "roeId", "estimateCy", "loadCall", "scaleReceiptId", "carriedCount", "kindOfWorkId", "payableTypeId", "payItemId", "unitCount", "measurementInches", "measuredAs", "rootBallInches", "rootBallHalfExposed", "surveyNumber", "markedIneligible" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/field-events/{fieldEventId}/number": { "put": { "operationId": "renumberFieldEvent", "summary": "A field event is given another ticket number, or a split’s collection another suffix (left out, its suffix stays). The ticket it leaves and the one it joins are both queued. Nothing asks whether the work is real. Refused for the number it already has, a number another field event of its kind holds, a suffix on a kind that takes none and a ticket locked as invoiced.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "RENUMBER", "parameters": [ { "name": "fieldEventId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ticketNumber": { "type": "string", "minLength": 1, "maxLength": 40 }, "splitSuffix": { "type": "string", "maxLength": 4 }, "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["ticketNumber"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workflow": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] }, "ticketNumber": { "type": "string" }, "kind": { "type": "string", "enum": [ "COLLECTION", "DISPOSAL", "HAUL_OUT_COLLECTION", "HAUL_OUT_DISPOSAL", "UNIT_RATE" ] }, "splitSuffix": { "type": "string" }, "source": { "type": "string", "enum": ["DEVICE", "BACK_OFFICE"] }, "masterPasscodeSession": { "anyOf": [ { "type": "string", "enum": ["AS_MONITOR", "TEMPORARY"] }, { "type": "null" } ] }, "createdById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "createdReasonId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "monitorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "startedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "endedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "start": { "anyOf": [ { "type": "object", "properties": { "latitude": { "type": "string" }, "longitude": { "type": "string" } }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "end": { "anyOf": [ { "type": "object", "properties": { "latitude": { "type": "string" }, "longitude": { "type": "string" } }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "address": { "type": ["string", "null"] }, "addressSource": { "anyOf": [ { "type": "string", "enum": ["LOOKED_UP", "TYPED"] }, { "type": "null" } ] }, "notes": { "type": ["string", "null"] }, "certNumber": { "type": "string" }, "certificationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certKeyedByHand": { "type": "boolean" }, "typedCapacityCy": { "type": ["number", "null"] }, "numberTyped": { "type": "boolean" }, "numberTypedReasonId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "siteId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "formDebrisTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "fieldTagId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "roeNumber": { "type": ["string", "null"] }, "roeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "estimateCy": { "type": ["number", "null"] }, "loadCall": { "type": ["number", "null"] }, "scaleReceiptId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "carriedCount": { "type": ["number", "null"] }, "kindOfWorkId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "payableTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "payItemId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "unitCount": { "type": ["number", "null"] }, "measurementInches": { "type": ["number", "null"] }, "measuredAs": { "anyOf": [ { "type": "string", "enum": ["CIRCUMFERENCE", "DIAMETER"] }, { "type": "null" } ] }, "rootBallInches": { "type": ["number", "null"] }, "rootBallHalfExposed": { "type": ["boolean", "null"] }, "surveyNumber": { "type": ["string", "null"] }, "markedIneligible": { "type": ["boolean", "null"] } }, "required": [ "id", "projectId", "workflow", "ticketNumber", "kind", "splitSuffix", "source", "masterPasscodeSession", "createdById", "createdReasonId", "monitorId", "startedAt", "endedAt", "deviceUtcOffsetMinutes", "start", "end", "address", "addressSource", "notes", "certNumber", "certificationId", "certKeyedByHand", "typedCapacityCy", "numberTyped", "numberTypedReasonId", "siteId", "formDebrisTypeId", "fieldTagId", "roeNumber", "roeId", "estimateCy", "loadCall", "scaleReceiptId", "carriedCount", "kindOfWorkId", "payableTypeId", "payItemId", "unitCount", "measurementInches", "measuredAs", "rootBallInches", "rootBallHalfExposed", "surveyNumber", "markedIneligible" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/field-events/{fieldEventId}/item-lines/{itemNameId}": { "put": { "operationId": "correctItemLine", "summary": "A line of an itemised unit rate ticket is corrected: its count or hours stated, a line it didn’t have added, or the line taken off (`TAKEN_OFF`: it stays, marked, and counts for nothing); stating its quantity again puts it back. Refused for a field event that isn’t unit rate work and for a ticket locked as invoiced.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "CORRECT", "parameters": [ { "name": "fieldEventId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "itemNameId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "quantity": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 99999999.99, "multipleOf": 0.01 }, { "type": "string", "const": "TAKEN_OFF" } ] }, "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["quantity"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fieldEventId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "itemNameId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "quantity": { "type": "number" }, "takenOffAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": ["id", "fieldEventId", "itemNameId", "quantity", "takenOffAt"], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/field-events/{fieldEventId}/carried-tickets": { "put": { "operationId": "correctCarriedTicket", "summary": "A ticket a load’s collection lists as carried is added, taken off (it stays, marked, and counts for nothing) or put back. Refused for a field event that isn’t a load’s collection and for a ticket locked as invoiced.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "CORRECT", "parameters": [ { "name": "fieldEventId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "carriedTicketNumber": { "type": "string", "minLength": 1, "maxLength": 40 }, "carried": { "type": "boolean" }, "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["carriedTicketNumber", "carried"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fieldEventId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "carriedTicketNumber": { "type": "string" }, "takenOffAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": ["id", "fieldEventId", "carriedTicketNumber", "takenOffAt"], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/field-events/{fieldEventId}/waypoints/{position}": { "patch": { "operationId": "correctWaypoint", "summary": "A waypoint a collection’s monitor marked is corrected in place: when it was marked and its fix (`null` for none), only what is stated changing; or it is taken off (it stays, marked) or put back. Nothing is queued: no ticket’s conclusions read a waypoint. Refused for a waypoint the field event doesn’t have, a fix that can’t be one and a ticket locked as invoiced.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "CORRECT", "parameters": [ { "name": "fieldEventId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "position", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[1-9][0-9]{0,2}$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "changes": { "type": "object", "properties": { "markedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "fix": { "anyOf": [ { "type": "object", "properties": { "latitude": { "type": "string", "pattern": "^-?\\d{1,3}(\\.\\d{1,8})?$" }, "longitude": { "type": "string", "pattern": "^-?\\d{1,3}(\\.\\d{1,8})?$" } }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "takenOff": { "type": "boolean" } }, "additionalProperties": false }, "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["changes"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fieldEventId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "position": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "markedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "fix": { "anyOf": [ { "type": "object", "properties": { "latitude": { "type": "string" }, "longitude": { "type": "string" } }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "unreadableGps": { "anyOf": [ { "type": "object", "properties": { "latitude": {}, "longitude": {} }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "takenOffAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "id", "fieldEventId", "position", "markedAt", "fix", "unreadableGps", "takenOffAt" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/photographs/{photoId}": { "patch": { "operationId": "markPhotograph", "summary": "A photograph is removed from the record or put back, and labelled in the firm’s own words: only what is stated changes, and a `null` label takes the label off. Nothing is deleted: its record, its file and its fingerprints stay. The ticket it is on is queued. Refused for a ticket locked as invoiced.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "CORRECT", "parameters": [ { "name": "photoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "marks": { "type": "object", "properties": { "removed": { "type": "boolean" }, "label": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] } }, "additionalProperties": false }, "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["marks"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fieldEventId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certificationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "scaleReceiptId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "roeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "surveyId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "incidentId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "dropOffLogId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "view": { "anyOf": [ { "type": "string", "enum": [ "OPERATOR_WITH_PLACARD", "INTERIOR_OR_BACK", "RIGHT", "LEFT", "FRONT" ] }, { "type": "null" } ] }, "stage": { "anyOf": [ { "type": "string", "enum": ["PRE_WORK", "MEASUREMENT", "POST_WORK"] }, { "type": "null" } ] }, "capturedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "uploadedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "removedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "label": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "fieldEventId", "certificationId", "scaleReceiptId", "roeId", "surveyId", "incidentId", "dropOffLogId", "view", "stage", "capturedAt", "uploadedAt", "removedAt", "label" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/photographs/{photoId}/files/{file}": { "get": { "operationId": "photographFile", "summary": "A photograph’s file as it was kept: the photograph itself or the depth file beside it, the bytes that were stored, under the type their own first bytes said, sent as a download and never as a page. A photograph removed from the record is read all the same. One whose file hasn’t arrived, or that has no depth file, is not found.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_REVIEW", "parameters": [ { "name": "photoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "file", "in": "path", "required": true, "schema": { "type": "string", "enum": ["photo", "depth"] } } ], "responses": { "200": { "description": "The answer.", "content": { "image/jpeg": { "schema": { "type": "string", "contentMediaType": "image/jpeg" } }, "image/heic": { "schema": { "type": "string", "contentMediaType": "image/heic" } }, "image/heif": { "schema": { "type": "string", "contentMediaType": "image/heif" } }, "image/png": { "schema": { "type": "string", "contentMediaType": "image/png" } }, "image/tiff": { "schema": { "type": "string", "contentMediaType": "image/tiff" } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/photographs": { "post": { "operationId": "addPhotograph", "summary": "A photograph is added in the back office to a record made there (a field event, a certification, an ROE, a survey, an incident or a drop-off log), its file sent whole as bytes, at most the policy’s size: what it is on, a certification’s view where it has one, and when it was taken with its clock’s offset, in the query. Its kind is told by its own first bytes (JPEG, HEIC or HEIF, PNG, TIFF); it is kept once where the server places it, its fingerprints the server’s reading of the bytes. The ticket it is on is queued, or a certification’s own flags. Refused for a record a phone made, a view on anything but a certification and a ticket locked as invoiced.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "CORRECT", "parameters": [ { "name": "on", "in": "query", "required": true, "schema": { "type": "string", "enum": ["FIELD_EVENT", "CERTIFICATION", "ROE", "SURVEY", "INCIDENT", "DROP_OFF_LOG"] } }, { "name": "recordId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "view", "in": "query", "required": false, "schema": { "type": "string", "enum": ["OPERATOR_WITH_PLACARD", "INTERIOR_OR_BACK", "RIGHT", "LEFT", "FRONT"] } }, { "name": "capturedAt", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, { "name": "utcOffsetMinutes", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^(0|-?[1-9][0-9]{0,2})$" } } ], "requestBody": { "required": true, "content": { "application/offset+octet-stream": { "schema": { "type": "string", "contentMediaType": "application/octet-stream" } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fieldEventId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certificationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "scaleReceiptId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "roeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "surveyId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "incidentId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "dropOffLogId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "view": { "anyOf": [ { "type": "string", "enum": [ "OPERATOR_WITH_PLACARD", "INTERIOR_OR_BACK", "RIGHT", "LEFT", "FRONT" ] }, { "type": "null" } ] }, "stage": { "anyOf": [ { "type": "string", "enum": ["PRE_WORK", "MEASUREMENT", "POST_WORK"] }, { "type": "null" } ] }, "capturedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "uploadedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "removedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "label": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "fieldEventId", "certificationId", "scaleReceiptId", "roeId", "surveyId", "incidentId", "dropOffLogId", "view", "stage", "capturedAt", "uploadedAt", "removedAt", "label" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/scale-receipts/{scaleReceiptId}": { "get": { "operationId": "readScaleReceipt", "summary": "One scale receipt as the tower copied it, with its photographs’ records and the field events that name it.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_REVIEW", "parameters": [ { "name": "scaleReceiptId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "scaleReceipt": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "receiptNumber": { "type": "string" }, "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "grossWeightLb": { "type": ["number", "null"] }, "tareWeightLb": { "type": ["number", "null"] }, "netWeightLb": { "type": ["number", "null"] }, "netWeightTons": { "type": ["number", "null"] }, "enteredById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "enteredAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "notes": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "receiptNumber", "siteId", "grossWeightLb", "tareWeightLb", "netWeightLb", "netWeightTons", "enteredById", "enteredAt", "notes" ], "additionalProperties": false }, "photographs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fieldEventId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certificationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "scaleReceiptId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "roeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "surveyId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "incidentId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "dropOffLogId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "view": { "anyOf": [ { "type": "string", "enum": [ "OPERATOR_WITH_PLACARD", "INTERIOR_OR_BACK", "RIGHT", "LEFT", "FRONT" ] }, { "type": "null" } ] }, "stage": { "anyOf": [ { "type": "string", "enum": ["PRE_WORK", "MEASUREMENT", "POST_WORK"] }, { "type": "null" } ] }, "capturedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "uploadedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "removedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "label": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "fieldEventId", "certificationId", "scaleReceiptId", "roeId", "surveyId", "incidentId", "dropOffLogId", "view", "stage", "capturedAt", "uploadedAt", "removedAt", "label" ], "additionalProperties": false } }, "fieldEventIds": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": ["scaleReceipt", "photographs", "fieldEventIds"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } }, "patch": { "operationId": "correctScaleReceipt", "summary": "A scale receipt is corrected in place: the site’s number as written, the site that issued it, its weights and its notes; only what is stated changes. Every ticket that points at it is queued; one locked as invoiced is left as it is.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "CORRECT", "parameters": [ { "name": "scaleReceiptId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "changes": { "type": "object", "properties": { "receiptNumber": { "type": "string", "minLength": 1, "maxLength": 40 }, "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "grossWeightLb": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 9999999999.99, "multipleOf": 0.01 }, { "type": "null" } ] }, "tareWeightLb": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 9999999999.99, "multipleOf": 0.01 }, { "type": "null" } ] }, "netWeightLb": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 9999999999.99, "multipleOf": 0.01 }, { "type": "null" } ] }, "netWeightTons": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 99999999.9999, "multipleOf": 0.0001 }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2000 }, { "type": "null" } ] } }, "additionalProperties": false }, "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["changes"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "receiptNumber": { "type": "string" }, "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "grossWeightLb": { "type": ["number", "null"] }, "tareWeightLb": { "type": ["number", "null"] }, "netWeightLb": { "type": ["number", "null"] }, "netWeightTons": { "type": ["number", "null"] }, "enteredById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "enteredAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "notes": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "receiptNumber", "siteId", "grossWeightLb", "tareWeightLb", "netWeightLb", "netWeightTons", "enteredById", "enteredAt", "notes" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/roes/{roeId}": { "patch": { "operationId": "correctRoe", "summary": "An ROE is corrected in place: its number, parcel, address, owner, whether and when it was signed, its notes and the answers to its form’s own fields; only what is stated changes, and `null` empties a detail that may be empty. A corrected number is found by what names it, and what named the old one finds no ROE; what each says it named never changes. Every ticket on it, before and after, is queued; one locked as invoiced is left as it is. Refused for a number another ROE of the project holds and answers that don’t fit their version.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "CORRECT", "parameters": [ { "name": "roeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "changes": { "type": "object", "properties": { "roeNumber": { "type": "string", "minLength": 1, "maxLength": 40 }, "parcelId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 40 }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2000 }, { "type": "null" } ] }, "ownerName": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "signed": { "type": "boolean" }, "signedDate": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2000 }, { "type": "null" } ] }, "answers": { "type": "object", "properties": { "answers": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 100 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number", "minimum": -9999999999.99, "maximum": 9999999999.99 }, { "type": "boolean" } ] } }, "formDefinitionId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["answers"], "additionalProperties": false } }, "additionalProperties": false }, "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["changes"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "roeNumber": { "type": "string" }, "parcelId": { "type": ["string", "null"] }, "address": { "type": ["string", "null"] }, "ownerName": { "type": ["string", "null"] }, "signed": { "type": "boolean" }, "signedDate": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "fix": { "anyOf": [ { "type": "object", "properties": { "latitude": { "type": "string" }, "longitude": { "type": "string" } }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "source": { "type": "string", "enum": ["DEVICE", "BACK_OFFICE"] }, "madeById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "madeAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "notes": { "type": ["string", "null"] }, "answers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": ["string", "number", "boolean"] } }, "formDefinitionId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": [ "id", "projectId", "roeNumber", "parcelId", "address", "ownerName", "signed", "signedDate", "fix", "source", "madeById", "madeAt", "notes", "answers", "formDefinitionId" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/roes/{roeId}/scope": { "put": { "operationId": "correctRoeScope", "summary": "A pick of an ROE’s scope, a debris type of the project’s load form or a payable type, is added, taken off (it stays, marked, and counts for nothing) or put back, with how many where the ROE says. Every ticket on the ROE is queued; one locked as invoiced is left as it is. Refused for a debris type that isn’t on the project’s load form.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "CORRECT", "parameters": [ { "name": "roeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "pick": { "anyOf": [ { "type": "object", "properties": { "formDebrisTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "count": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 9999 }, { "type": "null" } ] } }, "required": ["formDebrisTypeId"], "additionalProperties": false }, { "type": "object", "properties": { "payableTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "count": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 9999 }, { "type": "null" } ] } }, "required": ["payableTypeId"], "additionalProperties": false } ] }, "inScope": { "type": "boolean" }, "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["pick", "inScope"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "roeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "formDebrisTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "payableTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "count": { "type": ["number", "null"] }, "takenOffAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "id", "projectId", "roeId", "formDebrisTypeId", "payableTypeId", "count", "takenOffAt" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/surveys/{surveyId}": { "patch": { "operationId": "correctSurvey", "summary": "A survey is corrected in place: its work type, its survey number, the ROE number it names and its notes; only what is stated changes. A corrected ROE number finds its ROE again. The answers to its form’s own fields are given whole, against the version they answer. The project’s surveys are checked again on the next run. Refused for answers that don’t fit their version.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "CORRECT", "parameters": [ { "name": "surveyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "changes": { "type": "object", "properties": { "workTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "surveyNumber": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 40 }, { "type": "null" } ] }, "roeNumber": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 40 }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2000 }, { "type": "null" } ] }, "answers": { "type": "object", "properties": { "answers": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 100 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number", "minimum": -9999999999.99, "maximum": 9999999999.99 }, { "type": "boolean" } ] } }, "formDefinitionId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["answers"], "additionalProperties": false } }, "additionalProperties": false }, "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["changes"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "source": { "type": "string", "enum": ["DEVICE", "BACK_OFFICE"] }, "createdById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "createdReasonId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "monitorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "madeAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "fix": { "anyOf": [ { "type": "object", "properties": { "latitude": { "type": "string" }, "longitude": { "type": "string" } }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "notes": { "type": ["string", "null"] }, "answers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": ["string", "number", "boolean"] } }, "formDefinitionId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "workTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "surveyNumber": { "type": ["string", "null"] }, "roeNumber": { "type": ["string", "null"] }, "roeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": [ "id", "projectId", "source", "createdById", "createdReasonId", "monitorId", "madeAt", "deviceUtcOffsetMinutes", "fix", "notes", "answers", "formDefinitionId", "workTypeId", "surveyNumber", "roeNumber", "roeId" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/incidents/{incidentId}": { "patch": { "operationId": "correctIncident", "summary": "An incident is corrected in place: its type and sub-type, what happened, who was involved, where, the contractor, cert number and ROE number it names, and its notes; only what is stated changes. A corrected cert number finds its certification again, an ROE number its ROE. The answers to its form’s own fields are given whole, against the version they answer. It is on no ticket, so nothing is queued. Refused for answers that don’t fit their version.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "CORRECT", "parameters": [ { "name": "incidentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "changes": { "type": "object", "properties": { "incidentTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "incidentSubTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2000 }, { "type": "null" } ] }, "parties": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2000 }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2000 }, { "type": "null" } ] }, "contractorId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certNumber": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 40 }, { "type": "null" } ] }, "roeNumber": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 40 }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2000 }, { "type": "null" } ] }, "answers": { "type": "object", "properties": { "answers": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 100 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number", "minimum": -9999999999.99, "maximum": 9999999999.99 }, { "type": "boolean" } ] } }, "formDefinitionId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["answers"], "additionalProperties": false } }, "additionalProperties": false }, "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["changes"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "source": { "type": "string", "enum": ["DEVICE", "BACK_OFFICE"] }, "createdById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "createdReasonId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "monitorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "madeAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "fix": { "anyOf": [ { "type": "object", "properties": { "latitude": { "type": "string" }, "longitude": { "type": "string" } }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "notes": { "type": ["string", "null"] }, "answers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": ["string", "number", "boolean"] } }, "formDefinitionId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "incidentTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "incidentSubTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "description": { "type": ["string", "null"] }, "parties": { "type": ["string", "null"] }, "address": { "type": ["string", "null"] }, "contractorId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certNumber": { "type": ["string", "null"] }, "certificationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "roeNumber": { "type": ["string", "null"] }, "roeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": [ "id", "projectId", "source", "createdById", "createdReasonId", "monitorId", "madeAt", "deviceUtcOffsetMinutes", "fix", "notes", "answers", "formDefinitionId", "incidentTypeId", "incidentSubTypeId", "description", "parties", "address", "contractorId", "certNumber", "certificationId", "roeNumber", "roeId" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/drop-off-logs/{dropOffLogId}": { "patch": { "operationId": "correctDropOffLog", "summary": "A citizen drop-off log is corrected in place: its site, the resident’s name, where the debris came from, its notes and the answers to its form’s own fields; only what is stated changes. It is on no ticket, so nothing is queued. Refused for a site of another project and answers that don’t fit their version.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "CORRECT", "parameters": [ { "name": "dropOffLogId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "changes": { "type": "object", "properties": { "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "residentName": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "originAddress": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2000 }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2000 }, { "type": "null" } ] }, "answers": { "type": "object", "properties": { "answers": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 100 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number", "minimum": -9999999999.99, "maximum": 9999999999.99 }, { "type": "boolean" } ] } }, "formDefinitionId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["answers"], "additionalProperties": false } }, "additionalProperties": false }, "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["changes"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "source": { "type": "string", "enum": ["DEVICE", "BACK_OFFICE"] }, "createdById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "createdReasonId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "monitorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "madeAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "fix": { "anyOf": [ { "type": "object", "properties": { "latitude": { "type": "string" }, "longitude": { "type": "string" } }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "notes": { "type": ["string", "null"] }, "answers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": ["string", "number", "boolean"] } }, "formDefinitionId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "residentName": { "type": ["string", "null"] }, "originAddress": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "source", "createdById", "createdReasonId", "monitorId", "madeAt", "deviceUtcOffsetMinutes", "fix", "notes", "answers", "formDefinitionId", "siteId", "residentName", "originAddress" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/quarantined-records/{quarantinedRecordId}/renumberings": { "post": { "operationId": "renumberQuarantinedRecord", "summary": "A quarantined record is resolved by giving it the number it should have had: a field event a ticket number (and a split’s collection its suffix; left out, the suffix it was sent with stays), an ROE an ROE number. It is saved as a record of its own with the id its phone made and its photographs, written as the reviewer; a field event’s ticket is queued, and the tickets that were waiting for an ROE of that number. Resolved once. Refused for a number another record of its kind holds, the number it was sent with, the other kind of number and a ticket locked as invoiced.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "RENUMBER", "parameters": [ { "name": "quarantinedRecordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "to": { "anyOf": [ { "type": "object", "properties": { "ticketNumber": { "type": "string", "minLength": 1, "maxLength": 40 }, "splitSuffix": { "type": "string", "maxLength": 4 } }, "required": ["ticketNumber"], "additionalProperties": false }, { "type": "object", "properties": { "roeNumber": { "type": "string", "minLength": 1, "maxLength": 40 } }, "required": ["roeNumber"], "additionalProperties": false } ] }, "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["to"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "reason": { "type": "string", "enum": ["DUPLICATE_FIELD_EVENT", "DUPLICATE_ROE_NUMBER"] }, "holdingEventId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "holdingRoeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "receivedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "resolvedById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "resolvedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "resolution": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "reason", "holdingEventId", "holdingRoeId", "receivedAt", "resolvedById", "resolvedAt", "resolution" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/quarantined-records/{quarantinedRecordId}/second-copies": { "post": { "operationId": "markSecondCopy", "summary": "A quarantined record is resolved as a second copy of the record that holds its number: nothing is made from it, and it stays, marked with who said so and when. Resolved once.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "RENUMBER", "parameters": [ { "name": "quarantinedRecordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "reason": { "type": "string", "enum": ["DUPLICATE_FIELD_EVENT", "DUPLICATE_ROE_NUMBER"] }, "holdingEventId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "holdingRoeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "receivedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "resolvedById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "resolvedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "resolution": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "reason", "holdingEventId", "holdingRoeId", "receivedAt", "resolvedById", "resolvedAt", "resolution" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/held-records": { "get": { "operationId": "listHeldRecords", "summary": "What a phone sent that the server couldn’t save, held for a person, a page at a time, oldest first: by project (as sent) or by phone, waiting or resolved. Each exactly as sent, with what it was sent as, why it is held, the words its phone was told, the photographs kept with it and how it was resolved.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_REVIEW", "parameters": [ { "name": "projectId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "deviceId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "waiting", "in": "query", "required": false, "schema": { "type": "string", "enum": ["true", "false"] } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "heldRecords": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "deviceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "syncId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "sentId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "sentMonitorId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "sentAs": { "anyOf": [ { "type": "string", "enum": [ "FIELD_EVENT", "SCALE_RECEIPT", "INCIDENT", "DROP_OFF_LOG", "SURVEY", "ROE", "CERTIFICATION", "CLOCK_ENTRY", "PHOTO", "REPORT" ] }, { "type": "null" } ] }, "sent": { "$ref": "#/$defs/__schema0" }, "reason": { "type": "string", "enum": [ "NOT_A_RECORD", "NAMES_NO_RECORD", "ASSIGNMENT_NOT_SAVED", "CERTIFICATION_REFUSED", "OWNER_NOT_SAVED", "PROJECT_CLOSED", "REPORT_NOT_SAVED" ] }, "message": { "type": "string" }, "receivedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "photos": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "resolvedById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "resolvedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "resolution": { "type": ["string", "null"] } }, "required": [ "id", "deviceId", "syncId", "sentId", "projectId", "sentMonitorId", "sentAs", "sent", "reason", "message", "receivedAt", "photos", "resolvedById", "resolvedAt", "resolution" ], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["heldRecords", "next"], "additionalProperties": false, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/$defs/__schema0" } } ] } } } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/held-records/{heldRecordId}/savings": { "post": { "operationId": "saveHeldRecord", "summary": "A held record is resolved by saving it as corrected: the record as it should be, in the sync’s own shape, under the id its phone made and of the kind it was sent as. It is written as the reviewer, as the phone’s record it was, with the photographs kept with it; its tickets are queued. Resolved once. Refused for a held record with no id, another id, another kind, a report (closed only), a number another record holds, what the database refuses and a ticket locked as invoiced.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "CORRECT", "parameters": [ { "name": "heldRecordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "anyOf": [ { "oneOf": [ { "type": "object", "properties": { "record": { "type": "string", "const": "FIELD_EVENT" }, "fieldEvent": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workflow": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] }, "kind": { "type": "string", "enum": [ "COLLECTION", "DISPOSAL", "HAUL_OUT_COLLECTION", "HAUL_OUT_DISPOSAL", "UNIT_RATE" ] }, "ticketNumber": { "type": "string", "minLength": 1, "maxLength": 40 }, "splitSuffix": { "type": "string", "maxLength": 4 }, "monitorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "assignmentId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "setupVersion": { "type": "integer", "minimum": 1, "maximum": 2000000000 }, "masterPasscodeSession": { "anyOf": [ { "type": "string", "enum": ["AS_MONITOR", "TEMPORARY"] }, { "type": "null" } ] }, "numberTyped": { "type": "boolean" }, "numberTypedReasonId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certNumber": { "type": "string", "minLength": 1, "maxLength": 40 }, "certKeyedByHand": { "type": "boolean" }, "typedCapacityCy": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9999 }, { "type": "null" } ] }, "siteId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "startedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "endedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -720, "maximum": 840 }, "startLatitude": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ] }, "startLongitude": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ] }, "endLatitude": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ] }, "endLongitude": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "addressSource": { "anyOf": [ { "type": "string", "enum": ["LOOKED_UP", "TYPED"] }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "formDebrisTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "fieldTagId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "roeNumber": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 40 }, { "type": "null" } ] }, "estimateCy": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 9999999.9, "multipleOf": 0.1 }, { "type": "null" } ] }, "loadCall": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "scaleReceiptId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "carriedCount": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9999 }, { "type": "null" } ] }, "kindOfWorkId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "payableTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "payItemId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "unitCount": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 99999999.99, "multipleOf": 0.01 }, { "type": "null" } ] }, "measurementInches": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 9999999.9, "multipleOf": 0.1 }, { "type": "null" } ] }, "measuredAs": { "anyOf": [ { "type": "string", "enum": ["CIRCUMFERENCE", "DIAMETER"] }, { "type": "null" } ] }, "rootBallInches": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 9999999.9, "multipleOf": 0.1 }, { "type": "null" } ] }, "rootBallHalfExposed": { "type": ["boolean", "null"] }, "surveyNumber": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 40 }, { "type": "null" } ] }, "markedIneligible": { "type": ["boolean", "null"] }, "items": { "readOnly": true, "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "itemNameId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "quantity": { "type": "number", "minimum": 0, "maximum": 99999999.99, "multipleOf": 0.01 } }, "required": ["itemNameId", "quantity"], "additionalProperties": false } }, "carriedTickets": { "readOnly": true, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 40 } }, "waypoints": { "readOnly": true, "maxItems": 200, "type": "array", "items": { "type": "object", "properties": { "markedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "latitude": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ] } }, "required": ["markedAt", "latitude", "longitude"], "additionalProperties": false } } }, "required": [ "id", "projectId", "workflow", "kind", "ticketNumber", "splitSuffix", "monitorId", "assignmentId", "setupVersion", "masterPasscodeSession", "numberTyped", "numberTypedReasonId", "certNumber", "certKeyedByHand", "typedCapacityCy", "siteId", "startedAt", "endedAt", "deviceUtcOffsetMinutes", "endLatitude", "endLongitude", "address", "addressSource", "notes", "formDebrisTypeId", "fieldTagId", "roeNumber", "estimateCy", "loadCall", "scaleReceiptId", "carriedCount", "kindOfWorkId", "payableTypeId", "payItemId", "unitCount", "measurementInches", "measuredAs", "rootBallInches", "rootBallHalfExposed", "surveyNumber", "markedIneligible", "items", "carriedTickets", "waypoints" ], "additionalProperties": false } }, "required": ["record", "fieldEvent"], "additionalProperties": false }, { "type": "object", "properties": { "record": { "type": "string", "const": "SCALE_RECEIPT" }, "scaleReceipt": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "receiptNumber": { "type": "string", "minLength": 1, "maxLength": 40 }, "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "grossWeightLb": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 9999999999.99, "multipleOf": 0.01 }, { "type": "null" } ] }, "tareWeightLb": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 9999999999.99, "multipleOf": 0.01 }, { "type": "null" } ] }, "netWeightLb": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 9999999999.99, "multipleOf": 0.01 }, { "type": "null" } ] }, "netWeightTons": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 99999999.9999, "multipleOf": 0.0001 }, { "type": "null" } ] }, "enteredById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "enteredAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -720, "maximum": 840 } }, "required": [ "id", "projectId", "receiptNumber", "siteId", "grossWeightLb", "tareWeightLb", "netWeightLb", "netWeightTons", "enteredById", "enteredAt", "deviceUtcOffsetMinutes" ], "additionalProperties": false } }, "required": ["record", "scaleReceipt"], "additionalProperties": false }, { "type": "object", "properties": { "record": { "type": "string", "const": "INCIDENT" }, "incident": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "monitorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "assignmentId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "setupVersion": { "type": "integer", "minimum": 1, "maximum": 2000000000 }, "madeAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -720, "maximum": 840 }, "latitude": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "formDefinitionId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "answers": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 100 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 4000 }, { "type": "number" }, { "type": "boolean" } ] } }, "incidentTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "incidentSubTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "parties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "contractorId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certNumber": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 40 }, { "type": "null" } ] }, "roeNumber": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 40 }, { "type": "null" } ] } }, "required": [ "id", "projectId", "monitorId", "assignmentId", "setupVersion", "madeAt", "deviceUtcOffsetMinutes", "latitude", "longitude", "notes", "incidentTypeId", "incidentSubTypeId", "description", "parties", "address", "contractorId", "certNumber", "roeNumber" ], "additionalProperties": false } }, "required": ["record", "incident"], "additionalProperties": false }, { "type": "object", "properties": { "record": { "type": "string", "const": "DROP_OFF_LOG" }, "dropOffLog": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "monitorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "assignmentId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "setupVersion": { "type": "integer", "minimum": 1, "maximum": 2000000000 }, "madeAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -720, "maximum": 840 }, "latitude": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "formDefinitionId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "answers": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 100 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 4000 }, { "type": "number" }, { "type": "boolean" } ] } }, "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "residentName": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "originAddress": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] } }, "required": [ "id", "projectId", "monitorId", "assignmentId", "setupVersion", "madeAt", "deviceUtcOffsetMinutes", "latitude", "longitude", "notes", "siteId", "residentName", "originAddress" ], "additionalProperties": false } }, "required": ["record", "dropOffLog"], "additionalProperties": false }, { "type": "object", "properties": { "record": { "type": "string", "const": "SURVEY" }, "survey": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "monitorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "assignmentId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "setupVersion": { "type": "integer", "minimum": 1, "maximum": 2000000000 }, "madeAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -720, "maximum": 840 }, "latitude": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "formDefinitionId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "answers": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 100 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 4000 }, { "type": "number" }, { "type": "boolean" } ] } }, "workTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "surveyNumber": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 40 }, { "type": "null" } ] }, "roeNumber": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 40 }, { "type": "null" } ] } }, "required": [ "id", "projectId", "monitorId", "assignmentId", "setupVersion", "madeAt", "deviceUtcOffsetMinutes", "latitude", "longitude", "notes", "workTypeId", "surveyNumber", "roeNumber" ], "additionalProperties": false } }, "required": ["record", "survey"], "additionalProperties": false }, { "type": "object", "properties": { "record": { "type": "string", "const": "ROE" }, "roe": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "roeNumber": { "type": "string", "minLength": 1, "maxLength": 40 }, "parcelId": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "ownerName": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "signed": { "type": "boolean" }, "signedDate": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ] }, "madeById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "assignmentId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "madeAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -720, "maximum": 840 }, "formDefinitionId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "answers": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 100 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 4000 }, { "type": "number" }, { "type": "boolean" } ] } } }, "required": [ "id", "projectId", "roeNumber", "parcelId", "address", "ownerName", "signed", "signedDate", "madeById", "assignmentId", "madeAt", "deviceUtcOffsetMinutes" ], "additionalProperties": false } }, "required": ["record", "roe"], "additionalProperties": false }, { "type": "object", "properties": { "record": { "type": "string", "const": "CERTIFICATION" }, "certification": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "certNumber": { "type": "string", "minLength": 1, "maxLength": 40, "pattern": "\\S" }, "kind": { "type": "string", "enum": ["CONTAINER", "CREW"] }, "primeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "firstTierSub": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "secondTierSub": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "vehicleTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "vehicleTypeOther": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "crewTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "boxes": { "readOnly": true, "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "featureId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "featureOther": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "shape": { "type": "string", "enum": [ "RECTANGLE", "TRIANGLE", "TWO_LENGTH_HOIST", "ROUND_BOTTOM", "RADIUS_CORNER" ] }, "sign": { "type": "string", "enum": ["ADD", "SUBTRACT"] }, "length": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 9999 }, { "type": "null" } ] }, "secondLength": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 9999 }, { "type": "null" } ] }, "width": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 9999 }, { "type": "null" } ] }, "height": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 9999 }, { "type": "null" } ] }, "diameter": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 9999 }, { "type": "null" } ] }, "radius": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 9999 }, { "type": "null" } ] }, "run": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 9999 }, { "type": "null" } ] }, "corners": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 99 }, { "type": "null" } ] } }, "required": [ "featureId", "featureOther", "shape", "sign", "length", "secondLength", "width", "height", "diameter", "radius", "run", "corners" ], "additionalProperties": false } }, "driverName": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "driverPhone": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "driverLicenceNumber": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "driverLicenceState": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "driverLicenceExpiry": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "tagNumber": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "tagState": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "tagExpiry": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "certifiedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -720, "maximum": 840 }, "certifiedById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "assignmentId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "helperIds": { "readOnly": true, "maxItems": 20, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "clientRepresentativeName": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "contractorRepresentativeName": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "replaces": { "anyOf": [ { "type": "object", "properties": { "replacedId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "reason": { "type": "string", "maxLength": 2000 } }, "required": ["replacedId", "reason"], "additionalProperties": false }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] } }, "required": [ "id", "projectId", "certNumber", "kind", "primeId", "firstTierSub", "secondTierSub", "vehicleTypeId", "vehicleTypeOther", "crewTypeId", "boxes", "driverName", "driverPhone", "driverLicenceNumber", "driverLicenceState", "driverLicenceExpiry", "tagNumber", "tagState", "tagExpiry", "certifiedAt", "deviceUtcOffsetMinutes", "certifiedById", "assignmentId", "helperIds", "clientRepresentativeName", "contractorRepresentativeName", "replaces", "notes" ], "additionalProperties": false } }, "required": ["record", "certification"], "additionalProperties": false }, { "type": "object", "properties": { "record": { "type": "string", "const": "CLOCK_ENTRY" }, "clockEntry": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "assignmentId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workerId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "kind": { "type": "string", "enum": ["IN", "BREAK_START", "BREAK_END", "OUT"] }, "at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -720, "maximum": 840 }, "activityLines": { "readOnly": true, "maxItems": 200, "type": "array", "items": { "type": "object", "properties": { "startedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "endedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "fieldEventId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "activityId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "note": { "anyOf": [ { "type": "string", "maxLength": 2000, "pattern": "\\S" }, { "type": "null" } ] } }, "required": [ "startedAt", "endedAt", "fieldEventId", "activityId", "note" ], "additionalProperties": false } } }, "required": [ "id", "projectId", "assignmentId", "workerId", "kind", "at", "deviceUtcOffsetMinutes", "activityLines" ], "additionalProperties": false } }, "required": ["record", "clockEntry"], "additionalProperties": false } ] }, { "type": "object", "properties": { "record": { "type": "string", "const": "PHOTO" }, "photo": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "owner": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "FIELD_EVENT", "SCALE_RECEIPT", "ROE", "SURVEY", "INCIDENT", "DROP_OFF_LOG", "CERTIFICATION" ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["kind", "id"], "additionalProperties": false }, "view": { "anyOf": [ { "type": "string", "enum": [ "OPERATOR_WITH_PLACARD", "INTERIOR_OR_BACK", "RIGHT", "LEFT", "FRONT" ] }, { "type": "null" } ] }, "stage": { "default": null, "anyOf": [ { "type": "string", "enum": ["PRE_WORK", "MEASUREMENT", "POST_WORK"] }, { "type": "null" } ] }, "takenById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "capturedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -720, "maximum": 840 }, "latitude": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ] }, "originalSha256": { "type": "string", "pattern": "^[0-9a-f]{64}$" }, "uploadedSha256": { "type": "string", "pattern": "^[0-9a-f]{64}$" }, "depthSha256": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{64}$" }, { "type": "null" } ] } }, "required": [ "id", "projectId", "owner", "view", "takenById", "capturedAt", "deviceUtcOffsetMinutes", "latitude", "longitude", "originalSha256", "uploadedSha256", "depthSha256" ], "additionalProperties": false } }, "required": ["record", "photo"], "additionalProperties": false } ] }, "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["record", "note"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "deviceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "syncId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "sentId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "sentMonitorId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "sentAs": { "anyOf": [ { "type": "string", "enum": [ "FIELD_EVENT", "SCALE_RECEIPT", "INCIDENT", "DROP_OFF_LOG", "SURVEY", "ROE", "CERTIFICATION", "CLOCK_ENTRY", "PHOTO", "REPORT" ] }, { "type": "null" } ] }, "sent": { "$ref": "#/$defs/__schema0" }, "reason": { "type": "string", "enum": [ "NOT_A_RECORD", "NAMES_NO_RECORD", "ASSIGNMENT_NOT_SAVED", "CERTIFICATION_REFUSED", "OWNER_NOT_SAVED", "PROJECT_CLOSED", "REPORT_NOT_SAVED" ] }, "message": { "type": "string" }, "receivedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "photos": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "resolvedById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "resolvedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "resolution": { "type": ["string", "null"] } }, "required": [ "id", "deviceId", "syncId", "sentId", "projectId", "sentMonitorId", "sentAs", "sent", "reason", "message", "receivedAt", "photos", "resolvedById", "resolvedAt", "resolution" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/$defs/__schema0" } } ] } } } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/held-records/{heldRecordId}/closings": { "post": { "operationId": "closeHeldRecord", "summary": "A held record is closed, never to be saved: nothing is made from it, and what was sent stays, with its photographs, marked with who closed it, when and why. Resolved once.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VOID", "parameters": [ { "name": "heldRecordId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["note"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "deviceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "syncId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "sentId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "projectId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "sentMonitorId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "sentAs": { "anyOf": [ { "type": "string", "enum": [ "FIELD_EVENT", "SCALE_RECEIPT", "INCIDENT", "DROP_OFF_LOG", "SURVEY", "ROE", "CERTIFICATION", "CLOCK_ENTRY", "PHOTO", "REPORT" ] }, { "type": "null" } ] }, "sent": { "$ref": "#/$defs/__schema0" }, "reason": { "type": "string", "enum": [ "NOT_A_RECORD", "NAMES_NO_RECORD", "ASSIGNMENT_NOT_SAVED", "CERTIFICATION_REFUSED", "OWNER_NOT_SAVED", "PROJECT_CLOSED", "REPORT_NOT_SAVED" ] }, "message": { "type": "string" }, "receivedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "photos": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "resolvedById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "resolvedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "resolution": { "type": ["string", "null"] } }, "required": [ "id", "deviceId", "syncId", "sentId", "projectId", "sentMonitorId", "sentAs", "sent", "reason", "message", "receivedAt", "photos", "resolvedById", "resolvedAt", "resolution" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/$defs/__schema0" } } ] } } } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/set-aside-files": { "get": { "operationId": "listSetAsideFiles", "summary": "The files a phone uploaded for a photograph that weren’t the file it fingerprinted, a page at a time, oldest first: by project or by phone, waiting or resolved. Each beside its photograph (what it belongs to, the fingerprint its phone gave and whether that file has been kept since), with what arrived and how it was resolved. Never where either is kept.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_REVIEW", "parameters": [ { "name": "projectId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "deviceId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "waiting", "in": "query", "required": false, "schema": { "type": "string", "enum": ["true", "false"] } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "setAsideFiles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "photoId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "file": { "type": "string", "enum": ["photo", "depth"] }, "deviceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "receivedSha256": { "type": "string", "pattern": "^[0-9a-f]{64}$" }, "byteCount": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "contentType": { "type": "string" }, "receivedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "photograph": { "type": "object", "properties": { "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "belongsTo": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "FIELD_EVENT", "SCALE_RECEIPT", "ROE", "SURVEY", "INCIDENT", "DROP_OFF_LOG", "CERTIFICATION", "QUARANTINED_RECORD", "HELD_RECORD" ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["kind", "id"], "additionalProperties": false }, "fingerprinted": { "type": "string", "pattern": "^[0-9a-f]{64}$" }, "kept": { "type": "boolean" } }, "required": ["projectId", "belongsTo", "fingerprinted", "kept"], "additionalProperties": false }, "resolvedById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "resolvedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "resolution": { "type": ["string", "null"] } }, "required": [ "id", "photoId", "file", "deviceId", "receivedSha256", "byteCount", "contentType", "receivedAt", "photograph", "resolvedById", "resolvedAt", "resolution" ], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["setAsideFiles", "next"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/set-aside-files/{setAsideFileId}/file": { "get": { "operationId": "setAsideFile", "summary": "A file set aside, as it was kept: the bytes that were stored, under the type their own first bytes said, sent as a download and never as a page.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_REVIEW", "parameters": [ { "name": "setAsideFileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "image/jpeg": { "schema": { "type": "string", "contentMediaType": "image/jpeg" } }, "image/heic": { "schema": { "type": "string", "contentMediaType": "image/heic" } }, "image/heif": { "schema": { "type": "string", "contentMediaType": "image/heif" } }, "image/png": { "schema": { "type": "string", "contentMediaType": "image/png" } }, "image/tiff": { "schema": { "type": "string", "contentMediaType": "image/tiff" } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/set-aside-files/{setAsideFileId}/closings": { "post": { "operationId": "closeSetAsideFile", "summary": "A file set aside is closed: the photograph’s own file won’t come, and this one stays beside it, kept, never the photograph’s. Marked with who closed it, when and why. Resolved once.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VOID", "parameters": [ { "name": "setAsideFileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["note"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "photoId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "file": { "type": "string", "enum": ["photo", "depth"] }, "deviceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "receivedSha256": { "type": "string", "pattern": "^[0-9a-f]{64}$" }, "byteCount": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "contentType": { "type": "string" }, "receivedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "photograph": { "type": "object", "properties": { "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "belongsTo": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "FIELD_EVENT", "SCALE_RECEIPT", "ROE", "SURVEY", "INCIDENT", "DROP_OFF_LOG", "CERTIFICATION", "QUARANTINED_RECORD", "HELD_RECORD" ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["kind", "id"], "additionalProperties": false }, "fingerprinted": { "type": "string", "pattern": "^[0-9a-f]{64}$" }, "kept": { "type": "boolean" } }, "required": ["projectId", "belongsTo", "fingerprinted", "kept"], "additionalProperties": false }, "resolvedById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "resolvedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "resolution": { "type": ["string", "null"] } }, "required": [ "id", "photoId", "file", "deviceId", "receivedSha256", "byteCount", "contentType", "receivedAt", "photograph", "resolvedById", "resolvedAt", "resolution" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/quarantined-records": { "get": { "operationId": "listQuarantinedRecords", "summary": "The records a phone sent whose number another record holds, a page at a time, oldest first: by project or by phone, waiting or resolved. Each with what the phone sent, its phone and monitor, why, the record that holds its number and how it was resolved.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_REVIEW", "parameters": [ { "name": "projectId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "deviceId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "waiting", "in": "query", "required": false, "schema": { "type": "string", "enum": ["true", "false"] } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "quarantinedRecords": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "deviceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "monitorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "sent": { "$ref": "#/$defs/__schema0" }, "reason": { "type": "string", "enum": ["DUPLICATE_FIELD_EVENT", "DUPLICATE_ROE_NUMBER"] }, "holder": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "FIELD_EVENT" }, "fieldEvent": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workflow": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] }, "ticketNumber": { "type": "string" }, "kind": { "type": "string", "enum": [ "COLLECTION", "DISPOSAL", "HAUL_OUT_COLLECTION", "HAUL_OUT_DISPOSAL", "UNIT_RATE" ] }, "splitSuffix": { "type": "string" }, "source": { "type": "string", "enum": ["DEVICE", "BACK_OFFICE"] }, "masterPasscodeSession": { "anyOf": [ { "type": "string", "enum": ["AS_MONITOR", "TEMPORARY"] }, { "type": "null" } ] }, "createdById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "createdReasonId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "monitorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "startedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "endedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "start": { "anyOf": [ { "type": "object", "properties": { "latitude": { "type": "string" }, "longitude": { "type": "string" } }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "end": { "anyOf": [ { "type": "object", "properties": { "latitude": { "type": "string" }, "longitude": { "type": "string" } }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "address": { "type": ["string", "null"] }, "addressSource": { "anyOf": [ { "type": "string", "enum": ["LOOKED_UP", "TYPED"] }, { "type": "null" } ] }, "notes": { "type": ["string", "null"] }, "certNumber": { "type": "string" }, "certificationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certKeyedByHand": { "type": "boolean" }, "typedCapacityCy": { "type": ["number", "null"] }, "numberTyped": { "type": "boolean" }, "numberTypedReasonId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "siteId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "formDebrisTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "fieldTagId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "roeNumber": { "type": ["string", "null"] }, "roeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "estimateCy": { "type": ["number", "null"] }, "loadCall": { "type": ["number", "null"] }, "scaleReceiptId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "carriedCount": { "type": ["number", "null"] }, "kindOfWorkId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "payableTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "payItemId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "unitCount": { "type": ["number", "null"] }, "measurementInches": { "type": ["number", "null"] }, "measuredAs": { "anyOf": [ { "type": "string", "enum": ["CIRCUMFERENCE", "DIAMETER"] }, { "type": "null" } ] }, "rootBallInches": { "type": ["number", "null"] }, "rootBallHalfExposed": { "type": ["boolean", "null"] }, "surveyNumber": { "type": ["string", "null"] }, "markedIneligible": { "type": ["boolean", "null"] } }, "required": [ "id", "projectId", "workflow", "ticketNumber", "kind", "splitSuffix", "source", "masterPasscodeSession", "createdById", "createdReasonId", "monitorId", "startedAt", "endedAt", "deviceUtcOffsetMinutes", "start", "end", "address", "addressSource", "notes", "certNumber", "certificationId", "certKeyedByHand", "typedCapacityCy", "numberTyped", "numberTypedReasonId", "siteId", "formDebrisTypeId", "fieldTagId", "roeNumber", "roeId", "estimateCy", "loadCall", "scaleReceiptId", "carriedCount", "kindOfWorkId", "payableTypeId", "payItemId", "unitCount", "measurementInches", "measuredAs", "rootBallInches", "rootBallHalfExposed", "surveyNumber", "markedIneligible" ], "additionalProperties": false } }, "required": ["kind", "fieldEvent"], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "ROE" }, "roe": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "roeNumber": { "type": "string" }, "parcelId": { "type": ["string", "null"] }, "address": { "type": ["string", "null"] }, "ownerName": { "type": ["string", "null"] }, "signed": { "type": "boolean" }, "signedDate": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "fix": { "anyOf": [ { "type": "object", "properties": { "latitude": { "type": "string" }, "longitude": { "type": "string" } }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "source": { "type": "string", "enum": ["DEVICE", "BACK_OFFICE"] }, "madeById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "madeAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "notes": { "type": ["string", "null"] }, "answers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": ["string", "number", "boolean"] } }, "formDefinitionId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": [ "id", "projectId", "roeNumber", "parcelId", "address", "ownerName", "signed", "signedDate", "fix", "source", "madeById", "madeAt", "notes", "answers", "formDefinitionId" ], "additionalProperties": false } }, "required": ["kind", "roe"], "additionalProperties": false } ] }, "receivedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "resolvedById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "resolvedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "resolution": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "deviceId", "monitorId", "sent", "reason", "holder", "receivedAt", "resolvedById", "resolvedAt", "resolution" ], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["quarantinedRecords", "next"], "additionalProperties": false, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/$defs/__schema0" } } ] } } } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/field-events": { "post": { "operationId": "createFieldEvent", "summary": "A field event is created in the back office because a phone failed: its kind and number, the monitor whose work it was, when and where, the cert number and what its kind records, with a reason picked from the firm’s list. A detail left out is empty. It is a field event like any other: its ticket is queued, pairs by its number and is flagged as created in the back office. Refused for a number another field event of its kind holds, a fix that can’t be one, a reason the firm doesn’t offer for this, a detail its kind doesn’t record and a ticket locked as invoiced.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "CORRECT", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "monitorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "startedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "endedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -720, "maximum": 840 }, "start": { "anyOf": [ { "type": "object", "properties": { "latitude": { "type": "string", "pattern": "^-?\\d{1,3}(\\.\\d{1,8})?$" }, "longitude": { "type": "string", "pattern": "^-?\\d{1,3}(\\.\\d{1,8})?$" } }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "end": { "anyOf": [ { "type": "object", "properties": { "latitude": { "type": "string", "pattern": "^-?\\d{1,3}(\\.\\d{1,8})?$" }, "longitude": { "type": "string", "pattern": "^-?\\d{1,3}(\\.\\d{1,8})?$" } }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2000 }, { "type": "null" } ] }, "addressSource": { "anyOf": [ { "type": "string", "enum": ["LOOKED_UP", "TYPED"] }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2000 }, { "type": "null" } ] }, "certNumber": { "type": "string", "minLength": 1, "maxLength": 40 }, "siteId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "formDebrisTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "fieldTagId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "roeNumber": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 40 }, { "type": "null" } ] }, "estimateCy": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 9999999.9, "multipleOf": 0.1 }, { "type": "null" } ] }, "loadCall": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "scaleReceiptId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "carriedCount": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9999 }, { "type": "null" } ] }, "kindOfWorkId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "payableTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "payItemId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "unitCount": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 99999999.99, "multipleOf": 0.01 }, { "type": "null" } ] }, "measurementInches": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 9999999.9, "multipleOf": 0.1 }, { "type": "null" } ] }, "measuredAs": { "anyOf": [ { "type": "string", "enum": ["CIRCUMFERENCE", "DIAMETER"] }, { "type": "null" } ] }, "rootBallInches": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 9999999.9, "multipleOf": 0.1 }, { "type": "null" } ] }, "rootBallHalfExposed": { "type": ["boolean", "null"] }, "surveyNumber": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 40 }, { "type": "null" } ] }, "markedIneligible": { "type": ["boolean", "null"] }, "workflow": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] }, "kind": { "type": "string", "enum": [ "COLLECTION", "DISPOSAL", "HAUL_OUT_COLLECTION", "HAUL_OUT_DISPOSAL", "UNIT_RATE" ] }, "ticketNumber": { "type": "string", "minLength": 1, "maxLength": 40 }, "splitSuffix": { "type": "string", "maxLength": 4 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "itemNameId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "quantity": { "type": "number", "minimum": 0, "maximum": 99999999.99, "multipleOf": 0.01 } }, "required": ["itemNameId", "quantity"], "additionalProperties": false } }, "carriedTickets": { "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 40 } }, "reasonId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "monitorId", "startedAt", "endedAt", "deviceUtcOffsetMinutes", "certNumber", "workflow", "kind", "ticketNumber", "reasonId" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workflow": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] }, "ticketNumber": { "type": "string" }, "kind": { "type": "string", "enum": [ "COLLECTION", "DISPOSAL", "HAUL_OUT_COLLECTION", "HAUL_OUT_DISPOSAL", "UNIT_RATE" ] }, "splitSuffix": { "type": "string" }, "source": { "type": "string", "enum": ["DEVICE", "BACK_OFFICE"] }, "masterPasscodeSession": { "anyOf": [ { "type": "string", "enum": ["AS_MONITOR", "TEMPORARY"] }, { "type": "null" } ] }, "createdById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "createdReasonId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "monitorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "startedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "endedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "start": { "anyOf": [ { "type": "object", "properties": { "latitude": { "type": "string" }, "longitude": { "type": "string" } }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "end": { "anyOf": [ { "type": "object", "properties": { "latitude": { "type": "string" }, "longitude": { "type": "string" } }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "address": { "type": ["string", "null"] }, "addressSource": { "anyOf": [ { "type": "string", "enum": ["LOOKED_UP", "TYPED"] }, { "type": "null" } ] }, "notes": { "type": ["string", "null"] }, "certNumber": { "type": "string" }, "certificationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certKeyedByHand": { "type": "boolean" }, "typedCapacityCy": { "type": ["number", "null"] }, "numberTyped": { "type": "boolean" }, "numberTypedReasonId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "siteId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "formDebrisTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "fieldTagId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "roeNumber": { "type": ["string", "null"] }, "roeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "estimateCy": { "type": ["number", "null"] }, "loadCall": { "type": ["number", "null"] }, "scaleReceiptId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "carriedCount": { "type": ["number", "null"] }, "kindOfWorkId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "payableTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "payItemId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "unitCount": { "type": ["number", "null"] }, "measurementInches": { "type": ["number", "null"] }, "measuredAs": { "anyOf": [ { "type": "string", "enum": ["CIRCUMFERENCE", "DIAMETER"] }, { "type": "null" } ] }, "rootBallInches": { "type": ["number", "null"] }, "rootBallHalfExposed": { "type": ["boolean", "null"] }, "surveyNumber": { "type": ["string", "null"] }, "markedIneligible": { "type": ["boolean", "null"] } }, "required": [ "id", "projectId", "workflow", "ticketNumber", "kind", "splitSuffix", "source", "masterPasscodeSession", "createdById", "createdReasonId", "monitorId", "startedAt", "endedAt", "deviceUtcOffsetMinutes", "start", "end", "address", "addressSource", "notes", "certNumber", "certificationId", "certKeyedByHand", "typedCapacityCy", "numberTyped", "numberTypedReasonId", "siteId", "formDebrisTypeId", "fieldTagId", "roeNumber", "roeId", "estimateCy", "loadCall", "scaleReceiptId", "carriedCount", "kindOfWorkId", "payableTypeId", "payItemId", "unitCount", "measurementInches", "measuredAs", "rootBallInches", "rootBallHalfExposed", "surveyNumber", "markedIneligible" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/roes": { "get": { "operationId": "listRoes", "summary": "A project’s ROEs, a page at a time, in the order they were made: each with its scope, its photographs’ records and its QC mark.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_REVIEW", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "roes": { "type": "array", "items": { "type": "object", "properties": { "roe": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "roeNumber": { "type": "string" }, "parcelId": { "type": ["string", "null"] }, "address": { "type": ["string", "null"] }, "ownerName": { "type": ["string", "null"] }, "signed": { "type": "boolean" }, "signedDate": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "fix": { "anyOf": [ { "type": "object", "properties": { "latitude": { "type": "string" }, "longitude": { "type": "string" } }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "source": { "type": "string", "enum": ["DEVICE", "BACK_OFFICE"] }, "madeById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "madeAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "notes": { "type": ["string", "null"] }, "answers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": ["string", "number", "boolean"] } }, "formDefinitionId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": [ "id", "projectId", "roeNumber", "parcelId", "address", "ownerName", "signed", "signedDate", "fix", "source", "madeById", "madeAt", "notes", "answers", "formDefinitionId" ], "additionalProperties": false }, "scope": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "roeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "formDebrisTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "payableTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "count": { "type": ["number", "null"] }, "takenOffAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "id", "projectId", "roeId", "formDebrisTypeId", "payableTypeId", "count", "takenOffAt" ], "additionalProperties": false } }, "photographs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fieldEventId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certificationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "scaleReceiptId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "roeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "surveyId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "incidentId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "dropOffLogId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "view": { "anyOf": [ { "type": "string", "enum": [ "OPERATOR_WITH_PLACARD", "INTERIOR_OR_BACK", "RIGHT", "LEFT", "FRONT" ] }, { "type": "null" } ] }, "stage": { "anyOf": [ { "type": "string", "enum": ["PRE_WORK", "MEASUREMENT", "POST_WORK"] }, { "type": "null" } ] }, "capturedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "uploadedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "removedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "label": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "fieldEventId", "certificationId", "scaleReceiptId", "roeId", "surveyId", "incidentId", "dropOffLogId", "view", "stage", "capturedAt", "uploadedAt", "removedAt", "label" ], "additionalProperties": false } }, "qcMark": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "completedLoadId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "completedHaulOutId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "unitRateTicketId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certificationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "roeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "surveyId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "incidentId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "dropOffLogId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "status": { "type": "string", "enum": ["QC_REVIEW", "QC_APPROVED", "QC_ISSUES", "QC_VOID"] }, "setById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "setAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "note": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "completedLoadId", "completedHaulOutId", "unitRateTicketId", "certificationId", "roeId", "surveyId", "incidentId", "dropOffLogId", "status", "setById", "setAt", "note" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": ["roe", "scope", "photographs", "qcMark"], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["roes", "next"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } }, "post": { "operationId": "createRoe", "summary": "An ROE made on paper is entered in the back office: its number off the paper, parcel, address, owner, whether and when it was signed, where, its notes and the answers to its form’s own fields; it names the person who entered it. What was already waiting for its number points at it, and those tickets are queued. Refused for a number another ROE of the project holds, a fix that can’t be one and answers that don’t fit their version.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "CORRECT", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "roeNumber": { "type": "string", "minLength": 1, "maxLength": 40 }, "parcelId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 40 }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2000 }, { "type": "null" } ] }, "ownerName": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "signed": { "type": "boolean" }, "signedDate": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "fix": { "anyOf": [ { "type": "object", "properties": { "latitude": { "type": "string", "pattern": "^-?\\d{1,3}(\\.\\d{1,8})?$" }, "longitude": { "type": "string", "pattern": "^-?\\d{1,3}(\\.\\d{1,8})?$" } }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "madeAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2000 }, { "type": "null" } ] }, "answers": { "type": "object", "properties": { "answers": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 100 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number", "minimum": -9999999999.99, "maximum": 9999999999.99 }, { "type": "boolean" } ] } }, "formDefinitionId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["answers"], "additionalProperties": false } }, "required": [ "roeNumber", "parcelId", "address", "ownerName", "signed", "signedDate", "fix", "madeAt", "notes", "answers" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "roeNumber": { "type": "string" }, "parcelId": { "type": ["string", "null"] }, "address": { "type": ["string", "null"] }, "ownerName": { "type": ["string", "null"] }, "signed": { "type": "boolean" }, "signedDate": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "fix": { "anyOf": [ { "type": "object", "properties": { "latitude": { "type": "string" }, "longitude": { "type": "string" } }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "source": { "type": "string", "enum": ["DEVICE", "BACK_OFFICE"] }, "madeById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "madeAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "notes": { "type": ["string", "null"] }, "answers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": ["string", "number", "boolean"] } }, "formDefinitionId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": [ "id", "projectId", "roeNumber", "parcelId", "address", "ownerName", "signed", "signedDate", "fix", "source", "madeById", "madeAt", "notes", "answers", "formDefinitionId" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/surveys": { "get": { "operationId": "listSurveys", "summary": "A project’s surveys, a page at a time, in the order they were made: each with its own flags, its photographs’ records and its QC mark.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_REVIEW", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "surveys": { "type": "array", "items": { "type": "object", "properties": { "survey": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "source": { "type": "string", "enum": ["DEVICE", "BACK_OFFICE"] }, "createdById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "createdReasonId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "monitorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "madeAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "fix": { "anyOf": [ { "type": "object", "properties": { "latitude": { "type": "string" }, "longitude": { "type": "string" } }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "notes": { "type": ["string", "null"] }, "answers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": ["string", "number", "boolean"] } }, "formDefinitionId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "workTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "surveyNumber": { "type": ["string", "null"] }, "roeNumber": { "type": ["string", "null"] }, "roeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": [ "id", "projectId", "source", "createdById", "createdReasonId", "monitorId", "madeAt", "deviceUtcOffsetMinutes", "fix", "notes", "answers", "formDefinitionId", "workTypeId", "surveyNumber", "roeNumber", "roeId" ], "additionalProperties": false }, "flags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workflow": { "anyOf": [ { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] }, { "type": "null" } ] }, "ticketNumber": { "type": ["string", "null"] }, "fieldEventId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certificationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "disposalSiteId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "surveyId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "code": { "type": "string", "enum": [ "DEBRIS_TYPE_MISMATCH", "CERT_NUMBER_MISMATCH", "DISPOSAL_BEFORE_COLLECTION_ENDED", "OVERLAPPING_LOADS", "SPLIT_SUFFIX_GAP", "CARRIED_COUNT_MISMATCH", "NO_CERTIFICATION", "TYPED_CAPACITY_DIFFERS", "TAG_EXPIRED", "CERTIFICATION_REVOKED", "CERTIFICATION_REPLACED", "OUTSIDE_PROJECT_BOUNDARY", "NO_ZONE", "OUTSIDE_SITE_AREA", "PROJECT_NOT_ACTIVE", "SITE_NOT_YET_ACTIVE", "SITE_CLOSED", "NO_ROAD_ROUTE", "DEVICE_CLOCK_OFF", "WORK_TIME_AFTER_RECEIVED", "WORK_TIME_BEFORE_ENROLMENT", "DEVICE_TIME_ZONE_DIFFERS", "PHONE_OUT_OF_SERVICE", "TYPED_TICKET_NUMBER", "BACK_OFFICE_RECORD", "SITE_DOES_NOT_TAKE_LOADS", "SITE_NOT_FOR_HAUL_OUTS", "INELIGIBLE_SITE", "TIPPING_FEE_RULE_MISSING", "HAUL_OUT_DUMPED_AT_TDSR", "LOAD_CALL_ZERO", "LOAD_CALL_LOW", "LOAD_CALL_HIGH", "PILE_CALL_NOT_HIGHER", "QUANTITY_MISSING_FOR_PAY_ITEM", "SHARED_SCALE_WEIGHT", "RECEIPT_TWO_DEBRIS_TYPES", "SCALE_WEIGHT_UNUSABLE", "CARRIED_TICKET_NOT_FOUND", "CARRIED_TICKET_ON_ANOTHER_LOAD", "MEASUREMENT_MISSING", "GPS_MISSING", "PHOTOS_MISSING", "DECIMAL_COUNT", "NO_SIZE_BAND", "OUTSIDE_SIZE_BAND", "MARKED_INELIGIBLE", "STUMP_UNDER_24", "ROOT_BALL_NOT_WIDER", "FILL_WITHOUT_EXPOSED_ROOT_BALL", "ROOT_BALL_MISSING", "NO_SURVEY", "CREW_ITEM_OVER_12_HOURS", "CREW_TIME_OVERLAP", "ROE_MISSING", "ROE_NOT_ON_PROJECT", "ROE_UNSIGNED", "ROE_OUT_OF_SCOPE", "NO_PRE_WORK_SURVEY", "CERTIFICATION_PHOTO_MISSING", "PERMIT_OUTSTANDING", "NO_PRICING_RULE", "DUPLICATE_TRANSACTION_NUMBER", "NO_RATE_FOR_PRIME", "RATE_TO_BE_NEGOTIATED", "NOT_PROCESSED", "DETAIL_MISSING", "TYPED_NUMBER_NO_REASON", "WRONG_KIND_OF_BADGE", "GPS_UNREADABLE", "NOT_A_TICKET_NUMBER", "ENDED_BEFORE_STARTED", "SPLIT_NOT_ALLOWED", "OUTSIDE_CONTROL_RANGES", "ASSIGNMENT_ON_ANOTHER_PROJECT", "SCALE_NET_DISAGREES", "TWO_QUANTITIES", "NOT_PROCESSED_LINES_STAND", "SUB_NAME_ALIKE", "MONITOR_NOT_SIGNED_IN", "ASSIGNMENT_OF_ANOTHER_PERSON" ] }, "message": { "type": "string" }, "billing": { "type": "string", "enum": ["BILLS", "LINE_NOT_BILLED", "NOT_BILLED"] }, "slot": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "payItemId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "raisedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "clearedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "acceptances": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "flagId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "reasonId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "note": { "type": ["string", "null"] }, "acceptedById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "acceptedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "withdrawnById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "withdrawnAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "withdrawNote": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "flagId", "reasonId", "note", "acceptedById", "acceptedAt", "withdrawnById", "withdrawnAt", "withdrawNote" ], "additionalProperties": false } } }, "required": [ "id", "projectId", "workflow", "ticketNumber", "fieldEventId", "certificationId", "disposalSiteId", "surveyId", "code", "message", "billing", "slot", "payItemId", "raisedAt", "clearedAt", "acceptances" ], "additionalProperties": false } }, "photographs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fieldEventId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certificationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "scaleReceiptId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "roeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "surveyId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "incidentId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "dropOffLogId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "view": { "anyOf": [ { "type": "string", "enum": [ "OPERATOR_WITH_PLACARD", "INTERIOR_OR_BACK", "RIGHT", "LEFT", "FRONT" ] }, { "type": "null" } ] }, "stage": { "anyOf": [ { "type": "string", "enum": ["PRE_WORK", "MEASUREMENT", "POST_WORK"] }, { "type": "null" } ] }, "capturedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "uploadedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "removedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "label": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "fieldEventId", "certificationId", "scaleReceiptId", "roeId", "surveyId", "incidentId", "dropOffLogId", "view", "stage", "capturedAt", "uploadedAt", "removedAt", "label" ], "additionalProperties": false } }, "qcMark": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "completedLoadId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "completedHaulOutId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "unitRateTicketId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certificationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "roeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "surveyId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "incidentId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "dropOffLogId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "status": { "type": "string", "enum": ["QC_REVIEW", "QC_APPROVED", "QC_ISSUES", "QC_VOID"] }, "setById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "setAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "note": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "completedLoadId", "completedHaulOutId", "unitRateTicketId", "certificationId", "roeId", "surveyId", "incidentId", "dropOffLogId", "status", "setById", "setAt", "note" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": ["survey", "flags", "photographs", "qcMark"], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["surveys", "next"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } }, "post": { "operationId": "createSurvey", "summary": "A survey made on paper is entered in the back office: the monitor whose work it was, when and where, its work type, survey number, the ROE number it names (which finds its ROE), notes and the answers to its form’s own fields, with a reason picked from the firm’s list. The project’s surveys are checked on the next run. Refused for a reason the firm doesn’t offer for this, a fix that can’t be one and answers that don’t fit their version.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "CORRECT", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "monitorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "madeAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -720, "maximum": 840 }, "fix": { "anyOf": [ { "type": "object", "properties": { "latitude": { "type": "string", "pattern": "^-?\\d{1,3}(\\.\\d{1,8})?$" }, "longitude": { "type": "string", "pattern": "^-?\\d{1,3}(\\.\\d{1,8})?$" } }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2000 }, { "type": "null" } ] }, "answers": { "type": "object", "properties": { "answers": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 100 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number", "minimum": -9999999999.99, "maximum": 9999999999.99 }, { "type": "boolean" } ] } }, "formDefinitionId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["answers"], "additionalProperties": false }, "reasonId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "surveyNumber": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 40 }, { "type": "null" } ] }, "roeNumber": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 40 }, { "type": "null" } ] } }, "required": [ "monitorId", "madeAt", "deviceUtcOffsetMinutes", "fix", "notes", "answers", "reasonId", "workTypeId", "surveyNumber", "roeNumber" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "source": { "type": "string", "enum": ["DEVICE", "BACK_OFFICE"] }, "createdById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "createdReasonId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "monitorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "madeAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "fix": { "anyOf": [ { "type": "object", "properties": { "latitude": { "type": "string" }, "longitude": { "type": "string" } }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "notes": { "type": ["string", "null"] }, "answers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": ["string", "number", "boolean"] } }, "formDefinitionId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "workTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "surveyNumber": { "type": ["string", "null"] }, "roeNumber": { "type": ["string", "null"] }, "roeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": [ "id", "projectId", "source", "createdById", "createdReasonId", "monitorId", "madeAt", "deviceUtcOffsetMinutes", "fix", "notes", "answers", "formDefinitionId", "workTypeId", "surveyNumber", "roeNumber", "roeId" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/incidents": { "get": { "operationId": "listIncidents", "summary": "A project’s incidents, a page at a time, in the order they were made: each with its photographs’ records and its QC mark.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_REVIEW", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "incidents": { "type": "array", "items": { "type": "object", "properties": { "incident": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "source": { "type": "string", "enum": ["DEVICE", "BACK_OFFICE"] }, "createdById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "createdReasonId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "monitorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "madeAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "fix": { "anyOf": [ { "type": "object", "properties": { "latitude": { "type": "string" }, "longitude": { "type": "string" } }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "notes": { "type": ["string", "null"] }, "answers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": ["string", "number", "boolean"] } }, "formDefinitionId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "incidentTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "incidentSubTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "description": { "type": ["string", "null"] }, "parties": { "type": ["string", "null"] }, "address": { "type": ["string", "null"] }, "contractorId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certNumber": { "type": ["string", "null"] }, "certificationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "roeNumber": { "type": ["string", "null"] }, "roeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": [ "id", "projectId", "source", "createdById", "createdReasonId", "monitorId", "madeAt", "deviceUtcOffsetMinutes", "fix", "notes", "answers", "formDefinitionId", "incidentTypeId", "incidentSubTypeId", "description", "parties", "address", "contractorId", "certNumber", "certificationId", "roeNumber", "roeId" ], "additionalProperties": false }, "photographs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fieldEventId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certificationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "scaleReceiptId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "roeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "surveyId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "incidentId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "dropOffLogId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "view": { "anyOf": [ { "type": "string", "enum": [ "OPERATOR_WITH_PLACARD", "INTERIOR_OR_BACK", "RIGHT", "LEFT", "FRONT" ] }, { "type": "null" } ] }, "stage": { "anyOf": [ { "type": "string", "enum": ["PRE_WORK", "MEASUREMENT", "POST_WORK"] }, { "type": "null" } ] }, "capturedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "uploadedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "removedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "label": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "fieldEventId", "certificationId", "scaleReceiptId", "roeId", "surveyId", "incidentId", "dropOffLogId", "view", "stage", "capturedAt", "uploadedAt", "removedAt", "label" ], "additionalProperties": false } }, "qcMark": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "completedLoadId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "completedHaulOutId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "unitRateTicketId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certificationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "roeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "surveyId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "incidentId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "dropOffLogId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "status": { "type": "string", "enum": ["QC_REVIEW", "QC_APPROVED", "QC_ISSUES", "QC_VOID"] }, "setById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "setAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "note": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "completedLoadId", "completedHaulOutId", "unitRateTicketId", "certificationId", "roeId", "surveyId", "incidentId", "dropOffLogId", "status", "setById", "setAt", "note" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": ["incident", "photographs", "qcMark"], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["incidents", "next"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } }, "post": { "operationId": "createIncident", "summary": "An incident written on paper is entered in the back office: the monitor whose record it was, when and where, its type and sub-type, what happened, who was involved, the address, the contractor, cert number and ROE number it names (each finds its record), notes and the answers to its form’s own fields, with a reason picked from the firm’s list. It is on no ticket, so nothing is queued. Refused for a reason the firm doesn’t offer for this, a fix that can’t be one and answers that don’t fit their version.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "CORRECT", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "monitorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "madeAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -720, "maximum": 840 }, "fix": { "anyOf": [ { "type": "object", "properties": { "latitude": { "type": "string", "pattern": "^-?\\d{1,3}(\\.\\d{1,8})?$" }, "longitude": { "type": "string", "pattern": "^-?\\d{1,3}(\\.\\d{1,8})?$" } }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2000 }, { "type": "null" } ] }, "answers": { "type": "object", "properties": { "answers": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 100 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number", "minimum": -9999999999.99, "maximum": 9999999999.99 }, { "type": "boolean" } ] } }, "formDefinitionId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["answers"], "additionalProperties": false }, "reasonId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "incidentTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "incidentSubTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2000 }, { "type": "null" } ] }, "parties": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2000 }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2000 }, { "type": "null" } ] }, "contractorId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certNumber": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 40 }, { "type": "null" } ] }, "roeNumber": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 40 }, { "type": "null" } ] } }, "required": [ "monitorId", "madeAt", "deviceUtcOffsetMinutes", "fix", "notes", "answers", "reasonId", "incidentTypeId", "incidentSubTypeId", "description", "parties", "address", "contractorId", "certNumber", "roeNumber" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "source": { "type": "string", "enum": ["DEVICE", "BACK_OFFICE"] }, "createdById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "createdReasonId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "monitorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "madeAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "fix": { "anyOf": [ { "type": "object", "properties": { "latitude": { "type": "string" }, "longitude": { "type": "string" } }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "notes": { "type": ["string", "null"] }, "answers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": ["string", "number", "boolean"] } }, "formDefinitionId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "incidentTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "incidentSubTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "description": { "type": ["string", "null"] }, "parties": { "type": ["string", "null"] }, "address": { "type": ["string", "null"] }, "contractorId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certNumber": { "type": ["string", "null"] }, "certificationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "roeNumber": { "type": ["string", "null"] }, "roeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": [ "id", "projectId", "source", "createdById", "createdReasonId", "monitorId", "madeAt", "deviceUtcOffsetMinutes", "fix", "notes", "answers", "formDefinitionId", "incidentTypeId", "incidentSubTypeId", "description", "parties", "address", "contractorId", "certNumber", "certificationId", "roeNumber", "roeId" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/drop-off-logs": { "get": { "operationId": "listDropOffLogs", "summary": "A project’s citizen drop-off logs, a page at a time, in the order they were made: each with its photographs’ records and its QC mark.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_REVIEW", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "dropOffLogs": { "type": "array", "items": { "type": "object", "properties": { "dropOffLog": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "source": { "type": "string", "enum": ["DEVICE", "BACK_OFFICE"] }, "createdById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "createdReasonId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "monitorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "madeAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "fix": { "anyOf": [ { "type": "object", "properties": { "latitude": { "type": "string" }, "longitude": { "type": "string" } }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "notes": { "type": ["string", "null"] }, "answers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": ["string", "number", "boolean"] } }, "formDefinitionId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "residentName": { "type": ["string", "null"] }, "originAddress": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "source", "createdById", "createdReasonId", "monitorId", "madeAt", "deviceUtcOffsetMinutes", "fix", "notes", "answers", "formDefinitionId", "siteId", "residentName", "originAddress" ], "additionalProperties": false }, "photographs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fieldEventId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certificationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "scaleReceiptId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "roeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "surveyId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "incidentId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "dropOffLogId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "view": { "anyOf": [ { "type": "string", "enum": [ "OPERATOR_WITH_PLACARD", "INTERIOR_OR_BACK", "RIGHT", "LEFT", "FRONT" ] }, { "type": "null" } ] }, "stage": { "anyOf": [ { "type": "string", "enum": ["PRE_WORK", "MEASUREMENT", "POST_WORK"] }, { "type": "null" } ] }, "capturedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "uploadedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "removedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "label": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "fieldEventId", "certificationId", "scaleReceiptId", "roeId", "surveyId", "incidentId", "dropOffLogId", "view", "stage", "capturedAt", "uploadedAt", "removedAt", "label" ], "additionalProperties": false } }, "qcMark": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "completedLoadId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "completedHaulOutId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "unitRateTicketId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certificationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "roeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "surveyId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "incidentId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "dropOffLogId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "status": { "type": "string", "enum": ["QC_REVIEW", "QC_APPROVED", "QC_ISSUES", "QC_VOID"] }, "setById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "setAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "note": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "completedLoadId", "completedHaulOutId", "unitRateTicketId", "certificationId", "roeId", "surveyId", "incidentId", "dropOffLogId", "status", "setById", "setAt", "note" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": ["dropOffLog", "photographs", "qcMark"], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["dropOffLogs", "next"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } }, "post": { "operationId": "createDropOffLog", "summary": "A citizen drop-off log kept on paper is entered in the back office: the monitor whose log it was, when and where, the site, the resident’s name and where the debris came from, notes and the answers to its form’s own fields, with a reason picked from the firm’s list. It is on no ticket, so nothing is queued. Refused for a site of another project, a reason the firm doesn’t offer for this, a fix that can’t be one and answers that don’t fit their version.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "CORRECT", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "monitorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "madeAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -720, "maximum": 840 }, "fix": { "anyOf": [ { "type": "object", "properties": { "latitude": { "type": "string", "pattern": "^-?\\d{1,3}(\\.\\d{1,8})?$" }, "longitude": { "type": "string", "pattern": "^-?\\d{1,3}(\\.\\d{1,8})?$" } }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2000 }, { "type": "null" } ] }, "answers": { "type": "object", "properties": { "answers": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 100 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "number", "minimum": -9999999999.99, "maximum": 9999999999.99 }, { "type": "boolean" } ] } }, "formDefinitionId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["answers"], "additionalProperties": false }, "reasonId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "residentName": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "originAddress": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2000 }, { "type": "null" } ] } }, "required": [ "monitorId", "madeAt", "deviceUtcOffsetMinutes", "fix", "notes", "answers", "reasonId", "siteId", "residentName", "originAddress" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "source": { "type": "string", "enum": ["DEVICE", "BACK_OFFICE"] }, "createdById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "createdReasonId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "monitorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "madeAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "fix": { "anyOf": [ { "type": "object", "properties": { "latitude": { "type": "string" }, "longitude": { "type": "string" } }, "required": ["latitude", "longitude"], "additionalProperties": false }, { "type": "null" } ] }, "notes": { "type": ["string", "null"] }, "answers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": ["string", "number", "boolean"] } }, "formDefinitionId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "residentName": { "type": ["string", "null"] }, "originAddress": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "source", "createdById", "createdReasonId", "monitorId", "madeAt", "deviceUtcOffsetMinutes", "fix", "notes", "answers", "formDefinitionId", "siteId", "residentName", "originAddress" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/projects/{projectId}/certifications": { "get": { "operationId": "listCertifications", "summary": "A project’s certifications, a page at a time, by cert number as written: each whole, with its boxes, helpers, photographs’ records, QC mark and its own flags, where it came from (its phone, or the paper sheet with who entered it and why) and any revocation.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_REVIEW", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "certNumber", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 40 } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "certifications": { "type": "array", "items": { "type": "object", "properties": { "certification": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "certNumber": { "type": "string" }, "kind": { "type": "string", "enum": ["CONTAINER", "CREW"] }, "primeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "firstTierSubId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "secondTierSubId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "capacityCy": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "vehicleTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "vehicleTypeOther": { "type": ["string", "null"] }, "crewTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "driverName": { "type": ["string", "null"] }, "driverLicenceState": { "type": ["string", "null"] }, "driverLicenceExpiry": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "tagNumber": { "type": ["string", "null"] }, "tagState": { "type": ["string", "null"] }, "tagExpiry": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "certifiedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "certifiedById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "deviceId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "createdById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "createdReasonId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "clientRepresentativeName": { "type": ["string", "null"] }, "contractorRepresentativeName": { "type": ["string", "null"] }, "notes": { "type": ["string", "null"] }, "signaturesOnFile": { "type": "boolean" }, "replacesId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "replacedReason": { "type": ["string", "null"] }, "revokedFrom": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "revokedReason": { "type": ["string", "null"] }, "revokedById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": [ "id", "projectId", "certNumber", "kind", "primeId", "firstTierSubId", "secondTierSubId", "capacityCy", "vehicleTypeId", "vehicleTypeOther", "crewTypeId", "driverName", "driverLicenceState", "driverLicenceExpiry", "tagNumber", "tagState", "tagExpiry", "certifiedAt", "deviceUtcOffsetMinutes", "certifiedById", "deviceId", "createdById", "createdReasonId", "clientRepresentativeName", "contractorRepresentativeName", "notes", "signaturesOnFile", "replacesId", "replacedReason", "revokedFrom", "revokedReason", "revokedById" ], "additionalProperties": false }, "boxes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "position": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "shape": { "type": "string" }, "sign": { "type": "string" }, "featureId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "featureOther": { "type": ["string", "null"] }, "length": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "secondLength": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "diameter": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "radius": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "run": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "corners": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "takenOffAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "id", "position", "shape", "sign", "featureId", "featureOther", "length", "secondLength", "width", "height", "diameter", "radius", "run", "corners", "takenOffAt" ], "additionalProperties": false } }, "helperIds": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "photographs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fieldEventId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certificationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "scaleReceiptId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "roeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "surveyId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "incidentId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "dropOffLogId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "view": { "anyOf": [ { "type": "string", "enum": [ "OPERATOR_WITH_PLACARD", "INTERIOR_OR_BACK", "RIGHT", "LEFT", "FRONT" ] }, { "type": "null" } ] }, "stage": { "anyOf": [ { "type": "string", "enum": ["PRE_WORK", "MEASUREMENT", "POST_WORK"] }, { "type": "null" } ] }, "capturedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "uploadedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "removedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "label": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "fieldEventId", "certificationId", "scaleReceiptId", "roeId", "surveyId", "incidentId", "dropOffLogId", "view", "stage", "capturedAt", "uploadedAt", "removedAt", "label" ], "additionalProperties": false } }, "qcMark": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "completedLoadId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "completedHaulOutId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "unitRateTicketId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certificationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "roeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "surveyId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "incidentId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "dropOffLogId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "status": { "type": "string", "enum": ["QC_REVIEW", "QC_APPROVED", "QC_ISSUES", "QC_VOID"] }, "setById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "setAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "note": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "completedLoadId", "completedHaulOutId", "unitRateTicketId", "certificationId", "roeId", "surveyId", "incidentId", "dropOffLogId", "status", "setById", "setAt", "note" ], "additionalProperties": false }, { "type": "null" } ] }, "flags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workflow": { "anyOf": [ { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] }, { "type": "null" } ] }, "ticketNumber": { "type": ["string", "null"] }, "fieldEventId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certificationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "disposalSiteId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "surveyId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "code": { "type": "string", "enum": [ "DEBRIS_TYPE_MISMATCH", "CERT_NUMBER_MISMATCH", "DISPOSAL_BEFORE_COLLECTION_ENDED", "OVERLAPPING_LOADS", "SPLIT_SUFFIX_GAP", "CARRIED_COUNT_MISMATCH", "NO_CERTIFICATION", "TYPED_CAPACITY_DIFFERS", "TAG_EXPIRED", "CERTIFICATION_REVOKED", "CERTIFICATION_REPLACED", "OUTSIDE_PROJECT_BOUNDARY", "NO_ZONE", "OUTSIDE_SITE_AREA", "PROJECT_NOT_ACTIVE", "SITE_NOT_YET_ACTIVE", "SITE_CLOSED", "NO_ROAD_ROUTE", "DEVICE_CLOCK_OFF", "WORK_TIME_AFTER_RECEIVED", "WORK_TIME_BEFORE_ENROLMENT", "DEVICE_TIME_ZONE_DIFFERS", "PHONE_OUT_OF_SERVICE", "TYPED_TICKET_NUMBER", "BACK_OFFICE_RECORD", "SITE_DOES_NOT_TAKE_LOADS", "SITE_NOT_FOR_HAUL_OUTS", "INELIGIBLE_SITE", "TIPPING_FEE_RULE_MISSING", "HAUL_OUT_DUMPED_AT_TDSR", "LOAD_CALL_ZERO", "LOAD_CALL_LOW", "LOAD_CALL_HIGH", "PILE_CALL_NOT_HIGHER", "QUANTITY_MISSING_FOR_PAY_ITEM", "SHARED_SCALE_WEIGHT", "RECEIPT_TWO_DEBRIS_TYPES", "SCALE_WEIGHT_UNUSABLE", "CARRIED_TICKET_NOT_FOUND", "CARRIED_TICKET_ON_ANOTHER_LOAD", "MEASUREMENT_MISSING", "GPS_MISSING", "PHOTOS_MISSING", "DECIMAL_COUNT", "NO_SIZE_BAND", "OUTSIDE_SIZE_BAND", "MARKED_INELIGIBLE", "STUMP_UNDER_24", "ROOT_BALL_NOT_WIDER", "FILL_WITHOUT_EXPOSED_ROOT_BALL", "ROOT_BALL_MISSING", "NO_SURVEY", "CREW_ITEM_OVER_12_HOURS", "CREW_TIME_OVERLAP", "ROE_MISSING", "ROE_NOT_ON_PROJECT", "ROE_UNSIGNED", "ROE_OUT_OF_SCOPE", "NO_PRE_WORK_SURVEY", "CERTIFICATION_PHOTO_MISSING", "PERMIT_OUTSTANDING", "NO_PRICING_RULE", "DUPLICATE_TRANSACTION_NUMBER", "NO_RATE_FOR_PRIME", "RATE_TO_BE_NEGOTIATED", "NOT_PROCESSED", "DETAIL_MISSING", "TYPED_NUMBER_NO_REASON", "WRONG_KIND_OF_BADGE", "GPS_UNREADABLE", "NOT_A_TICKET_NUMBER", "ENDED_BEFORE_STARTED", "SPLIT_NOT_ALLOWED", "OUTSIDE_CONTROL_RANGES", "ASSIGNMENT_ON_ANOTHER_PROJECT", "SCALE_NET_DISAGREES", "TWO_QUANTITIES", "NOT_PROCESSED_LINES_STAND", "SUB_NAME_ALIKE", "MONITOR_NOT_SIGNED_IN", "ASSIGNMENT_OF_ANOTHER_PERSON" ] }, "message": { "type": "string" }, "billing": { "type": "string", "enum": ["BILLS", "LINE_NOT_BILLED", "NOT_BILLED"] }, "slot": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "payItemId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "raisedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "clearedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "acceptances": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "flagId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "reasonId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "note": { "type": ["string", "null"] }, "acceptedById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "acceptedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "withdrawnById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "withdrawnAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "withdrawNote": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "flagId", "reasonId", "note", "acceptedById", "acceptedAt", "withdrawnById", "withdrawnAt", "withdrawNote" ], "additionalProperties": false } } }, "required": [ "id", "projectId", "workflow", "ticketNumber", "fieldEventId", "certificationId", "disposalSiteId", "surveyId", "code", "message", "billing", "slot", "payItemId", "raisedAt", "clearedAt", "acceptances" ], "additionalProperties": false } } }, "required": [ "certification", "boxes", "helperIds", "photographs", "qcMark", "flags" ], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["certifications", "next"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } }, "post": { "operationId": "createCertification", "summary": "A certification sheet whose phone failed is entered in the back office: its number as the sheet has it, a container or a crew, the prime picked and the subs typed, what was certified, the boxes measured (the primary first; the capacity is worked out, never sent), the driver and the tag, when it was certified by the sheet, the monitor who certified it and the helpers, the representatives, the certification it replaces where a modified truck was certified again, notes and a reason picked from the firm’s list. It names the person who entered it. The field events already on its number are linked to it, and their tickets queued (the replaced one’s too). Refused for a number another certification of the project has, a reason the firm doesn’t offer for this and measurements that give no capacity.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "CORRECT", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "certNumber": { "type": "string", "minLength": 1, "maxLength": 40 }, "kind": { "type": "string", "enum": ["CONTAINER", "CREW"] }, "primeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "firstTierSub": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "secondTierSub": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "vehicleTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "vehicleTypeOther": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "crewTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "boxes": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "featureId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "featureOther": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "shape": { "type": "string", "enum": [ "RECTANGLE", "TRIANGLE", "TWO_LENGTH_HOIST", "ROUND_BOTTOM", "RADIUS_CORNER" ] }, "sign": { "type": "string", "enum": ["ADD", "SUBTRACT"] }, "length": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 9999 }, { "type": "null" } ] }, "secondLength": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 9999 }, { "type": "null" } ] }, "width": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 9999 }, { "type": "null" } ] }, "height": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 9999 }, { "type": "null" } ] }, "diameter": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 9999 }, { "type": "null" } ] }, "radius": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 9999 }, { "type": "null" } ] }, "run": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 9999 }, { "type": "null" } ] }, "corners": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 99 }, { "type": "null" } ] } }, "required": [ "featureId", "featureOther", "shape", "sign", "length", "secondLength", "width", "height", "diameter", "radius", "run", "corners" ], "additionalProperties": false } }, "driverName": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "driverPhone": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "driverLicenceNumber": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "driverLicenceState": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "driverLicenceExpiry": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "tagNumber": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "tagState": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "tagExpiry": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "certifiedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -720, "maximum": 840 }, "certifiedById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "helperIds": { "maxItems": 20, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "clientRepresentativeName": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "contractorRepresentativeName": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "replaces": { "anyOf": [ { "type": "object", "properties": { "certificationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "reason": { "type": "string", "minLength": 1, "maxLength": 2000 } }, "required": ["certificationId", "reason"], "additionalProperties": false }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2000 }, { "type": "null" } ] }, "reasonId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "certNumber", "kind", "primeId", "firstTierSub", "secondTierSub", "vehicleTypeId", "vehicleTypeOther", "crewTypeId", "boxes", "driverName", "driverPhone", "driverLicenceNumber", "driverLicenceState", "driverLicenceExpiry", "tagNumber", "tagState", "tagExpiry", "certifiedAt", "deviceUtcOffsetMinutes", "certifiedById", "helperIds", "clientRepresentativeName", "contractorRepresentativeName", "replaces", "notes", "reasonId" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "certNumber": { "type": "string" }, "kind": { "type": "string", "enum": ["CONTAINER", "CREW"] }, "primeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "firstTierSubId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "secondTierSubId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "capacityCy": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "vehicleTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "vehicleTypeOther": { "type": ["string", "null"] }, "crewTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "driverName": { "type": ["string", "null"] }, "driverLicenceState": { "type": ["string", "null"] }, "driverLicenceExpiry": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "tagNumber": { "type": ["string", "null"] }, "tagState": { "type": ["string", "null"] }, "tagExpiry": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "certifiedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "certifiedById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "deviceId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "createdById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "createdReasonId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "clientRepresentativeName": { "type": ["string", "null"] }, "contractorRepresentativeName": { "type": ["string", "null"] }, "notes": { "type": ["string", "null"] }, "signaturesOnFile": { "type": "boolean" }, "replacesId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "replacedReason": { "type": ["string", "null"] }, "revokedFrom": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "revokedReason": { "type": ["string", "null"] }, "revokedById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": [ "id", "projectId", "certNumber", "kind", "primeId", "firstTierSubId", "secondTierSubId", "capacityCy", "vehicleTypeId", "vehicleTypeOther", "crewTypeId", "driverName", "driverLicenceState", "driverLicenceExpiry", "tagNumber", "tagState", "tagExpiry", "certifiedAt", "deviceUtcOffsetMinutes", "certifiedById", "deviceId", "createdById", "createdReasonId", "clientRepresentativeName", "contractorRepresentativeName", "notes", "signaturesOnFile", "replacesId", "replacedReason", "revokedFrom", "revokedReason", "revokedById" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/certifications/{certificationId}": { "get": { "operationId": "readCertification", "summary": "One certification whole: its boxes (those taken off kept, marked), helpers, photographs’ records, QC mark and its own flags, where it came from and any revocation. Never the driver’s phone or licence number.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "VIEW_REVIEW", "parameters": [ { "name": "certificationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "certification": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "certNumber": { "type": "string" }, "kind": { "type": "string", "enum": ["CONTAINER", "CREW"] }, "primeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "firstTierSubId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "secondTierSubId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "capacityCy": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "vehicleTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "vehicleTypeOther": { "type": ["string", "null"] }, "crewTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "driverName": { "type": ["string", "null"] }, "driverLicenceState": { "type": ["string", "null"] }, "driverLicenceExpiry": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "tagNumber": { "type": ["string", "null"] }, "tagState": { "type": ["string", "null"] }, "tagExpiry": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "certifiedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "certifiedById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "deviceId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "createdById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "createdReasonId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "clientRepresentativeName": { "type": ["string", "null"] }, "contractorRepresentativeName": { "type": ["string", "null"] }, "notes": { "type": ["string", "null"] }, "signaturesOnFile": { "type": "boolean" }, "replacesId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "replacedReason": { "type": ["string", "null"] }, "revokedFrom": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "revokedReason": { "type": ["string", "null"] }, "revokedById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": [ "id", "projectId", "certNumber", "kind", "primeId", "firstTierSubId", "secondTierSubId", "capacityCy", "vehicleTypeId", "vehicleTypeOther", "crewTypeId", "driverName", "driverLicenceState", "driverLicenceExpiry", "tagNumber", "tagState", "tagExpiry", "certifiedAt", "deviceUtcOffsetMinutes", "certifiedById", "deviceId", "createdById", "createdReasonId", "clientRepresentativeName", "contractorRepresentativeName", "notes", "signaturesOnFile", "replacesId", "replacedReason", "revokedFrom", "revokedReason", "revokedById" ], "additionalProperties": false }, "boxes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "position": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "shape": { "type": "string" }, "sign": { "type": "string" }, "featureId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "featureOther": { "type": ["string", "null"] }, "length": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "secondLength": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "diameter": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "radius": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "run": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "corners": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "takenOffAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "id", "position", "shape", "sign", "featureId", "featureOther", "length", "secondLength", "width", "height", "diameter", "radius", "run", "corners", "takenOffAt" ], "additionalProperties": false } }, "helperIds": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "photographs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fieldEventId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certificationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "scaleReceiptId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "roeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "surveyId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "incidentId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "dropOffLogId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "view": { "anyOf": [ { "type": "string", "enum": [ "OPERATOR_WITH_PLACARD", "INTERIOR_OR_BACK", "RIGHT", "LEFT", "FRONT" ] }, { "type": "null" } ] }, "stage": { "anyOf": [ { "type": "string", "enum": ["PRE_WORK", "MEASUREMENT", "POST_WORK"] }, { "type": "null" } ] }, "capturedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "uploadedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "removedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "label": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "fieldEventId", "certificationId", "scaleReceiptId", "roeId", "surveyId", "incidentId", "dropOffLogId", "view", "stage", "capturedAt", "uploadedAt", "removedAt", "label" ], "additionalProperties": false } }, "qcMark": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "completedLoadId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "completedHaulOutId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "unitRateTicketId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certificationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "roeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "surveyId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "incidentId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "dropOffLogId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "status": { "type": "string", "enum": ["QC_REVIEW", "QC_APPROVED", "QC_ISSUES", "QC_VOID"] }, "setById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "setAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "note": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "completedLoadId", "completedHaulOutId", "unitRateTicketId", "certificationId", "roeId", "surveyId", "incidentId", "dropOffLogId", "status", "setById", "setAt", "note" ], "additionalProperties": false }, { "type": "null" } ] }, "flags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workflow": { "anyOf": [ { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] }, { "type": "null" } ] }, "ticketNumber": { "type": ["string", "null"] }, "fieldEventId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "certificationId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "disposalSiteId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "surveyId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "code": { "type": "string", "enum": [ "DEBRIS_TYPE_MISMATCH", "CERT_NUMBER_MISMATCH", "DISPOSAL_BEFORE_COLLECTION_ENDED", "OVERLAPPING_LOADS", "SPLIT_SUFFIX_GAP", "CARRIED_COUNT_MISMATCH", "NO_CERTIFICATION", "TYPED_CAPACITY_DIFFERS", "TAG_EXPIRED", "CERTIFICATION_REVOKED", "CERTIFICATION_REPLACED", "OUTSIDE_PROJECT_BOUNDARY", "NO_ZONE", "OUTSIDE_SITE_AREA", "PROJECT_NOT_ACTIVE", "SITE_NOT_YET_ACTIVE", "SITE_CLOSED", "NO_ROAD_ROUTE", "DEVICE_CLOCK_OFF", "WORK_TIME_AFTER_RECEIVED", "WORK_TIME_BEFORE_ENROLMENT", "DEVICE_TIME_ZONE_DIFFERS", "PHONE_OUT_OF_SERVICE", "TYPED_TICKET_NUMBER", "BACK_OFFICE_RECORD", "SITE_DOES_NOT_TAKE_LOADS", "SITE_NOT_FOR_HAUL_OUTS", "INELIGIBLE_SITE", "TIPPING_FEE_RULE_MISSING", "HAUL_OUT_DUMPED_AT_TDSR", "LOAD_CALL_ZERO", "LOAD_CALL_LOW", "LOAD_CALL_HIGH", "PILE_CALL_NOT_HIGHER", "QUANTITY_MISSING_FOR_PAY_ITEM", "SHARED_SCALE_WEIGHT", "RECEIPT_TWO_DEBRIS_TYPES", "SCALE_WEIGHT_UNUSABLE", "CARRIED_TICKET_NOT_FOUND", "CARRIED_TICKET_ON_ANOTHER_LOAD", "MEASUREMENT_MISSING", "GPS_MISSING", "PHOTOS_MISSING", "DECIMAL_COUNT", "NO_SIZE_BAND", "OUTSIDE_SIZE_BAND", "MARKED_INELIGIBLE", "STUMP_UNDER_24", "ROOT_BALL_NOT_WIDER", "FILL_WITHOUT_EXPOSED_ROOT_BALL", "ROOT_BALL_MISSING", "NO_SURVEY", "CREW_ITEM_OVER_12_HOURS", "CREW_TIME_OVERLAP", "ROE_MISSING", "ROE_NOT_ON_PROJECT", "ROE_UNSIGNED", "ROE_OUT_OF_SCOPE", "NO_PRE_WORK_SURVEY", "CERTIFICATION_PHOTO_MISSING", "PERMIT_OUTSTANDING", "NO_PRICING_RULE", "DUPLICATE_TRANSACTION_NUMBER", "NO_RATE_FOR_PRIME", "RATE_TO_BE_NEGOTIATED", "NOT_PROCESSED", "DETAIL_MISSING", "TYPED_NUMBER_NO_REASON", "WRONG_KIND_OF_BADGE", "GPS_UNREADABLE", "NOT_A_TICKET_NUMBER", "ENDED_BEFORE_STARTED", "SPLIT_NOT_ALLOWED", "OUTSIDE_CONTROL_RANGES", "ASSIGNMENT_ON_ANOTHER_PROJECT", "SCALE_NET_DISAGREES", "TWO_QUANTITIES", "NOT_PROCESSED_LINES_STAND", "SUB_NAME_ALIKE", "MONITOR_NOT_SIGNED_IN", "ASSIGNMENT_OF_ANOTHER_PERSON" ] }, "message": { "type": "string" }, "billing": { "type": "string", "enum": ["BILLS", "LINE_NOT_BILLED", "NOT_BILLED"] }, "slot": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "payItemId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "raisedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "clearedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "acceptances": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "flagId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "reasonId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "note": { "type": ["string", "null"] }, "acceptedById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "acceptedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "withdrawnById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "withdrawnAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "withdrawNote": { "type": ["string", "null"] } }, "required": [ "id", "projectId", "flagId", "reasonId", "note", "acceptedById", "acceptedAt", "withdrawnById", "withdrawnAt", "withdrawNote" ], "additionalProperties": false } } }, "required": [ "id", "projectId", "workflow", "ticketNumber", "fieldEventId", "certificationId", "disposalSiteId", "surveyId", "code", "message", "billing", "slot", "payItemId", "raisedAt", "clearedAt", "acceptances" ], "additionalProperties": false } } }, "required": [ "certification", "boxes", "helperIds", "photographs", "qcMark", "flags" ], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } }, "patch": { "operationId": "correctCertification", "summary": "A certification is corrected in place: its prime and subs (typed by name, placed under the prime as at certifying, a name already placed elsewhere on the project saved as a separate contractor with a warning), what was certified (picked or typed) or the crew type, the driver, the tag, the representatives and notes; only what is stated changes, and `null` empties a detail that may be empty. With the prime changed, the subs it had are placed again under the new prime by name. Every ticket that scanned it is queued, with the tickets that read them; one locked as invoiced is left as it is. Refused for a prime that isn’t one of the project’s and a second tier with no first.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "CORRECT", "parameters": [ { "name": "certificationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "changes": { "type": "object", "properties": { "primeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "firstTierSub": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "secondTierSub": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "vehicleTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "vehicleTypeOther": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "crewTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "driverName": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "driverPhone": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "driverLicenceNumber": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "driverLicenceState": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "driverLicenceExpiry": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "tagNumber": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "tagState": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "tagExpiry": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "clientRepresentativeName": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "contractorRepresentativeName": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2000 }, { "type": "null" } ] } }, "additionalProperties": false }, "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["changes"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "certNumber": { "type": "string" }, "kind": { "type": "string", "enum": ["CONTAINER", "CREW"] }, "primeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "firstTierSubId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "secondTierSubId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "capacityCy": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "vehicleTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "vehicleTypeOther": { "type": ["string", "null"] }, "crewTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "driverName": { "type": ["string", "null"] }, "driverLicenceState": { "type": ["string", "null"] }, "driverLicenceExpiry": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "tagNumber": { "type": ["string", "null"] }, "tagState": { "type": ["string", "null"] }, "tagExpiry": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "certifiedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "certifiedById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "deviceId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "createdById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "createdReasonId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "clientRepresentativeName": { "type": ["string", "null"] }, "contractorRepresentativeName": { "type": ["string", "null"] }, "notes": { "type": ["string", "null"] }, "signaturesOnFile": { "type": "boolean" }, "replacesId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "replacedReason": { "type": ["string", "null"] }, "revokedFrom": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "revokedReason": { "type": ["string", "null"] }, "revokedById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": [ "id", "projectId", "certNumber", "kind", "primeId", "firstTierSubId", "secondTierSubId", "capacityCy", "vehicleTypeId", "vehicleTypeOther", "crewTypeId", "driverName", "driverLicenceState", "driverLicenceExpiry", "tagNumber", "tagState", "tagExpiry", "certifiedAt", "deviceUtcOffsetMinutes", "certifiedById", "deviceId", "createdById", "createdReasonId", "clientRepresentativeName", "contractorRepresentativeName", "notes", "signaturesOnFile", "replacesId", "replacedReason", "revokedFrom", "revokedReason", "revokedById" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/certifications/{certificationId}/boxes/{position}": { "patch": { "operationId": "correctCertificationBox", "summary": "A mistake on one of a container certification’s boxes is corrected in place (box 0 is the primary): its measurements in whole inches, its shape (with the measurements that shape holds, and no others), whether it adds or subtracts, its feature (picked or typed), or the box taken off or put back; only what is stated changes, and the capacity is worked out again from the boxes, never sent. Every ticket that scanned the certification is queued where the capacity changed; one locked as invoiced is left as it is. Refused for a box the certification doesn’t have, for the primary taken off, for measurements that give no capacity and for a measurement the box’s shape doesn’t hold.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "CORRECT", "parameters": [ { "name": "certificationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "position", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^(0|[1-9][0-9]?)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "changes": { "type": "object", "properties": { "length": { "type": "integer", "minimum": 1, "maximum": 9999 }, "secondLength": { "type": "integer", "minimum": 1, "maximum": 9999 }, "width": { "type": "integer", "minimum": 1, "maximum": 9999 }, "height": { "type": "integer", "minimum": 1, "maximum": 9999 }, "diameter": { "type": "integer", "minimum": 1, "maximum": 9999 }, "radius": { "type": "integer", "minimum": 1, "maximum": 9999 }, "run": { "type": "integer", "minimum": 1, "maximum": 9999 }, "corners": { "type": "integer", "minimum": 1, "maximum": 99 }, "shape": { "type": "string", "enum": [ "RECTANGLE", "TRIANGLE", "TWO_LENGTH_HOIST", "ROUND_BOTTOM", "RADIUS_CORNER" ] }, "sign": { "type": "string", "enum": ["ADD", "SUBTRACT"] }, "featureId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "featureOther": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "takenOff": { "type": "boolean" } }, "additionalProperties": false }, "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["changes"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "certNumber": { "type": "string" }, "kind": { "type": "string", "enum": ["CONTAINER", "CREW"] }, "primeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "firstTierSubId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "secondTierSubId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "capacityCy": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "vehicleTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "vehicleTypeOther": { "type": ["string", "null"] }, "crewTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "driverName": { "type": ["string", "null"] }, "driverLicenceState": { "type": ["string", "null"] }, "driverLicenceExpiry": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "tagNumber": { "type": ["string", "null"] }, "tagState": { "type": ["string", "null"] }, "tagExpiry": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "certifiedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "certifiedById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "deviceId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "createdById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "createdReasonId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "clientRepresentativeName": { "type": ["string", "null"] }, "contractorRepresentativeName": { "type": ["string", "null"] }, "notes": { "type": ["string", "null"] }, "signaturesOnFile": { "type": "boolean" }, "replacesId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "replacedReason": { "type": ["string", "null"] }, "revokedFrom": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "revokedReason": { "type": ["string", "null"] }, "revokedById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": [ "id", "projectId", "certNumber", "kind", "primeId", "firstTierSubId", "secondTierSubId", "capacityCy", "vehicleTypeId", "vehicleTypeOther", "crewTypeId", "driverName", "driverLicenceState", "driverLicenceExpiry", "tagNumber", "tagState", "tagExpiry", "certifiedAt", "deviceUtcOffsetMinutes", "certifiedById", "deviceId", "createdById", "createdReasonId", "clientRepresentativeName", "contractorRepresentativeName", "notes", "signaturesOnFile", "replacesId", "replacedReason", "revokedFrom", "revokedReason", "revokedById" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/certifications/{certificationId}/boxes": { "post": { "operationId": "addCertificationBox", "summary": "A box is added to a container certification after its last, as the sheet has it: a feature (picked or typed), a shape with its own measurements in whole inches, and whether it adds or subtracts. The capacity is worked out again from the boxes, never sent, and every ticket that scanned the certification is queued where it changed; one locked as invoiced is left as it is. Refused for a crew, which is never measured, and for measurements that give no capacity.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "CORRECT", "parameters": [ { "name": "certificationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "box": { "type": "object", "properties": { "featureId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "featureOther": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "shape": { "type": "string", "enum": [ "RECTANGLE", "TRIANGLE", "TWO_LENGTH_HOIST", "ROUND_BOTTOM", "RADIUS_CORNER" ] }, "sign": { "type": "string", "enum": ["ADD", "SUBTRACT"] }, "length": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 9999 }, { "type": "null" } ] }, "secondLength": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 9999 }, { "type": "null" } ] }, "width": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 9999 }, { "type": "null" } ] }, "height": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 9999 }, { "type": "null" } ] }, "diameter": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 9999 }, { "type": "null" } ] }, "radius": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 9999 }, { "type": "null" } ] }, "run": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 9999 }, { "type": "null" } ] }, "corners": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 99 }, { "type": "null" } ] } }, "required": [ "featureId", "featureOther", "shape", "sign", "length", "secondLength", "width", "height", "diameter", "radius", "run", "corners" ], "additionalProperties": false }, "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": ["box"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "certNumber": { "type": "string" }, "kind": { "type": "string", "enum": ["CONTAINER", "CREW"] }, "primeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "firstTierSubId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "secondTierSubId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "capacityCy": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "vehicleTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "vehicleTypeOther": { "type": ["string", "null"] }, "crewTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "driverName": { "type": ["string", "null"] }, "driverLicenceState": { "type": ["string", "null"] }, "driverLicenceExpiry": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "tagNumber": { "type": ["string", "null"] }, "tagState": { "type": ["string", "null"] }, "tagExpiry": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "certifiedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "certifiedById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "deviceId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "createdById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "createdReasonId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "clientRepresentativeName": { "type": ["string", "null"] }, "contractorRepresentativeName": { "type": ["string", "null"] }, "notes": { "type": ["string", "null"] }, "signaturesOnFile": { "type": "boolean" }, "replacesId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "replacedReason": { "type": ["string", "null"] }, "revokedFrom": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "revokedReason": { "type": ["string", "null"] }, "revokedById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": [ "id", "projectId", "certNumber", "kind", "primeId", "firstTierSubId", "secondTierSubId", "capacityCy", "vehicleTypeId", "vehicleTypeOther", "crewTypeId", "driverName", "driverLicenceState", "driverLicenceExpiry", "tagNumber", "tagState", "tagExpiry", "certifiedAt", "deviceUtcOffsetMinutes", "certifiedById", "deviceId", "createdById", "createdReasonId", "clientRepresentativeName", "contractorRepresentativeName", "notes", "signaturesOnFile", "replacesId", "replacedReason", "revokedFrom", "revokedReason", "revokedById" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/certifications/{certificationId}/signatures-on-file": { "put": { "operationId": "markSignaturesOnFile", "summary": "Whether a certification’s signatures are on file is marked, yes or no. It changes nothing a ticket reads and queues nothing.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN", "MANAGER_ANALYST"], "x-open-adms-permission": "QC", "parameters": [ { "name": "certificationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "onFile": { "type": "boolean" } }, "required": ["onFile"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "certNumber": { "type": "string" }, "kind": { "type": "string", "enum": ["CONTAINER", "CREW"] }, "primeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "firstTierSubId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "secondTierSubId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "capacityCy": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "vehicleTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "vehicleTypeOther": { "type": ["string", "null"] }, "crewTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "driverName": { "type": ["string", "null"] }, "driverLicenceState": { "type": ["string", "null"] }, "driverLicenceExpiry": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "tagNumber": { "type": ["string", "null"] }, "tagState": { "type": ["string", "null"] }, "tagExpiry": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "certifiedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "certifiedById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "deviceId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "createdById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "createdReasonId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "clientRepresentativeName": { "type": ["string", "null"] }, "contractorRepresentativeName": { "type": ["string", "null"] }, "notes": { "type": ["string", "null"] }, "signaturesOnFile": { "type": "boolean" }, "replacesId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "replacedReason": { "type": ["string", "null"] }, "revokedFrom": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "revokedReason": { "type": ["string", "null"] }, "revokedById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": [ "id", "projectId", "certNumber", "kind", "primeId", "firstTierSubId", "secondTierSubId", "capacityCy", "vehicleTypeId", "vehicleTypeOther", "crewTypeId", "driverName", "driverLicenceState", "driverLicenceExpiry", "tagNumber", "tagState", "tagExpiry", "certifiedAt", "deviceUtcOffsetMinutes", "certifiedById", "deviceId", "createdById", "createdReasonId", "clientRepresentativeName", "contractorRepresentativeName", "notes", "signaturesOnFile", "replacesId", "replacedReason", "revokedFrom", "revokedReason", "revokedById" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/certifications/{certificationId}/revocations": { "post": { "operationId": "revokeCertification", "summary": "A certification is revoked from a day, in its project’s time zone, with a reason; it keeps the day, the reason and the admin. Nothing else on it changes. Every ticket that scanned it is queued; one locked as invoiced is left as it is.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN"], "parameters": [ { "name": "certificationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "from": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "reason": { "type": "string", "minLength": 1, "maxLength": 2000 } }, "required": ["from", "reason"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "certNumber": { "type": "string" }, "kind": { "type": "string", "enum": ["CONTAINER", "CREW"] }, "primeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "firstTierSubId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "secondTierSubId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "capacityCy": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "vehicleTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "vehicleTypeOther": { "type": ["string", "null"] }, "crewTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "driverName": { "type": ["string", "null"] }, "driverLicenceState": { "type": ["string", "null"] }, "driverLicenceExpiry": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "tagNumber": { "type": ["string", "null"] }, "tagState": { "type": ["string", "null"] }, "tagExpiry": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "certifiedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "certifiedById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "deviceId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "createdById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "createdReasonId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "clientRepresentativeName": { "type": ["string", "null"] }, "contractorRepresentativeName": { "type": ["string", "null"] }, "notes": { "type": ["string", "null"] }, "signaturesOnFile": { "type": "boolean" }, "replacesId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "replacedReason": { "type": ["string", "null"] }, "revokedFrom": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "revokedReason": { "type": ["string", "null"] }, "revokedById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": [ "id", "projectId", "certNumber", "kind", "primeId", "firstTierSubId", "secondTierSubId", "capacityCy", "vehicleTypeId", "vehicleTypeOther", "crewTypeId", "driverName", "driverLicenceState", "driverLicenceExpiry", "tagNumber", "tagState", "tagExpiry", "certifiedAt", "deviceUtcOffsetMinutes", "certifiedById", "deviceId", "createdById", "createdReasonId", "clientRepresentativeName", "contractorRepresentativeName", "notes", "signaturesOnFile", "replacesId", "replacedReason", "revokedFrom", "revokedReason", "revokedById" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/certifications/{certificationId}/unrevocations": { "post": { "operationId": "unrevokeCertification", "summary": "A certification’s revocation is taken back, with a reason: its day, reason and admin are cleared, the audit log keeping them, and every ticket that scanned it is queued, flagged no more for it; one locked as invoiced is left as it is. Refused for a certification that isn’t revoked.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["ADMIN"], "parameters": [ { "name": "certificationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "reason": { "type": "string", "minLength": 1, "maxLength": 2000 } }, "required": ["reason"], "additionalProperties": false } } } }, "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "certNumber": { "type": "string" }, "kind": { "type": "string", "enum": ["CONTAINER", "CREW"] }, "primeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "firstTierSubId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "secondTierSubId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "capacityCy": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "vehicleTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "vehicleTypeOther": { "type": ["string", "null"] }, "crewTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "driverName": { "type": ["string", "null"] }, "driverLicenceState": { "type": ["string", "null"] }, "driverLicenceExpiry": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "tagNumber": { "type": ["string", "null"] }, "tagState": { "type": ["string", "null"] }, "tagExpiry": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "certifiedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "certifiedById": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "deviceId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "createdById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "createdReasonId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "clientRepresentativeName": { "type": ["string", "null"] }, "contractorRepresentativeName": { "type": ["string", "null"] }, "notes": { "type": ["string", "null"] }, "signaturesOnFile": { "type": "boolean" }, "replacesId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "replacedReason": { "type": ["string", "null"] }, "revokedFrom": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "revokedReason": { "type": ["string", "null"] }, "revokedById": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": [ "id", "projectId", "certNumber", "kind", "primeId", "firstTierSubId", "secondTierSubId", "capacityCy", "vehicleTypeId", "vehicleTypeOther", "crewTypeId", "driverName", "driverLicenceState", "driverLicenceExpiry", "tagNumber", "tagState", "tagExpiry", "certifiedAt", "deviceUtcOffsetMinutes", "certifiedById", "deviceId", "createdById", "createdReasonId", "clientRepresentativeName", "contractorRepresentativeName", "notes", "signaturesOnFile", "replacesId", "replacedReason", "revokedFrom", "revokedReason", "revokedById" ], "additionalProperties": false }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 } }, "required": ["code", "message"], "additionalProperties": false } }, "queued": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "tickets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lockedAsInvoiced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["jobs", "tickets", "lockedAsInvoiced"], "additionalProperties": false } }, "required": ["record", "warnings"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/viewer/projects": { "get": { "operationId": "viewerProjects", "summary": "The projects the signed-in viewer is given, a page at a time, in the order they were entered: each by name, with its time zone and when it was closed.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["READ_ONLY_VIEWER"], "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "projects": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "timeZone": { "type": "string" }, "closedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": ["id", "name", "timeZone", "closedAt"], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["projects", "next"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/viewer/projects/{projectId}/roes": { "get": { "operationId": "viewerRoes", "summary": "A project’s ROEs as the signed-in viewer is shown them, a page at a time, in the order they were made: each by number, with whether and when it was signed, and its owner’s name only where the firm lets this viewer see private citizens by name.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["READ_ONLY_VIEWER"], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "roes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "roeNumber": { "type": "string" }, "signed": { "type": "boolean" }, "signedDate": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "ownerName": { "type": ["string", "null"] }, "parcelId": { "type": ["string", "null"] }, "address": { "type": ["string", "null"] }, "latitude": { "anyOf": [ { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, { "type": "null" } ] }, "scope": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "debrisType": { "type": ["string", "null"] }, "payableType": { "type": ["string", "null"] }, "count": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": ["id", "debrisType", "payableType", "count"], "additionalProperties": false } } }, "required": [ "id", "roeNumber", "signed", "signedDate", "ownerName", "parcelId", "address", "latitude", "longitude", "scope" ], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["roes", "next"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/viewer/projects/{projectId}/tickets/{workflow}/{ticketNumber}/history": { "get": { "operationId": "viewerTicketHistory", "summary": "What the audit log holds of one ticket as the signed-in client user or auditor is shown it, newest first, a page at a time: each change to its records, the values before and after as this viewer reads them, who made it and from where; never why. A contractor user is shown none; a ticket the viewer isn’t shown is not found.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["READ_ONLY_VIEWER"], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "workflow", "in": "path", "required": true, "schema": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] } }, { "name": "ticketNumber", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 40 } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[1-9][0-9]{0,18}$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "entries": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9]+$" }, "occurredAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "tableName": { "type": "string" }, "recordId": { "type": "string" }, "operation": { "type": "string", "enum": ["INSERT", "UPDATE", "DELETE"] }, "changedFields": { "type": "array", "items": { "type": "string" } }, "priorValue": { "anyOf": [ { "$ref": "#/$defs/__schema0" }, { "type": "null" } ] }, "newValue": { "anyOf": [ { "$ref": "#/$defs/__schema1" }, { "type": "null" } ] }, "actor": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, { "type": "null" } ] }, "source": { "type": "string", "enum": ["DEVICE", "BACK_OFFICE", "SYSTEM"] }, "deviceId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "reason": { "type": ["string", "null"] } }, "required": [ "id", "occurredAt", "tableName", "recordId", "operation", "changedFields", "priorValue", "newValue", "actor", "source", "deviceId", "reason" ], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "pattern": "^[0-9]+$" }, { "type": "null" } ] } }, "required": ["entries", "next"], "additionalProperties": false, "$defs": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/$defs/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/$defs/__schema0" } } ] }, "__schema1": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/$defs/__schema1" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/$defs/__schema1" } } ] } } } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/viewer/projects/{projectId}/certifications": { "get": { "operationId": "viewerCertifications", "summary": "A project’s certifications as the signed-in viewer is shown them, a page at a time, by cert number: each with its boxes, who it names by name and any revocation; never the driver’s phone or licence number. A contractor user is shown those naming its contractor.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["READ_ONLY_VIEWER"], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "certifications": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "certNumber": { "type": "string" }, "kind": { "type": "string", "enum": ["CONTAINER", "CREW"] }, "prime": { "type": ["string", "null"] }, "firstTierSub": { "type": ["string", "null"] }, "secondTierSub": { "type": ["string", "null"] }, "capacityCy": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "vehicleType": { "type": ["string", "null"] }, "crewType": { "type": ["string", "null"] }, "driverName": { "type": ["string", "null"] }, "tagNumber": { "type": ["string", "null"] }, "tagState": { "type": ["string", "null"] }, "tagExpiry": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "certifiedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "revokedFrom": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] }, "replacesId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "boxes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "position": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "shape": { "type": "string" }, "sign": { "type": "string" }, "length": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "secondLength": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "width": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "height": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "diameter": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "radius": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "run": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "corners": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "id", "position", "shape", "sign", "length", "secondLength", "width", "height", "diameter", "radius", "run", "corners" ], "additionalProperties": false } }, "helpers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "certNumber", "kind", "prime", "firstTierSub", "secondTierSub", "capacityCy", "vehicleType", "crewType", "driverName", "tagNumber", "tagState", "tagExpiry", "certifiedAt", "revokedFrom", "replacesId", "boxes", "helpers" ], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["certifications", "next"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/viewer/projects/{projectId}/surveys": { "get": { "operationId": "viewerSurveys", "summary": "A project’s surveys as the signed-in viewer is shown them, a page at a time, in the order they were made. A contractor user is shown none.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["READ_ONLY_VIEWER"], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "surveys": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "madeAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "latitude": { "anyOf": [ { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, { "type": "null" } ] }, "notes": { "type": ["string", "null"] }, "answers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": ["string", "number", "boolean"] } }, "workType": { "type": ["string", "null"] }, "surveyNumber": { "type": ["string", "null"] }, "roeNumber": { "type": ["string", "null"] } }, "required": [ "id", "madeAt", "deviceUtcOffsetMinutes", "latitude", "longitude", "notes", "answers", "workType", "surveyNumber", "roeNumber" ], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["surveys", "next"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/viewer/projects/{projectId}/incidents": { "get": { "operationId": "viewerIncidents", "summary": "A project’s incidents as the signed-in viewer is shown them, a page at a time, in the order they were made. A contractor user is shown none.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["READ_ONLY_VIEWER"], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "incidents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "madeAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "latitude": { "anyOf": [ { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, { "type": "null" } ] }, "notes": { "type": ["string", "null"] }, "answers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": ["string", "number", "boolean"] } }, "incidentType": { "type": ["string", "null"] }, "incidentSubType": { "type": ["string", "null"] }, "description": { "type": ["string", "null"] }, "parties": { "type": ["string", "null"] }, "address": { "type": ["string", "null"] }, "contractor": { "type": ["string", "null"] }, "certNumber": { "type": ["string", "null"] }, "roeNumber": { "type": ["string", "null"] } }, "required": [ "id", "madeAt", "deviceUtcOffsetMinutes", "latitude", "longitude", "notes", "answers", "incidentType", "incidentSubType", "description", "parties", "address", "contractor", "certNumber", "roeNumber" ], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["incidents", "next"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/viewer/projects/{projectId}/drop-off-logs": { "get": { "operationId": "viewerDropOffLogs", "summary": "A project’s citizen drop-off logs as the signed-in viewer is shown them, a page at a time, in the order they were made: the resident and where their debris came from only where the firm lets this viewer see private citizens by name. A contractor user is shown none.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["READ_ONLY_VIEWER"], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "dropOffLogs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "madeAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deviceUtcOffsetMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "latitude": { "anyOf": [ { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, { "type": "null" } ] }, "notes": { "type": ["string", "null"] }, "answers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": ["string", "number", "boolean"] } }, "site": { "type": ["string", "null"] }, "residentName": { "type": ["string", "null"] }, "originAddress": { "type": ["string", "null"] } }, "required": [ "id", "madeAt", "deviceUtcOffsetMinutes", "latitude", "longitude", "notes", "answers", "site", "residentName", "originAddress" ], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": ["dropOffLogs", "next"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/viewer/projects/{projectId}/setup": { "get": { "operationId": "viewerSetup", "summary": "A project’s setup as a client user or an auditor reads it: its forms and debris types, its pay items by code and description (never a rate), its sites and their facts, its contracts and their primes, its rules by name. Not found for a contractor user.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["READ_ONLY_VIEWER"], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "forms": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "documentType": { "type": "string", "enum": [ "LOAD", "HAUL_OUT", "UNIT_RATE", "CERTIFICATION", "ROE", "SURVEY", "INCIDENT", "DROP_OFF_LOG" ] }, "name": { "type": "string" }, "debrisTypes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": ["string", "null"] }, "reduced": { "type": "boolean" } }, "required": ["id", "name", "reduced"], "additionalProperties": false } } }, "required": ["id", "documentType", "name", "debrisTypes"], "additionalProperties": false } }, "payItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "code": { "type": "string" }, "description": { "type": "string" }, "unit": { "type": "string", "enum": ["CY", "TN", "EA", "LB", "HR", "CREW_DAY", "TBN"] } }, "required": ["id", "code", "description", "unit"], "additionalProperties": false } }, "sites": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "takesLoads": { "type": "boolean" }, "haulOutsLeaveHere": { "type": "boolean" }, "chargesTippingFee": { "type": "boolean" }, "ineligibleSite": { "type": "boolean" }, "activationDate": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "closeDate": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] } }, "required": [ "id", "name", "takesLoads", "haulOutsLeaveHere", "chargesTippingFee", "ineligibleSite", "activationDate", "closeDate" ], "additionalProperties": false } }, "contracts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "prime": { "type": ["string", "null"] } }, "required": ["id", "name", "prime"], "additionalProperties": false } }, "rules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "formId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "contractId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "active": { "type": "boolean" } }, "required": ["id", "name", "formId", "contractId", "active"], "additionalProperties": false } } }, "required": ["forms", "payItems", "sites", "contracts", "rules"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/viewer/projects/{projectId}/setup-check": { "get": { "operationId": "viewerSetupCheck", "summary": "The setup check as a client user or an auditor reads it: everything the project’s setup leaves open, each in plain words. Not found for a contractor user.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["READ_ONLY_VIEWER"], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "gaps": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "TIPPING_FEE_SITE_NO_PAY_ITEM", "DEBRIS_TYPE_NO_RULE", "NO_RATE_FOR_PRIME", "SIZE_BANDS_OVERLAP", "SIZE_BAND_GAP", "CREW_DAY_STEP_GAP", "RULE_NOT_VALID" ] }, "message": { "type": "string", "minLength": 1 }, "siteId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "debrisTypeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "payItemId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "primeId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "ruleId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": [ "code", "message", "siteId", "debrisTypeId", "payItemId", "primeId", "ruleId" ], "additionalProperties": false } } }, "required": ["gaps"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/viewer/projects/{projectId}/quantity-lookup": { "get": { "operationId": "viewerQuantityLookup", "summary": "What each of the project’s sites’ phones ask for, as a client user or an auditor reads it. Not found for a contractor user.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["READ_ONLY_VIEWER"], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "asks": { "type": "array", "items": { "type": "object", "properties": { "siteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "form": { "type": "string", "enum": ["LOAD", "HAUL_OUT"] }, "debrisTypeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "primeId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "asks": { "type": "string", "enum": ["LOAD_CALL", "SCALE_WEIGHT", "CARRIED_COUNT", "NOTHING_MORE"] } }, "required": ["siteId", "form", "debrisTypeId", "primeId", "asks"], "additionalProperties": false } } }, "required": ["asks"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/viewer/projects/{projectId}/tickets": { "get": { "operationId": "viewerTickets", "summary": "One workflow’s tickets on a project as the signed-in viewer is shown them, a page at a time, by number: each with the statuses its field events hold and how many field events it has. A contractor user is shown its own contractor’s tickets.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["READ_ONLY_VIEWER"], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "workflow", "in": "query", "required": true, "schema": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 40 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^([1-9][0-9]?|1[0-9]{2}|200)$" } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "tickets": { "type": "array", "items": { "type": "object", "properties": { "workflow": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] }, "ticketNumber": { "type": "string" }, "statuses": { "type": "array", "items": { "type": "string", "enum": ["PENDING", "COMPLETED", "MANUAL_REVIEW", "VOID"] } }, "fieldEvents": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 } }, "required": ["workflow", "ticketNumber", "statuses", "fieldEvents"], "additionalProperties": false } }, "next": { "type": ["string", "null"] } }, "required": ["tickets", "next"], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/viewer/projects/{projectId}/tickets/{workflow}/{ticketNumber}": { "get": { "operationId": "viewerTicket", "summary": "One ticket as the signed-in viewer is shown it: its field events, the completed record the system concluded from them, and its priced lines, with a line’s rate and amount only where this viewer is shown the money. A ticket the viewer isn’t shown is not found.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["READ_ONLY_VIEWER"], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "workflow", "in": "path", "required": true, "schema": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] } }, { "name": "ticketNumber", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 40 } } ], "responses": { "200": { "description": "The answer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "workflow": { "type": "string", "enum": ["LOAD", "HAUL_OUT", "UNIT_RATE"] }, "ticketNumber": { "type": "string" }, "statuses": { "type": "array", "items": { "type": "string", "enum": ["PENDING", "COMPLETED", "MANUAL_REVIEW", "VOID"] } }, "fieldEvents": { "minItems": 1, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "kind": { "type": "string", "enum": [ "COLLECTION", "DISPOSAL", "HAUL_OUT_COLLECTION", "HAUL_OUT_DISPOSAL", "UNIT_RATE" ] }, "splitSuffix": { "type": "string" }, "status": { "type": "string", "enum": ["PENDING", "COMPLETED", "MANUAL_REVIEW", "VOID"] }, "startedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "endedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "latitude": { "anyOf": [ { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, { "type": "null" } ] }, "address": { "type": ["string", "null"] }, "certNumber": { "type": "string" }, "loadCall": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "estimateCy": { "anyOf": [ { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, { "type": "null" } ] }, "unitCount": { "anyOf": [ { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, { "type": "null" } ] }, "debrisType": { "type": ["string", "null"] }, "site": { "type": ["string", "null"] }, "payItem": { "anyOf": [ { "type": "object", "properties": { "code": { "type": "string" }, "description": { "type": "string" } }, "required": ["code", "description"], "additionalProperties": false }, { "type": "null" } ] }, "recordedBy": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string" }, "monitorNumber": { "type": ["string", "null"] } }, "required": ["name", "monitorNumber"], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "kind", "splitSuffix", "status", "startedAt", "endedAt", "latitude", "longitude", "address", "certNumber", "loadCall", "estimateCy", "unitCount", "debrisType", "site", "payItem", "recordedBy" ], "additionalProperties": false } }, "completed": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "quantitySource": { "type": "string", "enum": ["LOAD_CALL", "SCALE_WEIGHT", "CARRIED_TICKETS"] }, "capacityCy": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "loadCall": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "volumeCy": { "anyOf": [ { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, { "type": "null" } ] }, "weightTons": { "anyOf": [ { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, { "type": "null" } ] }, "weightIsShare": { "type": "boolean" }, "carriedCount": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "collections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "collectionEventId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "splitSuffix": { "type": "string" }, "shareFraction": { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, "pileLoadCall": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "volumeCy": { "anyOf": [ { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, { "type": "null" } ] }, "weightTons": { "anyOf": [ { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, { "type": "null" } ] }, "mileage": { "anyOf": [ { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, { "type": "null" } ] }, "mileageSource": { "anyOf": [ { "type": "string", "enum": ["ROAD_ROUTE", "STRAIGHT_LINE"] }, { "type": "null" } ] } }, "required": [ "id", "collectionEventId", "splitSuffix", "shareFraction", "pileLoadCall", "volumeCy", "weightTons", "mileage", "mileageSource" ], "additionalProperties": false } } }, "required": [ "id", "quantitySource", "capacityCy", "loadCall", "volumeCy", "weightTons", "weightIsShare", "carriedCount", "collections" ], "additionalProperties": false }, { "type": "null" } ] }, "lines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "splitSuffix": { "type": "string" }, "slot": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "payItem": { "anyOf": [ { "type": "object", "properties": { "code": { "type": "string" }, "description": { "type": "string" } }, "required": ["code", "description"], "additionalProperties": false }, { "type": "null" } ] }, "unit": { "type": "string", "enum": ["CY", "TN", "EA", "LB", "HR", "CREW_DAY", "TBN"] }, "quantity": { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, "prime": { "type": ["string", "null"] }, "operatingSub": { "type": ["string", "null"] }, "rate": { "anyOf": [ { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, { "type": "null" } ] }, "amount": { "anyOf": [ { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, { "type": "null" } ] } }, "required": [ "id", "splitSuffix", "slot", "payItem", "unit", "quantity", "prime", "operatingSub", "rate", "amount" ], "additionalProperties": false } }, "flags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "code": { "type": "string", "enum": [ "DEBRIS_TYPE_MISMATCH", "CERT_NUMBER_MISMATCH", "DISPOSAL_BEFORE_COLLECTION_ENDED", "OVERLAPPING_LOADS", "SPLIT_SUFFIX_GAP", "CARRIED_COUNT_MISMATCH", "NO_CERTIFICATION", "TYPED_CAPACITY_DIFFERS", "TAG_EXPIRED", "CERTIFICATION_REVOKED", "CERTIFICATION_REPLACED", "OUTSIDE_PROJECT_BOUNDARY", "NO_ZONE", "OUTSIDE_SITE_AREA", "PROJECT_NOT_ACTIVE", "SITE_NOT_YET_ACTIVE", "SITE_CLOSED", "NO_ROAD_ROUTE", "DEVICE_CLOCK_OFF", "WORK_TIME_AFTER_RECEIVED", "WORK_TIME_BEFORE_ENROLMENT", "DEVICE_TIME_ZONE_DIFFERS", "PHONE_OUT_OF_SERVICE", "TYPED_TICKET_NUMBER", "BACK_OFFICE_RECORD", "SITE_DOES_NOT_TAKE_LOADS", "SITE_NOT_FOR_HAUL_OUTS", "INELIGIBLE_SITE", "TIPPING_FEE_RULE_MISSING", "HAUL_OUT_DUMPED_AT_TDSR", "LOAD_CALL_ZERO", "LOAD_CALL_LOW", "LOAD_CALL_HIGH", "PILE_CALL_NOT_HIGHER", "QUANTITY_MISSING_FOR_PAY_ITEM", "SHARED_SCALE_WEIGHT", "RECEIPT_TWO_DEBRIS_TYPES", "SCALE_WEIGHT_UNUSABLE", "CARRIED_TICKET_NOT_FOUND", "CARRIED_TICKET_ON_ANOTHER_LOAD", "MEASUREMENT_MISSING", "GPS_MISSING", "PHOTOS_MISSING", "DECIMAL_COUNT", "NO_SIZE_BAND", "OUTSIDE_SIZE_BAND", "MARKED_INELIGIBLE", "STUMP_UNDER_24", "ROOT_BALL_NOT_WIDER", "FILL_WITHOUT_EXPOSED_ROOT_BALL", "ROOT_BALL_MISSING", "NO_SURVEY", "CREW_ITEM_OVER_12_HOURS", "CREW_TIME_OVERLAP", "ROE_MISSING", "ROE_NOT_ON_PROJECT", "ROE_UNSIGNED", "ROE_OUT_OF_SCOPE", "NO_PRE_WORK_SURVEY", "CERTIFICATION_PHOTO_MISSING", "PERMIT_OUTSTANDING", "NO_PRICING_RULE", "DUPLICATE_TRANSACTION_NUMBER", "NO_RATE_FOR_PRIME", "RATE_TO_BE_NEGOTIATED", "NOT_PROCESSED", "DETAIL_MISSING", "TYPED_NUMBER_NO_REASON", "WRONG_KIND_OF_BADGE", "GPS_UNREADABLE", "NOT_A_TICKET_NUMBER", "ENDED_BEFORE_STARTED", "SPLIT_NOT_ALLOWED", "OUTSIDE_CONTROL_RANGES", "ASSIGNMENT_ON_ANOTHER_PROJECT", "SCALE_NET_DISAGREES", "TWO_QUANTITIES", "NOT_PROCESSED_LINES_STAND", "SUB_NAME_ALIKE", "MONITOR_NOT_SIGNED_IN", "ASSIGNMENT_OF_ANOTHER_PERSON" ] }, "message": { "type": "string" }, "raisedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "clearedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "accepted": { "type": "boolean" } }, "required": ["id", "code", "message", "raisedAt", "clearedAt", "accepted"], "additionalProperties": false } }, "photographs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fieldEventId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "scaleReceiptId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "view": { "anyOf": [ { "type": "string", "enum": [ "OPERATOR_WITH_PLACARD", "INTERIOR_OR_BACK", "RIGHT", "LEFT", "FRONT" ] }, { "type": "null" } ] }, "capturedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "uploadedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "label": { "type": ["string", "null"] } }, "required": [ "id", "fieldEventId", "scaleReceiptId", "view", "capturedAt", "uploadedAt", "label" ], "additionalProperties": false } }, "scaleReceipts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "receiptNumber": { "type": "string" }, "site": { "type": ["string", "null"] }, "grossWeightLb": { "anyOf": [ { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, { "type": "null" } ] }, "tareWeightLb": { "anyOf": [ { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, { "type": "null" } ] }, "netWeightLb": { "anyOf": [ { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, { "type": "null" } ] }, "netWeightTons": { "anyOf": [ { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" }, { "type": "null" } ] } }, "required": [ "id", "receiptNumber", "site", "grossWeightLb", "tareWeightLb", "netWeightLb", "netWeightTons" ], "additionalProperties": false } }, "itemLines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fieldEventId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "item": { "type": ["string", "null"] }, "quantity": { "type": "string", "pattern": "^-?[0-9]+(\\.[0-9]+)?$" } }, "required": ["id", "fieldEventId", "item", "quantity"], "additionalProperties": false } }, "carriedTickets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fieldEventId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "carriedTicketNumber": { "type": "string" } }, "required": ["id", "fieldEventId", "carriedTicketNumber"], "additionalProperties": false } }, "qcStatus": { "anyOf": [ { "type": "string", "enum": ["QC_REVIEW", "QC_APPROVED", "QC_ISSUES", "QC_VOID"] }, { "type": "null" } ] }, "lock": { "anyOf": [ { "type": "object", "properties": { "lockedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "batch": { "type": ["string", "null"] } }, "required": ["lockedAt", "batch"], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "workflow", "ticketNumber", "statuses", "fieldEvents", "completed", "lines", "flags", "photographs", "scaleReceipts", "itemLines", "carriedTickets", "qcStatus", "lock" ], "additionalProperties": false } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } }, "/viewer/photographs/{photoId}/files/{file}": { "get": { "operationId": "viewerPhotographFile", "summary": "A photograph’s file, or its depth file, as kept, for a viewer the database shows the photograph’s record: the bytes that were stored, under the type their own first bytes said, sent as a download and never as a page. A photograph the viewer isn’t shown is not found.", "x-open-adms-access": "SIGNED_IN", "x-open-adms-roles": ["READ_ONLY_VIEWER"], "parameters": [ { "name": "photoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "name": "file", "in": "path", "required": true, "schema": { "type": "string", "enum": ["photo", "depth"] } } ], "responses": { "200": { "description": "The answer.", "content": { "image/jpeg": { "schema": { "type": "string", "contentMediaType": "image/jpeg" } }, "image/heic": { "schema": { "type": "string", "contentMediaType": "image/heic" } }, "image/heif": { "schema": { "type": "string", "contentMediaType": "image/heif" } }, "image/png": { "schema": { "type": "string", "contentMediaType": "image/png" } }, "image/tiff": { "schema": { "type": "string", "contentMediaType": "image/tiff" } } } }, "default": { "description": "A refusal or a failure: a plain code and the request’s id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorAnswer" } } } } } } } }, "components": { "schemas": { "ErrorAnswer": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "BAD_REQUEST", "NOT_FOUND", "TOO_LARGE", "UNSUPPORTED_MEDIA_TYPE", "INTERNAL_ERROR", "PASSWORD_TOO_SHORT", "PASSWORD_TOO_LONG", "PASSWORD_BREACHED", "PASSWORD_EASY_TO_GUESS", "RESET_REFUSED", "NO_MAIL", "SIGN_IN_REFUSED", "NOT_SIGNED_IN", "CSRF_REFUSED", "PASSWORD_CHANGE_REQUIRED", "PASSWORD_WRONG", "PASSWORD_UNCHANGED", "TWO_STEP_CODE_NEEDED", "TWO_STEP_SETUP_REQUIRED", "TWO_STEP_REFUSED", "TWO_STEP_ALREADY_SET_UP", "TWO_STEP_NOT_SET_UP", "NOT_ALLOWED", "EMAIL_HELD", "LAST_ADMIN", "NOT_A_MANAGER_ANALYST", "NOT_A_VIEWER", "NOT_BACK_OFFICE", "UNKNOWN_CONTRACTOR", "UNKNOWN_PROJECT", "EMAIL_SIGNS_IN", "LIMITED", "NOT_SAVED", "ALREADY_HELD", "UNKNOWN_RECORD", "REFUSED_BY_THE_DATABASE", "ENROLMENT_REFUSED", "DEVICE_KEY_REFUSED", "PHONE_NOT_PROVEN", "MASTER_PASSCODE_NEEDED", "MASTER_PASSCODE_REFUSED", "PHONE_OUT_OF_SERVICE", "NOT_A_MONITOR", "UNAVAILABLE", "BUSY" ] }, "requestId": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "reason": { "type": "string", "minLength": 1, "maxLength": 64 }, "retryAfterSeconds": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 } }, "required": ["code", "requestId"], "additionalProperties": false } } } }