- Overview
-
Rest API Schemas
- Application schema
- Application message request
- Application message response
- Application reject request
- Application reject response
- Candidate schema
- Candidate get response
- Candidate search request
- Candidate search response
- Dossier schema
- Dossier get response
- Dossier search request
- Dossier search response
- Profile schema
- Profile get response
- Publication schema
- Publication publish request
- Publication publish response
- Publication get response
- Publication abort response
-
Integration API Schemas
- Application schema
- Application apply request
- Application apply response
- Application message request
- Application message response
- Application retract request
- Application retract response
- Application update request
- Application update response
- Publication schema
- Publication fetch response
- Publication fetched response
- Resource Schemas
- Error Schemas
Application message request
Application message request schema
JSON schema
- {
- "$schema": "http://json-schema.org/draft-04/schema",
- "id": "http://api.xeebo.com/schema/xeebo-rest-application-message-request-schema-v1.0.0.json",
- "title": "Application message request",
- "description": "Application message request schema",
- "type": "object",
- "properties": {
- "version": {
- "title": "Application message schema version",
- "$ref": "http://api.xeebo.com/schema/xeebo-rest-application-schema-v1.0.0.json#/definitions/versionType"
- },
- "message": {
- "title": "Message",
- "description": "Message data",
- "type": "object",
- "properties": {
- "id": {
- "title": "Message id",
- "description": "The message id (used for reference by inReplyTo)",
- "$ref": "http://api.xeebo.com/schema/xeebo-rest-application-schema-v1.0.0.json#/definitions/idMessageType"
- },
- "inReplyTo": {
- "title": "In reply to",
- "description": "The message reference id this message references",
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ]
- },
- "subject": {
- "title": "Subject",
- "description": "The message subject",
- "type": "string"
- },
- "body": {
- "title": "Body",
- "description": "The message body text",
- "type": "string"
- },
- "date": {
- "title": "Message sending date",
- "description": "The date the message was sent",
- "$ref": "http://api.xeebo.com/schema/xeebo-rest-application-schema-v1.0.0.json#/definitions/dateType"
- }
- },
- "required": [
- "id",
- "subject",
- "body",
- "date"
- ],
- "additionalProperties": false
- }
- },
- "required": [
- "version",
- "message"
- ],
- "additionalProperties": false
- }
JSON schema data description
Path/Attribute | Title | Description | Required |
---|