POST API/{profileId}/Inflow/Save
Post Inflow Object - Generates Magic Link and stores inflow progress
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
profileId | string |
Required |
Body Parameters
CH.Domain.APIModels.Inflow.InflowFormName | Description | Type | Additional information |
---|---|---|---|
User | CH.Domain.APIModels.Users.User |
None. |
|
PKID | integer |
None. |
|
OriginalPKID | integer |
None. |
|
Version | integer |
None. |
|
Source | string |
None. |
|
DateCreated | date |
None. |
|
DateUserNotification | date |
None. |
|
DatePublished | date |
None. |
|
UserID | string |
None. |
|
ProfileID | string |
None. |
|
MagicLink | string |
None. |
|
FunctionalArea | CH.Domain.APIModels.PayloadSubmissions.FunctionalAreas |
None. |
|
Data | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "user": { "value": "sample string 1", "name": "sample string 2", "firstName": "sample string 3", "middleName": "sample string 4", "lastName": "sample string 5", "email": "sample string 6", "orcidID": "sample string 7", "userAffiliations": [ { "pkid": 1, "value": "sample string 2", "name": "sample string 3", "customer": { "name": "sample string 1", "value": "sample string 2", "customerId": "sample string 3", "gridID": "sample string 4", "rorID": "sample string 5", "ringGoldID": "sample string 6", "isni": "sample string 7", "openAlexID": "sample string 8", "parentCustomerID": "sample string 9", "countryCode": "sample string 10", "street": "sample string 11", "city": "sample string 12", "postalCode": "sample string 13", "category": "sample string 14", "state": "sample string 15" }, "isPrimary": true, "facultyID": "sample string 4", "departmentID": "sample string 5", "department": "sample string 6", "address1": "sample string 7", "address2": "sample string 8", "address3": "sample string 9", "address4": "sample string 10", "city": "sample string 11", "state": "sample string 12", "postalCode": "sample string 13", "countryCode": "sample string 14" }, { "pkid": 1, "value": "sample string 2", "name": "sample string 3", "customer": { "name": "sample string 1", "value": "sample string 2", "customerId": "sample string 3", "gridID": "sample string 4", "rorID": "sample string 5", "ringGoldID": "sample string 6", "isni": "sample string 7", "openAlexID": "sample string 8", "parentCustomerID": "sample string 9", "countryCode": "sample string 10", "street": "sample string 11", "city": "sample string 12", "postalCode": "sample string 13", "category": "sample string 14", "state": "sample string 15" }, "isPrimary": true, "facultyID": "sample string 4", "departmentID": "sample string 5", "department": "sample string 6", "address1": "sample string 7", "address2": "sample string 8", "address3": "sample string 9", "address4": "sample string 10", "city": "sample string 11", "state": "sample string 12", "postalCode": "sample string 13", "countryCode": "sample string 14" } ], "userProfiles": [ { "pkid": 1, "value": "sample string 2", "name": "sample string 3", "profileID": "sample string 4", "roleID": "sample string 5" }, { "pkid": 1, "value": "sample string 2", "name": "sample string 3", "profileID": "sample string 4", "roleID": "sample string 5" } ], "userEmails": [ { "pkid": 1, "changed": 2, "providerId": "sample string 3", "userID": "sample string 4", "email": "sample string 5", "isPrimary": true, "emailType": 7, "emailLabel": "sample string 8" }, { "pkid": 1, "changed": 2, "providerId": "sample string 3", "userID": "sample string 4", "email": "sample string 5", "isPrimary": true, "emailType": 7, "emailLabel": "sample string 8" } ], "password": "sample string 8", "title": "sample string 9", "phone": "sample string 10", "acsId": "sample string 11", "orcidToken": "sample string 12", "paragonPlusId": "sample string 13", "netForumId": "sample string 14" }, "pkid": 1, "originalPKID": 1, "version": 1, "source": "sample string 2", "dateCreated": "2025-01-29T03:00:10.587627+00:00", "dateUserNotification": "2025-01-29T03:00:10.587627+00:00", "datePublished": "2025-01-29T03:00:10.587627+00:00", "userID": "sample string 3", "profileID": "sample string 4", "magicLink": "sample string 5", "functionalArea": 0, "data": "sample string 6" }
application/xml, text/xml
Sample:
<InflowForm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.Inflow"> <Data xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.PayloadSubmissions">sample string 6</Data> <DateCreated xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.PayloadSubmissions">2025-01-29T03:00:10.587627+00:00</DateCreated> <DatePublished xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.PayloadSubmissions">2025-01-29T03:00:10.587627+00:00</DatePublished> <DateUserNotification xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.PayloadSubmissions">2025-01-29T03:00:10.587627+00:00</DateUserNotification> <FunctionalArea xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.PayloadSubmissions">NotFound</FunctionalArea> <MagicLink xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.PayloadSubmissions">sample string 5</MagicLink> <OriginalPKID xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.PayloadSubmissions">1</OriginalPKID> <PKID xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.PayloadSubmissions">1</PKID> <ProfileID xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.PayloadSubmissions">sample string 4</ProfileID> <Source xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.PayloadSubmissions">sample string 2</Source> <UserID xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.PayloadSubmissions">sample string 3</UserID> <Version xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.PayloadSubmissions">1</Version> <User xmlns:d2p1="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.Users"> <Name xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.General">sample string 2</Name> <Value xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.General">sample string 1</Value> <d2p1:AcsId>sample string 11</d2p1:AcsId> <d2p1:Email>sample string 6</d2p1:Email> <d2p1:FirstName>sample string 3</d2p1:FirstName> <d2p1:LastName>sample string 5</d2p1:LastName> <d2p1:MiddleName>sample string 4</d2p1:MiddleName> <d2p1:NetForumId>sample string 14</d2p1:NetForumId> <d2p1:OrcidID>sample string 7</d2p1:OrcidID> <d2p1:OrcidToken>sample string 12</d2p1:OrcidToken> <d2p1:ParagonPlusId>sample string 13</d2p1:ParagonPlusId> <d2p1:Password>sample string 8</d2p1:Password> <d2p1:Phone>sample string 10</d2p1:Phone> <d2p1:Title>sample string 9</d2p1:Title> <d2p1:UserAffiliations xmlns:d3p1="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.Users.UserData"> <d3p1:UserAffiliation> <Name xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.General">sample string 3</Name> <Value xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.General">sample string 2</Value> <d3p1:Address1>sample string 7</d3p1:Address1> <d3p1:Address2>sample string 8</d3p1:Address2> <d3p1:Address3>sample string 9</d3p1:Address3> <d3p1:Address4>sample string 10</d3p1:Address4> <d3p1:City>sample string 11</d3p1:City> <d3p1:CountryCode>sample string 14</d3p1:CountryCode> <d3p1:Customer xmlns:d5p1="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.Customers"> <d5p1:Category>sample string 14</d5p1:Category> <d5p1:City>sample string 12</d5p1:City> <d5p1:CountryCode>sample string 10</d5p1:CountryCode> <d5p1:CustomerId>sample string 3</d5p1:CustomerId> <d5p1:GridID>sample string 4</d5p1:GridID> <d5p1:ISNI>sample string 7</d5p1:ISNI> <d5p1:Name>sample string 1</d5p1:Name> <d5p1:OpenAlexID>sample string 8</d5p1:OpenAlexID> <d5p1:ParentCustomerID>sample string 9</d5p1:ParentCustomerID> <d5p1:PostalCode>sample string 13</d5p1:PostalCode> <d5p1:RingGoldID>sample string 6</d5p1:RingGoldID> <d5p1:RorID>sample string 5</d5p1:RorID> <d5p1:State>sample string 15</d5p1:State> <d5p1:Street>sample string 11</d5p1:Street> <d5p1:Value>sample string 2</d5p1:Value> </d3p1:Customer> <d3p1:Department>sample string 6</d3p1:Department> <d3p1:DepartmentID>sample string 5</d3p1:DepartmentID> <d3p1:FacultyID>sample string 4</d3p1:FacultyID> <d3p1:IsPrimary>true</d3p1:IsPrimary> <d3p1:PKID>1</d3p1:PKID> <d3p1:PostalCode>sample string 13</d3p1:PostalCode> <d3p1:State>sample string 12</d3p1:State> </d3p1:UserAffiliation> <d3p1:UserAffiliation> <Name xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.General">sample string 3</Name> <Value xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.General">sample string 2</Value> <d3p1:Address1>sample string 7</d3p1:Address1> <d3p1:Address2>sample string 8</d3p1:Address2> <d3p1:Address3>sample string 9</d3p1:Address3> <d3p1:Address4>sample string 10</d3p1:Address4> <d3p1:City>sample string 11</d3p1:City> <d3p1:CountryCode>sample string 14</d3p1:CountryCode> <d3p1:Customer xmlns:d5p1="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.Customers"> <d5p1:Category>sample string 14</d5p1:Category> <d5p1:City>sample string 12</d5p1:City> <d5p1:CountryCode>sample string 10</d5p1:CountryCode> <d5p1:CustomerId>sample string 3</d5p1:CustomerId> <d5p1:GridID>sample string 4</d5p1:GridID> <d5p1:ISNI>sample string 7</d5p1:ISNI> <d5p1:Name>sample string 1</d5p1:Name> <d5p1:OpenAlexID>sample string 8</d5p1:OpenAlexID> <d5p1:ParentCustomerID>sample string 9</d5p1:ParentCustomerID> <d5p1:PostalCode>sample string 13</d5p1:PostalCode> <d5p1:RingGoldID>sample string 6</d5p1:RingGoldID> <d5p1:RorID>sample string 5</d5p1:RorID> <d5p1:State>sample string 15</d5p1:State> <d5p1:Street>sample string 11</d5p1:Street> <d5p1:Value>sample string 2</d5p1:Value> </d3p1:Customer> <d3p1:Department>sample string 6</d3p1:Department> <d3p1:DepartmentID>sample string 5</d3p1:DepartmentID> <d3p1:FacultyID>sample string 4</d3p1:FacultyID> <d3p1:IsPrimary>true</d3p1:IsPrimary> <d3p1:PKID>1</d3p1:PKID> <d3p1:PostalCode>sample string 13</d3p1:PostalCode> <d3p1:State>sample string 12</d3p1:State> </d3p1:UserAffiliation> </d2p1:UserAffiliations> <d2p1:UserEmails xmlns:d3p1="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.Users.UserData"> <d3p1:UserEmail> <d3p1:Changed>2</d3p1:Changed> <d3p1:Email>sample string 5</d3p1:Email> <d3p1:EmailLabel>sample string 8</d3p1:EmailLabel> <d3p1:EmailType>7</d3p1:EmailType> <d3p1:IsPrimary>true</d3p1:IsPrimary> <d3p1:PKID>1</d3p1:PKID> <d3p1:ProviderId>sample string 3</d3p1:ProviderId> <d3p1:UserID>sample string 4</d3p1:UserID> </d3p1:UserEmail> <d3p1:UserEmail> <d3p1:Changed>2</d3p1:Changed> <d3p1:Email>sample string 5</d3p1:Email> <d3p1:EmailLabel>sample string 8</d3p1:EmailLabel> <d3p1:EmailType>7</d3p1:EmailType> <d3p1:IsPrimary>true</d3p1:IsPrimary> <d3p1:PKID>1</d3p1:PKID> <d3p1:ProviderId>sample string 3</d3p1:ProviderId> <d3p1:UserID>sample string 4</d3p1:UserID> </d3p1:UserEmail> </d2p1:UserEmails> <d2p1:UserProfiles xmlns:d3p1="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.Users.UserData"> <d3p1:UserProfile> <Name xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.General">sample string 3</Name> <Value xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.General">sample string 2</Value> <d3p1:PKID>1</d3p1:PKID> <d3p1:ProfileID>sample string 4</d3p1:ProfileID> <d3p1:RoleID>sample string 5</d3p1:RoleID> </d3p1:UserProfile> <d3p1:UserProfile> <Name xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.General">sample string 3</Name> <Value xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.General">sample string 2</Value> <d3p1:PKID>1</d3p1:PKID> <d3p1:ProfileID>sample string 4</d3p1:ProfileID> <d3p1:RoleID>sample string 5</d3p1:RoleID> </d3p1:UserProfile> </d2p1:UserProfiles> </User> </InflowForm>
multipart/form-data
Sample:
<InflowForm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.Inflow"><Data xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.PayloadSubmissions">sample string 6</Data><DateCreated xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.PayloadSubmissions">2025-01-29T03:00:10.587627+00:00</DateCreated><DatePublished xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.PayloadSubmissions">2025-01-29T03:00:10.587627+00:00</DatePublished><DateUserNotification xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.PayloadSubmissions">2025-01-29T03:00:10.587627+00:00</DateUserNotification><FunctionalArea xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.PayloadSubmissions">NotFound</FunctionalArea><MagicLink xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.PayloadSubmissions">sample string 5</MagicLink><OriginalPKID xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.PayloadSubmissions">1</OriginalPKID><PKID xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.PayloadSubmissions">1</PKID><ProfileID xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.PayloadSubmissions">sample string 4</ProfileID><Source xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.PayloadSubmissions">sample string 2</Source><UserID xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.PayloadSubmissions">sample string 3</UserID><Version xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.PayloadSubmissions">1</Version><User xmlns:d2p1="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.Users"><Name xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.General">sample string 2</Name><Value xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.General">sample string 1</Value><d2p1:AcsId>sample string 11</d2p1:AcsId><d2p1:Email>sample string 6</d2p1:Email><d2p1:FirstName>sample string 3</d2p1:FirstName><d2p1:LastName>sample string 5</d2p1:LastName><d2p1:MiddleName>sample string 4</d2p1:MiddleName><d2p1:NetForumId>sample string 14</d2p1:NetForumId><d2p1:OrcidID>sample string 7</d2p1:OrcidID><d2p1:OrcidToken>sample string 12</d2p1:OrcidToken><d2p1:ParagonPlusId>sample string 13</d2p1:ParagonPlusId><d2p1:Password>sample string 8</d2p1:Password><d2p1:Phone>sample string 10</d2p1:Phone><d2p1:Title>sample string 9</d2p1:Title><d2p1:UserAffiliations xmlns:d3p1="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.Users.UserData"><d3p1:UserAffiliation><Name xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.General">sample string 3</Name><Value xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.General">sample string 2</Value><d3p1:Address1>sample string 7</d3p1:Address1><d3p1:Address2>sample string 8</d3p1:Address2><d3p1:Address3>sample string 9</d3p1:Address3><d3p1:Address4>sample string 10</d3p1:Address4><d3p1:City>sample string 11</d3p1:City><d3p1:CountryCode>sample string 14</d3p1:CountryCode><d3p1:Customer xmlns:d5p1="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.Customers"><d5p1:Category>sample string 14</d5p1:Category><d5p1:City>sample string 12</d5p1:City><d5p1:CountryCode>sample string 10</d5p1:CountryCode><d5p1:CustomerId>sample string 3</d5p1:CustomerId><d5p1:GridID>sample string 4</d5p1:GridID><d5p1:ISNI>sample string 7</d5p1:ISNI><d5p1:Name>sample string 1</d5p1:Name><d5p1:OpenAlexID>sample string 8</d5p1:OpenAlexID><d5p1:ParentCustomerID>sample string 9</d5p1:ParentCustomerID><d5p1:PostalCode>sample string 13</d5p1:PostalCode><d5p1:RingGoldID>sample string 6</d5p1:RingGoldID><d5p1:RorID>sample string 5</d5p1:RorID><d5p1:State>sample string 15</d5p1:State><d5p1:Street>sample string 11</d5p1:Street><d5p1:Value>sample string 2</d5p1:Value></d3p1:Customer><d3p1:Department>sample string 6</d3p1:Department><d3p1:DepartmentID>sample string 5</d3p1:DepartmentID><d3p1:FacultyID>sample string 4</d3p1:FacultyID><d3p1:IsPrimary>true</d3p1:IsPrimary><d3p1:PKID>1</d3p1:PKID><d3p1:PostalCode>sample string 13</d3p1:PostalCode><d3p1:State>sample string 12</d3p1:State></d3p1:UserAffiliation><d3p1:UserAffiliation><Name xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.General">sample string 3</Name><Value xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.General">sample string 2</Value><d3p1:Address1>sample string 7</d3p1:Address1><d3p1:Address2>sample string 8</d3p1:Address2><d3p1:Address3>sample string 9</d3p1:Address3><d3p1:Address4>sample string 10</d3p1:Address4><d3p1:City>sample string 11</d3p1:City><d3p1:CountryCode>sample string 14</d3p1:CountryCode><d3p1:Customer xmlns:d5p1="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.Customers"><d5p1:Category>sample string 14</d5p1:Category><d5p1:City>sample string 12</d5p1:City><d5p1:CountryCode>sample string 10</d5p1:CountryCode><d5p1:CustomerId>sample string 3</d5p1:CustomerId><d5p1:GridID>sample string 4</d5p1:GridID><d5p1:ISNI>sample string 7</d5p1:ISNI><d5p1:Name>sample string 1</d5p1:Name><d5p1:OpenAlexID>sample string 8</d5p1:OpenAlexID><d5p1:ParentCustomerID>sample string 9</d5p1:ParentCustomerID><d5p1:PostalCode>sample string 13</d5p1:PostalCode><d5p1:RingGoldID>sample string 6</d5p1:RingGoldID><d5p1:RorID>sample string 5</d5p1:RorID><d5p1:State>sample string 15</d5p1:State><d5p1:Street>sample string 11</d5p1:Street><d5p1:Value>sample string 2</d5p1:Value></d3p1:Customer><d3p1:Department>sample string 6</d3p1:Department><d3p1:DepartmentID>sample string 5</d3p1:DepartmentID><d3p1:FacultyID>sample string 4</d3p1:FacultyID><d3p1:IsPrimary>true</d3p1:IsPrimary><d3p1:PKID>1</d3p1:PKID><d3p1:PostalCode>sample string 13</d3p1:PostalCode><d3p1:State>sample string 12</d3p1:State></d3p1:UserAffiliation></d2p1:UserAffiliations><d2p1:UserEmails xmlns:d3p1="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.Users.UserData"><d3p1:UserEmail><d3p1:Changed>2</d3p1:Changed><d3p1:Email>sample string 5</d3p1:Email><d3p1:EmailLabel>sample string 8</d3p1:EmailLabel><d3p1:EmailType>7</d3p1:EmailType><d3p1:IsPrimary>true</d3p1:IsPrimary><d3p1:PKID>1</d3p1:PKID><d3p1:ProviderId>sample string 3</d3p1:ProviderId><d3p1:UserID>sample string 4</d3p1:UserID></d3p1:UserEmail><d3p1:UserEmail><d3p1:Changed>2</d3p1:Changed><d3p1:Email>sample string 5</d3p1:Email><d3p1:EmailLabel>sample string 8</d3p1:EmailLabel><d3p1:EmailType>7</d3p1:EmailType><d3p1:IsPrimary>true</d3p1:IsPrimary><d3p1:PKID>1</d3p1:PKID><d3p1:ProviderId>sample string 3</d3p1:ProviderId><d3p1:UserID>sample string 4</d3p1:UserID></d3p1:UserEmail></d2p1:UserEmails><d2p1:UserProfiles xmlns:d3p1="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.Users.UserData"><d3p1:UserProfile><Name xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.General">sample string 3</Name><Value xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.General">sample string 2</Value><d3p1:PKID>1</d3p1:PKID><d3p1:ProfileID>sample string 4</d3p1:ProfileID><d3p1:RoleID>sample string 5</d3p1:RoleID></d3p1:UserProfile><d3p1:UserProfile><Name xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.General">sample string 3</Name><Value xmlns="http://schemas.datacontract.org/2004/07/CH.Domain.APIModels.General">sample string 2</Value><d3p1:PKID>1</d3p1:PKID><d3p1:ProfileID>sample string 4</d3p1:ProfileID><d3p1:RoleID>sample string 5</d3p1:RoleID></d3p1:UserProfile></d2p1:UserProfiles></User></InflowForm>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
Returns Success
System.Web.Http.IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml, multipart/form-data
Sample:
Sample not available.