DigiOffice Gateway Web Services

<back to all web services

GetRegistrationprofileDetailsWithStandardDocument

Requires Authentication
GetRegistrationprofileDetailsWithStandardDocument Parameters:
NameParameterData TypeRequiredDescription
StandardDocumentIDqueryGuidNo
IsOffice365ContextqueryboolNo
RegistrationprofileDetails Parameters:
NameParameterData TypeRequiredDescription
StepsformList<RegistrationprofileStep>No
MessagesformList<InformationMessageBase>No
ReadOnlyformboolNo
Registrationprofile Parameters:
NameParameterData TypeRequiredDescription
IDformGuidNo
NameformstringNo
HintformstringNo
OrderformintNo
RegisterAutomaticallyformboolNo
RegisterInBackgroundformboolNo
ThumbnailUrlformstringNo
ProgCodeformstringNo
VersionControlTypeformintNo
WOPlaceLogoformintNo
WOPrinterBinsformstringNo
SelectAllFilesformboolNo
RegistrationprofileStep Parameters:
NameParameterData TypeRequiredDescription
IDformGuidNo
NameformstringNo
OrderformintNo
LayoutformRegistrationprofileStepLayoutNo
GroupsformList<RegistrationprofileGroup>No
RegistrationprofileStepLayout Enum:
OneColumn_12
TwoColumn_6_6
TwoColumn_7_5
ThreeColumn_4_4_4
RegistrationprofileGroup Parameters:
NameParameterData TypeRequiredDescription
IDformGuidNo
NameformstringNo
LabelformstringNo
OrderformintNo
ColumnIndexformintNo
FieldsformList<RegistrationprofileField>No
LabelLayoutTypeformintNo
RegistrationprofileField Parameters:
NameParameterData TypeRequiredDescription
IDformGuidNo
DocumentFieldIDformGuidNo
LabelformstringNo
UserControlTypeformstringNo
UserControlPropertiesformList<SerializableKeyValuePair<String,Object>>No
HintformstringNo
OrderformintNo
HasDependableFieldsformboolNo
EntityNameformstringNo
StateformRegistrationProfileFieldStateBaseNo
RegistrationProfileFieldStateBase Parameters:
NameParameterData TypeRequiredDescription
DocumentFieldIDformGuidNo
RequiredformboolNo
VisibleformboolNo
ReadonlyformboolNo
InformationMessageBase Parameters:
NameParameterData TypeRequiredDescription
TypeformMessageTypeNo
SummaryformstringNo
FullMessageformstringNo
FieldNameformstringNo
KeepOpenformboolNo
MessageType Enum:
NameValue
Information1
Warning2
Error3
Success4

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /csv/reply/GetRegistrationprofileDetailsWithStandardDocument HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"StandardDocumentID":"00000000-0000-0000-0000-000000000000","IsOffice365Context":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Steps":[{"ID":"00000000-0000-0000-0000-000000000000","Name":"String","Order":0,"Layout":"OneColumn_12","Groups":[{"ID":"00000000-0000-0000-0000-000000000000","Name":"String","Label":"String","Order":0,"ColumnIndex":0,"Fields":[{"ID":"00000000-0000-0000-0000-000000000000","DocumentFieldID":"00000000-0000-0000-0000-000000000000","Label":"String","UserControlType":"String","UserControlProperties":[{}],"Hint":"String","Order":0,"HasDependableFields":false,"EntityName":"String","State":{"DocumentFieldID":"00000000-0000-0000-0000-000000000000","Required":false,"Visible":false,"Readonly":false}}],"LabelLayoutType":0}]}],"Messages":[{}],"ReadOnly":false,"ID":"00000000-0000-0000-0000-000000000000","Name":"String","Hint":"String","Order":0,"RegisterAutomatically":false,"RegisterInBackground":false,"ThumbnailUrl":"String","ProgCode":"String","VersionControlType":0,"WOPlaceLogo":0,"WOPrinterBins":"String","SelectAllFiles":false}