{"swagger":"2.0","info":{"version":"v1","title":"Cabfind.Residion.Api.Client"},"host":"localhost:8110","schemes":["http"],"paths":{"/api/accounts/{accountId}":{"get":{"tags":["Account"],"summary":"Get Client Account","description":"Gets the specified Client Account","operationId":"GetClientAccount","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"The Id of the Client Account.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Account"}},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/accounts/{accountId}/references":{"get":{"tags":["Account"],"summary":"Get Client References","description":"Gets a collection of client references for this client account","operationId":"GetClientReferences","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"The Id of the Client Account.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ClientReference"}}},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/accounts/{accountId}/bookinggroups":{"get":{"tags":["Account"],"summary":"Get Booking Groups","description":"Gets a collection of booking groups for this client account","operationId":"GetBookingGroups","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"The Id of the Client Account.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BookingGroup"}}},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/accounts/{accountId}/bookinggroups/{groupName}/addMembers":{"post":{"tags":["Account"],"summary":"Add people to a booking group","operationId":"AddBookingGroupMembers","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"The Id of the Client Account.","required":true,"type":"string"},{"name":"groupName","in":"path","description":"Name of the group","required":true,"type":"string"},{"name":"members","in":"body","description":"Members to add","required":true,"schema":{"$ref":"#/definitions/AddMembers"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BookingGroup"}},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/accounts/{accountId}/bookinggroups/{groupName}/removeMembers":{"post":{"tags":["Account"],"summary":"Remove people from a booking group","operationId":"RemoveBookingGroupMembers","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"The Id of the Client Account.","required":true,"type":"string"},{"name":"groupName","in":"path","description":"Name of the group","required":true,"type":"string"},{"name":"members","in":"body","description":"Members to remove","required":true,"schema":{"$ref":"#/definitions/RemoveMembers"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BookingGroup"}},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/accounts/{accountId}/tpmgroups":{"get":{"tags":["Account"],"summary":"Get TPM Groups","description":"Gets a collection of travel policy management groups for this client account","operationId":"GetTpmGroups","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"The Id of the Client Account.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/TpmGroup"}}},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/accounts/{accountId}/tpmgroups/{groupName}/addMembers":{"post":{"tags":["Account"],"summary":"Add people to a tpm group","operationId":"AddTpmGroupMembers","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"The Id of the Client Account.","required":true,"type":"string"},{"name":"groupName","in":"path","description":"Name of the group","required":true,"type":"string"},{"name":"members","in":"body","description":"Members to add","required":true,"schema":{"$ref":"#/definitions/AddMembers"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TpmGroup"}},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/accounts/{accountId}/tpmgroups/{groupName}/removeMembers":{"post":{"tags":["Account"],"summary":"Remove people from a tpm group","operationId":"RemoveTpmGroupMembers","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"The Id of the Client Account.","required":true,"type":"string"},{"name":"groupName","in":"path","description":"Name of the group","required":true,"type":"string"},{"name":"members","in":"body","description":"Members to remove","required":true,"schema":{"$ref":"#/definitions/RemoveMembers"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TpmGroup"}},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/accounts/{accountId}/documents/upload":{"post":{"tags":["Account"],"summary":"Uploads a document","operationId":"UploadDocument","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":[],"parameters":[{"name":"accountId","in":"path","description":"The Id of the Client Account.","required":true,"type":"string"},{"name":"documentUpload","in":"body","description":"The document to upload","required":true,"schema":{"$ref":"#/definitions/DocumentUpload"}}],"responses":{"204":{"description":"No Content"}},"deprecated":false}},"/api/accounts/{accountId}/unifiedaddress":{"get":{"tags":["Account"],"summary":"Searches the address book and space service for an address","description":"Gets the user Address Book.","operationId":"GetUnifiedAddress","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"Specify the account ID","required":true,"type":"string"},{"name":"sortBy","in":"query","description":"Specify the sort order","required":true,"type":"string"},{"name":"limit","in":"query","description":"Specify a limit value for pagination. This is the number of records to be returned per request.","required":true,"type":"integer","format":"int32"},{"name":"offset","in":"query","description":"Specify an offset value for pagination. An offset of 10 means return results from record 11.","required":true,"type":"integer","format":"int32"},{"name":"searchString","in":"query","description":"Filter results by a search string","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PublicApiResponse[Address[]]"}},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/accounts/{accountId}/bookings":{"get":{"tags":["Booking"],"summary":"Get Client's Bookings","description":"Gets a collection of bookings in this client account based on the specified search criteria","operationId":"GetBookings","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"The Id of the Client Account.","required":true,"type":"string"},{"name":"offset","in":"query","description":"Specify an offset value for pagination. An offset of 10 means return results from record 11.","required":true,"type":"integer","format":"int32"},{"name":"limit","in":"query","description":"Specify a limit value for pagination. This is the number of records to be returned per request.","required":true,"type":"integer","format":"int32"},{"name":"filter.searchTerm","in":"query","required":false,"type":"string"},{"name":"filter.passengerName","in":"query","required":false,"type":"string"},{"name":"filter.statusFilter","in":"query","required":false,"type":"string"},{"name":"filter.travelStartDate","in":"query","required":false,"type":"string","format":"date-time"},{"name":"filter.travelEndDate","in":"query","required":false,"type":"string","format":"date-time"},{"name":"filter.supplierIds","in":"query","required":false,"type":"string"},{"name":"filter.bookedByParticipantIds","in":"query","required":false,"type":"string"},{"name":"filter.bookedForParticipantIds","in":"query","required":false,"type":"string"},{"name":"filter.leadPassengerParticipantIds","in":"query","required":false,"type":"string"},{"name":"filter.bookingReference","in":"query","required":false,"type":"string"},{"name":"filter.sortBy","in":"query","required":false,"type":"string"},{"name":"filter.sortOrder","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PublicApiResponse[PagedContentResponse[Booking]]"}},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/accounts/{accountId}/bookings/{bookingId}":{"get":{"tags":["Booking"],"summary":"Get a Client Booking","description":"Get a booking in this client account","operationId":"GetBooking","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"The Id of the Client Account.","required":true,"type":"string"},{"name":"bookingId","in":"path","description":"The Id of the Booking.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Booking"}},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/accounts/{accountId}/bookings/create/quoted":{"post":{"tags":["Booking"],"summary":"Create a new Quoted Booking","description":"Create a new booking and process the MCPS pipeline","operationId":"CreateQuotedBooking","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"The Id of the Client Account.","required":true,"type":"string"},{"name":"quotedBooking","in":"body","description":"A Booking object","required":true,"schema":{"$ref":"#/definitions/QuotedBooking"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PublicApiResponse[Guid]"}},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/accounts/{accountId}/bookings/quotedbookingresults/{bookingId}":{"get":{"tags":["Booking"],"summary":"Get a Quoted Booking","description":"Get a quoted booking","operationId":"GetQuotedBooking","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"account id","required":true,"type":"string"},{"name":"bookingId","in":"path","description":"booking id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PublicApiResponse[QuotedBookingResponse]"}},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/accounts/{accountId}/bookings/create/draft":{"post":{"tags":["Booking"],"summary":"Create a new Draft Booking","description":"Create a new booking with a Draft status","operationId":"CreateDraftBooking","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"The Id of the Client Account.","required":true,"type":"string"},{"name":"draftBooking","in":"body","description":"A Booking object","required":true,"schema":{"$ref":"#/definitions/DraftBooking"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Booking"}},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/accounts/{accountId}/bookings/{bookingId}/update":{"post":{"tags":["Booking"],"summary":"Update a Booking","description":"Update a Booking.","operationId":"UpdateBooking","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"The Id of the Client Account.","required":true,"type":"string"},{"name":"bookingId","in":"path","description":"The Id of the Booking.","required":true,"type":"string"},{"name":"bookingObject","in":"body","description":"The amended booking object","required":true,"schema":{"$ref":"#/definitions/DraftBooking"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PublicApiResponse[Guid]"}},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/accounts/{accountId}/bookings/{bookingId}/confirm":{"post":{"tags":["Booking"],"summary":"Accept Booking","description":"Accept the Supplier Estimate and update the status of the Booking to Confirmed","operationId":"ConfirmBooking","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"The Id of the Client Account.","required":true,"type":"string"},{"name":"bookingId","in":"path","description":"The Id of the Booking.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Object"}},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/accounts/{accountId}/bookings/{bookingId}/cancel":{"post":{"tags":["Booking"],"summary":"Cancel a Booking","description":"Cancel a booking","operationId":"CancelBooking","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"The Id of the Supplier Account.","required":true,"type":"string"},{"name":"bookingId","in":"path","description":"The Id of the Booking.","required":true,"type":"string"},{"name":"reason","in":"body","description":"Reason for cancelling","required":true,"schema":{"$ref":"#/definitions/BookingCancellationReason"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Object"}},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/accounts/{accountId}/bookings/{bookingId}/generatesupplierestimates":{"post":{"tags":["Booking"],"summary":"Generate Supplier Estimates through MCPS","description":"Submits a draft booking to the MCPS process to generate Supplier Estimates and change the booking status to Unconfirmed","operationId":"GenerateSupplierEstimates","consumes":[],"produces":[],"parameters":[{"name":"accountId","in":"path","description":"The Id of the Client Account.","required":true,"type":"string"},{"name":"bookingId","in":"path","description":"The Id of the Booking.","required":true,"type":"string"}],"responses":{"200":{"description":"OK"},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/accounts/{accountId}/bookings/{bookingId}/supplierestimates":{"get":{"tags":["Booking"],"summary":"Get all Supplier Estimates","description":"Get the Supplier Estimates that wwere generated against a booking by the MCPS process","operationId":"GetSupplierEstimates","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"The Id of the Client Account.","required":true,"type":"string"},{"name":"bookingId","in":"path","description":"The Id of the Booking.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/SupplierQuote"}}},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/accounts/{accountId}/bookings/{bookingId}/activitylog":{"get":{"tags":["Booking"],"summary":"Get the activity logs for a booking","description":"Get the activity logs for a Booking","operationId":"GetBookingactivityLogs","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"Filter results by AccountId","required":true,"type":"string"},{"name":"bookingId","in":"path","description":"The Id of the Booking.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BookingActivityLog"}},"401":{"description":"Unauthorised"}},"deprecated":false}},"/claims/{userId}":{"get":{"tags":["Claims"],"operationId":"Claims_GetUserClaims","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"userId","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Object"}}},"deprecated":false},"post":{"tags":["Claims"],"operationId":"Claims_AddRemoveUserClaims","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"userId","in":"path","required":true,"type":"string"},{"name":"updateClaims","in":"body","required":true,"schema":{"$ref":"#/definitions/ClaimUpdateModel"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Object"}}},"deprecated":false}},"/api/notifications":{"get":{"tags":["Notifications"],"summary":"Get notifications","description":"Gets notifications.","operationId":"GetNotifications","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"fromDate","in":"query","description":"Filter results by From Date","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Notification"}}},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/accounts/{accountId}/participants":{"get":{"tags":["Participant"],"summary":"Get Client Participants","description":"Gets a collection of participants in this client account based on the specified search criteria","operationId":"GetParticipants","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"The Id of the Client Account.","required":true,"type":"string"},{"name":"sortBy","in":"query","description":"Specify the sort order","required":false,"type":"string"},{"name":"limit","in":"query","description":"Specify a limit value for pagination. This is the number of records to be returned per request.","required":false,"type":"integer","format":"int32"},{"name":"offset","in":"query","description":"Specify an offset value for pagination. An offset of 10 means return results from record 11.","required":false,"type":"integer","format":"int32"},{"name":"firstname","in":"query","description":"Filter by First Name","required":false,"type":"string"},{"name":"lastName","in":"query","description":"Filter by Last Name","required":false,"type":"string"},{"name":"jobTitle","in":"query","description":"Filter by Job Title","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BasicParticipant"}}},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/accounts/{accountId}/participants/participants/{participantId}/canbookfor":{"get":{"tags":["Participant"],"summary":"Get the participants that this participant can book for","description":"Gets a collection of participants in this client account based on the specified search criteria","operationId":"GetCanBookForParticipants","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"The Id of the Client Account.","required":true,"type":"string"},{"name":"participantId","in":"path","description":"The participant who's claims to check","required":true,"type":"string"},{"name":"sortBy","in":"query","description":"Specify the sort order","required":false,"type":"string"},{"name":"limit","in":"query","description":"Specify a limit value for pagination. This is the number of records to be returned per request.","required":false,"type":"integer","format":"int32"},{"name":"offset","in":"query","description":"Specify an offset value for pagination. An offset of 10 means return results from record 11.","required":false,"type":"integer","format":"int32"},{"name":"firstname","in":"query","description":"Filter by First Name","required":false,"type":"string"},{"name":"lastName","in":"query","description":"Filter by Last Name","required":false,"type":"string"},{"name":"jobTitle","in":"query","description":"Filter by Job Title","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/BasicParticipant"}}},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/accounts/{accountId}/participants/{participantId}":{"get":{"tags":["Participant"],"summary":"Get a Client Participant","description":"Get a participant in this client account","operationId":"GetParticipant","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"The Id of the Client Account.","required":true,"type":"string"},{"name":"participantId","in":"path","description":"The Id of the Participant.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FullParticipant"}},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/accounts/{accountId}/participants/participants/create":{"post":{"tags":["Participant"],"summary":"Add a client participant - will automatically duplicate match on email address","description":"Add a participant to the client account.","operationId":"CreateParticipant","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"The Id of the Client Account.","required":true,"type":"string"},{"name":"participantCreationObject","in":"body","description":"An Participant Creation object","required":true,"schema":{"$ref":"#/definitions/ParticipantCreation"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FullParticipant"}},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/accounts/{accountId}/participants/participants/update":{"post":{"tags":["Participant"],"summary":"Update a client participant","description":"Add a participant to the client account.","operationId":"UpdateParticipant","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"The Id of the Client Account.","required":true,"type":"string"},{"name":"participantId","in":"query","description":"The Id of the participant to update","required":true,"type":"string"},{"name":"participantUpdateObject","in":"body","description":"An Participant Creation object","required":true,"schema":{"$ref":"#/definitions/ParticipantUpdate"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PublicApiResponse[FullParticipant]"}},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/accounts/{accountId}/participants/{participantId}/delete":{"delete":{"tags":["Participant"],"summary":"Deactivate a client Participant","description":"Deactivate a Participant from the client account","operationId":"DeleteParticipant","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"","required":true,"type":"string"},{"name":"participantId","in":"path","description":"The Id of the Participant.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Object"}},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/accounts/{accountId}/participants/{participantId}/travelpolicyrestrictions":{"get":{"tags":["Participant"],"summary":"Get Booking Restrictions","description":"Gets a set of data that states what vehicle types, valid travel times and limits for a participant.","operationId":"GetBookingRestrictions","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"The Id of the Client Account.","required":true,"type":"string"},{"name":"participantId","in":"path","description":"The Id of the Booked For participant.","required":true,"type":"string"},{"name":"bookingPickupDateTime","in":"query","description":"The date and time the pickup will occur (yyyy-MM-dd HH:mm). Null with use DateTime.Now","required":false,"type":"string","format":"date-time"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TravelPolicyRestrictions"}},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/accounts/{accountId}/participants/{participantId}/clientreferencepreferences":{"get":{"tags":["Participant"],"summary":"Get ParticipantClientReferencePreferences","description":"Gets the ParticipantClientReferencePreferences for the specified Client Account for the specified Participant.","operationId":"GetClientReferencePreferences","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"The Id of the Client Account the user is booking under.","required":true,"type":"string"},{"name":"participantId","in":"path","description":"The Id of the Participant.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ClientReferencePreference"}}},"401":{"description":"Unauthorised"}},"deprecated":false},"post":{"tags":["Participant"],"summary":"Update ParticipantClientReferencePreferences","description":"Update the ParticipantClientReferencePreferences for the specified Client Account for the specified Participant.","operationId":"UpdateClientReferencePreferences","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":[],"parameters":[{"name":"accountId","in":"path","description":"","required":true,"type":"string"},{"name":"participantId","in":"path","description":"The Id of the Participant.","required":true,"type":"string"},{"name":"clientReferencePreferences","in":"body","description":"A Client Reference Preferences object","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/ClientReferencePreference"}}}],"responses":{"200":{"description":"OK"},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/accounts/{accountId}/participants/{participantId}/mobileapp/enable":{"post":{"tags":["Participant"],"summary":"Enable mobile app access","description":"Enables mobile app access for a participant","operationId":"EnableMobileAppAccess","consumes":[],"produces":[],"parameters":[{"name":"accountId","in":"path","description":"","required":true,"type":"string"},{"name":"participantId","in":"path","description":"The Id of the Participant.","required":true,"type":"string"}],"responses":{"200":{"description":"OK"},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/accounts/{accountId}/participants/{participantId}/portalaccess/enable":{"post":{"tags":["Participant"],"summary":"Enable portal access","description":"Enables portal access for a participant","operationId":"EnablePortalAccess","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"","required":true,"type":"string"},{"name":"participantId","in":"path","description":"The Id of the Participant.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Object"}},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/accounts/{accountId}/participants/{participantId}/portalaccess/disable":{"post":{"tags":["Participant"],"summary":"Disable portal and mobile app access","description":"Disables portal and mobile app access for a participant","operationId":"DisablePortalAccess","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"","required":true,"type":"string"},{"name":"participantId","in":"path","description":"The Id of the Participant.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Object"}},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/accounts/{accountId}/participants/{participantId}/canbookfor":{"post":{"tags":["Participant"],"summary":"Update who the participant can book for","operationId":"UpdateCanBookFor","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":[],"parameters":[{"name":"accountId","in":"path","description":"","required":true,"type":"string"},{"name":"participantId","in":"path","description":"The Id of the Participant.","required":true,"type":"string"},{"name":"updateModel","in":"body","description":"The update model","required":true,"schema":{"$ref":"#/definitions/UpdateCanBookFor"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Unauthorised"}},"deprecated":false}},"/password/change":{"post":{"tags":["Password"],"operationId":"Password_ChangePassword","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"passwordChangeRequest","in":"body","required":true,"schema":{"$ref":"#/definitions/PasswordChangeRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Object"}}},"deprecated":false}},"/password/expired":{"get":{"tags":["Password"],"operationId":"Password_PasswordExpired","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Object"}}},"deprecated":false},"post":{"tags":["Password"],"operationId":"Password_PasswordExpiredSubmit","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"passwordChangeRequest","in":"body","required":true,"schema":{"$ref":"#/definitions/PasswordChangeRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Object"}}},"deprecated":false}},"/password/reset":{"get":{"tags":["Password"],"operationId":"Password_PasswordReset","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Object"}}},"deprecated":false},"post":{"tags":["Password"],"operationId":"Password_GeneratePasswordReset","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"passwordResetRequest","in":"body","required":true,"schema":{"$ref":"#/definitions/PasswordResetRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Object"}}},"deprecated":false}},"/password/reset/{token}":{"get":{"tags":["Password"],"operationId":"Password_GetPasswordResetToken","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"token","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Object"}}},"deprecated":false}},"/api/referencedata/optionsets":{"get":{"tags":["ReferenceData"],"summary":"Get Option Sets","operationId":"GetOptionSets","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/OptionSetName"}}},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/referencedata/optionsets/{key}":{"get":{"tags":["ReferenceData"],"summary":"Get Option Set Values","operationId":"GetOptionSetValues","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"key","in":"path","description":"The option set key","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/OptionSetValue"}}},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/referencedata/vehiclecategories":{"get":{"tags":["ReferenceData"],"summary":"Get all vehicle categories","operationId":"GetVehicleCategories","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/VehicleCategory"}}}},"deprecated":false}},"/api/referencedata/services":{"get":{"tags":["ReferenceData"],"summary":"Get all additional services","operationId":"GetServices","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Service"}}}},"deprecated":false}},"/api/referencedata/ErrorCodes":{"get":{"tags":["ReferenceData"],"summary":"Gets all system ErrorCodes","operationId":"GetErrorCodes","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"enum":["SortParameterIsInvalid","LimitParameterIsBelowLowerBound","OffsetParameterIsBelowLowerBound","SearchStringIsInvalid","GuidIdParameterIsEmpty","GuidIdParameterIsUnparsable","NameStringIsInvalid","LocationTypeIdIsInvalid","MeetingPointValueIsEmpty","AccountIdGuidIsEmpty","BookingReferenceGuidIsEmpty","JobReferenceGuidIsEmpty","BookedByParticipantIdGuidIsEmpty","LeadPassengerParticipantIdGuidIsEmpty","PassengerNameIsEmpty","SupplierIdGuidIsEmpty","StatusIsEmpty","ToDateTimeOutsideUpperBound","FromDateOutsideLowerBound","ParticipantUpdateInvalid","PersonTitleIsInvalid","PersonGenderIsInvalid","QuotedBookingAccountIsEmpty","QuotedBookingAccountDoesNotExist","QuotedBookingBookingForIsEmpty","QuotedBookingBookingForIsNotFound","QuotedBookingBookerIsEmpty","QuotedBookingBookerNotFound","QuotedBookingClientReferenceDoesNotExist","QuotedBookingClientReferenceNotProvided","QuotedBookingClientReferenceEnforcedNotSatisfied","QuotedBookingPickupDateTimeIsInThePast","QuotedBookingPickupLocationNotProvided","QuotedBookingDestinationLocationIsInvalid","QuotedBookingViaLocationIsInvalid","QuotedBookingSpaceServiceLocationDoesNotExist","QuotedBookingNoVehicleRequestsDefined","QuotedBookingVehicleCategoryNotAvailable","QuotedBookingTypeInvalid","QuotedBookingSourceIsMissing","QuotedBookingNoBookingSourcesDefined","QuotedBookingBookingSourceIsInvalid","QuotedBookingNoServices","QuotedBookingServiceNotValidForClient","UserInformationIsMissing"],"type":"string"}}}},"deprecated":false}},"/api/users/current/participantmappings":{"get":{"tags":["User"],"summary":"Gets the participant mappings for the current user","operationId":"GetParticipantMappings","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ParticipantMapping"}}},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/users/current/clientreferencepreferences/{accountId}":{"post":{"tags":["User"],"summary":"Update the client reference preference for the current user","description":"Update the ClientReferencePreferences for the specified Client Account for the logged in user.","operationId":"UpdateUserClientReferencePreferences","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":[],"parameters":[{"name":"accountId","in":"path","description":"","required":true,"type":"string"},{"name":"clientReferencePreferences","in":"body","description":"A Client Reference Preferences object","required":true,"schema":{"$ref":"#/definitions/UpdateClientReferencePreferences"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/users/current/details":{"get":{"tags":["User"],"summary":"Get a user's person object","description":"Get a user's personal details","operationId":"GetUserDetails","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"query","description":"","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FullParticipant"}},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/users/current/updateDetails":{"post":{"tags":["User"],"summary":"Update a user's person object","description":"Update a user's personal details","operationId":"UpdateUserDetails","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"userDetails","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/UpdateUserDetails"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Object"}},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/users/current/bookings":{"get":{"tags":["User"],"summary":"Get the current user's bookings","description":"Gets a collection of bookings in this user based on the specified search criteria","operationId":"GetUserBookings","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"query","description":"The Id of the Client Account.","required":true,"type":"string"},{"name":"sortBy","in":"query","description":"Specify the sort order","required":true,"type":"string"},{"name":"limit","in":"query","description":"Specify a limit value for pagination. This is the number of records to be returned per request.","required":true,"type":"integer","format":"int32"},{"name":"offset","in":"query","description":"Specify an offset value for pagination. An offset of 10 means return results from record 11.","required":true,"type":"integer","format":"int32"},{"name":"bookingReference","in":"query","description":"Filter by Booking Reference","required":true,"type":"string"},{"name":"jobReference","in":"query","description":"Filter by Job Reference","required":true,"type":"string"},{"name":"bookedforparticipantId","in":"query","description":"Filter by BookedFor ParticipantId","required":true,"type":"string"},{"name":"bookedbyparticipantId","in":"query","description":"Filter by BookedBy ParticipantId","required":true,"type":"string"},{"name":"leadpassengerparticipantId","in":"query","description":"Filter by Lead Passenger ParticipantId","required":true,"type":"string"},{"name":"passengerName","in":"query","description":"Filter by Passenger Name","required":true,"type":"string"},{"name":"supplierId","in":"query","description":"Filter by SupplierId","required":true,"type":"string"},{"name":"status","in":"query","description":"Filter by Status","required":true,"type":"string"},{"name":"fromDate","in":"query","description":"Filter results by lower Pickup Date","required":true,"type":"string","format":"date-time"},{"name":"toDate","in":"query","description":"Filter results by upper Pickup Date","required":true,"type":"string","format":"date-time"},{"name":"includeBookingGroups","in":"query","description":"Whether to include the user's booking group participants in the search","required":true,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Booking"}}},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/users/current/addressbook":{"get":{"tags":["UserAddressBook"],"summary":"Get the User saved Addresses","description":"Gets the user Address Book.","operationId":"GetUserAddresses","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"sortBy","in":"query","description":"Specify the sort order","required":true,"type":"string"},{"name":"limit","in":"query","description":"Specify a limit value for pagination. This is the number of records to be returned per request.","required":true,"type":"integer","format":"int32"},{"name":"offset","in":"query","description":"Specify an offset value for pagination. An offset of 10 means return results from record 11.","required":true,"type":"integer","format":"int32"},{"name":"searchString","in":"query","description":"Filter results by a search string","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PublicApiResponse[Address[]]"}},"401":{"description":"Unauthorised"}},"deprecated":false},"post":{"tags":["UserAddressBook"],"summary":"Add a user address","description":"Add an address to the user address book.","operationId":"CreateUserAddress","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"address","in":"body","description":"An AddressRequest object","required":true,"schema":{"$ref":"#/definitions/AddressRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PublicApiResponse[Address]"}},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/users/current/addressbook/{addressId}":{"get":{"tags":["UserAddressBook"],"summary":"Get a single User saved Address","description":"Gets an address from the user Address Book.","operationId":"GetUserAddress","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"addressId","in":"path","description":"The id of the address","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PublicApiResponse[Address]"}},"401":{"description":"Unauthorised"}},"deprecated":false},"post":{"tags":["UserAddressBook"],"summary":"Update a user address","description":"Update an address in the user address book.","operationId":"UpdateUserAddress","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"addressId","in":"path","description":"Address Id","required":true,"type":"string"},{"name":"address","in":"body","description":"An AddressRequest object","required":true,"schema":{"$ref":"#/definitions/AddressRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PublicApiResponse[Address]"}},"401":{"description":"Unauthorised"}},"deprecated":false}},"/api/users/current/addressbook/{addressId}/delete":{"post":{"tags":["UserAddressBook"],"summary":"Remove a user address","description":"Remove an address from the user address book","operationId":"DeleteUserAddress","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"addressId","in":"path","description":"","required":true,"type":"string"}],"responses":{"204":{"description":"No Content","schema":{"$ref":"#/definitions/Object"}}},"deprecated":false}},"/users/{userId}":{"get":{"tags":["Users"],"operationId":"Users_GetUser","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"userId","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Object"}}},"deprecated":false}},"/users/find":{"post":{"tags":["Users"],"operationId":"Users_FindUsers","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"users","in":"body","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Object"}}},"deprecated":false}},"/users/byclaim/{claimType}":{"get":{"tags":["Users"],"operationId":"Users_GetUsersByClaim","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"claimType","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Object"}}},"deprecated":false}},"/users/byclaim/{claimType}/{claimValue}":{"get":{"tags":["Users"],"operationId":"Users_GetUsersByClaimType","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"claimType","in":"path","required":true,"type":"string"},{"name":"claimValue","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Object"}}},"deprecated":false}},"/users":{"post":{"tags":["Users"],"operationId":"Users_AddUser","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"user","in":"body","required":true,"schema":{"$ref":"#/definitions/AddUserModel"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Object"}}},"deprecated":false}},"/users/{userId}/maintain":{"post":{"tags":["Users"],"operationId":"Users_MaintainUser","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"user","in":"body","required":true,"schema":{"$ref":"#/definitions/MaintainUserModel"}},{"name":"userId","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Object"}}},"deprecated":false}},"/users/{userId}/unlock":{"post":{"tags":["Users"],"operationId":"Users_UnlockUser","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"userId","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Object"}}},"deprecated":false}},"/users/{userId}/password/reset":{"post":{"tags":["Users"],"operationId":"Users_ResetPassword","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"userId","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Object"}}},"deprecated":false}},"/users/locked":{"get":{"tags":["Users"],"operationId":"Users_AccountLocked","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Object"}}},"deprecated":false}},"/users/password/reset/{token}":{"get":{"tags":["Users"],"operationId":"Users_GetPasswordResetToken","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"token","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Object"}}},"deprecated":false},"post":{"tags":["Users"],"operationId":"Users_PasswordReset","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"request","in":"body","required":true,"schema":{"$ref":"#/definitions/PasswordResetPasswordChangeRequest"}},{"name":"token","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Object"}}},"deprecated":false}}},"definitions":{"Object":{"type":"object","properties":{}},"Account":{"type":"object","properties":{"Id":{"type":"string"},"Name":{"type":"string"},"AccountNumber":{"type":"string"}}},"ClientReference":{"description":"Client reference","type":"object","properties":{"ClientReferenceId":{"description":"Client reference id","type":"string"},"Required":{"description":"Whether the field is required","type":"boolean"},"Mask":{"description":"Input mask","type":"string"},"Label":{"description":"Input label","type":"string"},"Name":{"description":"Client reference name","type":"string"},"OrderNumber":{"description":"Field order number","type":"string"},"LookupEnforced":{"description":"Whether the selected value must be contained in the values collection","type":"boolean"},"Values":{"description":"Reference values","type":"array","items":{"$ref":"#/definitions/ClientReferenceValue"}}}},"ClientReferenceValue":{"description":"Client reference value","type":"object","properties":{"ValueId":{"description":"Value id","type":"string"},"Value":{"description":"Actual value","type":"string"}}},"BookingGroup":{"description":"A booking group","type":"object","properties":{"Members":{"description":"The members of the group","type":"array","items":{"$ref":"#/definitions/Participant"}},"Name":{"description":"The name of the group","type":"string"}}},"Participant":{"description":"A person related to an account","type":"object","properties":{"ClientPortalEnabled":{"description":"Whether the participant has access to the client portal for this account","type":"boolean"},"Title":{"description":"Title","type":"string"},"Firstname":{"description":"First name","type":"string"},"MiddleNameOrInitial":{"description":"Middle name","type":"string"},"Surname":{"description":"Surname","type":"string"},"Suffix":{"description":"Suffix","type":"string"},"JobTitle":{"description":"Job title","type":"string"},"Gender":{"description":"Gender","type":"string"},"EmailAddress":{"description":"Email address","type":"string"},"AdditionalContactDetails":{"description":"Additional contact details","type":"array","items":{"$ref":"#/definitions/ContactDetail"}},"ParticipantId":{"description":"The id of the participant","type":"string"},"AccountId":{"description":"Account id","type":"string"},"AccountName":{"description":"The name of the account","type":"string"},"AccountNumber":{"description":"The unique account number","type":"string"}}},"ContactDetail":{"description":"A contact detail","type":"object","properties":{"Type":{"description":"The type of the contact detail","type":"string"},"Value":{"description":"The contact information","type":"string"},"Primary":{"description":"Whether this is the primary or not","type":"boolean"}}},"AddMembers":{"description":"Adding members to a group","type":"object","properties":{"ParticipantsToAdd":{"description":"Ids of the participants to add","type":"array","items":{"type":"string"}}}},"RemoveMembers":{"description":"Remove members from a group","type":"object","properties":{"ParticipantsToRemove":{"description":"Ids of the participants to remove","type":"array","items":{"type":"string"}}}},"TpmGroup":{"description":"A travel policy management group","type":"object","properties":{"Members":{"description":"The members of the group","type":"array","items":{"$ref":"#/definitions/Participant"}},"Name":{"description":"The name of the group","type":"string"}}},"DocumentUpload":{"description":"A document to be uploaded","type":"object","properties":{"Filename":{"description":"Document filename","type":"string"},"MimeType":{"description":"Document mime type","type":"string"},"DocumentType":{"description":"Type of document (compliance, insurance etc.)","type":"string"},"Document":{"description":"Contents of the document","type":"string"}}},"PublicApiResponse[Address[]]":{"description":"A response wrapper containing the requested data (if successful) and\r\n            an array containing response codes indicating the state of the request","type":"object","properties":{"Data":{"description":"The requested data","type":"array","items":{"$ref":"#/definitions/Address"}},"ResponseCodes":{"description":"A List of response codes from {Cabfind.Residion.Api.Client.Models.Responses.PublicApiResponseCodes}","type":"array","items":{"enum":["SortParameterIsInvalid","LimitParameterIsBelowLowerBound","OffsetParameterIsBelowLowerBound","SearchStringIsInvalid","GuidIdParameterIsEmpty","GuidIdParameterIsUnparsable","NameStringIsInvalid","LocationTypeIdIsInvalid","MeetingPointValueIsEmpty","AccountIdGuidIsEmpty","BookingReferenceGuidIsEmpty","JobReferenceGuidIsEmpty","BookedByParticipantIdGuidIsEmpty","LeadPassengerParticipantIdGuidIsEmpty","PassengerNameIsEmpty","SupplierIdGuidIsEmpty","StatusIsEmpty","ToDateTimeOutsideUpperBound","FromDateOutsideLowerBound","ParticipantUpdateInvalid","PersonTitleIsInvalid","PersonGenderIsInvalid","QuotedBookingAccountIsEmpty","QuotedBookingAccountDoesNotExist","QuotedBookingBookingForIsEmpty","QuotedBookingBookingForIsNotFound","QuotedBookingBookerIsEmpty","QuotedBookingBookerNotFound","QuotedBookingClientReferenceDoesNotExist","QuotedBookingClientReferenceNotProvided","QuotedBookingClientReferenceEnforcedNotSatisfied","QuotedBookingPickupDateTimeIsInThePast","QuotedBookingPickupLocationNotProvided","QuotedBookingDestinationLocationIsInvalid","QuotedBookingViaLocationIsInvalid","QuotedBookingSpaceServiceLocationDoesNotExist","QuotedBookingNoVehicleRequestsDefined","QuotedBookingVehicleCategoryNotAvailable","QuotedBookingTypeInvalid","QuotedBookingSourceIsMissing","QuotedBookingNoBookingSourcesDefined","QuotedBookingBookingSourceIsInvalid","QuotedBookingNoServices","QuotedBookingServiceNotValidForClient","UserInformationIsMissing"],"type":"string"}}}},"Address":{"description":"An address in the system","type":"object","properties":{"AddressId":{"description":"The address id","type":"string"},"MeetingPoints":{"description":"The meeting points for this address","type":"array","items":{"$ref":"#/definitions/MeetingPoint"}},"LocationId":{"description":"The location id from the space service","type":"string"},"Name":{"description":"The friendly name of the address","type":"string"},"AddressLine1":{"description":"Address line 1","type":"string"},"AddressLine2":{"description":"Address line 2","type":"string"},"AddressLine3":{"description":"Address line 3","type":"string"},"AddressLine4":{"description":"Address line 4","type":"string"},"County":{"description":"County","type":"string"},"CountryCode":{"description":"Country","type":"string"},"LocationTypeId":{"format":"int32","description":"Location Type ID","type":"integer"}}},"MeetingPoint":{"description":"A meeting point","type":"object","properties":{"Value":{"description":"The value e.g. at front exit","type":"string"}}},"BookingFilter":{"type":"object","properties":{"SearchTerm":{"type":"string"},"PassengerName":{"type":"string"},"StatusFilter":{"type":"string"},"TravelStartDate":{"format":"date-time","type":"string"},"TravelEndDate":{"format":"date-time","type":"string"},"SupplierIds":{"type":"string"},"BookedByParticipantIds":{"type":"string"},"BookedForParticipantIds":{"type":"string"},"LeadPassengerParticipantIds":{"type":"string"},"BookingReference":{"type":"string"},"SortBy":{"type":"string"},"SortOrder":{"type":"string"}}},"PublicApiResponse[PagedContentResponse[Booking]]":{"description":"A response wrapper containing the requested data (if successful) and\r\n            an array containing response codes indicating the state of the request","type":"object","properties":{"Data":{"$ref":"#/definitions/PagedContentResponse[Booking]","description":"The requested data"},"ResponseCodes":{"description":"A List of response codes from {Cabfind.Residion.Api.Client.Models.Responses.PublicApiResponseCodes}","type":"array","items":{"enum":["SortParameterIsInvalid","LimitParameterIsBelowLowerBound","OffsetParameterIsBelowLowerBound","SearchStringIsInvalid","GuidIdParameterIsEmpty","GuidIdParameterIsUnparsable","NameStringIsInvalid","LocationTypeIdIsInvalid","MeetingPointValueIsEmpty","AccountIdGuidIsEmpty","BookingReferenceGuidIsEmpty","JobReferenceGuidIsEmpty","BookedByParticipantIdGuidIsEmpty","LeadPassengerParticipantIdGuidIsEmpty","PassengerNameIsEmpty","SupplierIdGuidIsEmpty","StatusIsEmpty","ToDateTimeOutsideUpperBound","FromDateOutsideLowerBound","ParticipantUpdateInvalid","PersonTitleIsInvalid","PersonGenderIsInvalid","QuotedBookingAccountIsEmpty","QuotedBookingAccountDoesNotExist","QuotedBookingBookingForIsEmpty","QuotedBookingBookingForIsNotFound","QuotedBookingBookerIsEmpty","QuotedBookingBookerNotFound","QuotedBookingClientReferenceDoesNotExist","QuotedBookingClientReferenceNotProvided","QuotedBookingClientReferenceEnforcedNotSatisfied","QuotedBookingPickupDateTimeIsInThePast","QuotedBookingPickupLocationNotProvided","QuotedBookingDestinationLocationIsInvalid","QuotedBookingViaLocationIsInvalid","QuotedBookingSpaceServiceLocationDoesNotExist","QuotedBookingNoVehicleRequestsDefined","QuotedBookingVehicleCategoryNotAvailable","QuotedBookingTypeInvalid","QuotedBookingSourceIsMissing","QuotedBookingNoBookingSourcesDefined","QuotedBookingBookingSourceIsInvalid","QuotedBookingNoServices","QuotedBookingServiceNotValidForClient","UserInformationIsMissing"],"type":"string"}}}},"PagedContentResponse[Booking]":{"type":"object","properties":{"StartPage":{"format":"int32","type":"integer"},"EndPage":{"format":"int32","type":"integer"},"TotalPages":{"format":"int32","type":"integer"},"StartRow":{"format":"int32","type":"integer"},"EndRow":{"format":"int32","type":"integer"},"TotalRows":{"format":"int32","type":"integer"},"Rows":{"type":"array","items":{"$ref":"#/definitions/Booking"}}}},"Booking":{"description":"A Booking","type":"object","properties":{"BookingId":{"description":"The Id of the booking","type":"string"},"SupplierQuotes":{"description":"The supplier quotes","type":"array","items":{"$ref":"#/definitions/SupplierQuote"}},"BookingStatus":{"description":"Status of the booking","type":"string"},"IsTracked":{"description":"If a booking is tacked","type":"boolean","readOnly":true},"Pickup":{"$ref":"#/definitions/BookingStopRequest","description":"Pickup address GUID"},"Destination":{"$ref":"#/definitions/BookingStopRequest","description":"Destination address GUID"},"Vias":{"description":"Via address GUIDs","type":"array","items":{"$ref":"#/definitions/BookingStopRequest"}},"PickupDatetime":{"format":"date-time","description":"Pickup date and time (UTC)","type":"string"},"ClientAccountId":{"description":"Client account id","type":"string"},"ClientAccountName":{"description":"Client account name","type":"string"},"BookerParticipantId":{"description":"Booker participant id (if an existing participant)","type":"string"},"BookerName":{"description":"Booker name (if not an existing participant)","type":"string"},"BookerTelephone":{"description":"Booker telephone number","type":"string"},"BookerEmail":{"description":"Booker email","type":"string"},"BookedForParticipantId":{"description":"Booked for participant id","type":"string"},"BookedForName":{"description":"Booked for name","type":"string"},"BookingType":{"description":"Booking type","type":"string"},"BookingSource":{"description":"Booking source","type":"string"},"BookersReference":{"description":"Booker's reference","type":"string"},"LeadPassengerParticipantId":{"description":"Lead passenger participant id (if an existing participant)","type":"string"},"LeadPassengerName":{"description":"Lead passenger name (if not an existing participant)","type":"string"},"LeadPassengerTelephone":{"description":"Lead passenger telephone","type":"string"},"VehicleRequests":{"description":"Requested vehicles","type":"array","items":{"$ref":"#/definitions/VehicleRequest"}},"ClientReferenceValues":{"description":"Requested Client Reference Values","type":"array","items":{"$ref":"#/definitions/ClientReferenceValueRequest"}},"Notes":{"description":"Notes","type":"string"},"TotalPassengers":{"format":"int32","description":"Total no of passengers","type":"integer","readOnly":true},"CallbackUrl":{"description":"Call back url to be called when quotes are available","type":"string"}}},"SupplierQuote":{"description":"Supplier quote for a booking","type":"object","properties":{"SupplierId":{"description":"Supplier id","type":"string"},"SupplierName":{"description":"Supplier name","type":"string"},"FulfillmentId":{"description":"Fulfillment id","type":"string"},"Vehicles":{"description":"Vehicles that will be used to fulfill the request - TBC","type":"array","items":{"type":"string"}},"VehicleRequest":{"$ref":"#/definitions/VehicleRequest","description":"Vehicle Request"},"Price":{"format":"double","description":"Price for the booking","type":"number"}}},"BookingStopRequest":{"description":"Compound object to request booking stops","type":"object","properties":{"LocationGuid":{"description":"Space service reference for location","type":"string"},"LocationName":{"description":"Full address","type":"string"},"MeetingPoint":{"description":"Required meeting point relative to the location","type":"string"}}},"VehicleRequest":{"description":"A Requested Vehicle","type":"object","properties":{"VehicleCategoryId":{"description":"Category of vehicle (null if \"any vehicle\")","type":"string"},"VehicleCategory":{"description":"Vehicle Category text based category","type":"string"},"Services":{"description":"Additional vehicle services","type":"array","items":{"$ref":"#/definitions/VehicleRequestService"}},"SpecialInstructions":{"description":"Special instructions for this vehicle","type":"array","items":{"type":"string"}}}},"ClientReferenceValueRequest":{"description":"Client Reference Value Request","type":"object","properties":{"ClientReferenceId":{"description":"Client Reference Id","type":"string"},"Value":{"description":"Client Reference Value","type":"string"}}},"VehicleRequestService":{"description":"Vehicle Additional Service","type":"object","properties":{"ServiceId":{"description":"Additiona service id","type":"string"},"Amount":{"format":"double","description":"Amount required","type":"number"}}},"QuotedBooking":{"description":"Respresents a quoted booking","type":"object","properties":{"Pickup":{"$ref":"#/definitions/BookingStopRequest","description":"Pickup address GUID"},"Destination":{"$ref":"#/definitions/BookingStopRequest","description":"Destination address GUID"},"Vias":{"description":"Via address GUIDs","type":"array","items":{"$ref":"#/definitions/BookingStopRequest"}},"PickupDatetime":{"format":"date-time","description":"Pickup date and time (UTC)","type":"string"},"ClientAccountId":{"description":"Client account id","type":"string"},"BookerParticipantId":{"description":"Booker participant id","type":"string"},"BookerName":{"description":"Booker name (if not an existing participant)","type":"string"},"BookerTelephone":{"description":"Booker telephone number","type":"string"},"BookerEmail":{"description":"Booker email","type":"string"},"BookedForParticipantId":{"description":"Booked for participant id","type":"string"},"BookingType":{"description":"Booking type","type":"string"},"BookingSource":{"description":"Booking source","type":"string"},"BookersReference":{"description":"Booker's reference","type":"string"},"LeadPassengerParticipantId":{"description":"Lead passenger participant id (if an existing participant)","type":"string"},"LeadPassengerName":{"description":"Lead passenger name (if not an existing participant)","type":"string"},"LeadPassengerTelephone":{"description":"Lead passenger telephone","type":"string"},"VehicleRequests":{"description":"Requested vehicles","type":"array","items":{"$ref":"#/definitions/VehicleRequest"}},"ClientReferenceValues":{"description":"Requested Client Reference Values","type":"array","items":{"$ref":"#/definitions/ClientReferenceValueRequest"}},"Notes":{"description":"Notes","type":"string"},"CallbackUrl":{"description":"Call back url to be called when quotes are available","type":"string"}}},"PublicApiResponse[Guid]":{"description":"A response wrapper containing the requested data (if successful) and\r\n            an array containing response codes indicating the state of the request","type":"object","properties":{"Data":{"description":"The requested data","type":"string"},"ResponseCodes":{"description":"A List of response codes from {Cabfind.Residion.Api.Client.Models.Responses.PublicApiResponseCodes}","type":"array","items":{"enum":["SortParameterIsInvalid","LimitParameterIsBelowLowerBound","OffsetParameterIsBelowLowerBound","SearchStringIsInvalid","GuidIdParameterIsEmpty","GuidIdParameterIsUnparsable","NameStringIsInvalid","LocationTypeIdIsInvalid","MeetingPointValueIsEmpty","AccountIdGuidIsEmpty","BookingReferenceGuidIsEmpty","JobReferenceGuidIsEmpty","BookedByParticipantIdGuidIsEmpty","LeadPassengerParticipantIdGuidIsEmpty","PassengerNameIsEmpty","SupplierIdGuidIsEmpty","StatusIsEmpty","ToDateTimeOutsideUpperBound","FromDateOutsideLowerBound","ParticipantUpdateInvalid","PersonTitleIsInvalid","PersonGenderIsInvalid","QuotedBookingAccountIsEmpty","QuotedBookingAccountDoesNotExist","QuotedBookingBookingForIsEmpty","QuotedBookingBookingForIsNotFound","QuotedBookingBookerIsEmpty","QuotedBookingBookerNotFound","QuotedBookingClientReferenceDoesNotExist","QuotedBookingClientReferenceNotProvided","QuotedBookingClientReferenceEnforcedNotSatisfied","QuotedBookingPickupDateTimeIsInThePast","QuotedBookingPickupLocationNotProvided","QuotedBookingDestinationLocationIsInvalid","QuotedBookingViaLocationIsInvalid","QuotedBookingSpaceServiceLocationDoesNotExist","QuotedBookingNoVehicleRequestsDefined","QuotedBookingVehicleCategoryNotAvailable","QuotedBookingTypeInvalid","QuotedBookingSourceIsMissing","QuotedBookingNoBookingSourcesDefined","QuotedBookingBookingSourceIsInvalid","QuotedBookingNoServices","QuotedBookingServiceNotValidForClient","UserInformationIsMissing"],"type":"string"}}}},"PublicApiResponse[QuotedBookingResponse]":{"description":"A response wrapper containing the requested data (if successful) and\r\n            an array containing response codes indicating the state of the request","type":"object","properties":{"Data":{"$ref":"#/definitions/QuotedBookingResponse","description":"The requested data"},"ResponseCodes":{"description":"A List of response codes from {Cabfind.Residion.Api.Client.Models.Responses.PublicApiResponseCodes}","type":"array","items":{"enum":["SortParameterIsInvalid","LimitParameterIsBelowLowerBound","OffsetParameterIsBelowLowerBound","SearchStringIsInvalid","GuidIdParameterIsEmpty","GuidIdParameterIsUnparsable","NameStringIsInvalid","LocationTypeIdIsInvalid","MeetingPointValueIsEmpty","AccountIdGuidIsEmpty","BookingReferenceGuidIsEmpty","JobReferenceGuidIsEmpty","BookedByParticipantIdGuidIsEmpty","LeadPassengerParticipantIdGuidIsEmpty","PassengerNameIsEmpty","SupplierIdGuidIsEmpty","StatusIsEmpty","ToDateTimeOutsideUpperBound","FromDateOutsideLowerBound","ParticipantUpdateInvalid","PersonTitleIsInvalid","PersonGenderIsInvalid","QuotedBookingAccountIsEmpty","QuotedBookingAccountDoesNotExist","QuotedBookingBookingForIsEmpty","QuotedBookingBookingForIsNotFound","QuotedBookingBookerIsEmpty","QuotedBookingBookerNotFound","QuotedBookingClientReferenceDoesNotExist","QuotedBookingClientReferenceNotProvided","QuotedBookingClientReferenceEnforcedNotSatisfied","QuotedBookingPickupDateTimeIsInThePast","QuotedBookingPickupLocationNotProvided","QuotedBookingDestinationLocationIsInvalid","QuotedBookingViaLocationIsInvalid","QuotedBookingSpaceServiceLocationDoesNotExist","QuotedBookingNoVehicleRequestsDefined","QuotedBookingVehicleCategoryNotAvailable","QuotedBookingTypeInvalid","QuotedBookingSourceIsMissing","QuotedBookingNoBookingSourcesDefined","QuotedBookingBookingSourceIsInvalid","QuotedBookingNoServices","QuotedBookingServiceNotValidForClient","UserInformationIsMissing"],"type":"string"}}}},"QuotedBookingResponse":{"type":"object","properties":{"BookingId":{"type":"string"},"BookingStatus":{"type":"string"},"SupplierQuotes":{"$ref":"#/definitions/SupplierQuotes"},"IsMCPSComplete":{"type":"boolean"},"IsTracked":{"type":"boolean","readOnly":true},"Pickup":{"$ref":"#/definitions/BookingStopRequest","description":"Pickup address GUID"},"Destination":{"$ref":"#/definitions/BookingStopRequest","description":"Destination address GUID"},"Vias":{"description":"Via address GUIDs","type":"array","items":{"$ref":"#/definitions/BookingStopRequest"}},"PickupDatetime":{"format":"date-time","description":"Pickup date and time (UTC)","type":"string"},"ClientAccountId":{"description":"Client account id","type":"string"},"ClientAccountName":{"description":"Client account name","type":"string"},"BookerParticipantId":{"description":"Booker participant id (if an existing participant)","type":"string"},"BookerName":{"description":"Booker name (if not an existing participant)","type":"string"},"BookerTelephone":{"description":"Booker telephone number","type":"string"},"BookerEmail":{"description":"Booker email","type":"string"},"BookedForParticipantId":{"description":"Booked for participant id","type":"string"},"BookedForName":{"description":"Booked for name","type":"string"},"BookingType":{"description":"Booking type","type":"string"},"BookingSource":{"description":"Booking source","type":"string"},"BookersReference":{"description":"Booker's reference","type":"string"},"LeadPassengerParticipantId":{"description":"Lead passenger participant id (if an existing participant)","type":"string"},"LeadPassengerName":{"description":"Lead passenger name (if not an existing participant)","type":"string"},"LeadPassengerTelephone":{"description":"Lead passenger telephone","type":"string"},"VehicleRequests":{"description":"Requested vehicles","type":"array","items":{"$ref":"#/definitions/VehicleRequest"}},"ClientReferenceValues":{"description":"Requested Client Reference Values","type":"array","items":{"$ref":"#/definitions/ClientReferenceValueRequest"}},"Notes":{"description":"Notes","type":"string"},"TotalPassengers":{"format":"int32","description":"Total no of passengers","type":"integer","readOnly":true},"CallbackUrl":{"description":"Call back url to be called when quotes are available","type":"string"}}},"SupplierQuotes":{"type":"object","properties":{"SelectedSupplierQuotes":{"type":"array","items":{"$ref":"#/definitions/SupplierQuote"}},"AllSupplierQuotes":{"type":"array","items":{"$ref":"#/definitions/SupplierQuote"}}}},"DraftBooking":{"description":"Respresents a draft booking","type":"object","properties":{"Pickup":{"$ref":"#/definitions/BookingStopRequest","description":"Pickup address GUID"},"Destination":{"$ref":"#/definitions/BookingStopRequest","description":"Destination address GUID"},"Vias":{"description":"Via address GUIDs","type":"array","items":{"$ref":"#/definitions/BookingStopRequest"}},"PickupDatetime":{"format":"date-time","description":"Pickup date and time (UTC)","type":"string"},"ClientAccountId":{"description":"Client account id","type":"string"},"ClientAccountName":{"description":"Client account name","type":"string"},"BookerParticipantId":{"description":"Booker participant id (if an existing participant)","type":"string"},"BookerName":{"description":"Booker name (if not an existing participant)","type":"string"},"BookerTelephone":{"description":"Booker telephone number","type":"string"},"BookerEmail":{"description":"Booker email","type":"string"},"BookedForParticipantId":{"description":"Booked for participant id","type":"string"},"BookedForName":{"description":"Booked for name","type":"string"},"BookingType":{"description":"Booking type","type":"string"},"BookingSource":{"description":"Booking source","type":"string"},"BookersReference":{"description":"Booker's reference","type":"string"},"LeadPassengerParticipantId":{"description":"Lead passenger participant id (if an existing participant)","type":"string"},"LeadPassengerName":{"description":"Lead passenger name (if not an existing participant)","type":"string"},"LeadPassengerTelephone":{"description":"Lead passenger telephone","type":"string"},"VehicleRequests":{"description":"Requested vehicles","type":"array","items":{"$ref":"#/definitions/VehicleRequest"}},"ClientReferenceValues":{"description":"Requested Client Reference Values","type":"array","items":{"$ref":"#/definitions/ClientReferenceValueRequest"}},"Notes":{"description":"Notes","type":"string"},"TotalPassengers":{"format":"int32","description":"Total no of passengers","type":"integer","readOnly":true},"CallbackUrl":{"description":"Call back url to be called when quotes are available","type":"string"}}},"BookingCancellationReason":{"description":"The reason for cancelling a booking","type":"object","properties":{"Reason":{"description":"Reason","type":"string"}}},"BookingActivityLog":{"description":"Activity log for a booking","type":"object","properties":{"BookingId":{"description":"Booking Id","type":"string"},"Entries":{"description":"Log entries","type":"array","items":{"$ref":"#/definitions/ActivityLogEntry"}}}},"ActivityLogEntry":{"description":"Activity log entry","type":"object","properties":{"Person":{"description":"Person performing the activity","type":"string"},"EntryDate":{"format":"date-time","description":"Date and time the activity was made (UTC)","type":"string"},"EntryType":{"description":"The type of entry","type":"string"},"Entry":{"description":"The log message","type":"string"}}},"ClaimUpdateModel":{"type":"object","properties":{"AddClaims":{"type":"array","items":{"$ref":"#/definitions/BaseClaimDefinition"}},"RemoveClaims":{"type":"array","items":{"$ref":"#/definitions/BaseClaimDefinition"}}}},"BaseClaimDefinition":{"type":"object","properties":{"ClaimType":{"type":"string"},"ClaimValue":{"type":"string"},"CreatedDate":{"format":"date-time","type":"string"}}},"Notification":{"description":"A system notification","type":"object","properties":{"NotificationId":{"description":"The notification id","type":"string"},"NotificationDate":{"format":"date-time","description":"The date the notification was sent (UTC)","type":"string"},"ExpiryDate":{"format":"date-time","description":"The date the notification expires (e.g. a downtime notification should expire the day after the downtime was scheduled)","type":"string"},"NotificationType":{"description":"The type of notification","type":"string"},"NotificationText":{"description":"The notification text","type":"string"}}},"BasicParticipant":{"description":"A basic representation of a person linked to an account","type":"object","properties":{"Title":{"description":"Title","type":"string"},"Firstname":{"description":"First name","type":"string"},"MiddleNameOrInitial":{"description":"Middle name","type":"string"},"Surname":{"description":"Surname","type":"string"},"Suffix":{"description":"Suffix","type":"string"},"JobTitle":{"description":"Job title","type":"string"},"Gender":{"description":"Gender","type":"string"},"EmailAddress":{"description":"Email address","type":"string"},"AdditionalContactDetails":{"description":"Additional contact details","type":"array","items":{"$ref":"#/definitions/ContactDetail"}},"ParticipantId":{"description":"The id of the participant","type":"string"},"AccountId":{"description":"Account id","type":"string"},"AccountName":{"description":"The name of the account","type":"string"},"AccountNumber":{"description":"The unique account number","type":"string"}}},"FullParticipant":{"description":"A person related to an account with additional data","type":"object","properties":{"ReferencePreferences":{"description":"The reference preferences","type":"array","items":{"$ref":"#/definitions/ClientReferencePreference"}},"ClientPortalEnabled":{"description":"Whether the participant has access to the client portal for this account","type":"boolean"},"Title":{"description":"Title","type":"string"},"Firstname":{"description":"First name","type":"string"},"MiddleNameOrInitial":{"description":"Middle name","type":"string"},"Surname":{"description":"Surname","type":"string"},"Suffix":{"description":"Suffix","type":"string"},"JobTitle":{"description":"Job title","type":"string"},"Gender":{"description":"Gender","type":"string"},"EmailAddress":{"description":"Email address","type":"string"},"AdditionalContactDetails":{"description":"Additional contact details","type":"array","items":{"$ref":"#/definitions/ContactDetail"}},"ParticipantId":{"description":"The id of the participant","type":"string"},"AccountId":{"description":"Account id","type":"string"},"AccountName":{"description":"The name of the account","type":"string"},"AccountNumber":{"description":"The unique account number","type":"string"}}},"ClientReferencePreference":{"description":"A participants preference for a client reference","type":"object","properties":{"ClientReferenceId":{"description":"The reference","type":"string"},"Value":{"description":"The reference value","type":"string"}}},"ParticipantCreation":{"description":"Create a participant","type":"object","properties":{"Title":{"description":"Title","type":"string"},"Firstname":{"description":"First name","type":"string"},"MiddleNameOrInitial":{"description":"Middle name","type":"string"},"Surname":{"description":"Surname","type":"string"},"Suffix":{"description":"Suffix","type":"string"},"JobTitle":{"description":"Job title","type":"string"},"Gender":{"description":"Gender","type":"string"},"EmailAddress":{"description":"Email address","type":"string"},"AdditionalContactDetails":{"description":"Additional contact details","type":"array","items":{"$ref":"#/definitions/ContactDetail"}},"NotificationPreferences":{"$ref":"#/definitions/NotificationPreference","description":"An array of a persons notification preferences"}}},"NotificationPreference":{"description":"A participants notification preference","type":"object","properties":{"NotificationSms":{"description":"Notify by SMS?","type":"boolean"},"NotificationEmail":{"description":"Notify by Email?","type":"boolean"},"MarketingSms":{"description":"Notify marketing by SMS?","type":"boolean"},"MarketingEmail":{"description":"Notify marketing by Email?","type":"boolean"},"MarketingTelephone":{"description":"Notify marketing by Telephone?","type":"boolean"}}},"ParticipantUpdate":{"description":"Create a participant","type":"object","properties":{"Title":{"description":"Title","type":"string"},"Firstname":{"description":"First name","type":"string"},"MiddleNameOrInitial":{"description":"Middle name","type":"string"},"Surname":{"description":"Surname","type":"string"},"Suffix":{"description":"Suffix","type":"string"},"JobTitle":{"description":"Job title","type":"string"},"Gender":{"description":"Gender","type":"string"},"AdditionalContactDetails":{"description":"Additional contact details","type":"array","items":{"$ref":"#/definitions/ContactDetail"}},"NotificationPreferences":{"$ref":"#/definitions/NotificationPreference","description":"An array of a persons notification preferences"}}},"PublicApiResponse[FullParticipant]":{"description":"A response wrapper containing the requested data (if successful) and\r\n            an array containing response codes indicating the state of the request","type":"object","properties":{"Data":{"$ref":"#/definitions/FullParticipant","description":"The requested data"},"ResponseCodes":{"description":"A List of response codes from {Cabfind.Residion.Api.Client.Models.Responses.PublicApiResponseCodes}","type":"array","items":{"enum":["SortParameterIsInvalid","LimitParameterIsBelowLowerBound","OffsetParameterIsBelowLowerBound","SearchStringIsInvalid","GuidIdParameterIsEmpty","GuidIdParameterIsUnparsable","NameStringIsInvalid","LocationTypeIdIsInvalid","MeetingPointValueIsEmpty","AccountIdGuidIsEmpty","BookingReferenceGuidIsEmpty","JobReferenceGuidIsEmpty","BookedByParticipantIdGuidIsEmpty","LeadPassengerParticipantIdGuidIsEmpty","PassengerNameIsEmpty","SupplierIdGuidIsEmpty","StatusIsEmpty","ToDateTimeOutsideUpperBound","FromDateOutsideLowerBound","ParticipantUpdateInvalid","PersonTitleIsInvalid","PersonGenderIsInvalid","QuotedBookingAccountIsEmpty","QuotedBookingAccountDoesNotExist","QuotedBookingBookingForIsEmpty","QuotedBookingBookingForIsNotFound","QuotedBookingBookerIsEmpty","QuotedBookingBookerNotFound","QuotedBookingClientReferenceDoesNotExist","QuotedBookingClientReferenceNotProvided","QuotedBookingClientReferenceEnforcedNotSatisfied","QuotedBookingPickupDateTimeIsInThePast","QuotedBookingPickupLocationNotProvided","QuotedBookingDestinationLocationIsInvalid","QuotedBookingViaLocationIsInvalid","QuotedBookingSpaceServiceLocationDoesNotExist","QuotedBookingNoVehicleRequestsDefined","QuotedBookingVehicleCategoryNotAvailable","QuotedBookingTypeInvalid","QuotedBookingSourceIsMissing","QuotedBookingNoBookingSourcesDefined","QuotedBookingBookingSourceIsInvalid","QuotedBookingNoServices","QuotedBookingServiceNotValidForClient","UserInformationIsMissing"],"type":"string"}}}},"TravelPolicyRestrictions":{"description":"Restrictions placed on a participant when making a booking","type":"object","properties":{"JourneyDistance":{"$ref":"#/definitions/JourneyDistance","description":"Returns information about whether the participant has reached the Max Journeys limit for the period"},"SpendLimit":{"$ref":"#/definitions/SpendLimit","description":"Returns information about whether the participant has reached the Spend limit for the period"},"VehicleSelection":{"$ref":"#/definitions/VehicleSelection","description":"The vehicle categories available for selection by the Booked For Participant. \r\n            This list excludes categories that are restricted but includes ones that are advisory."},"ServiceSelection":{"$ref":"#/definitions/ServiceSelection","description":"The services available for selection by the Booked For Participant. \r\n            This list excludes services that are restricted but includes ones that are advisory"},"AvailableAdditionalServices":{"$ref":"#/definitions/ServiceSelection","description":"The additional services available for selection by the Booked For Participant. \r\n            This list excludes additional services that are restricted but includes ones that are advisory."},"TravelTimeSelection":{"$ref":"#/definitions/TravelTimeSelection","description":"The days and times within each day when the participant is allowed to travel."},"FixedRoute":{"$ref":"#/definitions/FixedRoute","description":"Returns information about whether the participant should only book fixed route journeys"}}},"JourneyDistance":{"description":"Journey distance model","type":"object","properties":{"LimitReached":{"description":"Has the limit been reached?","type":"boolean"},"Limit":{"format":"double","description":"The current limit value","type":"number"},"AdvisoryText":{"description":"The warning message for an advisory limit","type":"string"}}},"SpendLimit":{"description":"Spend limit model","type":"object","properties":{"LimitReached":{"description":"Has the limit been reached?","type":"boolean"},"Limit":{"format":"double","description":"The current limit value","type":"number"},"AdvisoryText":{"description":"The warning message for an advisory limit","type":"string"}}},"VehicleSelection":{"description":"The vehicle categories available for selection by the Booked For Participant. \r\n            This list excludes categories that are restricted but includes ones that are advisory.","type":"object","properties":{"AvailableCategories":{"description":"The vehicle categories that are available to the participant","type":"array","items":{"$ref":"#/definitions/TravelPolicyVehicleCategory"}},"AdvisoryText":{"description":"The warning message for an advisory limit","type":"string"}}},"ServiceSelection":{"description":"A service selection travel policy management item","type":"object","properties":{"AvailableServices":{"description":"The services that are available to the participant","type":"array","items":{"$ref":"#/definitions/TravelPolicyService"}},"AdvisoryText":{"description":"The warning message for an advisory limit","type":"string"}}},"TravelTimeSelection":{"description":"The days and times within each day when the participant is allowed to travel","type":"object","properties":{"RestrictionType":{"description":"If Restricted the participant is prevented from travelling outside of the availabletravelTimes. \r\n            If Advisory, a warning message is displayed if the participant chooses a travel time that is outside of the availabletravelTimes.","type":"string"},"AvailableTravelTime":{"description":"The restrictions applied to specific days","type":"object","additionalProperties":{"$ref":"#/definitions/DayRestriction"}},"AdvisoryText":{"description":"The warning message for an advisory limit","type":"string"}}},"FixedRoute":{"description":"A fixed route restriction","type":"object","properties":{"FixedRouteOnly":{"description":"If 'true', the fixed route only restriction applies","type":"boolean"},"AdvisoryText":{"description":"The warning message for an advisory limit","type":"string"}}},"TravelPolicyVehicleCategory":{"description":"A travel policy vehicle category item","type":"object","properties":{"IsAdvisory":{"description":"Is the vehicle category restriction advisory","type":"boolean"},"Id":{"description":"The id of the category","type":"string"}}},"TravelPolicyService":{"description":"A travel policy service item","type":"object","properties":{"IsAdvisory":{"description":"Is the service restriction advisory","type":"boolean"},"ServiceId":{"description":"Additional service id","type":"string"},"ServiceName":{"description":"Service name","type":"string"}}},"DayRestriction":{"description":"Booking restriction for a specific day","type":"object","properties":{"Allowed":{"description":"Allowed to book on this day","type":"boolean"},"StartTime":{"description":"The start of the time period that the participant is permitted to book","type":"string"},"EndTime":{"description":"The end of the time period that the participant is permitted to book","type":"string"}}},"UpdateCanBookFor":{"description":"Updates who a participant can book for","type":"object","properties":{"ParticipantIds":{"description":"The participants the participant can book for","type":"array","items":{"type":"string"}}}},"PasswordChangeRequest":{"type":"object","properties":{"OldPassword":{"type":"string"},"NewPassword":{"type":"string"}}},"PasswordResetRequest":{"type":"object","properties":{"Email":{"type":"string"}}},"OptionSetName":{"description":"An OptionSet name object","type":"object","properties":{"Key":{"description":"The unique key of the optionset","type":"string"},"Name":{"description":"The name of the optionset","type":"string"}}},"OptionSetValue":{"description":"An option set value object","type":"object","properties":{"Id":{"description":"The Id of the value","type":"string"},"Name":{"description":"The name of the value","type":"string"}}},"VehicleCategory":{"description":"A vehicle category","type":"object","properties":{"Name":{"description":"The name of the category","type":"string"},"Icon":{"description":"The icon that represents the category","type":"string"},"Id":{"description":"The id of the category","type":"string"}}},"Service":{"description":"A service definition","type":"object","properties":{"ServiceId":{"description":"Additional service id","type":"string"},"ServiceName":{"description":"Service name","type":"string"}}},"ParticipantMapping":{"description":"A participant->account mapping","type":"object","properties":{"ParticipantId":{"description":"The id of the participant","type":"string"},"AccountId":{"description":"Account id","type":"string"},"AccountName":{"description":"The name of the account","type":"string"},"AccountNumber":{"description":"The unique account number","type":"string"}}},"UpdateClientReferencePreferences":{"description":"Updates the client reference preferences for a participant","type":"object","properties":{"Preferences":{"description":"Preferences","type":"array","items":{"$ref":"#/definitions/ClientReferencePreference"}}}},"UpdateUserDetails":{"description":"User details for updating","type":"object","properties":{"UserId":{"description":"User Id","type":"string"},"Title":{"description":"Title","type":"string"},"Firstname":{"description":"First name","type":"string"},"MiddleNameOrInitial":{"description":"Middle name","type":"string"},"Surname":{"description":"Surname","type":"string"},"Suffix":{"description":"Suffix","type":"string"},"JobTitle":{"description":"Job title","type":"string"},"Gender":{"description":"Gender","type":"string"}}},"AddressRequest":{"description":"Adding members to a group","type":"object","properties":{"LocationId":{"description":"The address id","type":"string"},"Name":{"description":"The friendly name of the address","type":"string"},"MeetingPoints":{"description":"The meeting points for this address","type":"array","items":{"$ref":"#/definitions/MeetingPoint"}},"LocationTypeId":{"format":"int32","description":"The ID of the Location Type","type":"integer"}}},"PublicApiResponse[Address]":{"description":"A response wrapper containing the requested data (if successful) and\r\n            an array containing response codes indicating the state of the request","type":"object","properties":{"Data":{"$ref":"#/definitions/Address","description":"The requested data"},"ResponseCodes":{"description":"A List of response codes from {Cabfind.Residion.Api.Client.Models.Responses.PublicApiResponseCodes}","type":"array","items":{"enum":["SortParameterIsInvalid","LimitParameterIsBelowLowerBound","OffsetParameterIsBelowLowerBound","SearchStringIsInvalid","GuidIdParameterIsEmpty","GuidIdParameterIsUnparsable","NameStringIsInvalid","LocationTypeIdIsInvalid","MeetingPointValueIsEmpty","AccountIdGuidIsEmpty","BookingReferenceGuidIsEmpty","JobReferenceGuidIsEmpty","BookedByParticipantIdGuidIsEmpty","LeadPassengerParticipantIdGuidIsEmpty","PassengerNameIsEmpty","SupplierIdGuidIsEmpty","StatusIsEmpty","ToDateTimeOutsideUpperBound","FromDateOutsideLowerBound","ParticipantUpdateInvalid","PersonTitleIsInvalid","PersonGenderIsInvalid","QuotedBookingAccountIsEmpty","QuotedBookingAccountDoesNotExist","QuotedBookingBookingForIsEmpty","QuotedBookingBookingForIsNotFound","QuotedBookingBookerIsEmpty","QuotedBookingBookerNotFound","QuotedBookingClientReferenceDoesNotExist","QuotedBookingClientReferenceNotProvided","QuotedBookingClientReferenceEnforcedNotSatisfied","QuotedBookingPickupDateTimeIsInThePast","QuotedBookingPickupLocationNotProvided","QuotedBookingDestinationLocationIsInvalid","QuotedBookingViaLocationIsInvalid","QuotedBookingSpaceServiceLocationDoesNotExist","QuotedBookingNoVehicleRequestsDefined","QuotedBookingVehicleCategoryNotAvailable","QuotedBookingTypeInvalid","QuotedBookingSourceIsMissing","QuotedBookingNoBookingSourcesDefined","QuotedBookingBookingSourceIsInvalid","QuotedBookingNoServices","QuotedBookingServiceNotValidForClient","UserInformationIsMissing"],"type":"string"}}}},"PublicApiResponse":{"description":"A response wrapper containing an empty data field and an array containing \r\n            response codes indicating the state of the request.","type":"object","properties":{"Data":{"description":"This field should not be populated. Use the generic version of {Cabfind.Residion.Api.Client.Models.Responses.PublicApiResponse} instead.","type":"string"},"ResponseCodes":{"description":"A List of response codes from {Cabfind.Residion.Api.Client.Models.Responses.PublicApiResponseCodes}","type":"array","items":{"enum":["SortParameterIsInvalid","LimitParameterIsBelowLowerBound","OffsetParameterIsBelowLowerBound","SearchStringIsInvalid","GuidIdParameterIsEmpty","GuidIdParameterIsUnparsable","NameStringIsInvalid","LocationTypeIdIsInvalid","MeetingPointValueIsEmpty","AccountIdGuidIsEmpty","BookingReferenceGuidIsEmpty","JobReferenceGuidIsEmpty","BookedByParticipantIdGuidIsEmpty","LeadPassengerParticipantIdGuidIsEmpty","PassengerNameIsEmpty","SupplierIdGuidIsEmpty","StatusIsEmpty","ToDateTimeOutsideUpperBound","FromDateOutsideLowerBound","ParticipantUpdateInvalid","PersonTitleIsInvalid","PersonGenderIsInvalid","QuotedBookingAccountIsEmpty","QuotedBookingAccountDoesNotExist","QuotedBookingBookingForIsEmpty","QuotedBookingBookingForIsNotFound","QuotedBookingBookerIsEmpty","QuotedBookingBookerNotFound","QuotedBookingClientReferenceDoesNotExist","QuotedBookingClientReferenceNotProvided","QuotedBookingClientReferenceEnforcedNotSatisfied","QuotedBookingPickupDateTimeIsInThePast","QuotedBookingPickupLocationNotProvided","QuotedBookingDestinationLocationIsInvalid","QuotedBookingViaLocationIsInvalid","QuotedBookingSpaceServiceLocationDoesNotExist","QuotedBookingNoVehicleRequestsDefined","QuotedBookingVehicleCategoryNotAvailable","QuotedBookingTypeInvalid","QuotedBookingSourceIsMissing","QuotedBookingNoBookingSourcesDefined","QuotedBookingBookingSourceIsInvalid","QuotedBookingNoServices","QuotedBookingServiceNotValidForClient","UserInformationIsMissing"],"type":"string"}}}},"AddUserModel":{"type":"object","properties":{"Id":{"type":"string"},"Email":{"type":"string"},"FirstName":{"type":"string"},"Surname":{"type":"string"},"MiddleNameOrInitial":{"type":"string"}}},"MaintainUserModel":{"type":"object","properties":{"Id":{"type":"string"},"Email":{"type":"string"},"FirstName":{"type":"string"},"Surname":{"type":"string"},"MiddleNameOrInitial":{"type":"string"}}},"PasswordResetPasswordChangeRequest":{"type":"object","properties":{"NewPassword":{"type":"string"},"UserId":{"type":"string"},"Token":{"type":"string"}}}}}