POST Cases
Create service case according information sent in Servicecase instance
Request Information
URI Parameters
None.
Body Parameters
service case information
InitPro.Ida.Web.Api.Dto.Create.ServicecaseName | Description | Type | Additional information |
---|---|---|---|
CaseNumber |
Possibility to generate CaseNumber yourself instead of autocreate |
string |
Max length: 48 |
BusinessKey |
identifies the business case |
string |
Required |
Status |
StatusKey of start status |
string |
Required |
BookingDate |
Possibility to set booking time of status e.g.: "BookingDate": "2020-03-12T13:12:11Z" |
date |
None. |
Workflow |
Workflow is used when BusinessKey has no unique Workflow assigned. |
string |
None. |
Warranty |
Service case in Warranty? default - no |
boolean |
None. |
Customer |
identifies customer |
InitPro.Ida.Web.Api.Dto.Create.Customer |
Required |
DeliveryAddress |
possibility to add a differing delivery address |
InitPro.Ida.Web.Api.Dto.Create.Address |
None. |
InvoiceAddress |
possibility to add a differing delivery address |
InitPro.Ida.Web.Api.Dto.Create.Address |
None. |
Product |
identifies the device/product |
InitPro.Ida.Web.Api.Dto.Create.Product |
Required |
SymptomDescription |
Describes symptom/problem |
string |
Required |
SymptomCodes |
Possibility to add Symptom Codes "SymptomCodes": [["01001","02001",null,"03001","05001"],["01001","02001",null,"03001","05001"]] |
Collection of Collection of string |
None. |
Insurance |
Insurance data |
InitPro.Ida.Web.Api.Dto.Create.Insurance |
None. |
Comment |
what would a world be like without a comment everywhere ;) |
string |
None. |
Store |
Store will be added |
string |
None. |
Pricelist |
Connects servicecase to a pricelist - Pricelist feature has to be enabled for your company |
string |
None. |
Commoncharges |
Add Commoncharges to your service case |
Collection of InitPro.Ida.Web.Api.Dto.Create.CommonCharge |
None. |
Service |
add Servicetype and/or Priority to your service case |
InitPro.Ida.Web.Api.Dto.Service |
None. |
Attributes |
Case Attributes |
InitPro.Ida.Web.Api.Dto.Create.Attributes |
None. |
References |
add Case References |
InitPro.Ida.Web.Api.Dto.Create.References |
None. |
ProofOfPurchase | InitPro.Ida.Web.Api.Dto.ProofOfPurchase |
None. |
Request Formats
application/json, text/json
{ "CaseNumber": "sample string 1", "BusinessKey": "sample string 2", "Status": "sample string 3", "BookingDate": "2025-04-29T16:20:05.8139313+02:00", "Workflow": "sample string 4", "Warranty": true, "Customer": { "CustomerContactType": "sample string 1", "CustomerNumber": "sample string 2", "Language": "sample string 3", "Currency": "sample string 4", "TermsOfPayment": "sample string 5", "Salutation": "sample string 6", "FirstName": "sample string 7", "LastName": "sample string 8", "CompanyName": "sample string 9", "Department": "sample string 10", "Phone": "sample string 11", "PhoneMobile": "sample string 12", "Email": "sample string 13", "Street": "sample string 14", "Additional": "sample string 15", "ZipCode": "sample string 16", "City": "sample string 17", "Country": "sample string 18", "State": "sample string 19", "DateOfBirth": "2025-04-29" }, "DeliveryAddress": { "Salutation": "sample string 1", "FirstName": "sample string 2", "LastName": "sample string 3", "CompanyName": "sample string 4", "Department": "sample string 5", "Phone": "sample string 6", "PhoneMobile": "sample string 7", "Email": "sample string 8", "Street": "sample string 9", "Additional": "sample string 10", "ZipCode": "sample string 11", "City": "sample string 12", "Country": "sample string 13", "State": "sample string 14", "DateOfBirth": "2025-04-29" }, "InvoiceAddress": { "Salutation": "sample string 1", "FirstName": "sample string 2", "LastName": "sample string 3", "CompanyName": "sample string 4", "Department": "sample string 5", "Phone": "sample string 6", "PhoneMobile": "sample string 7", "Email": "sample string 8", "Street": "sample string 9", "Additional": "sample string 10", "ZipCode": "sample string 11", "City": "sample string 12", "Country": "sample string 13", "State": "sample string 14", "DateOfBirth": "2025-04-29" }, "Product": { "ProductId": 1, "ProductArticleNumber": "sample string 2", "SerialNumber": "sample string 3", "SecondSerialNumber": "sample string 4", "Pin": "sample string 5" }, "SymptomDescription": "sample string 6", "SymptomCodes": [ [ "sample string 1", "sample string 2" ], [ "sample string 1", "sample string 2" ] ], "Insurance": { "InsuranceKey": "sample string 1", "ContractNumber": "sample string 2", "ClaimNumber": "sample string 3", "AuthorizationNumber": "sample string 4", "Retention": 1.0, "RetentionAccepted": true, "StreetPrice": 1.0, "AdditionalInformation": "sample string 6" }, "Comment": "sample string 7", "Store": "sample string 8", "Pricelist": "sample string 9", "Commoncharges": [ { "CommonChargeKey": "sample string 1", "PriceNet": 1.0 }, { "CommonChargeKey": "sample string 1", "PriceNet": 1.0 } ], "Service": { "Servicetype": "sample string 1", "ServicetypeKey": "sample string 2", "Priority": "sample string 3" }, "Attributes": { "Recustomize": true, "CustomerInquiry": true, "Backup": true }, "References": { "Reference1": "sample string 1", "Reference2": "sample string 2", "Reference3": "sample string 3", "Reference4": "sample string 4" }, "ProofOfPurchase": { "PurchaseDate": "sample string 1", "WarrantyEndDate": "sample string 2", "Validated": true } }
application/xml, text/xml
<Servicecase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/InitPro.Ida.Web.Api.Dto.Create"> <Attributes> <Backup>true</Backup> <CustomerInquiry>true</CustomerInquiry> <Recustomize>true</Recustomize> </Attributes> <BookingDate>2025-04-29T16:20:05.8139313+02:00</BookingDate> <BusinessKey>sample string 2</BusinessKey> <CaseNumber>sample string 1</CaseNumber> <Comment>sample string 7</Comment> <Commoncharges> <CommonCharge> <CommonChargeKey>sample string 1</CommonChargeKey> <PriceNet>1</PriceNet> </CommonCharge> <CommonCharge> <CommonChargeKey>sample string 1</CommonChargeKey> <PriceNet>1</PriceNet> </CommonCharge> </Commoncharges> <Customer> <Additional>sample string 15</Additional> <City>sample string 17</City> <CompanyName>sample string 9</CompanyName> <Country>sample string 18</Country> <DateOfBirth>2025-04-29T16:20:05.8139313+02:00</DateOfBirth> <Department>sample string 10</Department> <Email>sample string 13</Email> <FirstName>sample string 7</FirstName> <LastName>sample string 8</LastName> <Phone>sample string 11</Phone> <PhoneMobile>sample string 12</PhoneMobile> <Salutation>sample string 6</Salutation> <State>sample string 19</State> <Street>sample string 14</Street> <ZipCode>sample string 16</ZipCode> <Currency>sample string 4</Currency> <CustomerContactType>sample string 1</CustomerContactType> <CustomerNumber>sample string 2</CustomerNumber> <Language>sample string 3</Language> <TermsOfPayment>sample string 5</TermsOfPayment> </Customer> <DeliveryAddress> <Additional>sample string 10</Additional> <City>sample string 12</City> <CompanyName>sample string 4</CompanyName> <Country>sample string 13</Country> <DateOfBirth>2025-04-29T16:20:05.8139313+02:00</DateOfBirth> <Department>sample string 5</Department> <Email>sample string 8</Email> <FirstName>sample string 2</FirstName> <LastName>sample string 3</LastName> <Phone>sample string 6</Phone> <PhoneMobile>sample string 7</PhoneMobile> <Salutation>sample string 1</Salutation> <State>sample string 14</State> <Street>sample string 9</Street> <ZipCode>sample string 11</ZipCode> </DeliveryAddress> <Insurance> <AdditionalInformation>sample string 6</AdditionalInformation> <AuthorizationNumber>sample string 4</AuthorizationNumber> <ClaimNumber>sample string 3</ClaimNumber> <ContractNumber>sample string 2</ContractNumber> <InsuranceKey>sample string 1</InsuranceKey> <Retention>1</Retention> <RetentionAccepted>true</RetentionAccepted> <StreetPrice>1</StreetPrice> </Insurance> <InvoiceAddress> <Additional>sample string 10</Additional> <City>sample string 12</City> <CompanyName>sample string 4</CompanyName> <Country>sample string 13</Country> <DateOfBirth>2025-04-29T16:20:05.8139313+02:00</DateOfBirth> <Department>sample string 5</Department> <Email>sample string 8</Email> <FirstName>sample string 2</FirstName> <LastName>sample string 3</LastName> <Phone>sample string 6</Phone> <PhoneMobile>sample string 7</PhoneMobile> <Salutation>sample string 1</Salutation> <State>sample string 14</State> <Street>sample string 9</Street> <ZipCode>sample string 11</ZipCode> </InvoiceAddress> <Pricelist>sample string 9</Pricelist> <Product> <Pin>sample string 5</Pin> <ProductArticleNumber>sample string 2</ProductArticleNumber> <ProductId>1</ProductId> <SecondSerialNumber>sample string 4</SecondSerialNumber> <SerialNumber>sample string 3</SerialNumber> </Product> <ProofOfPurchase xmlns:d2p1="http://schemas.datacontract.org/2004/07/InitPro.Ida.Web.Api.Dto"> <d2p1:PurchaseDate>sample string 1</d2p1:PurchaseDate> <d2p1:Validated>true</d2p1:Validated> <d2p1:WarrantyEndDate>sample string 2</d2p1:WarrantyEndDate> </ProofOfPurchase> <References> <Reference1>sample string 1</Reference1> <Reference2>sample string 2</Reference2> <Reference3>sample string 3</Reference3> <Reference4>sample string 4</Reference4> </References> <Service xmlns:d2p1="http://schemas.datacontract.org/2004/07/InitPro.Ida.Web.Api.Dto"> <d2p1:Priority>sample string 3</d2p1:Priority> <d2p1:Servicetype>sample string 1</d2p1:Servicetype> <d2p1:ServicetypeKey>sample string 2</d2p1:ServicetypeKey> </Service> <Status>sample string 3</Status> <Store>sample string 8</Store> <SymptomCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:ArrayOfstring> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </d2p1:ArrayOfstring> <d2p1:ArrayOfstring> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </d2p1:ArrayOfstring> </SymptomCodes> <SymptomDescription>sample string 6</SymptomDescription> <Warranty>true</Warranty> <Workflow>sample string 4</Workflow> </Servicecase>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
Http StatusCode - 200 and service case Number, 400 and error information in case of errors
System.Web.Http.IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample not available.