Martide API Documentation
Welcome to the API Documentation!
API Endpoints
https://api.martide.com/companyHeaders
Authorization: Bearer <YOUR_TOKEN_HERE>Travel Agencies
Travel Agencies API
Queries
assignments
Description
List assignments of the company
Response
Returns a ListAssignments
Example
Query
query Assignments(
$page: Int,
$pageSize: Int
) {
assignments(
page: $page,
pageSize: $pageSize
) {
assignments {
id
changeOverDate
listingExpireDate
daysLeft
vesselTradingArea
minAndMaxPrice
budgetMin
budgetMax
activated
public
currencyCode
budgetUnit
contractLength
hiresNeeded
contractLengthType
type
contractVariance
slug
status
description
timeInRank
timeInRankUnit
timeOnVessel
timeOnVesselUnit
visaTypes {
...VisaTypeFragment
}
vessel {
...VesselFragment
}
creator {
...AccountFragment
}
manningAgents {
...CompanyFragment
}
nationalityRequirements {
...CountryFragment
}
company {
...JobCompanyFragment
}
vesselType
ranksDocumentTypes
documentTypesName
documentTypes
toHire
toApply
profiles
crewSlotHistory {
...CrewSlotHistoryFragment
}
candidates {
...CandidateFragment
}
assignments {
...AssignmentFragment
}
companySeafarerRank {
...CompanySeafarerRankFragment
}
timeWithTechnicalOperatorUnit
timeWithTechnicalOperator
exCrewCount
recruited
hired
applied
jobType
commentForCandidate
commentForManningAgent
minimumExperienceYears
}
pagination {
pageNumber
pageSize
totalEntries
totalPages
}
}
}
Variables
{"page": 987, "pageSize": 123}
Response
{
"data": {
"assignments": {
"assignments": [Job],
"pagination": PaginationInfo
}
}
}
companyPublicJobs
Description
retrieves company public jobs
Example
Query
query CompanyPublicJobs($companyId: Uuid!) {
companyPublicJobs(companyId: $companyId) {
id
changeOverDate
listingExpireDate
daysLeft
vesselTradingArea
minAndMaxPrice
budgetMin
budgetMax
activated
public
currencyCode
budgetUnit
contractLength
hiresNeeded
contractLengthType
type
contractVariance
slug
status
description
timeInRank
timeInRankUnit
timeOnVessel
timeOnVesselUnit
visaTypes {
id
type
name
isoName
country {
...CountryFragment
}
}
vessel {
id
name
imo
mmsi
length
width
photoThumb
photoOriginal
photo
yearBuilt
dwt
tradingPattern
specialEquipment
teu
vesselCompanyName
logo
vesselType {
...VesselTypeFragment
}
engine {
...EngineFragment
}
ecdis {
...EcdisFragment
}
vesselContacts {
...VesselContactFragment
}
clientCompanies {
...CompanyFragment
}
protectionAndIndemnityClub {
...ProtectionAndIndemnityClubFragment
}
classificationSociety {
...ClassificationSocietyFragment
}
itfUnion {
...ItfUnionFragment
}
flag {
...CountryFragment
}
managers {
...VesselManagerFragment
}
crewHistories {
...CrewSlotHistoryFragment
}
slots {
...SlotFragment
}
onboardEmbarkations {
...EmbarkationFragment
}
embarkations {
...EmbarkationFragment
}
account {
...VesselAccountFragment
}
vesselPosition {
...VesselPositionFragment
}
handoverDurations {
...HandoverDurationFragment
}
vesselMinimumSafeMannings {
...VesselMinimumSafeManningFragment
}
previousManagers {
...PreviousManagerFragment
}
previousNames {
...VesselPreviousNameFragment
}
documents {
...VesselDocumentFragment
}
crewCompliments {
...CrewComplimentFragment
}
companyVessel {
...CompanyVesselFragment
}
grossTonnage
draught
cargo
callsign
craneType
itfCovered
wLeft
lFore
propeller
decksNumber
hullType
hullMaterial
insurer
grain
liquidGas
liquidOil
grossRegisteredTonnage
netRegisteredTonnage
speedService
speedMax
fuelConsumption
lengthBWPerpendiculars
lengthOverall
displacementSummer
summerDwt
depth
breadthMoulded
breadthExtreme
yardNumber
placeOfBuild
builder
eni
status
}
creator {
id
email
firstName
lastName
avatar
company {
...CompanyFragment
}
}
manningAgents {
id
closedOn
description
email
employeesCount
foundedOn
logo
location
name
status
slug
url
active
type
country {
...CountryFragment
}
vessels {
...VesselFragment
}
addresses {
...AddressFragment
}
}
nationalityRequirements {
id
visaType
iso
iso3
isoName
name
numcode
states {
...StateFragment
}
visaTypes {
...VisaTypeFragment
}
}
company {
name
description
country {
...CountryFragment
}
email
url
slug
}
vesselType
ranksDocumentTypes
documentTypesName
documentTypes
toHire
toApply
profiles
crewSlotHistory {
status
startDate
endDate
slot {
...SlotFragment
}
}
candidates {
id
email
firstName
aboutMe
type
gender
maritalStatus
jobStatus
lastName
middleName
salutation
avatar
resume {
...ResumeFragment
}
facebookProfile
twitterProfile
linkedinProfile
dateOfBirth
placeOfBirth
birthProvince
pseudoId
isDeleted
allowSavedSearch
isSubscribedToNewsletter
emailConfirmedAt
timezone
locationStatus
localAirportIataCode
hairColour
eyeColour
overallsSize
shoeSize
collarSize
capSize
weight
height
bmi
bloodType
weightUnit
heightUnit
shoeSizeUnit
collarSizeUnit
capSizeUnit
bankAccounts {
...BankAccountFragment
}
addresses {
...AddressFragment
}
documents {
...DocumentFragment
}
assessmentTests {
...AssessmentTestFragment
}
medicalDocuments {
...MedicalDocumentFragment
}
payslips {
...PayslipFragment
}
appraisals {
...AppraisalFragment
}
visas {
...VisaFragment
}
workHistories {
...WorkHistoryFragment
}
educations {
...EducationFragment
}
jobPreference {
...JobPreferenceFragment
}
languages {
...LanguageFragment
}
emergencyContact {
...EmergencyContactFragment
}
nextOfKinContact {
...NextOfKinContactFragment
}
socialMedias {
...SocialMediaFragment
}
messengers {
...MessengerFragment
}
specialSkills {
...SpecialSkillFragment
}
workSummary {
...WorkSummaryFragment
}
contracts {
...ContractFragment
}
localAirport {
...AirportFragment
}
nationality {
...CountryFragment
}
birthCountry {
...CountryFragment
}
residence {
...CountryFragment
}
termsAccepted
embarkations {
...EmbarkationFragment
}
insertedAt
updatedAt
currentRecruiter {
...CandidateRecruiterFragment
}
currentLeadSource {
...CandidateLeadSourceFragment
}
seafarerRank {
...SeafarerRankFragment
}
nationalitiesSailedWith {
...CountryFragment
}
seafarerPools {
...SeafarerPoolFragment
}
trainings {
...TrainingFragment
}
candidateClientStatuses {
...CandidateClientStatusFragment
}
candidateStatus {
...CandidateStatusFragment
}
phones {
...PhoneFragment
}
manningBy {
...CompanyFragment
}
createdBy {
...CompanyFragment
}
maxCrewComplementSailedWith
tradingAreas
nseNsid
}
assignments {
message
profiles {
...MapItemFragment
}
assignmentState
rejectedState
rejectedStageId
rejectionReason
rejectedDatetime
acceptedStates
acceptedStageIds
approvalRequestStageIds
overridedStageIds
hasQuestionnaireSubmitted
hasSendQuestionnaire
leftHomeTicketDetail
arrivedHomeTicketDetail
type
candidate {
...CandidateFragment
}
appliedByAccount {
...AccountFragment
}
appliedByCompany {
...CompanyFragment
}
hiredByAccount {
...AccountFragment
}
transferredFrom {
...AssignmentFragment
}
transferredTo {
...AssignmentFragment
}
rejectedByAccount {
...AccountFragment
}
withdrawnByCandidate {
...CandidateFragment
}
form {
...AssignmentFormFragment
}
proposal {
...ProposalFragment
}
seaServiceChecks {
...SeaServiceCheckFragment
}
contactInterviews {
...ContactInterviewFragment
}
assignmentNotes {
...AssignmentNoteFragment
}
documentStatuses {
...DocumentStatusFragment
}
documents {
...DocumentFragment
}
assignmentApproveHistories {
...AssignmentApproveHistoryFragment
}
medicalDocuments {
...DocumentFragment
}
vaccinations {
...DocumentFragment
}
embarkation {
...EmbarkationFragment
}
contracts {
...ContractFragment
}
}
companySeafarerRank {
id
customName
originalName
active
abbreviation
seafarerRank {
...SeafarerRankFragment
}
}
timeWithTechnicalOperatorUnit
timeWithTechnicalOperator
exCrewCount
recruited
hired
applied
jobType
commentForCandidate
commentForManningAgent
minimumExperienceYears
}
}
Variables
{"companyId": Uuid}
Response
{
"data": {
"companyPublicJobs": [
{
"id": Uuid,
"changeOverDate": "2007-12-03",
"listingExpireDate": "2007-12-03",
"daysLeft": "abc123",
"vesselTradingArea": "abc123",
"minAndMaxPrice": "xyz789",
"budgetMin": Decimal,
"budgetMax": Decimal,
"activated": true,
"public": true,
"currencyCode": "xyz789",
"budgetUnit": "xyz789",
"contractLength": 987,
"hiresNeeded": 987,
"contractLengthType": "xyz789",
"type": "xyz789",
"contractVariance": 987,
"slug": "abc123",
"status": "xyz789",
"description": "abc123",
"timeInRank": 987,
"timeInRankUnit": "xyz789",
"timeOnVessel": 123,
"timeOnVesselUnit": "xyz789",
"visaTypes": [VisaType],
"vessel": Vessel,
"creator": Account,
"manningAgents": [Company],
"nationalityRequirements": [Country],
"company": JobCompany,
"vesselType": "xyz789",
"ranksDocumentTypes": ["xyz789"],
"documentTypesName": ["abc123"],
"documentTypes": [Uuid],
"toHire": ["abc123"],
"toApply": ["abc123"],
"profiles": ["abc123"],
"crewSlotHistory": CrewSlotHistory,
"candidates": [Candidate],
"assignments": [Assignment],
"companySeafarerRank": CompanySeafarerRank,
"timeWithTechnicalOperatorUnit": "abc123",
"timeWithTechnicalOperator": 987,
"exCrewCount": 123,
"recruited": 123,
"hired": 123,
"applied": 123,
"jobType": "abc123",
"commentForCandidate": "xyz789",
"commentForManningAgent": "xyz789",
"minimumExperienceYears": 987
}
]
}
}
crewChanges
Description
List crew changes of the company
Response
Returns a ListCrewChanges
Example
Query
query CrewChanges(
$page: Int,
$pageSize: Int
) {
crewChanges(
page: $page,
pageSize: $pageSize
) {
crewChanges {
id
onSignersDate
offSignersDate
portLocode
airportIataCode
vessel {
...VesselFragment
}
ports {
...CrewChangePortFragment
}
status
type {
...CrewChangeTypeFragment
}
offSignersCount
offSigners {
...PassengerFragment
}
onSignersCount
onSigners {
...PassengerFragment
}
}
pagination {
pageNumber
pageSize
totalEntries
totalPages
}
}
}
Variables
{"page": 123, "pageSize": 123}
Response
{
"data": {
"crewChanges": {
"crewChanges": [CrewChange],
"pagination": PaginationInfo
}
}
}
flights
Description
List flights on a crew change
Response
Returns a ListFlights
Example
Query
query Flights(
$crewChangeId: Uuid!,
$page: Int,
$pageSize: Int
) {
flights(
crewChangeId: $crewChangeId,
page: $page,
pageSize: $pageSize
) {
flights {
id
state
price
ticketConditions
sent
currencyCode
passengerTrip {
...PassengerTripFragment
}
passenger {
...PassengerFragment
}
legs {
...FlightLegFragment
}
eTickets {
...AttachmentFragment
}
checkedInBaggageCount
checkedInBaggageWeight
carryOnBaggageCount
}
pagination {
pageNumber
pageSize
totalEntries
totalPages
}
}
}
Variables
{"crewChangeId": Uuid, "page": 123, "pageSize": 123}
Response
{
"data": {
"flights": {
"flights": [Flight],
"pagination": PaginationInfo
}
}
}
jobSearch
Description
retrieves jobs with the args filter and order
Response
Returns [Job]
Example
Query
query JobSearch(
$limit: Int,
$offset: Int,
$filter: JobFilter,
$order: SortOrder
) {
jobSearch(
limit: $limit,
offset: $offset,
filter: $filter,
order: $order
) {
id
changeOverDate
listingExpireDate
daysLeft
vesselTradingArea
minAndMaxPrice
budgetMin
budgetMax
activated
public
currencyCode
budgetUnit
contractLength
hiresNeeded
contractLengthType
type
contractVariance
slug
status
description
timeInRank
timeInRankUnit
timeOnVessel
timeOnVesselUnit
visaTypes {
id
type
name
isoName
country {
...CountryFragment
}
}
vessel {
id
name
imo
mmsi
length
width
photoThumb
photoOriginal
photo
yearBuilt
dwt
tradingPattern
specialEquipment
teu
vesselCompanyName
logo
vesselType {
...VesselTypeFragment
}
engine {
...EngineFragment
}
ecdis {
...EcdisFragment
}
vesselContacts {
...VesselContactFragment
}
clientCompanies {
...CompanyFragment
}
protectionAndIndemnityClub {
...ProtectionAndIndemnityClubFragment
}
classificationSociety {
...ClassificationSocietyFragment
}
itfUnion {
...ItfUnionFragment
}
flag {
...CountryFragment
}
managers {
...VesselManagerFragment
}
crewHistories {
...CrewSlotHistoryFragment
}
slots {
...SlotFragment
}
onboardEmbarkations {
...EmbarkationFragment
}
embarkations {
...EmbarkationFragment
}
account {
...VesselAccountFragment
}
vesselPosition {
...VesselPositionFragment
}
handoverDurations {
...HandoverDurationFragment
}
vesselMinimumSafeMannings {
...VesselMinimumSafeManningFragment
}
previousManagers {
...PreviousManagerFragment
}
previousNames {
...VesselPreviousNameFragment
}
documents {
...VesselDocumentFragment
}
crewCompliments {
...CrewComplimentFragment
}
companyVessel {
...CompanyVesselFragment
}
grossTonnage
draught
cargo
callsign
craneType
itfCovered
wLeft
lFore
propeller
decksNumber
hullType
hullMaterial
insurer
grain
liquidGas
liquidOil
grossRegisteredTonnage
netRegisteredTonnage
speedService
speedMax
fuelConsumption
lengthBWPerpendiculars
lengthOverall
displacementSummer
summerDwt
depth
breadthMoulded
breadthExtreme
yardNumber
placeOfBuild
builder
eni
status
}
creator {
id
email
firstName
lastName
avatar
company {
...CompanyFragment
}
}
manningAgents {
id
closedOn
description
email
employeesCount
foundedOn
logo
location
name
status
slug
url
active
type
country {
...CountryFragment
}
vessels {
...VesselFragment
}
addresses {
...AddressFragment
}
}
nationalityRequirements {
id
visaType
iso
iso3
isoName
name
numcode
states {
...StateFragment
}
visaTypes {
...VisaTypeFragment
}
}
company {
name
description
country {
...CountryFragment
}
email
url
slug
}
vesselType
ranksDocumentTypes
documentTypesName
documentTypes
toHire
toApply
profiles
crewSlotHistory {
status
startDate
endDate
slot {
...SlotFragment
}
}
candidates {
id
email
firstName
aboutMe
type
gender
maritalStatus
jobStatus
lastName
middleName
salutation
avatar
resume {
...ResumeFragment
}
facebookProfile
twitterProfile
linkedinProfile
dateOfBirth
placeOfBirth
birthProvince
pseudoId
isDeleted
allowSavedSearch
isSubscribedToNewsletter
emailConfirmedAt
timezone
locationStatus
localAirportIataCode
hairColour
eyeColour
overallsSize
shoeSize
collarSize
capSize
weight
height
bmi
bloodType
weightUnit
heightUnit
shoeSizeUnit
collarSizeUnit
capSizeUnit
bankAccounts {
...BankAccountFragment
}
addresses {
...AddressFragment
}
documents {
...DocumentFragment
}
assessmentTests {
...AssessmentTestFragment
}
medicalDocuments {
...MedicalDocumentFragment
}
payslips {
...PayslipFragment
}
appraisals {
...AppraisalFragment
}
visas {
...VisaFragment
}
workHistories {
...WorkHistoryFragment
}
educations {
...EducationFragment
}
jobPreference {
...JobPreferenceFragment
}
languages {
...LanguageFragment
}
emergencyContact {
...EmergencyContactFragment
}
nextOfKinContact {
...NextOfKinContactFragment
}
socialMedias {
...SocialMediaFragment
}
messengers {
...MessengerFragment
}
specialSkills {
...SpecialSkillFragment
}
workSummary {
...WorkSummaryFragment
}
contracts {
...ContractFragment
}
localAirport {
...AirportFragment
}
nationality {
...CountryFragment
}
birthCountry {
...CountryFragment
}
residence {
...CountryFragment
}
termsAccepted
embarkations {
...EmbarkationFragment
}
insertedAt
updatedAt
currentRecruiter {
...CandidateRecruiterFragment
}
currentLeadSource {
...CandidateLeadSourceFragment
}
seafarerRank {
...SeafarerRankFragment
}
nationalitiesSailedWith {
...CountryFragment
}
seafarerPools {
...SeafarerPoolFragment
}
trainings {
...TrainingFragment
}
candidateClientStatuses {
...CandidateClientStatusFragment
}
candidateStatus {
...CandidateStatusFragment
}
phones {
...PhoneFragment
}
manningBy {
...CompanyFragment
}
createdBy {
...CompanyFragment
}
maxCrewComplementSailedWith
tradingAreas
nseNsid
}
assignments {
message
profiles {
...MapItemFragment
}
assignmentState
rejectedState
rejectedStageId
rejectionReason
rejectedDatetime
acceptedStates
acceptedStageIds
approvalRequestStageIds
overridedStageIds
hasQuestionnaireSubmitted
hasSendQuestionnaire
leftHomeTicketDetail
arrivedHomeTicketDetail
type
candidate {
...CandidateFragment
}
appliedByAccount {
...AccountFragment
}
appliedByCompany {
...CompanyFragment
}
hiredByAccount {
...AccountFragment
}
transferredFrom {
...AssignmentFragment
}
transferredTo {
...AssignmentFragment
}
rejectedByAccount {
...AccountFragment
}
withdrawnByCandidate {
...CandidateFragment
}
form {
...AssignmentFormFragment
}
proposal {
...ProposalFragment
}
seaServiceChecks {
...SeaServiceCheckFragment
}
contactInterviews {
...ContactInterviewFragment
}
assignmentNotes {
...AssignmentNoteFragment
}
documentStatuses {
...DocumentStatusFragment
}
documents {
...DocumentFragment
}
assignmentApproveHistories {
...AssignmentApproveHistoryFragment
}
medicalDocuments {
...DocumentFragment
}
vaccinations {
...DocumentFragment
}
embarkation {
...EmbarkationFragment
}
contracts {
...ContractFragment
}
}
companySeafarerRank {
id
customName
originalName
active
abbreviation
seafarerRank {
...SeafarerRankFragment
}
}
timeWithTechnicalOperatorUnit
timeWithTechnicalOperator
exCrewCount
recruited
hired
applied
jobType
commentForCandidate
commentForManningAgent
minimumExperienceYears
}
}
Variables
{
"limit": 123,
"offset": 123,
"filter": JobFilter,
"order": "ASC"
}
Response
{
"data": {
"jobSearch": [
{
"id": Uuid,
"changeOverDate": "2007-12-03",
"listingExpireDate": "2007-12-03",
"daysLeft": "xyz789",
"vesselTradingArea": "abc123",
"minAndMaxPrice": "xyz789",
"budgetMin": Decimal,
"budgetMax": Decimal,
"activated": false,
"public": true,
"currencyCode": "abc123",
"budgetUnit": "xyz789",
"contractLength": 987,
"hiresNeeded": 123,
"contractLengthType": "xyz789",
"type": "xyz789",
"contractVariance": 123,
"slug": "xyz789",
"status": "xyz789",
"description": "xyz789",
"timeInRank": 123,
"timeInRankUnit": "abc123",
"timeOnVessel": 987,
"timeOnVesselUnit": "xyz789",
"visaTypes": [VisaType],
"vessel": Vessel,
"creator": Account,
"manningAgents": [Company],
"nationalityRequirements": [Country],
"company": JobCompany,
"vesselType": "abc123",
"ranksDocumentTypes": ["xyz789"],
"documentTypesName": ["abc123"],
"documentTypes": [Uuid],
"toHire": ["abc123"],
"toApply": ["xyz789"],
"profiles": ["xyz789"],
"crewSlotHistory": CrewSlotHistory,
"candidates": [Candidate],
"assignments": [Assignment],
"companySeafarerRank": CompanySeafarerRank,
"timeWithTechnicalOperatorUnit": "xyz789",
"timeWithTechnicalOperator": 987,
"exCrewCount": 987,
"recruited": 123,
"hired": 987,
"applied": 987,
"jobType": "xyz789",
"commentForCandidate": "abc123",
"commentForManningAgent": "abc123",
"minimumExperienceYears": 987
}
]
}
}
recruitments
Description
List recruitments of the company
Response
Returns a ListRecruitments
Example
Query
query Recruitments(
$page: Int,
$pageSize: Int
) {
recruitments(
page: $page,
pageSize: $pageSize
) {
recruitments {
id
changeOverDate
listingExpireDate
daysLeft
vesselTradingArea
minAndMaxPrice
budgetMin
budgetMax
activated
public
currencyCode
budgetUnit
contractLength
hiresNeeded
contractLengthType
type
contractVariance
slug
status
description
timeInRank
timeInRankUnit
timeOnVessel
timeOnVesselUnit
visaTypes {
...VisaTypeFragment
}
vessel {
...VesselFragment
}
creator {
...AccountFragment
}
manningAgents {
...CompanyFragment
}
nationalityRequirements {
...CountryFragment
}
company {
...JobCompanyFragment
}
vesselType
ranksDocumentTypes
documentTypesName
documentTypes
toHire
toApply
profiles
crewSlotHistory {
...CrewSlotHistoryFragment
}
candidates {
...CandidateFragment
}
assignments {
...AssignmentFragment
}
companySeafarerRank {
...CompanySeafarerRankFragment
}
timeWithTechnicalOperatorUnit
timeWithTechnicalOperator
exCrewCount
recruited
hired
applied
jobType
commentForCandidate
commentForManningAgent
minimumExperienceYears
}
pagination {
pageNumber
pageSize
totalEntries
totalPages
}
}
}
Variables
{"page": 987, "pageSize": 123}
Response
{
"data": {
"recruitments": {
"recruitments": [Job],
"pagination": PaginationInfo
}
}
}
seafarers
Description
List seafarers of the company
Response
Returns a ListSeafarers
Example
Query
query Seafarers(
$page: Int,
$pageSize: Int
) {
seafarers(
page: $page,
pageSize: $pageSize
) {
seafarers {
id
email
firstName
aboutMe
type
gender
maritalStatus
jobStatus
lastName
middleName
salutation
avatar
resume {
...ResumeFragment
}
facebookProfile
twitterProfile
linkedinProfile
dateOfBirth
placeOfBirth
birthProvince
pseudoId
isDeleted
allowSavedSearch
isSubscribedToNewsletter
emailConfirmedAt
timezone
locationStatus
localAirportIataCode
hairColour
eyeColour
overallsSize
shoeSize
collarSize
capSize
weight
height
bmi
bloodType
weightUnit
heightUnit
shoeSizeUnit
collarSizeUnit
capSizeUnit
bankAccounts {
...BankAccountFragment
}
addresses {
...AddressFragment
}
documents {
...DocumentFragment
}
assessmentTests {
...AssessmentTestFragment
}
medicalDocuments {
...MedicalDocumentFragment
}
payslips {
...PayslipFragment
}
appraisals {
...AppraisalFragment
}
visas {
...VisaFragment
}
workHistories {
...WorkHistoryFragment
}
educations {
...EducationFragment
}
jobPreference {
...JobPreferenceFragment
}
languages {
...LanguageFragment
}
emergencyContact {
...EmergencyContactFragment
}
nextOfKinContact {
...NextOfKinContactFragment
}
socialMedias {
...SocialMediaFragment
}
messengers {
...MessengerFragment
}
specialSkills {
...SpecialSkillFragment
}
workSummary {
...WorkSummaryFragment
}
contracts {
...ContractFragment
}
localAirport {
...AirportFragment
}
nationality {
...CountryFragment
}
birthCountry {
...CountryFragment
}
residence {
...CountryFragment
}
termsAccepted
embarkations {
...EmbarkationFragment
}
insertedAt
updatedAt
currentRecruiter {
...CandidateRecruiterFragment
}
currentLeadSource {
...CandidateLeadSourceFragment
}
seafarerRank {
...SeafarerRankFragment
}
nationalitiesSailedWith {
...CountryFragment
}
seafarerPools {
...SeafarerPoolFragment
}
trainings {
...TrainingFragment
}
candidateClientStatuses {
...CandidateClientStatusFragment
}
candidateStatus {
...CandidateStatusFragment
}
phones {
...PhoneFragment
}
manningBy {
...CompanyFragment
}
createdBy {
...CompanyFragment
}
maxCrewComplementSailedWith
tradingAreas
nseNsid
}
pagination {
pageNumber
pageSize
totalEntries
totalPages
}
}
}
Variables
{"page": 123, "pageSize": 987}
Response
{
"data": {
"seafarers": {
"seafarers": [Candidate],
"pagination": PaginationInfo
}
}
}
vessels
Description
List vessels of the company
Response
Returns a ListVessels
Example
Query
query Vessels(
$page: Int,
$pageSize: Int
) {
vessels(
page: $page,
pageSize: $pageSize
) {
vessels {
id
name
imo
mmsi
length
width
photoThumb
photoOriginal
photo
yearBuilt
dwt
tradingPattern
specialEquipment
teu
vesselCompanyName
logo
vesselType {
...VesselTypeFragment
}
engine {
...EngineFragment
}
ecdis {
...EcdisFragment
}
vesselContacts {
...VesselContactFragment
}
clientCompanies {
...CompanyFragment
}
protectionAndIndemnityClub {
...ProtectionAndIndemnityClubFragment
}
classificationSociety {
...ClassificationSocietyFragment
}
itfUnion {
...ItfUnionFragment
}
flag {
...CountryFragment
}
managers {
...VesselManagerFragment
}
crewHistories {
...CrewSlotHistoryFragment
}
slots {
...SlotFragment
}
onboardEmbarkations {
...EmbarkationFragment
}
embarkations {
...EmbarkationFragment
}
account {
...VesselAccountFragment
}
vesselPosition {
...VesselPositionFragment
}
handoverDurations {
...HandoverDurationFragment
}
vesselMinimumSafeMannings {
...VesselMinimumSafeManningFragment
}
previousManagers {
...PreviousManagerFragment
}
previousNames {
...VesselPreviousNameFragment
}
documents {
...VesselDocumentFragment
}
crewCompliments {
...CrewComplimentFragment
}
companyVessel {
...CompanyVesselFragment
}
grossTonnage
draught
cargo
callsign
craneType
itfCovered
wLeft
lFore
propeller
decksNumber
hullType
hullMaterial
insurer
grain
liquidGas
liquidOil
grossRegisteredTonnage
netRegisteredTonnage
speedService
speedMax
fuelConsumption
lengthBWPerpendiculars
lengthOverall
displacementSummer
summerDwt
depth
breadthMoulded
breadthExtreme
yardNumber
placeOfBuild
builder
eni
status
}
pagination {
pageNumber
pageSize
totalEntries
totalPages
}
}
}
Variables
{"page": 123, "pageSize": 987}
Response
{
"data": {
"vessels": {
"vessels": [Vessel],
"pagination": PaginationInfo
}
}
}
Mutations
addFlightOption
Description
Add flight option to a crew change
Response
Returns an UpsertFlight
Arguments
| Name | Description |
|---|---|
input - AddFlightInput!
|
Example
Query
mutation AddFlightOption($input: AddFlightInput!) {
addFlightOption(input: $input) {
flight {
id
state
price
ticketConditions
sent
currencyCode
passengerTrip {
...PassengerTripFragment
}
passenger {
...PassengerFragment
}
legs {
...FlightLegFragment
}
eTickets {
...AttachmentFragment
}
checkedInBaggageCount
checkedInBaggageWeight
carryOnBaggageCount
}
errors {
key
message
}
success {
message
}
}
}
Variables
{"input": AddFlightInput}
Response
{
"data": {
"addFlightOption": {
"flight": Flight,
"errors": [InputError],
"success": SuccessInput
}
}
}
deleteFlightOption
Description
Delete flight option
Response
Returns a DeleteFlight
Arguments
| Name | Description |
|---|---|
flightId - Uuid!
|
Example
Query
mutation DeleteFlightOption($flightId: Uuid!) {
deleteFlightOption(flightId: $flightId) {
errors {
key
message
}
success {
message
}
deleted
deletedRecordId
}
}
Variables
{"flightId": Uuid}
Response
{
"data": {
"deleteFlightOption": {
"errors": [InputError],
"success": SuccessInput,
"deleted": true,
"deletedRecordId": Uuid
}
}
}
updateFlightOption
Description
Update flight option
Response
Returns an UpsertFlight
Arguments
| Name | Description |
|---|---|
flightId - Uuid!
|
|
input - UpdateFlightInput!
|
Example
Query
mutation UpdateFlightOption(
$flightId: Uuid!,
$input: UpdateFlightInput!
) {
updateFlightOption(
flightId: $flightId,
input: $input
) {
flight {
id
state
price
ticketConditions
sent
currencyCode
passengerTrip {
...PassengerTripFragment
}
passenger {
...PassengerFragment
}
legs {
...FlightLegFragment
}
eTickets {
...AttachmentFragment
}
checkedInBaggageCount
checkedInBaggageWeight
carryOnBaggageCount
}
errors {
key
message
}
success {
message
}
}
}
Variables
{
"flightId": Uuid,
"input": UpdateFlightInput
}
Response
{
"data": {
"updateFlightOption": {
"flight": Flight,
"errors": [InputError],
"success": SuccessInput
}
}
}
Types
Account
AddFlightInput
Fields
| Input Field | Description |
|---|---|
passengerTripId - Uuid!
|
|
price - Decimal!
|
|
currencyCode - CurrencyCode!
|
|
ticketConditions - String!
|
|
legs - [AddFlightLegInput]!
|
|
eTickets - [AttachmentInput]
|
|
state - FlightState
|
Example
{
"passengerTripId": "2198e588-712a-44bc-9ba1-0dd8e34149d2",
"price": 100,
"currencyCode": "USD",
"ticketConditions": "Non-refundable",
"legs": [
{
"departureAirportIataCode": "AMS",
"arrivalAirportIataCode": "LAX",
"departureDate": "2020-01-01",
"departureTime": "12:00:00",
"arrivalDate": "2020-01-01",
"arrivalTime": "14:00:00",
"cabinClass": "ECONOMY",
"flightNumber": "KL123"
}
],
"eTickets": [AttachmentInput],
"state": "CONFIRMED"
}
AddFlightLegInput
Example
{
"departureDate": "2024-01-01",
"departureTime": "08:00:00Z",
"arrivalDate": "2024-01-01",
"arrivalTime": "12:00:00Z",
"luggageCount": 987,
"luggageWeight": 24.2,
"cabinClass": "ECONOMY",
"flightNumber": "CEB115",
"arrivalAirportIataCode": "MNL",
"departureAirportIataCode": "HKG"
}
Address
Example
{
"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"city": "Manila",
"street1": "3125 Juan Luna St., Tondo",
"street2": "Block 4",
"zipCode": "1013",
"nickname": "Work",
"country": Country,
"state": "NCR",
"addressType": "Work"
}
AddressType
Description
The selected address types available
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BILLING"
Airport
Example
{
"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"iataCode": "SIN",
"icaoCode": "WSSS",
"name": "Changi Airport",
"location": "Singapore",
"timezone": "Asia/Singapore",
"dst": ""
}
Appraisal
Example
{
"id": Uuid,
"documentTypeId": "abc123",
"startDate": "2007-12-03",
"endDate": "2007-12-03",
"company": Company,
"attachments": [Attachment]
}
AssessmentTest
Fields
| Field Name | Description |
|---|---|
id - Uuid
|
|
assignmentId - Uuid
|
|
testScore - Int
|
|
assessmentDate - Date
|
|
assessmentTestType - AssessmentTestType
|
|
assessmentTestResult - Attachment
|
|
assessmentFailedTestAnswers - Attachment
|
|
company - Company
|
Example
{
"id": Uuid,
"assignmentId": Uuid,
"testScore": 987,
"assessmentDate": "2007-12-03",
"assessmentTestType": AssessmentTestType,
"assessmentTestResult": Attachment,
"assessmentFailedTestAnswers": Attachment,
"company": Company
}
AssessmentTestType
Assignment
Fields
| Field Name | Description |
|---|---|
message - String
|
|
profiles - [MapItem]
|
|
assignmentState - String
|
|
rejectedState - String
|
|
rejectedStageId - Uuid
|
|
rejectionReason - String
|
|
rejectedDatetime - DateDatetime
|
|
acceptedStates - [String]
|
|
acceptedStageIds - [Uuid]
|
|
approvalRequestStageIds - [Uuid]
|
|
overridedStageIds - [Uuid]
|
|
hasQuestionnaireSubmitted - Boolean
|
|
hasSendQuestionnaire - Boolean
|
|
leftHomeTicketDetail - String
|
|
arrivedHomeTicketDetail - String
|
|
type - String
|
|
candidate - Candidate
|
|
appliedByAccount - Account
|
|
appliedByCompany - Company
|
|
hiredByAccount - Account
|
|
transferredFrom - Assignment
|
|
transferredTo - Assignment
|
|
rejectedByAccount - Account
|
|
withdrawnByCandidate - Candidate
|
|
form - AssignmentForm
|
|
proposal - Proposal
|
|
seaServiceChecks - [SeaServiceCheck]
|
|
contactInterviews - [ContactInterview]
|
|
assignmentNotes - [AssignmentNote]
|
|
documentStatuses - [DocumentStatus]
|
|
documents - [Document]
|
|
assignmentApproveHistories - [AssignmentApproveHistory]
|
|
medicalDocuments - [Document]
|
|
vaccinations - [Document]
|
|
embarkation - Embarkation
|
|
contracts - [Contract]
|
Example
{
"message": "xyz789",
"profiles": [MapItem],
"assignmentState": "xyz789",
"rejectedState": "abc123",
"rejectedStageId": Uuid,
"rejectionReason": "xyz789",
"rejectedDatetime": DateDatetime,
"acceptedStates": ["abc123"],
"acceptedStageIds": [Uuid],
"approvalRequestStageIds": [Uuid],
"overridedStageIds": [Uuid],
"hasQuestionnaireSubmitted": false,
"hasSendQuestionnaire": false,
"leftHomeTicketDetail": "abc123",
"arrivedHomeTicketDetail": "abc123",
"type": "xyz789",
"candidate": Candidate,
"appliedByAccount": Account,
"appliedByCompany": Company,
"hiredByAccount": Account,
"transferredFrom": Assignment,
"transferredTo": Assignment,
"rejectedByAccount": Account,
"withdrawnByCandidate": Candidate,
"form": AssignmentForm,
"proposal": Proposal,
"seaServiceChecks": [SeaServiceCheck],
"contactInterviews": [ContactInterview],
"assignmentNotes": [AssignmentNote],
"documentStatuses": [DocumentStatus],
"documents": [Document],
"assignmentApproveHistories": [
AssignmentApproveHistory
],
"medicalDocuments": [Document],
"vaccinations": [Document],
"embarkation": Embarkation,
"contracts": [Contract]
}
AssignmentApproveHistory
Fields
| Field Name | Description |
|---|---|
approvedBy - Account
|
|
stage - PipelineStage
|
Example
{
"approvedBy": Account,
"stage": PipelineStage
}
AssignmentForm
Description
You can set the name and description in Settings > Forms
Fields
| Field Name | Description |
|---|---|
name - String
|
|
description - String
|
|
questions - [Question]
|
Example
{
"name": "Crewing Interview",
"description": "Crewing interview questions",
"questions": [Question]
}
AssignmentNote
Attachment
Example
{
"id": "d480f6a-6c54-23c5-90e6-gtasda8f0851",
"fileName": "cv.pdf",
"original": "https://storage.api.com/cv-original.pdf",
"thumbnail": "https://storage.api.com/cv-thumbnail.png",
"mimeType": "application/pdf",
"fileSize": 13924
}
AttachmentInput
BankAccount
Description
You can view the bank accounts in Candidate/Seafarer profile
Fields
| Field Name | Description |
|---|---|
id - Uuid
|
|
bankName - String
|
This field will be removed in the next release |
beneficiaryBankName - String
|
|
beneficiaryName - String
|
This field will be removed in the next release |
beneficiary - String
|
|
bic - String
|
This field will be removed in the next release |
beneficiarySwiftBic - String
|
|
iban - String
|
This field will be removed in the next release |
accountNumber - String
|
This field will be removed in the next release |
beneficiaryIban - String
|
|
paymentSplit - Int
|
This field will be removed in the next release |
beneficiaryPaymentSplit - Int
|
|
intermediaryName - String
|
|
intermediaryBankName - String
|
|
intermediaryRoutingNumber - String
|
This field will be removed in the next release |
intermediaryBic - String
|
This field will be removed in the next release |
intermediaryBankSwiftBic - String
|
|
intermediaryIban - String
|
This field will be removed in the next release |
intermediaryBankIban - String
|
|
intermediaryBankCity - String
|
|
intermediaryBankCountry - Country
|
|
type - String
|
|
address - Address
|
This field will be removed in the next release |
beneficiaryAddress - Address
|
|
city - String
|
This field will be removed in the next release |
beneficiaryBankCity - String
|
|
country - Country
|
This field will be removed in the next release |
beneficiaryBankCountry - Country
|
Example
{
"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"bankName": "Caliber Bank",
"beneficiaryBankName": "xyz789",
"beneficiaryName": "Lia ArkWright",
"beneficiary": "xyz789",
"bic": "CALBPHMM254",
"beneficiarySwiftBic": "abc123",
"iban": "PH734879154598191936928849",
"accountNumber": "1545981919369",
"beneficiaryIban": "xyz789",
"paymentSplit": 25,
"beneficiaryPaymentSplit": 987,
"intermediaryName": "New Life Bank Group",
"intermediaryBankName": "xyz789",
"intermediaryRoutingNumber": "044000024",
"intermediaryBic": "NLBGPHMM562",
"intermediaryBankSwiftBic": "xyz789",
"intermediaryIban": "PH96ABNA5427658955",
"intermediaryBankIban": "xyz789",
"intermediaryBankCity": "abc123",
"intermediaryBankCountry": Country,
"type": "xyz789",
"address": Address,
"beneficiaryAddress": Address,
"city": "abc123",
"beneficiaryBankCity": "xyz789",
"country": Country,
"beneficiaryBankCountry": Country
}
Billing
Fields
| Field Name | Description |
|---|---|
email - String
|
|
name - String
|
|
address - Address
|
|
bankAccount - BankAccount
|
|
company - Company
|
Example
{
"email": "john.smith@mail.com",
"name": "John Smith",
"address": Address,
"bankAccount": BankAccount,
"company": Company
}
Boolean
Description
The Boolean scalar type represents true or false.
Example
true
CabinClass
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ECONOMY"
Candidate
Fields
| Field Name | Description |
|---|---|
id - Uuid
|
|
email - String
|
Seafarers email address |
firstName - String
|
Seafarers first name |
aboutMe - String
|
A short biography of the seafarer. |
type - String
|
|
gender - String
|
The gender of the seafarer |
maritalStatus - String
|
Seafarers martial status |
jobStatus - String
|
Is the seafarer open for new jobs |
lastName - String
|
Seafarers last name |
middleName - String
|
Seafarers middle name |
salutation - String
|
Seafarers salutation |
avatar - String
|
Seafarers profile photo |
resume - Resume
|
|
facebookProfile - String
|
Seafarers Facebook account |
twitterProfile - String
|
Seafarers Twitter account |
linkedinProfile - String
|
Seafarers LinkedIn acount |
dateOfBirth - Date
|
Seafarers date of birth |
placeOfBirth - String
|
Seafarers place of birth |
birthProvince - String
|
Seafarer place of birth province |
pseudoId - String
|
Company specific id for this seafarer |
isDeleted - Boolean
|
Seafarers status |
allowSavedSearch - Boolean
|
|
isSubscribedToNewsletter - Boolean
|
Is the seafarer subscribed to the Martide newsletter |
emailConfirmedAt - DateDatetime
|
When the seafarer confirmed their account |
timezone - String
|
Seafarers timezone |
locationStatus - String
|
This field will be removed in the next version |
localAirportIataCode - String
|
|
hairColour - String
|
|
eyeColour - String
|
|
overallsSize - String
|
|
shoeSize - Decimal
|
|
collarSize - Decimal
|
|
capSize - Decimal
|
|
weight - Decimal
|
|
height - Decimal
|
|
bmi - Decimal
|
|
bloodType - String
|
|
weightUnit - String
|
|
heightUnit - String
|
|
shoeSizeUnit - String
|
|
collarSizeUnit - String
|
|
capSizeUnit - String
|
|
bankAccounts - [BankAccount]
|
|
addresses - [Address]
|
|
documents - [Document]
|
|
assessmentTests - [AssessmentTest]
|
|
medicalDocuments - [MedicalDocument]
|
|
payslips - [Payslip]
|
|
appraisals - [Appraisal]
|
|
visas - [Visa]
|
|
workHistories - [WorkHistory]
|
|
educations - [Education]
|
|
jobPreference - JobPreference
|
|
languages - [Language]
|
|
emergencyContact - EmergencyContact
|
|
nextOfKinContact - NextOfKinContact
|
|
socialMedias - [SocialMedia]
|
|
messengers - [Messenger]
|
|
specialSkills - [SpecialSkill]
|
|
workSummary - WorkSummary
|
|
contracts - [Contract]
|
|
localAirport - Airport
|
|
nationality - Country
|
|
birthCountry - Country
|
|
residence - Country
|
|
termsAccepted - Boolean
|
|
embarkations - [Embarkation]
|
|
insertedAt - DateDatetime
|
|
updatedAt - DateDatetime
|
|
currentRecruiter - CandidateRecruiter
|
|
currentLeadSource - CandidateLeadSource
|
|
seafarerRank - SeafarerRank
|
|
nationalitiesSailedWith - [Country]
|
|
seafarerPools - [SeafarerPool]
|
|
trainings - [Training]
|
|
candidateClientStatuses - [CandidateClientStatus]
|
|
candidateStatus - CandidateStatus
|
|
phones - [Phone]
|
|
manningBy - Company
|
|
createdBy - Company
|
|
maxCrewComplementSailedWith - Int
|
|
tradingAreas - String
|
|
nseNsid - String
|
Example
{
"id": Uuid,
"email": "xyz789",
"firstName": "xyz789",
"aboutMe": "abc123",
"type": "xyz789",
"gender": "abc123",
"maritalStatus": "abc123",
"jobStatus": "abc123",
"lastName": "xyz789",
"middleName": "xyz789",
"salutation": "xyz789",
"avatar": "xyz789",
"resume": Resume,
"facebookProfile": "xyz789",
"twitterProfile": "abc123",
"linkedinProfile": "abc123",
"dateOfBirth": "2007-12-03",
"placeOfBirth": "xyz789",
"birthProvince": "xyz789",
"pseudoId": "xyz789",
"isDeleted": true,
"allowSavedSearch": false,
"isSubscribedToNewsletter": true,
"emailConfirmedAt": DateDatetime,
"timezone": "xyz789",
"locationStatus": "xyz789",
"localAirportIataCode": "abc123",
"hairColour": "abc123",
"eyeColour": "xyz789",
"overallsSize": "abc123",
"shoeSize": Decimal,
"collarSize": Decimal,
"capSize": Decimal,
"weight": Decimal,
"height": Decimal,
"bmi": Decimal,
"bloodType": "xyz789",
"weightUnit": "xyz789",
"heightUnit": "xyz789",
"shoeSizeUnit": "abc123",
"collarSizeUnit": "xyz789",
"capSizeUnit": "abc123",
"bankAccounts": [BankAccount],
"addresses": [Address],
"documents": [Document],
"assessmentTests": [AssessmentTest],
"medicalDocuments": [MedicalDocument],
"payslips": [Payslip],
"appraisals": [Appraisal],
"visas": [Visa],
"workHistories": [WorkHistory],
"educations": [Education],
"jobPreference": JobPreference,
"languages": [Language],
"emergencyContact": EmergencyContact,
"nextOfKinContact": NextOfKinContact,
"socialMedias": [SocialMedia],
"messengers": [Messenger],
"specialSkills": [SpecialSkill],
"workSummary": WorkSummary,
"contracts": [Contract],
"localAirport": Airport,
"nationality": Country,
"birthCountry": Country,
"residence": Country,
"termsAccepted": true,
"embarkations": [Embarkation],
"insertedAt": DateDatetime,
"updatedAt": DateDatetime,
"currentRecruiter": CandidateRecruiter,
"currentLeadSource": CandidateLeadSource,
"seafarerRank": SeafarerRank,
"nationalitiesSailedWith": [Country],
"seafarerPools": [SeafarerPool],
"trainings": [Training],
"candidateClientStatuses": [CandidateClientStatus],
"candidateStatus": CandidateStatus,
"phones": [Phone],
"manningBy": Company,
"createdBy": Company,
"maxCrewComplementSailedWith": 987,
"tradingAreas": "xyz789",
"nseNsid": "abc123"
}
CandidateClientStatus
Description
Field can be used to view the status of a candidate for employer clients.
Fields
| Field Name | Description |
|---|---|
id - Uuid
|
|
status - EmploymentStatusType
|
|
clientCompanyName - String
|
Example
{
"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"status": "ACTIVE",
"clientCompanyName": "Martide Client"
}
CandidateLeadSource
Fields
| Field Name | Description |
|---|---|
id - Uuid
|
|
leadSource - LeadSource
|
Example
{
"id": Uuid,
"leadSource": LeadSource
}
CandidateRecruiter
CandidateStatus
Description
Field can be used to view the status of a candidate for employer.
Fields
| Field Name | Description |
|---|---|
id - Uuid
|
|
companyName - String
|
|
status - EmploymentStatusType
|
Example
{
"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"companyName": "Martide",
"status": "ACTIVE"
}
ClassificationSociety
Company
Fields
| Field Name | Description |
|---|---|
id - String
|
|
closedOn - DateDatetime
|
|
description - String
|
|
email - String
|
|
employeesCount - String
|
|
foundedOn - DateDatetime
|
|
logo - String
|
|
location - String
|
|
name - String
|
|
status - String
|
|
slug - String
|
|
url - String
|
|
active - Boolean
|
|
type - String
|
|
country - Country
|
|
vessels - [Vessel]
|
|
addresses - [Address]
|
Example
{
"id": "xyz789",
"closedOn": DateDatetime,
"description": "abc123",
"email": "xyz789",
"employeesCount": "xyz789",
"foundedOn": DateDatetime,
"logo": "xyz789",
"location": "abc123",
"name": "xyz789",
"status": "xyz789",
"slug": "xyz789",
"url": "abc123",
"active": true,
"type": "abc123",
"country": Country,
"vessels": [Vessel],
"addresses": [Address]
}
CompanySeafarerRank
Description
A Company's custom seafarer's rank.
Example
{
"id": "2c7a08b6-bfbf-44df-98ee-2b86c7ac82b7",
"customName": "Martide Second Engineer",
"originalName": "Second Engineer",
"active": true,
"abbreviation": "2/E",
"seafarerRank": SeafarerRank
}
CompanyVessel
Description
A company's basic vessel details.
Example
{
"monthlyCrewingBudget": "50,000.00",
"budgetCurrencyCode": "USD",
"email": "contact@martide.com",
"phone": "1-940-644-2369",
"emergencyContact": "1-940-644-2370",
"billing": Billing,
"wageScale": WageScale
}
ContactInterview
Contract
Description
Details of a contract.
Fields
| Field Name | Description |
|---|---|
id - Uuid
|
|
effectiveDate - Date
|
|
expiryDate - Date
|
|
effectiveAt - String
|
|
effectiveExtensionAt - String
|
|
agreedSalary - Decimal
|
|
currencyCode - String
|
|
company - Company
|
|
contractLength - Int
|
|
contractVariance - Int
|
|
expiringSoon - Boolean
|
|
expired - Boolean
|
|
attachments - [Attachment]
|
|
companySeafarerRank - CompanySeafarerRank
|
|
vessel - Vessel
|
|
contractVarianceUnit - ContractVarianceUnit
|
|
contractLengthUnit - ContractLengthUnit
|
|
type - ContractType
|
Example
{
"id": "12a5decb-0dbf-45f2-acc6-06f12a459d8b",
"effectiveDate": "2023-10-21",
"expiryDate": "2025-02-21",
"effectiveAt": "at_sign_on",
"effectiveExtensionAt": "end_of_contract",
"agreedSalary": 5000.01,
"currencyCode": "USD",
"company": Company,
"contractLength": 90,
"contractVariance": 15,
"expiringSoon": true,
"expired": false,
"attachments": [Attachment],
"companySeafarerRank": CompanySeafarerRank,
"vessel": Vessel,
"contractVarianceUnit": "DAYS",
"contractLengthUnit": "DAYS",
"type": "CONTRACT"
}
ContractLengthUnit
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DAYS"
ContractType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CONTRACT"
ContractVarianceUnit
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DAYS"
Country
Description
Information about a country
Example
{
"id": "0060fd4b-e78e-4e59-a84b-cee9a52e7496",
"visaType": true,
"iso": "GB",
"iso3": "GBR",
"isoName": "UNITED KINGDOM",
"name": "United Kingdom",
"numcode": "826",
"states": [State],
"visaTypes": [VisaType]
}
CrewChange
Fields
| Field Name | Description |
|---|---|
id - Uuid
|
|
onSignersDate - Date
|
|
offSignersDate - Date
|
|
portLocode - String
|
|
airportIataCode - String
|
|
vessel - Vessel
|
|
ports - [CrewChangePort]
|
|
status - CrewChangeStatus
|
|
type - CrewChangeType
|
|
offSignersCount - Int
|
|
offSigners - [Passenger]
|
|
onSignersCount - Int
|
|
onSigners - [Passenger]
|
Example
{
"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"onSignersDate": "2024-01-01",
"offSignersDate": "2024-08-01",
"portLocode": "SG BKM",
"airportIataCode": "SIN",
"vessel": Vessel,
"ports": [CrewChangePort],
"status": "OPEN",
"type": CrewChangeType,
"offSignersCount": 123,
"offSigners": [Passenger],
"onSignersCount": 123,
"onSigners": [Passenger]
}
CrewChangeMember
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ON_SIGNER"
CrewChangePort
Example
{
"id": Uuid,
"portLocode": "xyz789",
"airportIataCode": "xyz789",
"berthingDate": "2007-12-03",
"berthingTime": "10:15:30Z",
"departureDate": "2007-12-03",
"departureTime": "10:15:30Z",
"isPreferred": true,
"purchaseOrderNumber": "xyz789",
"expenses": [TravelExpense]
}
CrewChangeStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"OPEN"
CrewChangeType
CrewCompliment
Fields
| Field Name | Description |
|---|---|
crewNumber - Int
|
can be seen at crew tab in vessels page |
companySeafarerRank - CompanySeafarerRank
|
Example
{
"crewNumber": 1,
"companySeafarerRank": CompanySeafarerRank
}
CrewSlotHistory
Fields
| Field Name | Description |
|---|---|
status - CrewSlotHistoryStatus
|
|
startDate - Date
|
|
endDate - Date
|
|
slot - Slot
|
Example
{
"status": "IN_PROCESS",
"startDate": "2015-07-03",
"endDate": "2016-07-03",
"slot": Slot
}
CrewSlotHistoryStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"IN_PROCESS"
CurrencyCode
Values
| Enum Value | Description |
|---|---|
|
|
United Arab Emirates Dirham |
|
|
Afghan Afghani |
|
|
Albanian Lek |
|
|
Armenian Dram |
|
|
Netherlands Antillean Guilder |
|
|
Angolan Kwanza |
|
|
Argentine Peso |
|
|
Australian Dollar |
|
|
Aruban Florin |
|
|
Azerbaijani Manat |
|
|
Bosnia-Herzegovina Convertible Mark |
|
|
Barbadian Dollar |
|
|
Bangladeshi Taka |
|
|
Bulgarian Lev |
|
|
Bahraini Dinar |
|
|
Burundian Franc |
|
|
Bermudan Dollar |
|
|
Brunei Dollar |
|
|
Bolivian Boliviano |
|
|
Bolivian Mvdol |
|
|
Brazilian Real |
|
|
Bahamian Dollar |
|
|
Bhutanese Ngultrum |
|
|
Botswanan Pula |
|
|
Belarusian Ruble |
|
|
Belize Dollar |
|
|
Canadian Dollar |
|
|
Congolese Franc |
|
|
WIR Euro |
|
|
Swiss Franc |
|
|
WIR Franc |
|
|
Chilean Unit of Account (UF) |
|
|
Chilean Peso |
|
|
Chinese Yuan |
|
|
Colombian Peso |
|
|
Colombian Real Value Unit |
|
|
Costa Rican Colón |
|
|
Cuban Convertible Peso |
|
|
Cuban Peso |
|
|
Cape Verdean Escudo |
|
|
Czech Koruna |
|
|
Djiboutian Franc |
|
|
Danish Krone |
|
|
Dominican Peso |
|
|
Algerian Dinar |
|
|
Egyptian Pound |
|
|
Eritrean Nakfa |
|
|
Ethiopian Birr |
|
|
Euro |
|
|
Fijian Dollar |
|
|
Falkland Islands Pound |
|
|
British Pound |
|
|
Georgian Lari |
|
|
Ghanaian Cedi |
|
|
Gibraltar Pound |
|
|
Gambian Dalasi |
|
|
Guinean Franc |
|
|
Guatemalan Quetzal |
|
|
Guyanaese Dollar |
|
|
Hong Kong Dollar |
|
|
Honduran Lempira |
|
|
Croatian Kuna |
|
|
Haitian Gourde |
|
|
Hungarian Forint |
|
|
Indonesian Rupiah |
|
|
Israeli New Shekel |
|
|
Indian Rupee |
|
|
Iraqi Dinar |
|
|
Iranian Rial |
|
|
Icelandic Króna |
|
|
Jamaican Dollar |
|
|
Jordanian Dinar |
|
|
Japanese Yen |
|
|
Kenyan Shilling |
|
|
Kyrgyz Som |
|
|
Cambodian Riel |
|
|
Comorian Franc |
|
|
North Korean Won |
|
|
South Korean Won |
|
|
Kuwaiti Dinar |
|
|
Cayman Islands Dollar |
|
|
Kazakhstani Tenge |
|
|
Laotian Kip |
|
|
Lebanese Pound |
|
|
Sri Lankan Rupee |
|
|
Liberian Dollar |
|
|
Lesotho Loti |
|
|
Libyan Dinar |
|
|
Moroccan Dirham |
|
|
Moldovan Leu |
|
|
Malagasy Ariary |
|
|
Macedonian Denar |
|
|
Myanmar Kyat |
|
|
Mongolian Tugrik |
|
|
Macanese Pataca |
|
|
Mauritanian Ouguiya |
|
|
Mauritian Rupee |
|
|
Maldivian Rufiyaa |
|
|
Malawian Kwacha |
|
|
Mexican Peso |
|
|
Mexican Investment Unit |
|
|
Malaysian Ringgit |
|
|
Mozambican Metical |
|
|
Namibian Dollar |
|
|
Nigerian Naira |
|
|
Nicaraguan Córdoba |
|
|
Norwegian Krone |
|
|
Nepalese Rupee |
|
|
New Zealand Dollar |
|
|
Omani Rial |
|
|
Panamanian Balboa |
|
|
Peruvian Sol |
|
|
Papua New Guinean Kina |
|
|
Philippine Peso |
|
|
Pakistani Rupee |
|
|
Polish Zloty |
|
|
Paraguayan Guarani |
|
|
Qatari Riyal |
|
|
Romanian Leu |
|
|
Serbian Dinar |
|
|
Russian Ruble |
|
|
Rwandan Franc |
|
|
Saudi Riyal |
|
|
Solomon Islands Dollar |
|
|
Seychellois Rupee |
|
|
Sudanese Pound |
|
|
Swedish Krona |
|
|
Singapore Dollar |
|
|
St. Helena Pound |
|
|
Sierra Leonean Leone |
|
|
Somali Shilling |
|
|
Surinamese Dollar |
|
|
South Sudanese Pound |
|
|
São Tomé & Príncipe Dobra |
|
|
Salvadoran Colón |
|
|
Syrian Pound |
|
|
Swazi Lilangeni |
|
|
Thai Baht |
|
|
Tajikistani Somoni |
|
|
Turkmenistani Manat |
|
|
Tunisian Dinar |
|
|
Tongan Paʻanga |
|
|
Turkish Lira |
|
|
Trinidad & Tobago Dollar |
|
|
New Taiwan Dollar |
|
|
Tanzanian Shilling |
|
|
Ukrainian Hryvnia |
|
|
Ugandan Shilling |
|
|
US Dollar |
|
|
US Dollar (Next day) |
|
|
Uruguayan Peso (Indexed Units) |
|
|
Uruguayan Peso |
|
|
Uruguayan Nominal Wage Index Unit |
|
|
Uzbekistani Som |
|
|
Venezuelan Bolívar |
|
|
Vietnamese Dong |
|
|
Vanuatu Vatu |
|
|
Samoan Tala |
|
|
Central African CFA Franc |
|
|
Silver |
|
|
Gold |
|
|
European Composite Unit |
|
|
European Monetary Unit |
|
|
European Unit of Account (XBC) |
|
|
European Unit of Account (XBD) |
|
|
East Caribbean Dollar |
|
|
Special Drawing Rights |
|
|
West African CFA Franc |
|
|
Palladium |
|
|
CFP Franc |
|
|
Platinum |
|
|
Sucre |
|
|
Testing Currency Code |
|
|
ADB Unit of Account |
|
|
Unknown Currency |
|
|
Yemeni Rial |
|
|
South African Rand |
|
|
Zambian Kwacha |
|
|
Zimbabwean Dollar |
Example
"AED"
Date
Description
The Date scalar type represents a date. The Date appears in a JSON response as an ISO8601 formatted string, without a time component.
Example
"2007-12-03"
DateDatetime
Description
DateTime is a scalar macro that allows you to turn a string into a datetime
Example
DateDatetime
Decimal
Description
The Decimal scalar type represents signed double-precision fractional values parsed by the Decimal library. The Decimal appears in a JSON response as a string to preserve precision.
Example
Decimal
DeleteFlight
Fields
| Field Name | Description |
|---|---|
errors - [InputError]
|
|
success - SuccessInput
|
|
deleted - Boolean
|
|
deletedRecordId - Uuid!
|
Example
{
"errors": [InputError],
"success": SuccessInput,
"deleted": true,
"deletedRecordId": Uuid
}
DischargeReason
Document
Fields
| Field Name | Description |
|---|---|
id - Uuid
|
|
documentNumber - String
|
|
place - String
|
This field will be removed in the next version |
type - String
|
|
startDate - Date
|
|
endDate - Date
|
|
validatedAt - DateDatetime
|
|
unlimited - Boolean
|
|
documentType - DocumentType
|
Document type information |
country - Country
|
|
vesselEcdis - Ecdis
|
|
expiringSoon - Boolean
|
|
expired - Boolean
|
|
attachments - [Attachment]
|
Example
{
"id": "d480f6a-6c54-23c5-90e6-gtasda8f0851",
"documentNumber": "97309222",
"place": "xyz789",
"type": "Visa",
"startDate": "2023-09-01",
"endDate": "2026-09-01",
"validatedAt": DateDatetime,
"unlimited": true,
"documentType": DocumentType,
"country": Country,
"vesselEcdis": Ecdis,
"expiringSoon": false,
"expired": false,
"attachments": [Attachment]
}
DocumentStatus
Description
Can be seen at Document Valitation tab in Assignment/Recruitment page
Fields
| Field Name | Description |
|---|---|
validationStatus - String
|
pending, approved, or rejected |
validatedAt - DateDatetime
|
|
document - Document
|
Example
{
"validationStatus": "xyz789",
"validatedAt": DateDatetime,
"document": Document
}
DocumentType
EarningType
Description
Wage scale earning type name
Fields
| Field Name | Description |
|---|---|
name - String
|
Example
{"name": "Basic Salary"}
Ecdis
Education
Description
Educational attainment of a candidate.
Example
{
"id": "0a4ddcda-2b06-4b21-9e55-b50575d95de4",
"schoolName": "Lake Martin Maritime Academy",
"city": "Lake Martin",
"degreeMajor": "Marine Engineering",
"activity": "Education activity",
"fieldOfStudy": "Marine Engineering",
"degreeType": "Postdoctorate",
"notes": "Education notes",
"endDate": "2016-07-03",
"startDate": "2015-07-03",
"country": Country
}
Embarkation
Fields
| Field Name | Description |
|---|---|
id - Uuid
|
|
estimatedLeftHomeDate - Date
|
|
estimatedArrivedHomeDate - Date
|
|
estimatedSignOnDate - Date
|
|
estimatedSignOffDate - Date
|
|
actualLeftHomeDate - Date
|
|
actualArrivedHomeDate - Date
|
|
actualSignOnDate - Date
|
|
actualSignOffDate - Date
|
|
embarkationStatus - String
|
|
client - String
|
|
vessel - Vessel
|
|
seafarerManningAgency - Company
|
|
companySeafarerRank - SeafarerRanking
|
|
dischargeReason - DischargeReason
|
|
status - EmbarkationStatus
|
|
assignmentStatus - EmbarkationAssignmentStatus
|
Example
{
"id": "3f513254-222a-4007-baf7-ccf703f9f693",
"estimatedLeftHomeDate": "2023-09-01",
"estimatedArrivedHomeDate": "2024-01-01",
"estimatedSignOnDate": "2023-09-04",
"estimatedSignOffDate": "2023-12-28",
"actualLeftHomeDate": "2007-12-03",
"actualArrivedHomeDate": "2007-12-03",
"actualSignOnDate": "20230-09-03",
"actualSignOffDate": "2023-12-27",
"embarkationStatus": "Hired",
"client": "Kuhic Group",
"vessel": Vessel,
"seafarerManningAgency": Company,
"companySeafarerRank": SeafarerRanking,
"dischargeReason": DischargeReason,
"status": "EMBARKATION_HIRED",
"assignmentStatus": "HIRED"
}
EmbarkationAssignmentStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"HIRED"
EmbarkationStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EMBARKATION_HIRED"
EmergencyContact
Fields
| Field Name | Description |
|---|---|
id - Uuid
|
|
relationshipType - String
|
|
firstName - String
|
|
familyName - String
|
|
phoneType - String
|
|
phoneNumber - String
|
|
nextOfKinSameAsContact - Boolean
|
|
nextOfKinFirstName - String
|
|
nextOfKinFamilyName - String
|
|
nextOfKinPhoneType - String
|
|
nextOfKinPhoneNumber - String
|
|
address - Address
|
Example
{
"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"relationshipType": "Parent",
"firstName": "Lorna",
"familyName": "Wright",
"phoneType": "Mobile",
"phoneNumber": "+639093502800",
"nextOfKinSameAsContact": false,
"nextOfKinFirstName": "Ansel",
"nextOfKinFamilyName": "Lehner",
"nextOfKinPhoneType": "Mobile",
"nextOfKinPhoneNumber": "+639092559603",
"address": Address
}
EmploymentStatusType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACTIVE"
Engine
Flight
Fields
| Field Name | Description |
|---|---|
id - Uuid
|
|
state - FlightState
|
|
price - Decimal
|
|
ticketConditions - String
|
|
sent - Boolean
|
|
currencyCode - CurrencyCode
|
|
passengerTrip - PassengerTrip
|
|
passenger - Passenger
|
|
legs - [FlightLeg]
|
|
eTickets - [Attachment]
|
|
checkedInBaggageCount - Int
|
|
checkedInBaggageWeight - Decimal
|
|
carryOnBaggageCount - Int
|
Example
{
"id": "50fbf7f5-a193-486f-bea9-d612e1e96398",
"state": "CONFIRMED",
"price": "3000.00",
"ticketConditions": "Non-refundable",
"sent": false,
"currencyCode": "AED",
"passengerTrip": PassengerTrip,
"passenger": Passenger,
"legs": [FlightLeg],
"eTickets": [Attachment],
"checkedInBaggageCount": 123,
"checkedInBaggageWeight": Decimal,
"carryOnBaggageCount": 987
}
FlightLeg
Example
{
"id": "a206a513-12e4-44ea-a855-8f4c52ec5217",
"departureDate": "2024-01-01",
"departureTime": "08:00:00Z",
"arrivalDate": "2024-01-01",
"arrivalTime": "12:00:00Z",
"luggageCount": 5,
"luggageWeight": 24.5,
"cabinClass": "ECONOMY",
"flightNumber": "CEB115",
"arrivalAirportIataCode": "MNL",
"departureAirportIataCode": "SIN"
}
FlightState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CONFIRMED"
Gender
Description
The selected types for gender
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"M"
HandoverDuration
Fields
| Field Name | Description |
|---|---|
days - Int
|
|
companySeafarerRank - CompanySeafarerRank
|
Example
{"days": 123, "companySeafarerRank": CompanySeafarerRank}
InputError
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
123
ItfUnion
Job
Fields
| Field Name | Description |
|---|---|
id - Uuid
|
|
changeOverDate - Date
|
|
listingExpireDate - Date
|
|
daysLeft - String
|
|
vesselTradingArea - String
|
|
minAndMaxPrice - String
|
|
budgetMin - Decimal
|
|
budgetMax - Decimal
|
|
activated - Boolean
|
|
public - Boolean
|
|
currencyCode - String
|
|
budgetUnit - String
|
|
contractLength - Int
|
|
hiresNeeded - Int
|
|
contractLengthType - String
|
|
type - String
|
|
contractVariance - Int
|
|
slug - String
|
|
status - String
|
|
description - String
|
|
timeInRank - Int
|
|
timeInRankUnit - String
|
|
timeOnVessel - Int
|
|
timeOnVesselUnit - String
|
|
visaTypes - [VisaType]
|
|
vessel - Vessel
|
|
creator - Account
|
|
manningAgents - [Company]
|
|
nationalityRequirements - [Country]
|
|
company - JobCompany
|
|
vesselType - String
|
|
ranksDocumentTypes - [String]
|
|
documentTypesName - [String]
|
|
documentTypes - [Uuid]
|
|
toHire - [String]
|
|
toApply - [String]
|
|
profiles - [String]
|
|
crewSlotHistory - CrewSlotHistory
|
|
candidates - [Candidate]
|
|
assignments - [Assignment]
|
|
companySeafarerRank - CompanySeafarerRank
|
|
timeWithTechnicalOperatorUnit - String
|
|
timeWithTechnicalOperator - Int
|
|
exCrewCount - Int
|
|
recruited - Int
|
|
hired - Int
|
|
applied - Int
|
|
jobType - String
|
|
commentForCandidate - String
|
|
commentForManningAgent - String
|
|
minimumExperienceYears - Int
|
Example
{
"id": Uuid,
"changeOverDate": "2007-12-03",
"listingExpireDate": "2007-12-03",
"daysLeft": "abc123",
"vesselTradingArea": "abc123",
"minAndMaxPrice": "abc123",
"budgetMin": Decimal,
"budgetMax": Decimal,
"activated": false,
"public": true,
"currencyCode": "abc123",
"budgetUnit": "xyz789",
"contractLength": 987,
"hiresNeeded": 123,
"contractLengthType": "xyz789",
"type": "xyz789",
"contractVariance": 987,
"slug": "xyz789",
"status": "xyz789",
"description": "abc123",
"timeInRank": 987,
"timeInRankUnit": "xyz789",
"timeOnVessel": 987,
"timeOnVesselUnit": "xyz789",
"visaTypes": [VisaType],
"vessel": Vessel,
"creator": Account,
"manningAgents": [Company],
"nationalityRequirements": [Country],
"company": JobCompany,
"vesselType": "abc123",
"ranksDocumentTypes": ["xyz789"],
"documentTypesName": ["abc123"],
"documentTypes": [Uuid],
"toHire": ["abc123"],
"toApply": ["abc123"],
"profiles": ["xyz789"],
"crewSlotHistory": CrewSlotHistory,
"candidates": [Candidate],
"assignments": [Assignment],
"companySeafarerRank": CompanySeafarerRank,
"timeWithTechnicalOperatorUnit": "xyz789",
"timeWithTechnicalOperator": 123,
"exCrewCount": 987,
"recruited": 987,
"hired": 123,
"applied": 123,
"jobType": "xyz789",
"commentForCandidate": "xyz789",
"commentForManningAgent": "abc123",
"minimumExperienceYears": 123
}
JobCompany
JobFilter
Description
Filtering options for jobs
Fields
| Input Field | Description |
|---|---|
rank - String
|
Position Rank |
companyName - String
|
Matching a Company name |
companyNames - [String]
|
Matching at least one Company names |
budgetMin - Decimal
|
Budget min starting from >= |
budgetMax - Decimal
|
Budget max ending at <= |
engineType - String
|
Matching an engine type 2 stroke or 4 stroke |
vesselType - String
|
Matching a vessel type |
vesselTypes - [String]
|
Matching at least one vessel type |
changeOverDateFrom - Date
|
Change over date from this date >= |
changeOverDateTo - Date
|
Change over date to this date <= |
Example
{
"rank": "abc123",
"companyName": "xyz789",
"companyNames": ["xyz789"],
"budgetMin": Decimal,
"budgetMax": Decimal,
"engineType": "abc123",
"vesselType": "xyz789",
"vesselTypes": ["xyz789"],
"changeOverDateFrom": "2007-12-03",
"changeOverDateTo": "2007-12-03"
}
JobPreference
Description
Job preference of a candidate. It's helpful to filter candidates by their preferences when applying for jobs.
Fields
| Field Name | Description |
|---|---|
id - Uuid
|
|
minDwt - Int
|
|
maxDwt - Int
|
|
preferredContractLength - String
|
|
availabilityDate - Date
|
|
enginePower - Int
|
|
salaryRequirement - Int
|
|
minSalary - Int
|
removed in the newer version |
minSalaryMoney - String
|
|
maxSalary - Int
|
|
maxSalaryMoney - String
|
removed in the newer version |
salaryExpectation - Int
|
|
salaryExpectationMoney - String
|
|
minEngine - Int
|
|
maxEngine - Int
|
|
vesselTypes - [VesselType]
|
Example
{
"id": Uuid,
"minDwt": 123,
"maxDwt": 123,
"preferredContractLength": "xyz789",
"availabilityDate": "2007-12-03",
"enginePower": 987,
"salaryRequirement": 123,
"minSalary": 123,
"minSalaryMoney": "abc123",
"maxSalary": 123,
"maxSalaryMoney": "abc123",
"salaryExpectation": 123,
"salaryExpectationMoney": "abc123",
"minEngine": 123,
"maxEngine": 987,
"vesselTypes": [VesselType]
}
Language
LeadSource
ListAssignments
Fields
| Field Name | Description |
|---|---|
assignments - [Job]
|
|
pagination - PaginationInfo
|
Example
{
"assignments": [Job],
"pagination": PaginationInfo
}
ListCrewChanges
Fields
| Field Name | Description |
|---|---|
crewChanges - [CrewChange]
|
|
pagination - PaginationInfo
|
Example
{
"crewChanges": [CrewChange],
"pagination": PaginationInfo
}
ListFlights
Fields
| Field Name | Description |
|---|---|
flights - [Flight]
|
|
pagination - PaginationInfo
|
Example
{
"flights": [Flight],
"pagination": PaginationInfo
}
ListRecruitments
Fields
| Field Name | Description |
|---|---|
recruitments - [Job]
|
|
pagination - PaginationInfo
|
Example
{
"recruitments": [Job],
"pagination": PaginationInfo
}
ListSeafarers
Fields
| Field Name | Description |
|---|---|
seafarers - [Candidate]
|
|
pagination - PaginationInfo
|
Example
{
"seafarers": [Candidate],
"pagination": PaginationInfo
}
ListVessels
Fields
| Field Name | Description |
|---|---|
vessels - [Vessel]
|
|
pagination - PaginationInfo
|
Example
{
"vessels": [Vessel],
"pagination": PaginationInfo
}
MapItem
MedicalDocument
Example
{
"id": Uuid,
"documentNumber": "abc123",
"referenceNumber": "abc123",
"type": "xyz789",
"startDate": "2007-12-03",
"endDate": "2007-12-03",
"country": Country,
"documentType": DocumentType,
"unlimited": false,
"expiringSoon": true,
"expired": false,
"attachments": [Attachment]
}
Messenger
Description
Detail of a message including the app used.
Fields
| Field Name | Description |
|---|---|
id - Uuid
|
|
username - String
|
|
service - MessengerService
|
Example
{
"id": "0aca9bd1-17bb-4510-9dcb-e347c56dfe56",
"username": "johndoe101",
"service": "WECHAT"
}
MessengerService
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"WECHAT"
NextOfKinContact
Description
Contact details of seafarer's next of kin.
Example
{
"id": "01347c3f-caf3-4590-936e-1c0029df7a26",
"relationshipType": "Parent",
"firstName": "Carol",
"lastName": "Denvers",
"phoneNumber": "+639093502800",
"address": Address,
"phoneType": "HOME"
}
PaginationInfo
Passenger
Fields
| Field Name | Description |
|---|---|
id - Uuid
|
|
seafarerId - Uuid
|
|
email - String
|
|
homeAirport - String
|
|
passportEndDate - Date
|
|
passportNumber - String
|
|
passportCountry - String
|
|
gender - Gender
|
|
nationality - String
|
|
dob - Date
|
|
firstName - String
|
|
lastName - String
|
|
crewChangeMember - CrewChangeMember
|
|
companySeafarerRank - SeafarerRank
|
|
rankOrder - Int
|
|
crewChangeId - Uuid
|
|
embarkation - Embarkation
|
|
phones - [Phone]
|
Example
{
"id": "087745fd-db2a-40ed-b7d8-71b3e5e11769",
"seafarerId": Uuid,
"email": "johndoe@martide.com",
"homeAirport": "SIN",
"passportEndDate": "2024-01-01",
"passportNumber": "PA0912345",
"passportCountry": "SIN",
"gender": "M",
"nationality": "SIN",
"dob": "1990-01-01",
"firstName": "John",
"lastName": "Doe",
"crewChangeMember": "ON_SIGNER",
"companySeafarerRank": SeafarerRank,
"rankOrder": 1,
"crewChangeId": Uuid,
"embarkation": Embarkation,
"phones": [Phone]
}
PassengerTrip
Payslip
Fields
| Field Name | Description |
|---|---|
id - Uuid
|
|
vesselName - String
|
This field will be remove in the next version |
rank - String
|
This field will be remove in the next version |
startDate - Date
|
|
endDate - Date
|
|
company - Company
|
|
embarkations - Embarkation
|
|
attachments - [Attachment]
|
Example
{
"id": Uuid,
"vesselName": "xyz789",
"rank": "xyz789",
"startDate": "2007-12-03",
"endDate": "2007-12-03",
"company": Company,
"embarkations": Embarkation,
"attachments": [Attachment]
}
Phone
PhoneType
Description
The selected phone types available
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"HOME"
PipelineStage
Example
{
"position": 2,
"requiredBefore": 3,
"step": 1,
"name": "Personal Information",
"state": "AWAITING",
"insource": false,
"outsourceManning": true,
"outsourceClient": true,
"skip": "ex-crew",
"assigneeId": "f7dc2074-99e6-4715-9fd5-e3e5ddbc23ef"
}
PipelineStageState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
This value will be replaced by assessment_test |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AWAITING"
PreviousManager
Proposal
Description
The first stage of assignment / recruitment pipeline where the summary of the employment details is being laid out.
Example
{
"agreedSalary": 1100,
"contractLength": 18,
"contractLengthUnit": "months",
"jobPostStep": "1",
"contractVariance": 5,
"contractVarianceUnit": "months",
"currencyCode": "USD"
}
ProtectionAndIndemnityClub
Fields
| Field Name | Description |
|---|---|
name - String
|
Example
{
"name": "The Shipowners' Mutual Protection & Indemnity Association (Luxembourg)"
}
Question
Fields
| Field Name | Description |
|---|---|
questionType - QuestionType
|
paragraph, multiple_choice, multiple_choice_multi_select, checkboxes, linear_scale, multiple_choice_grid, or checkbox_grid |
title - String
|
|
slideFrom - String
|
only for linear_scale |
slideTo - String
|
only for linear_scale |
labelSlideFrom - String
|
only for linear_scale |
labelSlideTo - String
|
only for linear_scale |
position - Int
|
order of question in form |
options - [QuestionOption]
|
only for multiple_choice, multiple_choice_multi_select, checkboxes, multiple_choice_grid, or checkbox_grid |
rows - [QuestionRow]
|
only for multiple_choice_grid, or checkbox_grid |
Example
{
"questionType": "LINEAR_SCALE",
"title": "English knowledge?",
"slideFrom": "1",
"slideTo": "10",
"labelSlideFrom": "From",
"labelSlideTo": "To",
"position": 2,
"options": [],
"rows": []
}
QuestionOption
Fields
| Field Name | Description |
|---|---|
name - String
|
Example
{"name": "Yes"}
QuestionRow
Fields
| Field Name | Description |
|---|---|
name - String
|
Example
{"name": "Reason's for application?"}
QuestionType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PARAGRAPH"
Resume
SeaServiceCheck
Description
Sea service check stage on pipeline stage.
Fields
| Field Name | Description |
|---|---|
status - SeaServiceCheckStatus
|
|
jobPostStep - String
|
|
stage - PipelineStage
|
|
seaServiceNotes - [SeaServiceNote]
|
Example
{
"status": "APPROVED",
"jobPostStep": "1",
"stage": PipelineStage,
"seaServiceNotes": [SeaServiceNote]
}
SeaServiceCheckStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"PENDING"
SeaServiceNote
Fields
| Field Name | Description |
|---|---|
company - String
|
|
startAt - Date
|
|
endAt - Date
|
|
seafarerRank - SeafarerRank
|
|
notes - [MapItem]
|
Example
{
"company": "Ocean Oasis",
"startAt": "2024-01-01",
"endAt": "2024-02-25",
"seafarerRank": SeafarerRank,
"notes": [MapItem]
}
SeafarerPool
SeafarerRank
SeafarerRanking
Slot
Fields
| Field Name | Description |
|---|---|
numId - Int
|
|
histories - [CrewSlotHistory]
|
|
companySeafarerRank - CompanySeafarerRank
|
|
embarkations - [Embarkation]
|
Example
{
"numId": 123,
"histories": [CrewSlotHistory],
"companySeafarerRank": CompanySeafarerRank,
"embarkations": [Embarkation]
}
SocialMedia
SortOrder
Description
sorts the order from either ASC or DESC
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ASC"
SpecialSkill
State
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"abc123"
SuccessInput
Description
A message thats set when successful update occurs
Fields
| Field Name | Description |
|---|---|
message - String!
|
Example
{"message": "Successfully updated record."}
Summary
Time
Description
The Time scalar type represents a time. The Time appears in a JSON response as an ISO8601 formatted string, without a date component.
Example
"10:15:30Z"
Training
TravelExpense
Fields
| Field Name | Description |
|---|---|
id - Uuid
|
|
expense - String
|
|
currencyCode - CurrencyCode
|
|
actualCost - Decimal
|
|
direction - TravelExpenseDirection
|
|
autoCalculateCost - Boolean
|
|
crewChangePortId - Uuid
|
Example
{
"id": Uuid,
"expense": "abc123",
"currencyCode": "AED",
"actualCost": Decimal,
"direction": "SIGN_ON",
"autoCalculateCost": true,
"crewChangePortId": Uuid
}
TravelExpenseDirection
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"SIGN_ON"
UpdateFlightInput
Fields
| Input Field | Description |
|---|---|
price - Decimal
|
|
currencyCode - CurrencyCode
|
|
ticketConditions - String
|
|
legs - [UpdateFlightLegInput]
|
|
eTickets - [AttachmentInput]
|
|
state - FlightState
|
Example
{
"price": 321,
"currencyCode": "PHP",
"ticketConditions": "The passenger is required to arrive at Carrier's check-in location sufficiently in advance of the indicated flight departure time to permit completion of any government formalities and departure procedures and in any event not later than the time that maybe indicated by the Carrier.",
"legs": [
{
"departureAirportIataCode": "AMS",
"arrivalAirportIataCode": "LAX",
"departureDate": "2020-01-01",
"departureTime": "12:00:00",
"arrivalDate": "2020-01-01",
"arrivalTime": "14:00:00",
"cabinClass": "BUSINESS",
"flightNumber": "KL123"
},
{"id": "9c248254-5f63-45d4-9897-c4d5edb132e3", "delete": true}
],
"eTickets": [AttachmentInput],
"state": "CONFIRMED"
}
UpdateFlightLegInput
Example
{
"id": "d480f6a-6c54-23c5-90e6-gtasda8f0851",
"delete": false,
"departureDate": "2024-01-01",
"departureTime": "08:00:00Z",
"arrivalDate": "2024-03-01",
"arrivalTime": "12:00:00Z",
"luggageCount": 987,
"luggageWeight": 24.2,
"cabinClass": "ECONOMY",
"flightNumber": "CEB115",
"arrivalAirportIataCode": "MNL",
"departureAirportIataCode": "HKG"
}
Upload
Description
Represents an uploaded file.
Example
Upload
UpsertFlight
Fields
| Field Name | Description |
|---|---|
flight - Flight
|
|
errors - [InputError]
|
|
success - SuccessInput
|
Example
{
"flight": Flight,
"errors": [InputError],
"success": SuccessInput
}
Uuid
Description
UUID is a scalar macro that checks if id is a valid uuid
Example
Uuid
Vessel
Fields
| Field Name | Description |
|---|---|
id - String
|
|
name - String
|
|
imo - Int
|
|
mmsi - String
|
|
length - Int
|
|
width - Int
|
|
photoThumb - String
|
|
photoOriginal - String
|
|
photo - String
|
Use photo_thumb and photo_original instead |
yearBuilt - Int
|
|
dwt - String
|
|
tradingPattern - String
|
|
specialEquipment - String
|
|
teu - Int
|
|
vesselCompanyName - String
|
|
logo - String
|
|
vesselType - VesselType
|
|
engine - Engine
|
|
ecdis - Ecdis
|
|
vesselContacts - [VesselContact]
|
|
clientCompanies - [Company]
|
|
protectionAndIndemnityClub - ProtectionAndIndemnityClub
|
|
classificationSociety - ClassificationSociety
|
|
itfUnion - ItfUnion
|
|
flag - Country
|
|
managers - [VesselManager]
|
|
crewHistories - [CrewSlotHistory]
|
|
slots - [Slot]
|
|
onboardEmbarkations - [Embarkation]
|
|
embarkations - [Embarkation]
|
|
account - VesselAccount
|
|
vesselPosition - VesselPosition
|
|
handoverDurations - [HandoverDuration]
|
|
vesselMinimumSafeMannings - [VesselMinimumSafeManning]
|
|
previousManagers - [PreviousManager]
|
|
previousNames - [VesselPreviousName]
|
|
documents - [VesselDocument]
|
|
crewCompliments - [CrewCompliment]
|
|
companyVessel - CompanyVessel
|
|
grossTonnage - Int
|
|
draught - Decimal
|
|
cargo - String
|
|
callsign - String
|
|
craneType - String
|
|
itfCovered - String
|
|
wLeft - Decimal
|
|
lFore - Decimal
|
|
propeller - String
|
|
decksNumber - Decimal
|
|
hullType - String
|
|
hullMaterial - String
|
|
insurer - String
|
|
grain - String
|
|
liquidGas - String
|
|
liquidOil - String
|
|
grossRegisteredTonnage - Decimal
|
|
netRegisteredTonnage - Decimal
|
|
speedService - Decimal
|
|
speedMax - Decimal
|
|
fuelConsumption - String
|
|
lengthBWPerpendiculars - Decimal
|
|
lengthOverall - Decimal
|
|
displacementSummer - String
|
|
summerDwt - Decimal
|
|
depth - Decimal
|
|
breadthMoulded - Decimal
|
|
breadthExtreme - Decimal
|
|
yardNumber - String
|
|
placeOfBuild - String
|
|
builder - String
|
|
eni - Decimal
|
|
status - String
|
Example
{
"id": "xyz789",
"name": "abc123",
"imo": 123,
"mmsi": "xyz789",
"length": 987,
"width": 987,
"photoThumb": "abc123",
"photoOriginal": "xyz789",
"photo": "abc123",
"yearBuilt": 987,
"dwt": "abc123",
"tradingPattern": "abc123",
"specialEquipment": "xyz789",
"teu": 987,
"vesselCompanyName": "abc123",
"logo": "xyz789",
"vesselType": VesselType,
"engine": Engine,
"ecdis": Ecdis,
"vesselContacts": [VesselContact],
"clientCompanies": [Company],
"protectionAndIndemnityClub": ProtectionAndIndemnityClub,
"classificationSociety": ClassificationSociety,
"itfUnion": ItfUnion,
"flag": Country,
"managers": [VesselManager],
"crewHistories": [CrewSlotHistory],
"slots": [Slot],
"onboardEmbarkations": [Embarkation],
"embarkations": [Embarkation],
"account": VesselAccount,
"vesselPosition": VesselPosition,
"handoverDurations": [HandoverDuration],
"vesselMinimumSafeMannings": [VesselMinimumSafeManning],
"previousManagers": [PreviousManager],
"previousNames": [VesselPreviousName],
"documents": [VesselDocument],
"crewCompliments": [CrewCompliment],
"companyVessel": CompanyVessel,
"grossTonnage": 987,
"draught": Decimal,
"cargo": "xyz789",
"callsign": "xyz789",
"craneType": "xyz789",
"itfCovered": "xyz789",
"wLeft": Decimal,
"lFore": Decimal,
"propeller": "xyz789",
"decksNumber": Decimal,
"hullType": "abc123",
"hullMaterial": "abc123",
"insurer": "xyz789",
"grain": "xyz789",
"liquidGas": "xyz789",
"liquidOil": "abc123",
"grossRegisteredTonnage": Decimal,
"netRegisteredTonnage": Decimal,
"speedService": Decimal,
"speedMax": Decimal,
"fuelConsumption": "abc123",
"lengthBWPerpendiculars": Decimal,
"lengthOverall": Decimal,
"displacementSummer": "xyz789",
"summerDwt": Decimal,
"depth": Decimal,
"breadthMoulded": Decimal,
"breadthExtreme": Decimal,
"yardNumber": "abc123",
"placeOfBuild": "xyz789",
"builder": "xyz789",
"eni": Decimal,
"status": "xyz789"
}
VesselAccount
Fields
| Field Name | Description |
|---|---|
email - String
|
Example
{"email": "vessel-manager@example.com"}
VesselContact
VesselData
Example
{
"id": "xyz789",
"name": "xyz789",
"photo": "xyz789",
"vesselDwt": "xyz789",
"vesselTypeId": "xyz789",
"vesselEngine": "abc123",
"vesselMaker": "xyz789"
}
VesselDocument
Description
Document relating to a vessel. Found on the Vessels page then on the Documents section.
Fields
| Field Name | Description |
|---|---|
id - Uuid
|
|
documentNumber - String
|
|
name - String
|
|
documentType - VesselDocumentType
|
|
startDate - Date
|
|
endDate - Date
|
|
country - Country
|
|
attachments - [Attachment]
|
Example
{
"id": "d480f6a-6c54-23c5-90e6-gtasda8f0851",
"documentNumber": "97309222",
"name": "MLC",
"documentType": VesselDocumentType,
"startDate": "2023-09-01",
"endDate": "2026-09-01",
"country": Country,
"attachments": [Attachment]
}
VesselDocumentType
VesselManager
Fields
| Field Name | Description |
|---|---|
vesselRole - VesselRole
|
|
account - Account
|
Example
{
"vesselRole": VesselRole,
"account": Account
}
VesselMinimumSafeManning
Fields
| Field Name | Description |
|---|---|
crewNumber - Int
|
|
companySeafarerRank - CompanySeafarerRank
|
Example
{
"crewNumber": 123,
"companySeafarerRank": CompanySeafarerRank
}
VesselPosition
Example
{
"latitude": Decimal,
"longitude": Decimal,
"speed": Decimal,
"heading": 123,
"course": 123,
"aisDataSource": "abc123",
"datasourceTimestamp": DateDatetime
}
VesselPreviousName
VesselRole
Fields
| Field Name | Description |
|---|---|
name - String
|
Example
{"name": "Resources Manager"}
VesselType
Visa
Example
{
"id": "d480f6a-6c54-23c5-90e6-gtasda8f0851",
"type": "Work Permit",
"startDate": "2020-01-01",
"endDate": "2027-08-01",
"visaNumber": "78728119",
"country": Country,
"visaType": VisaType,
"unlimited": true,
"expiringSoon": false,
"expired": false,
"attachments": [Attachment]
}
VisaType
WageScale
Fields
| Field Name | Description |
|---|---|
name - String
|
|
validFrom - Date
|
|
validTo - Date
|
|
currencyCode - String
|
|
wageScaleLevels - [WageScaleLevel]
|
|
earningTypes - [EarningType]
|
Example
{
"name": "Default Wage Scale",
"validFrom": "2024-01-01",
"validTo": "2024-08-01",
"currencyCode": "USD",
"wageScaleLevels": [WageScaleLevel],
"earningTypes": [EarningType]
}
WageScaleLevel
Fields
| Field Name | Description |
|---|---|
code - String
|
|
companySeafarerRank - CompanySeafarerRank
|
Example
{
"code": "MAS-1",
"companySeafarerRank": CompanySeafarerRank
}
WorkHistory
Description
Work history for a candidate, including vessel details and employment period. Fields actual_sign_on_date and actual_sign_off_date replace the deprecated start_at and end_at.
Fields
| Field Name | Description |
|---|---|
id - Uuid
|
|
company - String
|
|
manningAgent - String
|
|
isCurrent - Boolean
|
|
endAt - Date
|
This field will be removed in the next version |
actualSignOffDate - String
|
|
startAt - Date
|
This field will be removed in the next version |
actualSignOnDate - String
|
|
yearRange - String
|
|
dischargeReason - String
|
|
flag - Country
|
|
vesselName - String
|
|
vesselDwt - Int
|
|
vesselEngineKw - Int
|
This field will be removed in the next version |
vesselEngineType - String
|
|
vesselCraneType - String
|
|
vesselCargoType - String
|
|
vesselGrt - Int
|
|
vesselYearOfBuild - Int
|
|
vesselImo - Int
|
|
vesselType - VesselType
|
|
vesselData - VesselData
|
|
seafarerRank - SeafarerRank
|
Example
{
"id": "087745fd-db2a-40ed-b7d8-71b3e5e11769",
"company": "Pfeffer Group",
"manningAgent": "Hermann-Moen",
"isCurrent": true,
"endAt": "2022-07-27",
"actualSignOffDate": "abc123",
"startAt": "2022-01-27",
"actualSignOnDate": "xyz789",
"yearRange": "0",
"dischargeReason": "abc123",
"flag": Country,
"vesselName": "M/V Cebu",
"vesselDwt": 2000,
"vesselEngineKw": 636,
"vesselEngineType": "Sulzer",
"vesselCraneType": "abc123",
"vesselCargoType": "xyz789",
"vesselGrt": 123,
"vesselYearOfBuild": 123,
"vesselImo": 987,
"vesselType": VesselType,
"vesselData": VesselData,
"seafarerRank": SeafarerRank
}