Process BIM Service

The Process BIM Service is used to process a raw BIM message that creates a new bag or updates an existing bag and records the event. When the BIM message is not BagJourney compliant, BagJourney logs the non-compliant information in the log file and returns the error messages. The API is provided with a mandatory Customer Service API Key and raw BIM as a JSON input.

The Process BIM Service operation is a HTTP POST request with mandatory parameters. The response of this operation will be in JSON format.

POST

Verb URI Structure
POST https://bagjourney.sita.aero/baggage/processbim/v1.0/

Request Parameters

Key Value Description Format
bim_message String Raw BIM that creates new bag or updates an existing bag

Request Query Parameters

Key Value Mandatory Description
apiKey String True The API key to identify the customer

Request Query JSON Response

The request will return a response in the following standard format:

JSON schema for processBIM Response


{
	"type":"object",
	"description":"Process BIM",
	"required":true,
	"properties":{
		"success" : {			
			"type": "boolean",
			"required": true,
			"description":"Success"
		},
		"success_code" : {			
			"type": "string",
			"required": false,
			"description":"Code returned by the system after successful creation of user"
		},
		"success_message" : {			
			"type": "string",
			"required": false,
			"description":"Message returned by the system after successful creation of user"
		},
		"warnings" : { 
				"required": false, 
				"type": "array", 
				"description":"List of Warnings", 
			"items": 
			{ 
				"type":"object", 
                "description":"Warnings", 
                "required":false, 
                "properties":{ 
                        "warning_code": { 
                                "type":"string", 
                                "description":"Warning code of the message", 
                                "required":true 
                        }, 
                        "warning_description": { 
                                "type":"string", 
                                "description":"Warning description corresponding to the Error code", 
                                "required":true 
                        } 
				}	 
			} 
		},		
		"errors" : { 
				"required": false, 
				"type": "array", 
				"description":"List of Errors", 
			"items": 
			{ 
				"type":"object", 
                "description":"Error", 
                "required":false, 
                "properties":{ 
                        "error_code": { 
                                "type":"string", 
                                "description":"Error code of the message", 
                                "required":true 
                        }, 
                        "error_description": { 
                                "type":"string", 
                                "description":"Error description corresponding to the Error code", 
                                "required":true 
                        } 
				}	 
			} 
		}
	}
}

Responses

Sample Response - Success
HTTP Code Text Description
200 OK Success
JSONP

1.



{
   "success": true,
   "success_code": "BJYPRB027",
   "message" : "Message processed successfully "
  }


  

2.


{
   "success": true,
   "success_code": "BJYPRB037",
   "success_message": "Message processed successfully",
   "warnings": [   {
      "warning_code": "BJYPRB025",
      "warning_message": ".W not IATA compliant for Weight Indicator and/or Number of Checked Bags and/or Checked Weight"
   }]
}




Sample Response - Failure
HTTP Code Text Description
400 Bad Request The request is invalid. On violation of not providing mandatory fields or any data kind validation on request parameters except for API Key.
401 Unauthorized
  1. Customer Service API Key is mandatory
  2. Customer Service API Key does not exist
  3. Customer Application not authorized to process BPM
402 Not Found Resource not found


JSONP – Sample response for HTTP Code 400


{
   "success": false,
   "errors": [
{"error_code": "BJYPRB039","error_description": "BSM does not contain .V Element"},
{"error_code": "BJYPRB040","error_description": "BSM does not contain End of BSM Message Identifier"},
{"error_code": "BJYPRB041","error_description": "BSM does not contain .F Element"},

{"error_code": "BJYPRB001","error_description": "Customer Service API Key is mandatory"},
{"error_code": "BJYPRB002","error_description": "Customer Service API Key does not exist"},
{"error_code": "BJYPRB003","error_description": "Raw BPM is mandatory"},
{"error_code": "BJYPRB004","error_description": "BPM does not contain BPM Message Identifier"},
{"error_code": "BJYPRB005","error_description": "BPM does not contain .V Element"},
{"error_code": "BJYPRB006","error_description": "BPM does not contain .F Element, when .U Element is present and contains Stowage Device Id and/or Aircraft Compartment Id"},
{"error_code": "BJYPRB007","error_description": "BPM does not contain .N Element"},
{"error_code": "BJYPRB008","error_description": "BPM does not contain .N Element or .B Element, when BPM is not used for Container positioning"},
{"error_code": "BJYPRB009","error_description": "BPM does not contain .B Element"},
{"error_code": "BJYPRB010","error_description": "BPM does not contain .N Element or .B Element, when BPM is not used for Container positioning"},
{"error_code": "BJYPRB011","error_description": "Incorrect message identifier"},
{"error_code": "BJYPRB012","error_description": "V is strictly less than 8 characters"},
{"error_code": "BJYPRB013","error_description": "Incorrect version number},
{"error_code": "BJYPRB014","error_description": "Incorrect baggage source indicator"},
{"error_code": "BJYPRB015","error_description": "Invalid airport code in .V"},
{"error_code": "BJYPRB016","error_description": ".N is not equal to 16 characters"},
{"error_code": "BJYPRB017","error_description": "Invalid tag number"},
{"error_code": "BJYPRB018","error_description": ".B is not equal to 20 characters"},
{"error_code": "BJYPRB019","error_description": "Invalid tag number},
{"error_code": "BJYPRB020","error_description": "<Flight Type> is strictly less than 16 characters"},
{"error_code": "BJYPRB021","error_description": "Flight number in <Flight Type> is strictly more than 8 characters"},
{"error_code": "BJYPRB022","error_description": "Date in <Flight Type> is not equal to 5 characters"},
{"error_code": "BJYPRB023","error_description": "Invalid airport code in .F"},
{"error_code": "BJYPRB027","error_description": ".B not IATA compliant for Baggage Status Code at Airport <Airport Code in .V>"},
{"error_code": "BJYSRV001","error_description": "System is currently unavailable, please contact SITA Administrator"}
   ]
}