GET api/BookingTypes/{bookingTypeIdentity}/BookingForm
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
bookingTypeIdentity | string |
Required |
Body Parameters
None.
Response Information
Resource Description
BookingFormName | Description | Type | Additional information |
---|---|---|---|
Identity | globally unique identifier |
None. |
|
Name | string |
None. |
|
Description | string |
None. |
|
Sections | Collection of Section |
None. |
|
AssociatedBookingTypes | Collection of BookingType |
None. |
Response Formats
application/json, text/json
Sample:
{ "Identity": "797c8e5f-cf7b-4a42-a607-ab2e30e37c9d", "Name": "sample string 2", "Description": "sample string 3", "Sections": [ { "Identity": "c9004cc1-46f6-4b2e-aa79-b6c384e4b734", "Name": "sample string 2", "Rank": 3, "Fields": [ { "Identity": "b97831be-08cd-4b98-a97f-370c15335e94", "Rank": 2, "Description": "sample string 3", "FieldType": 0, "IsActive": true }, { "Identity": "b97831be-08cd-4b98-a97f-370c15335e94", "Rank": 2, "Description": "sample string 3", "FieldType": 0, "IsActive": true } ] }, { "Identity": "c9004cc1-46f6-4b2e-aa79-b6c384e4b734", "Name": "sample string 2", "Rank": 3, "Fields": [ { "Identity": "b97831be-08cd-4b98-a97f-370c15335e94", "Rank": 2, "Description": "sample string 3", "FieldType": 0, "IsActive": true }, { "Identity": "b97831be-08cd-4b98-a97f-370c15335e94", "Rank": 2, "Description": "sample string 3", "FieldType": 0, "IsActive": true } ] } ], "AssociatedBookingTypes": [ { "BookingForm": { "Identity": "b24faa3c-e4e7-4981-8abb-85425f6af991", "Name": "sample string 2" }, "BasePermissionGroups": [ { "Identity": "b24faa3c-e4e7-4981-8abb-85425f6af991", "Name": "sample string 2" }, { "Identity": "b24faa3c-e4e7-4981-8abb-85425f6af991", "Name": "sample string 2" } ], "BoboPermissionGroups": [ { "Identity": "b24faa3c-e4e7-4981-8abb-85425f6af991", "Name": "sample string 2" }, { "Identity": "b24faa3c-e4e7-4981-8abb-85425f6af991", "Name": "sample string 2" } ], "Description": "sample string 1", "ResourceRestrictionRules": [ { "Name": "sample string 1", "Identity": "2ddd58f7-50fe-424b-a733-e46823f502cf", "ResourceType": { "Identity": "b24faa3c-e4e7-4981-8abb-85425f6af991", "Name": "sample string 2" }, "Min": 3, "Max": 4, "ResourceGroups": [ { "Identity": "b24faa3c-e4e7-4981-8abb-85425f6af991", "Name": "sample string 2" }, { "Identity": "b24faa3c-e4e7-4981-8abb-85425f6af991", "Name": "sample string 2" } ], "AllowResourceSelection": true, "IsPrimary": true }, { "Name": "sample string 1", "Identity": "2ddd58f7-50fe-424b-a733-e46823f502cf", "ResourceType": { "Identity": "b24faa3c-e4e7-4981-8abb-85425f6af991", "Name": "sample string 2" }, "Min": 3, "Max": 4, "ResourceGroups": [ { "Identity": "b24faa3c-e4e7-4981-8abb-85425f6af991", "Name": "sample string 2" }, { "Identity": "b24faa3c-e4e7-4981-8abb-85425f6af991", "Name": "sample string 2" } ], "AllowResourceSelection": true, "IsPrimary": true } ], "ImageUri": "http://webapihelppage2.com", "CanEdit": true, "CanBookOnBehalfOf": true, "CanBookAsSomeoneElse": true, "HasExternallyManagedResources": true, "ReadPermissionGroups": [ { "Identity": "b24faa3c-e4e7-4981-8abb-85425f6af991", "Name": "sample string 2" }, { "Identity": "b24faa3c-e4e7-4981-8abb-85425f6af991", "Name": "sample string 2" } ], "WritePermissionGroups": [ { "Identity": "b24faa3c-e4e7-4981-8abb-85425f6af991", "Name": "sample string 2" }, { "Identity": "b24faa3c-e4e7-4981-8abb-85425f6af991", "Name": "sample string 2" } ], "Identity": "d3f27b7c-0143-4e4f-8c4b-cf8b6d012b27", "Name": "sample string 7" }, { "BookingForm": { "Identity": "b24faa3c-e4e7-4981-8abb-85425f6af991", "Name": "sample string 2" }, "BasePermissionGroups": [ { "Identity": "b24faa3c-e4e7-4981-8abb-85425f6af991", "Name": "sample string 2" }, { "Identity": "b24faa3c-e4e7-4981-8abb-85425f6af991", "Name": "sample string 2" } ], "BoboPermissionGroups": [ { "Identity": "b24faa3c-e4e7-4981-8abb-85425f6af991", "Name": "sample string 2" }, { "Identity": "b24faa3c-e4e7-4981-8abb-85425f6af991", "Name": "sample string 2" } ], "Description": "sample string 1", "ResourceRestrictionRules": [ { "Name": "sample string 1", "Identity": "2ddd58f7-50fe-424b-a733-e46823f502cf", "ResourceType": { "Identity": "b24faa3c-e4e7-4981-8abb-85425f6af991", "Name": "sample string 2" }, "Min": 3, "Max": 4, "ResourceGroups": [ { "Identity": "b24faa3c-e4e7-4981-8abb-85425f6af991", "Name": "sample string 2" }, { "Identity": "b24faa3c-e4e7-4981-8abb-85425f6af991", "Name": "sample string 2" } ], "AllowResourceSelection": true, "IsPrimary": true }, { "Name": "sample string 1", "Identity": "2ddd58f7-50fe-424b-a733-e46823f502cf", "ResourceType": { "Identity": "b24faa3c-e4e7-4981-8abb-85425f6af991", "Name": "sample string 2" }, "Min": 3, "Max": 4, "ResourceGroups": [ { "Identity": "b24faa3c-e4e7-4981-8abb-85425f6af991", "Name": "sample string 2" }, { "Identity": "b24faa3c-e4e7-4981-8abb-85425f6af991", "Name": "sample string 2" } ], "AllowResourceSelection": true, "IsPrimary": true } ], "ImageUri": "http://webapihelppage2.com", "CanEdit": true, "CanBookOnBehalfOf": true, "CanBookAsSomeoneElse": true, "HasExternallyManagedResources": true, "ReadPermissionGroups": [ { "Identity": "b24faa3c-e4e7-4981-8abb-85425f6af991", "Name": "sample string 2" }, { "Identity": "b24faa3c-e4e7-4981-8abb-85425f6af991", "Name": "sample string 2" } ], "WritePermissionGroups": [ { "Identity": "b24faa3c-e4e7-4981-8abb-85425f6af991", "Name": "sample string 2" }, { "Identity": "b24faa3c-e4e7-4981-8abb-85425f6af991", "Name": "sample string 2" } ], "Identity": "d3f27b7c-0143-4e4f-8c4b-cf8b6d012b27", "Name": "sample string 7" } ] }
application/xml, text/xml
Sample:
<BookingForm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model.ConfigurableBookingForms.Forms"> <AssociatedBookingTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model"> <d2p1:BookingType> <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">d3f27b7c-0143-4e4f-8c4b-cf8b6d012b27</Identity> <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 7</Name> <d2p1:ReadPermissionGroups xmlns:d4p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security"> <d4p1:NamedObject> <d4p1:Identity>b24faa3c-e4e7-4981-8abb-85425f6af991</d4p1:Identity> <d4p1:Name>sample string 2</d4p1:Name> </d4p1:NamedObject> <d4p1:NamedObject> <d4p1:Identity>b24faa3c-e4e7-4981-8abb-85425f6af991</d4p1:Identity> <d4p1:Name>sample string 2</d4p1:Name> </d4p1:NamedObject> </d2p1:ReadPermissionGroups> <d2p1:WritePermissionGroups xmlns:d4p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security"> <d4p1:NamedObject> <d4p1:Identity>b24faa3c-e4e7-4981-8abb-85425f6af991</d4p1:Identity> <d4p1:Name>sample string 2</d4p1:Name> </d4p1:NamedObject> <d4p1:NamedObject> <d4p1:Identity>b24faa3c-e4e7-4981-8abb-85425f6af991</d4p1:Identity> <d4p1:Name>sample string 2</d4p1:Name> </d4p1:NamedObject> </d2p1:WritePermissionGroups> <d2p1:BasePermissionGroups xmlns:d4p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security"> <d4p1:NamedObject> <d4p1:Identity>b24faa3c-e4e7-4981-8abb-85425f6af991</d4p1:Identity> <d4p1:Name>sample string 2</d4p1:Name> </d4p1:NamedObject> <d4p1:NamedObject> <d4p1:Identity>b24faa3c-e4e7-4981-8abb-85425f6af991</d4p1:Identity> <d4p1:Name>sample string 2</d4p1:Name> </d4p1:NamedObject> </d2p1:BasePermissionGroups> <d2p1:BoboPermissionGroups xmlns:d4p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security"> <d4p1:NamedObject> <d4p1:Identity>b24faa3c-e4e7-4981-8abb-85425f6af991</d4p1:Identity> <d4p1:Name>sample string 2</d4p1:Name> </d4p1:NamedObject> <d4p1:NamedObject> <d4p1:Identity>b24faa3c-e4e7-4981-8abb-85425f6af991</d4p1:Identity> <d4p1:Name>sample string 2</d4p1:Name> </d4p1:NamedObject> </d2p1:BoboPermissionGroups> <d2p1:BookingForm xmlns:d4p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security"> <d4p1:Identity>b24faa3c-e4e7-4981-8abb-85425f6af991</d4p1:Identity> <d4p1:Name>sample string 2</d4p1:Name> </d2p1:BookingForm> <d2p1:CanBookAsSomeoneElse>true</d2p1:CanBookAsSomeoneElse> <d2p1:CanBookOnBehalfOf>true</d2p1:CanBookOnBehalfOf> <d2p1:CanEdit>true</d2p1:CanEdit> <d2p1:Description>sample string 1</d2p1:Description> <d2p1:HasExternallyManagedResources>true</d2p1:HasExternallyManagedResources> <d2p1:ImageUri>http://webapihelppage2.com/</d2p1:ImageUri> <d2p1:ResourceRestrictionRules> <d2p1:ResourceRequirementTemplate> <d2p1:AllowResourceSelection>true</d2p1:AllowResourceSelection> <d2p1:Identity>2ddd58f7-50fe-424b-a733-e46823f502cf</d2p1:Identity> <d2p1:IsPrimary>true</d2p1:IsPrimary> <d2p1:Max>4</d2p1:Max> <d2p1:Min>3</d2p1:Min> <d2p1:Name>sample string 1</d2p1:Name> <d2p1:ResourceGroups xmlns:d6p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security"> <d6p1:NamedObject> <d6p1:Identity>b24faa3c-e4e7-4981-8abb-85425f6af991</d6p1:Identity> <d6p1:Name>sample string 2</d6p1:Name> </d6p1:NamedObject> <d6p1:NamedObject> <d6p1:Identity>b24faa3c-e4e7-4981-8abb-85425f6af991</d6p1:Identity> <d6p1:Name>sample string 2</d6p1:Name> </d6p1:NamedObject> </d2p1:ResourceGroups> <d2p1:ResourceType xmlns:d6p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security"> <d6p1:Identity>b24faa3c-e4e7-4981-8abb-85425f6af991</d6p1:Identity> <d6p1:Name>sample string 2</d6p1:Name> </d2p1:ResourceType> </d2p1:ResourceRequirementTemplate> <d2p1:ResourceRequirementTemplate> <d2p1:AllowResourceSelection>true</d2p1:AllowResourceSelection> <d2p1:Identity>2ddd58f7-50fe-424b-a733-e46823f502cf</d2p1:Identity> <d2p1:IsPrimary>true</d2p1:IsPrimary> <d2p1:Max>4</d2p1:Max> <d2p1:Min>3</d2p1:Min> <d2p1:Name>sample string 1</d2p1:Name> <d2p1:ResourceGroups xmlns:d6p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security"> <d6p1:NamedObject> <d6p1:Identity>b24faa3c-e4e7-4981-8abb-85425f6af991</d6p1:Identity> <d6p1:Name>sample string 2</d6p1:Name> </d6p1:NamedObject> <d6p1:NamedObject> <d6p1:Identity>b24faa3c-e4e7-4981-8abb-85425f6af991</d6p1:Identity> <d6p1:Name>sample string 2</d6p1:Name> </d6p1:NamedObject> </d2p1:ResourceGroups> <d2p1:ResourceType xmlns:d6p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security"> <d6p1:Identity>b24faa3c-e4e7-4981-8abb-85425f6af991</d6p1:Identity> <d6p1:Name>sample string 2</d6p1:Name> </d2p1:ResourceType> </d2p1:ResourceRequirementTemplate> </d2p1:ResourceRestrictionRules> </d2p1:BookingType> <d2p1:BookingType> <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">d3f27b7c-0143-4e4f-8c4b-cf8b6d012b27</Identity> <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 7</Name> <d2p1:ReadPermissionGroups xmlns:d4p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security"> <d4p1:NamedObject> <d4p1:Identity>b24faa3c-e4e7-4981-8abb-85425f6af991</d4p1:Identity> <d4p1:Name>sample string 2</d4p1:Name> </d4p1:NamedObject> <d4p1:NamedObject> <d4p1:Identity>b24faa3c-e4e7-4981-8abb-85425f6af991</d4p1:Identity> <d4p1:Name>sample string 2</d4p1:Name> </d4p1:NamedObject> </d2p1:ReadPermissionGroups> <d2p1:WritePermissionGroups xmlns:d4p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security"> <d4p1:NamedObject> <d4p1:Identity>b24faa3c-e4e7-4981-8abb-85425f6af991</d4p1:Identity> <d4p1:Name>sample string 2</d4p1:Name> </d4p1:NamedObject> <d4p1:NamedObject> <d4p1:Identity>b24faa3c-e4e7-4981-8abb-85425f6af991</d4p1:Identity> <d4p1:Name>sample string 2</d4p1:Name> </d4p1:NamedObject> </d2p1:WritePermissionGroups> <d2p1:BasePermissionGroups xmlns:d4p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security"> <d4p1:NamedObject> <d4p1:Identity>b24faa3c-e4e7-4981-8abb-85425f6af991</d4p1:Identity> <d4p1:Name>sample string 2</d4p1:Name> </d4p1:NamedObject> <d4p1:NamedObject> <d4p1:Identity>b24faa3c-e4e7-4981-8abb-85425f6af991</d4p1:Identity> <d4p1:Name>sample string 2</d4p1:Name> </d4p1:NamedObject> </d2p1:BasePermissionGroups> <d2p1:BoboPermissionGroups xmlns:d4p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security"> <d4p1:NamedObject> <d4p1:Identity>b24faa3c-e4e7-4981-8abb-85425f6af991</d4p1:Identity> <d4p1:Name>sample string 2</d4p1:Name> </d4p1:NamedObject> <d4p1:NamedObject> <d4p1:Identity>b24faa3c-e4e7-4981-8abb-85425f6af991</d4p1:Identity> <d4p1:Name>sample string 2</d4p1:Name> </d4p1:NamedObject> </d2p1:BoboPermissionGroups> <d2p1:BookingForm xmlns:d4p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security"> <d4p1:Identity>b24faa3c-e4e7-4981-8abb-85425f6af991</d4p1:Identity> <d4p1:Name>sample string 2</d4p1:Name> </d2p1:BookingForm> <d2p1:CanBookAsSomeoneElse>true</d2p1:CanBookAsSomeoneElse> <d2p1:CanBookOnBehalfOf>true</d2p1:CanBookOnBehalfOf> <d2p1:CanEdit>true</d2p1:CanEdit> <d2p1:Description>sample string 1</d2p1:Description> <d2p1:HasExternallyManagedResources>true</d2p1:HasExternallyManagedResources> <d2p1:ImageUri>http://webapihelppage2.com/</d2p1:ImageUri> <d2p1:ResourceRestrictionRules> <d2p1:ResourceRequirementTemplate> <d2p1:AllowResourceSelection>true</d2p1:AllowResourceSelection> <d2p1:Identity>2ddd58f7-50fe-424b-a733-e46823f502cf</d2p1:Identity> <d2p1:IsPrimary>true</d2p1:IsPrimary> <d2p1:Max>4</d2p1:Max> <d2p1:Min>3</d2p1:Min> <d2p1:Name>sample string 1</d2p1:Name> <d2p1:ResourceGroups xmlns:d6p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security"> <d6p1:NamedObject> <d6p1:Identity>b24faa3c-e4e7-4981-8abb-85425f6af991</d6p1:Identity> <d6p1:Name>sample string 2</d6p1:Name> </d6p1:NamedObject> <d6p1:NamedObject> <d6p1:Identity>b24faa3c-e4e7-4981-8abb-85425f6af991</d6p1:Identity> <d6p1:Name>sample string 2</d6p1:Name> </d6p1:NamedObject> </d2p1:ResourceGroups> <d2p1:ResourceType xmlns:d6p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security"> <d6p1:Identity>b24faa3c-e4e7-4981-8abb-85425f6af991</d6p1:Identity> <d6p1:Name>sample string 2</d6p1:Name> </d2p1:ResourceType> </d2p1:ResourceRequirementTemplate> <d2p1:ResourceRequirementTemplate> <d2p1:AllowResourceSelection>true</d2p1:AllowResourceSelection> <d2p1:Identity>2ddd58f7-50fe-424b-a733-e46823f502cf</d2p1:Identity> <d2p1:IsPrimary>true</d2p1:IsPrimary> <d2p1:Max>4</d2p1:Max> <d2p1:Min>3</d2p1:Min> <d2p1:Name>sample string 1</d2p1:Name> <d2p1:ResourceGroups xmlns:d6p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security"> <d6p1:NamedObject> <d6p1:Identity>b24faa3c-e4e7-4981-8abb-85425f6af991</d6p1:Identity> <d6p1:Name>sample string 2</d6p1:Name> </d6p1:NamedObject> <d6p1:NamedObject> <d6p1:Identity>b24faa3c-e4e7-4981-8abb-85425f6af991</d6p1:Identity> <d6p1:Name>sample string 2</d6p1:Name> </d6p1:NamedObject> </d2p1:ResourceGroups> <d2p1:ResourceType xmlns:d6p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security"> <d6p1:Identity>b24faa3c-e4e7-4981-8abb-85425f6af991</d6p1:Identity> <d6p1:Name>sample string 2</d6p1:Name> </d2p1:ResourceType> </d2p1:ResourceRequirementTemplate> </d2p1:ResourceRestrictionRules> </d2p1:BookingType> </AssociatedBookingTypes> <Description>sample string 3</Description> <Identity>797c8e5f-cf7b-4a42-a607-ab2e30e37c9d</Identity> <Name>sample string 2</Name> <Sections xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model.ConfigurableBookingForms.Sections"> <d2p1:Section> <d2p1:Fields xmlns:d4p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model.ConfigurableBookingForms.Fields"> <d4p1:Field> <d4p1:Description>sample string 3</d4p1:Description> <d4p1:FieldType>Attachment</d4p1:FieldType> <d4p1:Identity>b97831be-08cd-4b98-a97f-370c15335e94</d4p1:Identity> <d4p1:IsActive>true</d4p1:IsActive> <d4p1:Rank>2</d4p1:Rank> </d4p1:Field> <d4p1:Field> <d4p1:Description>sample string 3</d4p1:Description> <d4p1:FieldType>Attachment</d4p1:FieldType> <d4p1:Identity>b97831be-08cd-4b98-a97f-370c15335e94</d4p1:Identity> <d4p1:IsActive>true</d4p1:IsActive> <d4p1:Rank>2</d4p1:Rank> </d4p1:Field> </d2p1:Fields> <d2p1:Identity>c9004cc1-46f6-4b2e-aa79-b6c384e4b734</d2p1:Identity> <d2p1:Name>sample string 2</d2p1:Name> <d2p1:Rank>3</d2p1:Rank> </d2p1:Section> <d2p1:Section> <d2p1:Fields xmlns:d4p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model.ConfigurableBookingForms.Fields"> <d4p1:Field> <d4p1:Description>sample string 3</d4p1:Description> <d4p1:FieldType>Attachment</d4p1:FieldType> <d4p1:Identity>b97831be-08cd-4b98-a97f-370c15335e94</d4p1:Identity> <d4p1:IsActive>true</d4p1:IsActive> <d4p1:Rank>2</d4p1:Rank> </d4p1:Field> <d4p1:Field> <d4p1:Description>sample string 3</d4p1:Description> <d4p1:FieldType>Attachment</d4p1:FieldType> <d4p1:Identity>b97831be-08cd-4b98-a97f-370c15335e94</d4p1:Identity> <d4p1:IsActive>true</d4p1:IsActive> <d4p1:Rank>2</d4p1:Rank> </d4p1:Field> </d2p1:Fields> <d2p1:Identity>c9004cc1-46f6-4b2e-aa79-b6c384e4b734</d2p1:Identity> <d2p1:Name>sample string 2</d2p1:Name> <d2p1:Rank>3</d2p1:Rank> </d2p1:Section> </Sections> </BookingForm>